Skip to content

Update doc string for dryRun in FCM send methods. #509

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chong-shao merged 3 commits into from
Feb 19, 2021
Merged

Update doc string for dryRun in FCM send methods. #509

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3afbcf0
Update doc string for dryRun in FCM send methods to mention that it c…
chong-shao Jan 13, 2021
7a05b00
Address reviewers comments
chong-shao Jan 21, 2021
1eedc4d
Address reviewers comments
chong-shao Feb 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions src/main/java/com/google/firebase/messaging/FirebaseMessaging.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,9 @@ public String send(@NonNull Message message) throws FirebaseMessagingException {
* Sends the given {@link Message} via Firebase Cloud Messaging.
*
* <p>If the {@code dryRun} option is set to true, the message will not be actually sent. Instead
* FCM performs all the necessary validations, and emulates the send operation.
* FCM performs all the necessary validations and emulates the send operation. The {@code dryRun}
* option is useful for determining whether an FCM registration has been deleted. However, it
* cannot be used to validate APNs tokens.
*
* @param message A non-null {@link Message} to be sent.
* @param dryRun a boolean indicating whether to perform a dry run (validation only) of the send.
Expand Down Expand Up @@ -161,8 +163,10 @@ public BatchResponse sendAll(
* send the entire list as a single RPC call. Compared to the {@link #send(Message)} method, this
* is a significantly more efficient way to send multiple messages.
*
* <p>If the {@code dryRun} option is set to true, the messages will not be actually sent. Instead
* FCM performs all the necessary validations, and emulates the send operation.
* <p>If the {@code dryRun} option is set to true, the message will not be actually sent. Instead

@egilmorez egilmorez Jan 14, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comments as above.

* FCM performs all the necessary validations, and emulates the send operation. The {@code dryRun}
* option is useful for determining whether an FCM registration has been deleted. But it cannot be
* used to validate APNs tokens.
*
* <p>The responses list obtained by calling {@link BatchResponse#getResponses()} on the return
* value corresponds to the order of input messages.
Expand Down Expand Up @@ -227,7 +231,9 @@ public BatchResponse sendMulticast(
* Sends the given multicast message to all the FCM registration tokens specified in it.
*
* <p>If the {@code dryRun} option is set to true, the message will not be actually sent. Instead
* FCM performs all the necessary validations, and emulates the send operation.
* FCM performs all the necessary validations, and emulates the send operation. The {@code dryRun}
* option is useful for determining whether an FCM registration has been deleted. But it cannot be
* used to validate APNs tokens.
*
* <p>This method uses the {@link #sendAll(List)} API under the hood to send the given
* message to all the target recipients. The responses list obtained by calling
Expand Down