public class

FirebaseMessaging

extends Object
java.lang.Object
   ↳ com.google.firebase.messaging.FirebaseMessaging

Class Overview

This class is the entry point for all server-side Firebase Cloud Messaging actions.

You can get an instance of FirebaseMessaging via getInstance(FirebaseApp), and then use it to send messages or manage FCM topic subscriptions.

Summary

Public Methods
static FirebaseMessaging getInstance()
Gets the FirebaseMessaging instance for the default FirebaseApp.
synchronized static FirebaseMessaging getInstance(FirebaseApp app)
Gets the FirebaseMessaging instance for the specified FirebaseApp.
ApiFuture<String> sendAsync(Message message, boolean dryRun)
Sends the given Message via Firebase Cloud Messaging.
ApiFuture<String> sendAsync(Message message)
Sends the given Message via Firebase Cloud Messaging.
ApiFuture<TopicManagementResponse> subscribeToTopicAsync(List<String> registrationTokens, String topic)
Subscribes a list of registration tokens to a topic.
ApiFuture<TopicManagementResponse> unsubscribeFromTopicAsync(List<String> registrationTokens, String topic)
Unubscribes a list of registration tokens from a topic.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public static FirebaseMessaging getInstance ()

Gets the FirebaseMessaging instance for the default FirebaseApp.

Returns

public static synchronized FirebaseMessaging getInstance (FirebaseApp app)

Gets the FirebaseMessaging instance for the specified FirebaseApp.

Returns

public ApiFuture<String> sendAsync (Message message, boolean dryRun)

Sends the given Message via Firebase Cloud Messaging.

If the 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.

Parameters
message A non-null Message to be sent.
dryRun a boolean indicating whether to perform a dry run (validation only) of the send.
Returns
  • An ApiFuture that will complete with a message ID string when the message has been sent, or when the emulation has finished.

public ApiFuture<String> sendAsync (Message message)

Sends the given Message via Firebase Cloud Messaging.

Parameters
message A non-null Message to be sent.
Returns
  • An ApiFuture that will complete with a message ID string when the message has been sent.

public ApiFuture<TopicManagementResponse> subscribeToTopicAsync (List<String> registrationTokens, String topic)

Subscribes a list of registration tokens to a topic.

Parameters
registrationTokens A non-null, non-empty list of device registration tokens, with at most 1000 entries.
topic Name of the topic to subscribe to. May contain the /topics/ prefix.
Returns

public ApiFuture<TopicManagementResponse> unsubscribeFromTopicAsync (List<String> registrationTokens, String topic)

Unubscribes a list of registration tokens from a topic.

Parameters
registrationTokens A non-null, non-empty list of device registration tokens, with at most 1000 entries.
topic Name of the topic to unsubscribe from. May contain the /topics/ prefix.
Returns