FirebaseMessaging

class FirebaseMessaging

Top level Firebase Cloud Messaging singleton that provides methods for subscribing to topics and sending upstream messages.

In order to receive messages, declare an implementation of FirebaseMessagingService in the app manifest. To process messages, override base class methods to handle any events required by the application.

Summary

Constants
`const String!`	`INSTANCE_ID_SCOPE = "FCM"` This property is deprecated. Use `getToken` instead

Constants

const String!

INSTANCE_ID_SCOPE = "FCM"

This property is deprecated.

Use getToken instead

Public functions
`Task<Void!>`	`deleteToken()` Deletes the FCM registration token for this Firebase project.
`Boolean`	`deliveryMetricsExportToBigQueryEnabled()` Determines whether Firebase Cloud Messaging exports message delivery metrics to BigQuery.
`synchronized java-static FirebaseMessaging`	`getInstance()`
`Task<String!>`	`getToken()` Returns the FCM registration token for this Firebase project.
`Boolean`	`isAutoInitEnabled()` Determines whether FCM auto-initialization is enabled or disabled.
`Boolean`	`isNotificationDelegationEnabled()` Returns whether notification delegation is enabled or not.
`Unit`	`send(message: RemoteMessage)` This function is deprecated. FCM upstream messaging is deprecated and will be decommissioned in June 2024.
`Unit`	`setAutoInitEnabled(enable: Boolean)` Enables or disables auto-initialization of Firebase Cloud Messaging.
`Unit`	`setDeliveryMetricsExportToBigQuery(enable: Boolean)` Enables or disables Firebase Cloud Messaging message delivery metrics export to BigQuery.
`Task<Void!>`	`setNotificationDelegationEnabled(enable: Boolean)` Sets notification delegation to enabled or disabled.
`Task<Void!>`	`subscribeToTopic(topic: String)` Subscribes to `topic` in the background.
`Task<Void!>`	`unsubscribeFromTopic(topic: String)` Unsubscribes from `topic` in the background.

Constants

INSTANCE_ID_SCOPE

const val INSTANCE_ID_SCOPE = "FCM": String!

Specifies scope used in obtaining a registration token when calling FirebaseInstanceId.getToken()

Public functions

deleteToken

fun deleteToken(): Task<Void!>

Deletes the FCM registration token for this Firebase project.

Note that if auto-init is enabled, a new token will be generated the next time the app is started. Disable auto-init (setAutoInitEnabled) to avoid this.

Note that this does not delete the Firebase Installations ID that may have been created when generating the token. See FirebaseInstallations.delete() for deleting that.

deliveryMetricsExportToBigQueryEnabled

fun deliveryMetricsExportToBigQueryEnabled(): Boolean

Determines whether Firebase Cloud Messaging exports message delivery metrics to BigQuery.

Returns
`Boolean`	true if Firebase Cloud Messaging exports message delivery metrics to BigQuery.

getInstance

synchronized java-static fun getInstance(): FirebaseMessaging

getToken

fun getToken(): Task<String!>

Returns the FCM registration token for this Firebase project.

This creates a Firebase Installations ID, if one does not exist, and sends information about the application and the device where it's running to the Firebase backend. See deleteToken for information on deleting the token and the Firebase Installations ID.

Returns
`Task<String!>`	`Task` with the token.

isAutoInitEnabled

fun isAutoInitEnabled(): Boolean

Determines whether FCM auto-initialization is enabled or disabled.

Returns
`Boolean`	true if auto-init is enabled and false if auto-init is disabled

isNotificationDelegationEnabled

fun isNotificationDelegationEnabled(): Boolean

Returns whether notification delegation is enabled or not.

Returns
`Boolean`	true if enabled, false otherwise.

send

fun send(message: RemoteMessage): Unit

Sends message upstream to your app server.

When there is an active connection the message will be sent immediately, otherwise the message will be queued up to the time to live (TTL) set in the message.

setAutoInitEnabled

fun setAutoInitEnabled(enable: Boolean): Unit

Enables or disables auto-initialization of Firebase Cloud Messaging.

When enabled, Firebase Cloud Messaging generates a registration token on app startup if there is no valid one (see getToken) and periodically sends data to the Firebase backend to validate the token. This setting is persisted across app restarts and overrides the setting specified in your manifest.

By default, Firebase Cloud Messaging auto-initialization is enabled. If you need to change the default, (for example, because you want to prompt the user before Firebase Cloud Messaging generates/refreshes a registration token on app startup), add to your application’s manifest:

<meta-data android:name="firebase_messaging_auto_init_enabled" android:value="false" />

Parameters
`enable: Boolean`	Whether Firebase Cloud Messaging should auto-initialize.

setDeliveryMetricsExportToBigQuery

fun setDeliveryMetricsExportToBigQuery(enable: Boolean): Unit

Enables or disables Firebase Cloud Messaging message delivery metrics export to BigQuery.

By default, message delivery metrics are not exported to BigQuery. Use this method to enable or disable the export at runtime. In addition, you can enable the export by adding to your manifest. Note that the run-time method call will override the manifest value.

<meta-data android:name= "delivery_metrics_exported_to_big_query_enabled"
android:value="true"/>

Parameters
`enable: Boolean`	Whether Firebase Cloud Messaging should export message delivery metrics to BigQuery.

setNotificationDelegationEnabled

fun setNotificationDelegationEnabled(enable: Boolean): Task<Void!>

Sets notification delegation to enabled or disabled.

By default, notification delegation is enabled. You can also the following manifest entry to disable notification delegation:

<meta-data android:name="firebase_messaging_notification_delegation_enabled"
android:value="false"/>

Setting notification delegation using this method will override any value set in the manifest.

Notification delegation is supported from Android Q and above. See setNotificationDelegate

Parameters
`enable: Boolean`	Whether to enable or disable notification delegation.

Returns
`Task<Void!>`	A Task that completes when the notification delegation has been set.

subscribeToTopic

fun subscribeToTopic(topic: String): Task<Void!>

Subscribes to topic in the background.

The subscribe operation is persisted and will be retried until successful.

This uses an FCM registration token to identify the app instance, generating one if it does not exist (see getToken), which periodically sends data to the Firebase backend when auto-init is enabled. To delete the data, delete the token (deleteToken) and the Firebase Installations ID (FirebaseInstallations.delete()). To stop the periodic sending of data, disable auto-init (setAutoInitEnabled).

Parameters
`topic: String`	The name of the topic to subscribe. Must match the following regular expression: "[a-zA-Z0-9-_.~%]{1,900}".

Returns
`Task<Void!>`	A task that will be completed when the topic has been successfully subscribed to.

unsubscribeFromTopic

fun unsubscribeFromTopic(topic: String): Task<Void!>

Unsubscribes from topic in the background.

The unsubscribe operation is persisted and will be retried until successful.

Parameters
`topic: String`	The name of the topic to unsubscribe from. Must match the following regular expression: "[a-zA-Z0-9-_.~%]{1,900}".

Returns
`Task<Void!>`	A task that will be completed when the topic has been successfully unsubscribed from.