react-native-firebase / messaging/lib/modular
messaging/lib/modular
AuthorizationStatus
constAuthorizationStatus:object
Defined in: messaging/lib/statics.ts:4
NotificationAndroidPriority
constNotificationAndroidPriority:object
Defined in: messaging/lib/statics.ts:12
NotificationAndroidVisibility
constNotificationAndroidVisibility:object
Defined in: messaging/lib/statics.ts:20
deleteToken()
deleteToken(
messaging,tokenOptions?):Promise<void>
Defined in: messaging/lib/modular.ts:52
Removes access to an FCM token previously authorized by its scope. Messages sent by the server to this token will fail.
experimentalSetDeliveryMetricsExportedToBigQueryEnabled()
experimentalSetDeliveryMetricsExportedToBigQueryEnabled(
messaging,enabled):Promise<void>
Defined in: messaging/lib/modular.ts:431
Sets whether message delivery metrics are exported to BigQuery is enabled or disabled. The value is false by default. Set this to true to allow exporting of message delivery metrics to BigQuery.
enabled
boolean
A boolean value to enable or disable exporting of message delivery metrics to BigQuery.
getAPNSToken()
getAPNSToken(
messaging):Promise<string|null>
Defined in: messaging/lib/modular.ts:223
On iOS, it is possible to get the users APNs token. This may be required if you want to send messages to your iOS devices without using the FCM service.
getDidOpenSettingsForNotification()
getDidOpenSettingsForNotification(
messaging):Promise<boolean>
Defined in: messaging/lib/modular.ts:170
When the app is opened from iOS notifications settings from a quit state,
this method will return true or false if the app was opened via another method.
Returns
Promise<boolean>
Promise that resolves with a boolean indicating if the app was opened from settings.
getInitialNotification()
getInitialNotification(
messaging):Promise<RemoteMessage|null>
Defined in: messaging/lib/modular.ts:159
When a notification from FCM has triggered the application to open from a quit state,
this method will return a RemoteMessage containing the notification data, or null if
the app was opened via another method.
getIsHeadless()
getIsHeadless(
messaging):Promise<boolean>
Defined in: messaging/lib/modular.ts:181
Returns whether the root view is headless or not i.e true if the app was launched in the background (for example, by data-only cloud message)
getMessaging()
getMessaging(
app?):Messaging
Defined in: messaging/lib/modular.ts:37
Returns a Messaging instance for the given app.
getToken()
getToken(
messaging,options?):Promise<string>
Defined in: messaging/lib/modular.ts:66
Returns an FCM token for this device. Optionally, you can specify custom options for your own use case.
hasPermission()
hasPermission(
messaging):Promise<AuthorizationStatus>
Defined in: messaging/lib/modular.ts:261
Returns a AuthorizationStatus as to whether the user has messaging permission for this app.
isAutoInitEnabled()
isAutoInitEnabled(
messaging):boolean
Defined in: messaging/lib/modular.ts:137
Returns whether messaging auto initialization is enabled or disabled for the device.
isDeliveryMetricsExportToBigQueryEnabled()
isDeliveryMetricsExportToBigQueryEnabled(
messaging):boolean
Defined in: messaging/lib/modular.ts:380
Returns a boolean whether message delivery metrics are exported to BigQuery.
isDeviceRegisteredForRemoteMessages()
isDeviceRegisteredForRemoteMessages(
messaging):boolean
Defined in: messaging/lib/modular.ts:203
Returns a boolean value whether the user has registered for remote notifications via
registerDeviceForRemoteMessages(). For iOS. Android always returns true.
isNotificationDelegationEnabled()
isNotificationDelegationEnabled(
messaging):boolean
Defined in: messaging/lib/modular.ts:390
Returns a boolean whether message delegation is enabled. Android only, always returns false on iOS
isSupported()
isSupported(
messaging):Promise<boolean>
Defined in: messaging/lib/modular.ts:419
Checks if all required APIs exist in the browser.
onDeletedMessages()
onDeletedMessages(
messaging,listener): () =>void
Defined in: messaging/lib/modular.ts:272
Called when the FCM server deletes pending messages.
onMessage()
onMessage(
messaging,listener): () =>void
Defined in: messaging/lib/modular.ts:81
When any FCM payload is received, the listener callback is called with a RemoteMessage.
This subscriber method is only called when the app is active (in the foreground).
listener
(message) => any
Called with a RemoteMessage when a new FCM payload is received from the server.
onMessageSent()
onMessageSent(
messaging,listener): () =>void
Defined in: messaging/lib/modular.ts:283
When sending a RemoteMessage, this listener is called when the message has been sent to FCM.
onNotificationOpenedApp()
onNotificationOpenedApp(
messaging,listener): () =>void
Defined in: messaging/lib/modular.ts:96
When the user presses a notification displayed via FCM, this listener will be called if the app has opened from a background state.
listener
(message) => any
Called with a RemoteMessage when a notification press opens the application.
onSendError()
onSendError(
messaging,listener): () =>void
Defined in: messaging/lib/modular.ts:298
When sending a RemoteMessage, this listener is called when an error is thrown and the
message could not be sent.
onTokenRefresh()
onTokenRefresh(
messaging,listener): () =>void
Defined in: messaging/lib/modular.ts:112
Called when a new registration token is generated for the device. For example, this event can happen when a token expires or when the server invalidates the token.
This subscriber method is only called when the app is active (in the foreground).
registerDeviceForRemoteMessages()
registerDeviceForRemoteMessages(
messaging):Promise<void>
Defined in: messaging/lib/modular.ts:192
On iOS, if your app wants to receive remote messages from FCM (via APNs), you must explicitly register with APNs if auto-registration has been disabled.
requestPermission()
requestPermission(
messaging,iosPermissions?):Promise<AuthorizationStatus>
Defined in: messaging/lib/modular.ts:124
On iOS, messaging permission must be requested by the current application before messages can be received or sent.
sendMessage()
sendMessage(
messaging,message):Promise<void>
Defined in: messaging/lib/modular.ts:347
Send a new RemoteMessage to the FCM server.
setAPNSToken()
setAPNSToken(
messaging,token,type?):Promise<void>
Defined in: messaging/lib/modular.ts:251
On iOS, This method is used to set the APNs Token received by the application delegate.
Note that the token is expected to be a hexadecimal string, as it is an NSData type in
the underlying native firebase SDK, and raw data may only be passed as a string if it is
hex encoded. Calling code is responsible for correct encoding, you should verify by comparing
the results of getAPNSToken() with your token parameter to make sure they are equivalent.
Messaging uses method swizzling to ensure that the APNs token is set automatically. However, if you have disabled swizzling by setting FirebaseAppDelegateProxyEnabled to NO in your app's Info.plist, you should manually set the APNs token in your application delegate's application(_:didRegisterForRemoteNotificationsWithDeviceToken:) method.
If you would like to set the type of the APNs token, rather than relying on automatic detection, provide a type of either 'prod', 'sandbox'. Omitting the type parameter or specifying 'unknown' will rely on automatic type detection based on provisioning profile.
At a native level you may also call objective-c [FIRMessaging setAPNSToken]; as needed.
setAutoInitEnabled()
setAutoInitEnabled(
messaging,enabled):Promise<void>
Defined in: messaging/lib/modular.ts:147
Sets whether messaging auto initialization is enabled or disabled for the device.
setBackgroundMessageHandler()
setBackgroundMessageHandler(
messaging,handler):void
Defined in: messaging/lib/modular.ts:314
Set a message handler function which is called when the app is in the background or terminated. In Android, a headless task is created, allowing you to access the React Native environment to perform tasks such as updating local storage, or sending a network request.
handler
(message) => Promise<any>
Called when a message is sent and the application is in a background or terminated state.
setNotificationDelegationEnabled()
setNotificationDelegationEnabled(
messaging,enabled):Promise<void>
Defined in: messaging/lib/modular.ts:402
Sets whether message notification delegation is enabled or disabled. The value is false by default. Set this to true to allow delegation of notification to Google Play Services. Note if true message handlers will not function on Android, and it has no effect on iOS
enabled
boolean
A boolean value to enable or disable delegation of messages to Google Play Services.
setOpenSettingsForNotificationsHandler()
setOpenSettingsForNotificationsHandler(
messaging,handler):void
Defined in: messaging/lib/modular.ts:329
Set a handler function which is called when the ${App Name} notifications settings
link in iOS settings is clicked.
subscribeToTopic()
subscribeToTopic(
messaging,topic):Promise<void>
Defined in: messaging/lib/modular.ts:359
Apps can subscribe to a topic, which allows the FCM server to send targeted messages to only those devices subscribed to that topic.
unregisterDeviceForRemoteMessages()
unregisterDeviceForRemoteMessages(
messaging):Promise<void>
Defined in: messaging/lib/modular.ts:212
Unregisters the app from receiving remote notifications.
unsubscribeFromTopic()
unsubscribeFromTopic(
messaging,topic):Promise<void>
Defined in: messaging/lib/modular.ts:370
Unsubscribe the device from a topic.