Cloud Messaging API Reference
This section documents all Firebase Cloud Messaging (FCM) Blueprint nodes provided by the plugin. These nodes allow you to request notification permission, manage FCM tokens, subscribe to messaging topics, control automatic initialization, and receive incoming push messages.
All Cloud Messaging nodes require Firebase to be successfully initialized before use.
Notification Permission
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Request Cloud Messaging Notification Permission | – | – | Requests notification permission for Firebase Cloud Messaging. On iOS, this displays the system notification permission prompt and registers the application for remote notifications if permission is granted. On Android 13+ (API level 33+), it requests POST_NOTIFICATIONS. On Android 12 and lower, no runtime notification permission is required. |
Token Management
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Get Cloud Messaging Token | – | On Success (Token): Called when the current FCM token is retrieved successfully. On Failure (Error Message): Called if token retrieval fails. |
Asynchronously retrieves the current Firebase Cloud Messaging registration token for this device. |
| Delete Cloud Messaging Token | – | On Success: Called when the current FCM token is deleted successfully. On Failure (Error Message): Called if token deletion fails. |
Deletes the current FCM token. A new token will be generated automatically if messaging is re-initialized. |
| Listen Cloud Messaging New Token | – | On Token (Token): Called whenever a new FCM token is generated or refreshed. | Registers a listener that is triggered when Firebase issues a new FCM token. |
Topics
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Subscribe to Topic | Topic (string) |
On Success (Topic): Called when subscription succeeds. On Failure (Topic, Error Message): Called if subscription fails. |
Subscribes the device to the specified FCM topic. |
| Unsubscribe from Topic | Topic (string) |
On Success (Topic): Called when unsubscription succeeds. On Failure (Topic, Error Message): Called if unsubscription fails. |
Unsubscribes the device from the specified FCM topic. |
Auto Initialization
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Set Auto Initialization Enabled | bEnabled (bool) |
– | Enables or disables automatic Firebase Cloud Messaging initialization. Enabled by default and should only be changed if manual control is required. |
| Is Auto Initialization Enabled | – | bool |
Returns whether automatic Cloud Messaging initialization is currently enabled. |
Message Listener
| Node | Parameters | Callbacks / Return | Description |
|---|---|---|---|
| Listen Cloud Messaging | – | On Message (Title, Body, DataJson): Called when an FCM notification or data message is received. | Registers a listener for incoming Firebase Cloud Messaging messages. The callback provides the notification title, body, and raw data payload in JSON format. |