React Native Firebase
    Preparing search index...

    Functions

    deleteToken

    Removes access to an FCM token previously authorized by its scope.

    experimentalSetDeliveryMetricsExportedToBigQueryEnabled

    Sets whether message delivery metrics are exported to BigQuery is enabled or disabled.

    getAPNSToken

    Returns the APNs device token on iOS.

    getDidOpenSettingsForNotification

    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.

    getInitialNotification

    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.

    getIsHeadless

    Returns whether the root view is headless or not.

    getMessaging

    Returns the Messaging instance for the default or given FirebaseApp.

    getToken

    Returns an FCM token for this device.

    hasPermission

    Returns a AuthorizationStatus as to whether the user has messaging permission for this app.

    isAutoInitEnabled

    Returns whether messaging auto initialization is enabled or disabled for the device.

    isDeliveryMetricsExportToBigQueryEnabled

    Returns a boolean whether message delivery metrics are exported to BigQuery.

    isDeviceRegisteredForRemoteMessages

    Returns a boolean value whether the user has registered for remote notifications via registerDeviceForRemoteMessages().

    isNotificationDelegationEnabled

    Returns a boolean whether message delegation is enabled. Android only, always returns false on iOS.

    isSupported

    Checks if all required APIs exist in the browser.

    onDeletedMessages

    Called when the FCM server deletes pending messages.

    onMessage

    Subscribes to foreground FCM messages.

    onMessageSent

    When sending a RemoteMessage, this listener is called when the message has been sent to FCM.

    onNotificationOpenedApp

    When the user presses a notification displayed via FCM, this listener will be called if the app has opened from a background state.

    onSendError

    When sending a RemoteMessage, this listener is called when an error is thrown and the message could not be sent.

    onTokenRefresh

    Called when a new registration token is generated for the device.

    registerDeviceForRemoteMessages

    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

    On iOS, messaging permission must be requested by the current application before messages can be received or sent.

    sendMessage

    Send a new RemoteMessage to the FCM server.

    setAPNSToken

    Sets the APNs device token received by the application delegate.

    setAutoInitEnabled

    Sets whether messaging auto initialization is enabled or disabled for the device.

    setBackgroundMessageHandler

    Set a message handler function which is called when the app is in the background or terminated.

    setNotificationDelegationEnabled

    Sets whether message notification delegation is enabled or disabled.

    setOpenSettingsForNotificationsHandler

    Set a handler function which is called when the ${App Name} notifications settings link in iOS settings is clicked.

    subscribeToTopic

    Apps can subscribe to a topic, which allows the FCM server to send targeted messages to only those devices subscribed to that topic.

    unregisterDeviceForRemoteMessages

    Unregisters the app from receiving remote notifications.

    unsubscribeFromTopic

    Unsubscribe the device from a topic.

    References

    FcmOptions → FcmOptions
    GetTokenOptions → GetTokenOptions
    IOSPermissions → IOSPermissions
    MessagePriority → MessagePriority
    Messaging → Messaging
    NativeTokenOptions → NativeTokenOptions
    Notification → Notification
    NotificationIOSCriticalSound → NotificationIOSCriticalSound
    RemoteMessage → RemoteMessage
    SendErrorEvent → SendErrorEvent

    Variables

    AuthorizationStatus

    Authorization status values returned by the deprecated permission APIs.

    NotificationAndroidPriority
    NotificationAndroidVisibility
    SDK_VERSION