firebase-messaging/com.google.firebase.messaging/FirebaseMessaging

FirebaseMessaging

actual class FirebaseMessaging(source)

Firebase Cloud Messaging, as the Android SDK's com.google.firebase.messaging.FirebaseMessaging. Receiving messages is platform code on every platform (FirebaseMessagingService on Android).

The JS SDK has no topic subscription (a web client's token is subscribed from a server with the Admin SDK) and no auto-init (a token is only ever generated by getToken): those members do nothing on JS and carry @UnsupportedOnJs, so code compiled for JS gets a warning until it opts in.

actual class FirebaseMessaging(source)

expect class FirebaseMessaging(source)

Firebase Cloud Messaging, as the Android SDK's com.google.firebase.messaging.FirebaseMessaging. Receiving messages is platform code on every platform (FirebaseMessagingService on Android).

The JS SDK has no topic subscription (a web client's token is subscribed from a server with the Admin SDK) and no auto-init (a token is only ever generated by getToken): those members do nothing on JS and carry @UnsupportedOnJs, so code compiled for JS gets a warning until it opts in.

actual class FirebaseMessaging(source)

actual class FirebaseMessaging(source)

firebase-java-sdk has no Cloud Messaging: every operation fails with an UnsupportedOperationException.

actual class FirebaseMessaging(source)

Types

actual object Companion

actual object Companion

expect object Companion

actual object Companion

actual object Companion

actual object Companion

Properties

val ios: FIRMessaging

The underlying Firebase iOS SDK object.

isAutoInitEnabled

actual var isAutoInitEnabled: Boolean

Whether the registration token is generated automatically at startup, which apps turn off until the user has consented. Always false on JS, where a token is only generated by getToken; setting it does nothing there.

actual var isAutoInitEnabled: Boolean

Whether the registration token is generated automatically at startup, which apps turn off until the user has consented. Always false on JS, where a token is only generated by getToken; setting it does nothing there.

expect var isAutoInitEnabled: Boolean

Whether the registration token is generated automatically at startup, which apps turn off until the user has consented. Always false on JS, where a token is only generated by getToken; setting it does nothing there.

actual var isAutoInitEnabled: Boolean

Always false: the JS SDK only generates a token in getToken. Setting it does nothing.

actual var isAutoInitEnabled: Boolean

Kept in memory: there is no registration to initialise on the JVM.

actual var isAutoInitEnabled: Boolean

Always false: the JS SDK only generates a token in getToken. Setting it does nothing.

val js: Messaging

The underlying Firebase JS SDK object.

val js: Messaging

The underlying Firebase JS SDK object.

Functions

actual fun deleteToken(): Task<Nothing?>

Deletes the registration token of this app instance, so it stops receiving messages.

actual fun deleteToken(): Task<Nothing?>

Deletes the registration token of this app instance, so it stops receiving messages.

expect fun deleteToken(): Task<Nothing?>

Deletes the registration token of this app instance, so it stops receiving messages.

actual fun deleteToken(): Task<Nothing?>

Deletes the registration token of this app instance, so it stops receiving messages.

actual fun deleteToken(): Task<Nothing?>

Deletes the registration token of this app instance, so it stops receiving messages.

actual fun deleteToken(): Task<Nothing?>

Deletes the registration token of this app instance, so it stops receiving messages.

deliveryMetricsExportToBigQueryEnabled

actual fun deliveryMetricsExportToBigQueryEnabled(): Boolean

Whether message delivery data is exported to BigQuery. Android only: the Apple and JS SDKs configure the export themselves (the Apple notification service extension), so this is always false there.

actual fun deliveryMetricsExportToBigQueryEnabled(): Boolean

Always false: on Apple platforms the notification service extension exports delivery data itself.

expect fun deliveryMetricsExportToBigQueryEnabled(): Boolean

Whether message delivery data is exported to BigQuery. Android only: the Apple and JS SDKs configure the export themselves (the Apple notification service extension), so this is always false there.

actual fun deliveryMetricsExportToBigQueryEnabled(): Boolean

Always false: the JS SDK exports delivery data through its own configuration.

actual fun deliveryMetricsExportToBigQueryEnabled(): Boolean

Whether message delivery data is exported to BigQuery. Android only: the Apple and JS SDKs configure the export themselves (the Apple notification service extension), so this is always false there.

actual fun deliveryMetricsExportToBigQueryEnabled(): Boolean

Always false: the JS SDK exports delivery data through its own configuration.

open operator override fun equals(other: Any?): Boolean

open operator override fun equals(other: Any?): Boolean

open operator override fun equals(other: Any?): Boolean

actual fun getToken(): Task<String>

The registration token of this app instance, requested from the backend if needed.

actual fun getToken(): Task<String>

The registration token of this app instance, requested from the backend if needed.

expect fun getToken(): Task<String>

The registration token of this app instance, requested from the backend if needed.

actual fun getToken(): Task<String>

The registration token of this app instance, requested from the backend if needed.

actual fun getToken(): Task<String>

The registration token of this app instance, requested from the backend if needed.

actual fun getToken(): Task<String>

The registration token of this app instance, requested from the backend if needed.

open override fun hashCode(): Int

open override fun hashCode(): Int

open override fun hashCode(): Int

isNotificationDelegationEnabled

actual fun isNotificationDelegationEnabled(): Boolean

Whether notifications are delegated to Google Play services (an Android feature); always false elsewhere.

actual fun isNotificationDelegationEnabled(): Boolean

Always false: notification delegation is an Android feature.

expect fun isNotificationDelegationEnabled(): Boolean

Whether notifications are delegated to Google Play services (an Android feature); always false elsewhere.

actual fun isNotificationDelegationEnabled(): Boolean

Always false: notification delegation is an Android feature.

actual fun isNotificationDelegationEnabled(): Boolean

Whether notifications are delegated to Google Play services (an Android feature); always false elsewhere.

actual fun isNotificationDelegationEnabled(): Boolean

Always false: notification delegation is an Android feature.

actual fun register(): Task<Nothing?>

Registers this app instance with FCM by its Firebase installation ID (FID), for direct-send messaging. On Android it needs the firebase_messaging_installation_id_enabled manifest flag. The Apple and JS SDKs have no FID registration: the task fails there.

actual fun register(): Task<Nothing?>

Fails: the iOS SDK has no registration by Firebase installation ID.

expect fun register(): Task<Nothing?>

Registers this app instance with FCM by its Firebase installation ID (FID), for direct-send messaging. On Android it needs the firebase_messaging_installation_id_enabled manifest flag. The Apple and JS SDKs have no FID registration: the task fails there.

actual fun register(): Task<Nothing?>

Fails: the JS SDK has no registration by Firebase installation ID.

actual fun register(): Task<Nothing?>

Registers this app instance with FCM by its Firebase installation ID (FID), for direct-send messaging. On Android it needs the firebase_messaging_installation_id_enabled manifest flag. The Apple and JS SDKs have no FID registration: the task fails there.

actual fun register(): Task<Nothing?>

Fails: the JS SDK has no registration by Firebase installation ID.

setDeliveryMetricsExportToBigQuery

actual fun setDeliveryMetricsExportToBigQuery(enable: Boolean)

Exports message delivery data to BigQuery (Android only); does nothing elsewhere, see deliveryMetricsExportToBigQueryEnabled.

actual fun setDeliveryMetricsExportToBigQuery(enable: Boolean)

Does nothing: on Apple platforms the notification service extension exports delivery data itself.

expect fun setDeliveryMetricsExportToBigQuery(enable: Boolean)

Exports message delivery data to BigQuery (Android only); does nothing elsewhere, see deliveryMetricsExportToBigQueryEnabled.

actual fun setDeliveryMetricsExportToBigQuery(enable: Boolean)

Does nothing: the JS SDK exports delivery data through its own configuration.

actual fun setDeliveryMetricsExportToBigQuery(enable: Boolean)

Exports message delivery data to BigQuery (Android only); does nothing elsewhere, see deliveryMetricsExportToBigQueryEnabled.

actual fun setDeliveryMetricsExportToBigQuery(enable: Boolean)

Does nothing: the JS SDK exports delivery data through its own configuration.

setNotificationDelegationEnabled

actual fun setNotificationDelegationEnabled(enable: Boolean): Task<Nothing?>

Delegates notifications to Google Play services (an Android feature); does nothing elsewhere.

actual fun setNotificationDelegationEnabled(enable: Boolean): Task<Nothing?>

Does nothing: notification delegation is an Android feature.

expect fun setNotificationDelegationEnabled(enable: Boolean): Task<Nothing?>

Delegates notifications to Google Play services (an Android feature); does nothing elsewhere.

actual fun setNotificationDelegationEnabled(enable: Boolean): Task<Nothing?>

Does nothing: notification delegation is an Android feature.

actual fun setNotificationDelegationEnabled(enable: Boolean): Task<Nothing?>

Delegates notifications to Google Play services (an Android feature); does nothing elsewhere.

actual fun setNotificationDelegationEnabled(enable: Boolean): Task<Nothing?>

Does nothing: notification delegation is an Android feature.

subscribeToTopic

actual fun subscribeToTopic(topic: String): Task<Nothing?>

Subscribes this app instance to topic. A no-op on JS, whose SDK has no client-side topic subscription.

actual fun subscribeToTopic(topic: String): Task<Nothing?>

Subscribes this app instance to topic. A no-op on JS, whose SDK has no client-side topic subscription.

expect fun subscribeToTopic(topic: String): Task<Nothing?>

Subscribes this app instance to topic. A no-op on JS, whose SDK has no client-side topic subscription.

actual fun subscribeToTopic(topic: String): Task<Nothing?>

A no-op: the JS SDK has no client-side topic subscription (a web token is subscribed from a server with the Admin SDK).

actual fun subscribeToTopic(topic: String): Task<Nothing?>

Subscribes this app instance to topic. A no-op on JS, whose SDK has no client-side topic subscription.

actual fun subscribeToTopic(topic: String): Task<Nothing?>

A no-op: the JS SDK has no client-side topic subscription (a web token is subscribed from a server with the Admin SDK).

open override fun toString(): String

open override fun toString(): String

open override fun toString(): String

open override fun toString(): String

actual fun unregister(): Task<Nothing?>

Unregisters this app instance from FCM's FID registration, see register; the task fails on Apple and JS.

actual fun unregister(): Task<Nothing?>

Fails: the iOS SDK has no registration by Firebase installation ID.

expect fun unregister(): Task<Nothing?>

Unregisters this app instance from FCM's FID registration, see register; the task fails on Apple and JS.

actual fun unregister(): Task<Nothing?>

Fails: the JS SDK has no registration by Firebase installation ID.

actual fun unregister(): Task<Nothing?>

Unregisters this app instance from FCM's FID registration, see register; the task fails on Apple and JS.

actual fun unregister(): Task<Nothing?>

Fails: the JS SDK has no registration by Firebase installation ID.

unsubscribeFromTopic

actual fun unsubscribeFromTopic(topic: String): Task<Nothing?>

Unsubscribes this app instance from topic. A no-op on JS, whose SDK has no client-side topic subscription.

actual fun unsubscribeFromTopic(topic: String): Task<Nothing?>

Unsubscribes this app instance from topic. A no-op on JS, whose SDK has no client-side topic subscription.

expect fun unsubscribeFromTopic(topic: String): Task<Nothing?>

Unsubscribes this app instance from topic. A no-op on JS, whose SDK has no client-side topic subscription.

actual fun unsubscribeFromTopic(topic: String): Task<Nothing?>

A no-op: the JS SDK has no client-side topic subscription (a web token is subscribed from a server with the Admin SDK).

actual fun unsubscribeFromTopic(topic: String): Task<Nothing?>

Unsubscribes this app instance from topic. A no-op on JS, whose SDK has no client-side topic subscription.

actual fun unsubscribeFromTopic(topic: String): Task<Nothing?>

A no-op: the JS SDK has no client-side topic subscription (a web token is subscribed from a server with the Admin SDK).