aboutsummaryrefslogtreecommitdiffhomepage
path: root/Firebase/Messaging/Public
diff options
context:
space:
mode:
authorGravatar Riz <rsattar@gmail.com>2017-07-31 15:23:53 -0700
committerGravatar GitHub <noreply@github.com>2017-07-31 15:23:53 -0700
commit91fee9d66dabc6d7db34df1a47fc22a50b45ffb2 (patch)
tree7fff9b708cf5f564ac2e75df72e546166cb6bcb6 /Firebase/Messaging/Public
parentf648d299549b5198c1d1da0c0ca512c0b299836c (diff)
Add comment about how multiple senders are supported (#158)
This is a slight tweak to the block comment describing `-retrieveFCMTokenForSenderID:completion:`, to more explicitly mention that this can be used to support the scenario of allow multiple senders to send notifications to the same client app.
Diffstat (limited to 'Firebase/Messaging/Public')
-rw-r--r--Firebase/Messaging/Public/FIRMessaging.h17
1 files changed, 11 insertions, 6 deletions
diff --git a/Firebase/Messaging/Public/FIRMessaging.h b/Firebase/Messaging/Public/FIRMessaging.h
index 409b562..7313f23 100644
--- a/Firebase/Messaging/Public/FIRMessaging.h
+++ b/Firebase/Messaging/Public/FIRMessaging.h
@@ -367,12 +367,17 @@ FIR_SWIFT_NAME(Messaging)
/**
- * Retrieves an FCM registration token for a particular Sender ID. This registration token is
- * not cached by FIRMessaging. FIRMessaging should have an APNS token set before calling this
- * to ensure that notifications can be delivered via APNS using this FCM token. You may
- * re-retrieve the FCM token once you have the APNS token set, to associate it with the FCM
- * token. The default FCM token is automatically associated with the APNS token, if the APNS
- * token data is available.
+ * Retrieves an FCM registration token for a particular Sender ID. This can be used to allow
+ * multiple senders to send notifications to the same device. By providing a different Sender
+ * ID than your default when fetching a token, you can create a new FCM token which you can
+ * give to a different sender. Both tokens will deliver notifications to your device, and you
+ * can revoke a token when you need to.
+ *
+ * This registration token is not cached by FIRMessaging. FIRMessaging should have an APNS
+ * token set before calling this to ensure that notifications can be delivered via APNS using
+ * this FCM token. You may re-retrieve the FCM token once you have the APNS token set, to
+ * associate it with the FCM token. The default FCM token is automatically associated with
+ * the APNS token, if the APNS token data is available.
*
* @param senderID The Sender ID for a particular Firebase project.
* @param completion The completion handler to handle the token request.