You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Options for features provided by the FCM SDK for Web. See [WebpushFcmOptions](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#webpushfcmoptions)
13
+
Options for features provided by the FCM SDK for Web. See [WebpushFcmOptions](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#webpushfcmoptions)<!---->.
| [serviceWorkerRegistration](./messaging_.gettokenoptions.md#gettokenoptionsserviceworkerregistration) | ServiceWorkerRegistration | Theserviceworkerregistrationforreceivingpushmessaging. Iftheregistrationisnotprovidedexplicitly, youneedtohavea <code>firebase-messaging-sw.js</code> atyourrootlocation. See [Retrievethecurrentregistrationtoken](https://firebase.google.com/docs/cloud-messaging/js/client#retrieve-the-current-registration-token) for more details. |
26
-
| [vapidKey](./messaging_.gettokenoptions.md#gettokenoptionsvapidkey) | string | Thepublicserverkeyprovidedtopushservices. Itisusedtoauthenticatethepushsubscriberstoreceivepushmessagesonlyfromsendingserversthatholdthecorrespondingprivatekey. Ifitisnotprovided, adefaultVAPIDkeyisused. Notethatsomepushservices (ChromePushService) requireanon-defaultVAPIDkey. Therefore, itisrecommendedtogenerateandimportaVAPIDkeyforyourprojectwith [ConfigureWebCredentialswithFCM](https://firebase.google.com/docs/cloud-messaging/js/client#configure_web_credentials_with_fcm)<!-- -->. See [The Web Push Protocol](https://developers.google.com/web/fundamentals/push-notifications/web-push-protocol) for details on web push services. |
25
+
| [serviceWorkerRegistration](./messaging_.gettokenoptions.md#gettokenoptionsserviceworkerregistration) | ServiceWorkerRegistration | Theserviceworkerregistrationforreceivingpushmessaging. Iftheregistrationisnotprovidedexplicitly, youneedtohavea <code>firebase-messaging-sw.js</code> atyourrootlocation. See [Accesstheregistrationtoken](https://firebase.google.com/docs/cloud-messaging/js/client#access_the_registration_token) for more details. |
26
+
| [vapidKey](./messaging_.gettokenoptions.md#gettokenoptionsvapidkey) | string | Thepublicserverkeyprovidedtopushservices. Thekeyisusedtoauthenticatepushsubscriberstoreceivepushmessagesonlyfromsendingserversthatholdthecorrespondingprivatekey. Ifitisnotprovided, adefaultVAPIDkeyisused. Notethatsomepushservices (ChromePushService) requireanon-defaultVAPIDkey. Therefore, itisrecommendedtogenerateandimportaVAPIDkeyforyourprojectwith [ConfigureWebCredentialswithFCM](https://firebase.google.com/docs/cloud-messaging/js/client#configure_web_credentials_in_your_app)<!-- -->. See [The Web Push Protocol](https://developers.google.com/web/fundamentals/push-notifications/web-push-protocol) for details on web push services. |
27
27
28
28
## GetTokenOptions.serviceWorkerRegistration
29
29
30
-
Theserviceworkerregistrationforreceivingpushmessaging. Iftheregistrationisnotprovidedexplicitly, youneedtohavea `firebase-messaging-sw.js` atyourrootlocation. See [Retrievethecurrentregistrationtoken](https://firebase.google.com/docs/cloud-messaging/js/client#retrieve-the-current-registration-token) for more details.
30
+
Theserviceworkerregistrationforreceivingpushmessaging. Iftheregistrationisnotprovidedexplicitly, youneedtohavea `firebase-messaging-sw.js` atyourrootlocation. See [Accesstheregistrationtoken](https://firebase.google.com/docs/cloud-messaging/js/client#access_the_registration_token) for more details.
Thepublicserverkeyprovidedtopushservices. Itisusedtoauthenticatethepushsubscriberstoreceivepushmessagesonlyfromsendingserversthatholdthecorrespondingprivatekey. Ifitisnotprovided, adefaultVAPIDkeyisused. Notethatsomepushservices (ChromePushService) requireanon-defaultVAPIDkey. Therefore, itisrecommendedtogenerateandimportaVAPIDkeyforyourprojectwith [ConfigureWebCredentialswithFCM](https://firebase.google.com/docs/cloud-messaging/js/client#configure_web_credentials_with_fcm)<!-- -->. See [The Web Push Protocol](https://developers.google.com/web/fundamentals/push-notifications/web-push-protocol) for details on web push services.
40
+
Thepublicserverkeyprovidedtopushservices. Thekeyisusedtoauthenticatepushsubscriberstoreceivepushmessagesonlyfromsendingserversthatholdthecorrespondingprivatekey. Ifitisnotprovided, adefaultVAPIDkeyisused. Notethatsomepushservices (ChromePushService) requireanon-defaultVAPIDkey. Therefore, itisrecommendedtogenerateandimportaVAPIDkeyforyourprojectwith [ConfigureWebCredentialswithFCM](https://firebase.google.com/docs/cloud-messaging/js/client#configure_web_credentials_in_your_app)<!-- -->. See [The Web Push Protocol](https://developers.google.com/web/fundamentals/push-notifications/web-push-protocol) for details on web push services.
|[getMessaging(app)](./messaging_.md#getmessaging)| Retrieves a Firebase Cloud Messaging instance. |
20
20
| <b>function(messaging...)</b> |
21
21
|[deleteToken(messaging)](./messaging_.md#deletetoken)| Deletes the registration token associated with this [Messaging](./messaging_.messaging.md#messaging_interface) instance and unsubscribes the [Messaging](./messaging_.messaging.md#messaging_interface) instance from the push subscription. |
22
-
|[getToken(messaging, options)](./messaging_.md#gettoken)| Subscribes the [Messaging](./messaging_.messaging.md#messaging_interface) instance to push notifications. Returns an Firebase Cloud Messaging registration token that can be used to send push messages to that [Messaging](./messaging_.messaging.md#messaging_interface) instance.<!---->If a notification permission isn't already granted, this method asks the user for permission. The returned promise rejects if the user does not allow the app to show notifications. |
22
+
|[getToken(messaging, options)](./messaging_.md#gettoken)| Subscribes the [Messaging](./messaging_.messaging.md#messaging_interface) instance to push notifications. Returns a Firebase Cloud Messaging registration token that can be used to send push messages to that [Messaging](./messaging_.messaging.md#messaging_interface) instance.<!---->If notification permission isn't already granted, this method asks the user for permission. The returned promise rejects if the user does not allow the app to show notifications. |
23
23
|[onMessage(messaging, nextOrObserver)](./messaging_.md#onmessage)| When a push message is received and the user is currently on a page for your origin, the message is passed to the page and an <code>onMessage()</code> event is dispatched with the payload of the push message. |
24
24
| <b>function()</b> |
25
25
|[isSupported()](./messaging_.md#issupported)| Checks if all required APIs exist in the browser. |
|[FcmOptions](./messaging_.fcmoptions.md#fcmoptions_interface)| Options for features provided by the FCM SDK for Web. See [WebpushFcmOptions](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#webpushfcmoptions)|
32
-
|[GetTokenOptions](./messaging_.gettokenoptions.md#gettokenoptions_interface)| Options for [getToken()](./messaging_.md#gettoken)|
33
-
|[MessagePayload](./messaging_.messagepayload.md#messagepayload_interface)| Message payload that contains the notification payload that is represented with [NotificationPayload](./messaging_.notificationpayload.md#notificationpayload_interface) and the data payload that contains an arbitrary number of key-value pairs sent by developers through the [Send API](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification)|
31
+
|[FcmOptions](./messaging_.fcmoptions.md#fcmoptions_interface)| Options for features provided by the FCM SDK for Web. See [WebpushFcmOptions](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#webpushfcmoptions)<!---->.|
32
+
|[GetTokenOptions](./messaging_.gettokenoptions.md#gettokenoptions_interface)| Options for [getToken()](./messaging_.md#gettoken)<!---->.|
33
+
|[MessagePayload](./messaging_.messagepayload.md#messagepayload_interface)| Message payload that contains the notification payload that is represented with [NotificationPayload](./messaging_.notificationpayload.md#notificationpayload_interface) and the data payload that contains an arbitrary number of key-value pairs sent by developers through the [Send API](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification)<!---->.|
34
34
|[Messaging](./messaging_.messaging.md#messaging_interface)| Public interface of the Firebase Cloud Messaging SDK. |
35
-
|[NotificationPayload](./messaging_.notificationpayload.md#notificationpayload_interface)| Display notification details. They are sent through the [Send API](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification)|
35
+
|[NotificationPayload](./messaging_.notificationpayload.md#notificationpayload_interface)| Display notification details. Details are sent through the [Send API](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification)<!---->.|
36
36
37
37
## getMessaging()
38
38
@@ -80,9 +80,9 @@ The promise resolves when the token has been successfully deleted.
80
80
81
81
## getToken()
82
82
83
-
Subscribes the [Messaging](./messaging_.messaging.md#messaging_interface) instance to push notifications. Returns an Firebase Cloud Messaging registration token that can be used to send push messages to that [Messaging](./messaging_.messaging.md#messaging_interface) instance.
83
+
Subscribes the [Messaging](./messaging_.messaging.md#messaging_interface) instance to push notifications. Returns a Firebase Cloud Messaging registration token that can be used to send push messages to that [Messaging](./messaging_.messaging.md#messaging_interface) instance.
84
84
85
-
If a notification permission isn't already granted, this method asks the user for permission. The returned promise rejects if the user does not allow the app to show notifications.
85
+
If notification permission isn't already granted, this method asks the user for permission. The returned promise rejects if the user does not allow the app to show notifications.
| messaging |[Messaging](./messaging_.messaging.md#messaging_interface)| The [Messaging](./messaging_.messaging.md#messaging_interface) instance. |
98
-
| options |[GetTokenOptions](./messaging_.gettokenoptions.md#gettokenoptions_interface)| Provides an optional vapid key and an optinoal service worker registration |
98
+
| options |[GetTokenOptions](./messaging_.gettokenoptions.md#gettokenoptions_interface)| Provides an optional vapid key and an optional service worker registration.|
Message payload that contains the notification payload that is represented with [NotificationPayload](./messaging_.notificationpayload.md#notificationpayload_interface) and the data payload that contains an arbitrary number of key-value pairs sent by developers through the [Send API](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification)
13
+
Message payload that contains the notification payload that is represented with [NotificationPayload](./messaging_.notificationpayload.md#notificationpayload_interface) and the data payload that contains an arbitrary number of key-value pairs sent by developers through the [Send API](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification)<!---->.
OptionsforfeaturesprovidedbytheFCMSDKforWeb. See [WebpushFcmOptions](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#webpushfcmoptions)
56
+
OptionsforfeaturesprovidedbytheFCMSDKforWeb. See [WebpushFcmOptions](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#webpushfcmoptions)<!-- -->.
Display notification details. They are sent through the [Send API](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification)
13
+
Display notification details. Details are sent through the [Send API](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification)<!---->.
Options for features provided by the FCM SDK for Web. See [WebpushFcmOptions](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#webpushfcmoptions)
13
+
Options for features provided by the FCM SDK for Web. See [WebpushFcmOptions](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#webpushfcmoptions)<!---->.
0 commit comments