Google is committed to advancing racial equity for Black communities. See how.

FirebaseMessagingService

public class FirebaseMessagingService extends Service

Base class for receiving messages from Firebase Cloud Messaging.

Extending this class is required to be able to handle downstream messages. It also provides functionality to automatically display notifications, and has methods that are invoked to give the status of upstream messages.

Override base class methods to handle any events required by the application. All methods are invoked on a background thread, and may be called when the app is in the background or not open.

Include the following in the manifest:

 <service
     android:name=".YourFirebaseMessagingService"
     android:exported="false">
     <intent-filter>
         <action android:name="com.google.firebase.MESSAGING_EVENT" />
     </intent-filter>
 </service>

To support receiving messages in direct boot mode, add android:directBootAware="true" to the service declaration. See Receive FCM messages in direct boot mode for more information.

Inherited Constant Summary

Public Constructor Summary

FirebaseMessagingService()

Public Method Summary

void
onDeletedMessages()
Called when the Firebase Cloud Messaging server deletes pending messages.
void
onDestroy()
void
onMessageReceived(RemoteMessage message)
Called when a message is received.
void
onMessageSent(String msgId)
Called when an upstream message has been successfully sent to the GCM connection server.
void
onNewToken(String token)
Called when a new token for the default Firebase project is generated.
void
onSendError(String msgId, Exception exception)
Called when there was an error sending an upstream message.

Inherited Method Summary

Public Constructors

public FirebaseMessagingService ()

Public Methods

public void onDeletedMessages ()

Called when the Firebase Cloud Messaging server deletes pending messages. This may be due to:

  1. Too many messages stored on the Firebase Cloud Messaging server. This can occur when the app's servers send a bunch of non-collapsible messages to Firebase Cloud Messaging servers while the device is offline.
  2. The device hasn't connected in a long time and the app server has recently (within the last 4 weeks) sent a message to the app on that device.

It is recommended that the app do a full sync with the app server after receiving this call. See here for more information.

public void onDestroy ()

public void onMessageReceived (RemoteMessage message)

Called when a message is received.

This is also called when a notification message is received while the app is in the foreground. The notification parameters can be retrieved with RemoteMessage.getNotification().

Parameters
message Remote message that has been received.

public void onMessageSent (String msgId)

Called when an upstream message has been successfully sent to the GCM connection server.

Parameters
msgId of the upstream message sent using FirebaseMessaging.send(RemoteMessage).

public void onNewToken (String token)

Called when a new token for the default Firebase project is generated.

This is invoked after app install when a token is first generated, and again if the token changes.

Parameters
token The token used for sending messages to this application instance. This token is the same as the one retrieved by FirebaseMessaging.getToken().

public void onSendError (String msgId, Exception exception)

Called when there was an error sending an upstream message.

Parameters
msgId of the upstream message sent using FirebaseMessaging.send(RemoteMessage).
exception description of the error, typically a SendException.