Firebase.Messaging.FirebaseMessaging

Firebase CloudMessaging API.

Summary

Firebase CloudMessaging allows you to send data from your server to your users' devices, and receive messages from devices on the same connection if you're using a XMPP server.

The FCM service handles all aspects of queueing of messages and delivery to client applications running on target devices.

Properties

DeliveryMetricsExportedToBigQueryEnabled
static bool
Enables or disablesFirebase CloudMessaging message delivery metrics export to BigQuery.
TokenRegistrationOnInitEnabled
static bool
Enable or disable token registration during initialization ofFirebase CloudMessaging.

Events

MessageReceived
static System.EventHandler<MessageReceivedEventArgs >
Called on the client when a message arrives.
TokenReceived
static System.EventHandler<TokenReceivedEventArgs >
Called on the client when a registration token message arrives.

Public static functions

DeleteTokenAsync()
System.Threading.Tasks.Task
Deletes the default token for thisFirebase project.
GetTokenAsync()
System.Threading.Tasks.Task< string >
This creates aFirebaseInstallations ID, if one does not exist, and sends information about the application and the device where it's running to theFirebase backend.
RequestPermissionAsync()
System.Threading.Tasks.Task
Displays a prompt to the user requesting permission to display notifications.
SubscribeAsync(string topic)
System.Threading.Tasks.Task
Subscribe to receive all messages to the specified topic.
UnsubscribeAsync(string topic)
System.Threading.Tasks.Task
Unsubscribe from a topic.

Properties

DeliveryMetricsExportedToBigQueryEnabled

staticboolDeliveryMetricsExportedToBigQueryEnabled

Enables or disablesFirebase CloudMessaging 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.

Note: This function is currently only implemented on Android, and has no behavior on other platforms.

TokenRegistrationOnInitEnabled

staticboolTokenRegistrationOnInitEnabled

Enable or disable token registration during initialization ofFirebase CloudMessaging.

This token is what identifies the user toFirebase, so disabling this avoids creating any new identity and automatically sending it toFirebase, unless consent has been granted.

If this setting is enabled, it triggers the token registration refresh immediately. This setting is persisted across app restarts and overrides the setting "firebase_messaging_auto_init_enabled" specified in your Android manifest (on Android) or Info.plist (on iOS and tvOS).

By default, token registration during initialization is enabled.

The registration happens before you can programmatically disable it, so if you need to change the default, (for example, because you want to prompt the user before FCM generates/refreshes a registration token on app startup), add to your application’s manifest:

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

or on iOS or tvOS to your Info.plist:

<key>FirebaseMessagingAutoInitEnabled</key><false/>

Events

MessageReceived

staticSystem.EventHandler<MessageReceivedEventArgs>MessageReceived

Called on the client when a message arrives.

TokenReceived

staticSystem.EventHandler<TokenReceivedEventArgs>TokenReceived

Called on the client when a registration token message arrives.

Public static functions

DeleteTokenAsync

System.Threading.Tasks.TaskDeleteTokenAsync()

Deletes the default token for thisFirebase project.

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

Details
Returns
A task that completes when the token is deleted.

GetTokenAsync

System.Threading.Tasks.Task<string>GetTokenAsync()

This creates aFirebaseInstallations ID, if one does not exist, and sends information about the application and the device where it's running to theFirebase backend.

Details
Returns
A task with the token.

RequestPermissionAsync

System.Threading.Tasks.TaskRequestPermissionAsync()

Displays a prompt to the user requesting permission to display notifications.

The permission prompt only appears on iOS and tvOS. If the user has already agreed to allow notifications, no prompt is displayed and the returned future is completed immediately.

Details
Returns
A Task that completes when the notification prompt has been dismissed.

SubscribeAsync

System.Threading.Tasks.TaskSubscribeAsync(stringtopic)

Subscribe to receive all messages to the specified topic.

Subscribes an app instance to a topic, enabling it to receive messages sent to that topic.

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

UnsubscribeAsync

System.Threading.Tasks.TaskUnsubscribeAsync(stringtopic)

Unsubscribe from a topic.

Unsubscribes an app instance from a topic, stopping it from receiving any further messages sent to that topic.

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

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024-08-07 UTC.