Messaging class

Messaging service bound to the provided app.

Signature:

export declare class Messaging 

Properties

Methods

Messaging.app

The App associated with the current Messaging service instance.

Signature:

get app(): App;

Example

var app = messaging.app;

Messaging.enableLegacyHttpTransport()

This will be removed when the HTTP/2 transport implementation reaches the same stability as the legacy HTTP/1.1 implementation.

Enables the use of legacy HTTP/1.1 transport for sendEach() and sendEachForMulticast().

Signature:

enableLegacyHttpTransport(): void;

Returns:

void

Example

const messaging = getMessaging(app);
messaging.enableLegacyTransport();
messaging.sendEach(messages);

Messaging.send()

Sends the given message via FCM.

Signature:

send(message: Message, dryRun?: boolean): Promise<string>;

Parameters

Returns:

Promise<string>

A promise fulfilled with a unique message ID string after the message has been successfully handed off to the FCM service for delivery.

Messaging.sendEach()

Sends each message in the given array via Firebase Cloud Messaging.

This method makes a single RPC call for each message in the given array.

The responses list obtained from the return value corresponds to the order of messages. An error from this method or a BatchResponse with all failures indicates a total failure, meaning that none of the messages in the list could be sent. Partial failures or no failures are only indicated by a BatchResponse return value.

Signature:

sendEach(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;

Parameters

Returns:

Promise<BatchResponse>

A Promise fulfilled with an object representing the result of the send operation.

Messaging.sendEachForMulticast()

Sends the given multicast message to all the FCM registration tokens specified in it.

This method uses the Messaging.sendEach() API under the hood to send the given message to all the target recipients. The responses list obtained from the return value corresponds to the order of tokens in the MulticastMessage. An error from this method or a BatchResponse with all failures indicates a total failure, meaning that the messages in the list could be sent. Partial failures or failures are only indicated by a BatchResponse return value.

Signature:

sendEachForMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;

Parameters

Returns:

Promise<BatchResponse>

A Promise fulfilled with an object representing the result of the send operation.

Messaging.subscribeToTopic()

Subscribes a device to an FCM topic.

See Subscribe to a topic for code samples and detailed documentation. Optionally, you can provide an array of tokens to subscribe multiple devices.

Signature:

subscribeToTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;

Parameters

Returns:

Promise<MessagingTopicManagementResponse>

A promise fulfilled with the server's response after the device has been subscribed to the topic.

Messaging.unsubscribeFromTopic()

Unsubscribes a device from an FCM topic.

See Unsubscribe from a topic for code samples and detailed documentation. Optionally, you can provide an array of tokens to unsubscribe multiple devices.

Signature:

unsubscribeFromTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;

Parameters

Returns:

Promise<MessagingTopicManagementResponse>

A promise fulfilled with the server's response after the device has been unsubscribed from the topic.