Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference

{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}

@firebase/messaging

Functions

Interfaces

function(app, ...)

getMessaging(app) {:#getmessaging_cf608e1}

Retrieves a Firebase Cloud Messaging instance.

<b>Signature:</b>

export declare function getMessagingInWindow(app?: FirebaseApp): Messaging;

Parameters

<b>Returns:</b>

Messaging

The Firebase Cloud Messaging instance associated with the provided firebase app.

function(messaging, ...)

deleteToken(messaging) {:#deletetoken_3fae4b1}

Deletes the registration token associated with this Messaging instance and unsubscribes the Messaging instance from the push subscription.

<b>Signature:</b>

export declare function deleteToken(messaging: Messaging): Promise<boolean>;

Parameters

<b>Returns:</b>

Promise<boolean>

The promise resolves when the token has been successfully deleted.

getToken(messaging, options) {:#gettoken_b538f38}

Subscribes the Messaging instance to push notifications. Returns a Firebase Cloud Messaging registration token that can be used to send push messages to that Messaging 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.

<b>Signature:</b>

export declare function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;

Parameters

<b>Returns:</b>

Promise<string>

The promise resolves with an FCM registration token.

onMessage(messaging, nextOrObserver) {:#onmessage_b9887da}

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 onMessage() event is dispatched with the payload of the push message.

<b>Signature:</b>

export declare function onMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;

Parameters

<b>Returns:</b>

Unsubscribe

To stop listening for messages execute this returned function.

function()

isSupported() {:#issupported}

Checks if all required APIs exist in the browser.

<b>Signature:</b>

export declare function isWindowSupported(): Promise<boolean>;

<b>Returns:</b>

Promise<boolean>

a Promise that resolves to a boolean.