Delegate to handle FCM token refreshes, and remote data messages received via FCM direct channel.

Declaration

weakvardelegate:(anyMessagingDelegate)?{getset}

FIRMessaging

Declaration

classfuncmessaging()->Self

Return Value

An instance of Messaging.

Unavailable

Use +messaging instead.

Unavailable. Use +messaging instead.

This property is used to set the APNs Token received by the application delegate.

Messaging uses method swizzling to ensure that the APNs token is set automatically. However, if you have disabled swizzling by settingFirebaseAppDelegateProxyEnabled toNO in your app’s Info.plist, you should manually set the APNs token in your application delegate’sapplication(_:didRegisterForRemoteNotificationsWithDeviceToken:) method.

If you would like to set the type of the APNs token, rather than relying on automatic detection, seesetAPNSToken(_:type:).

Declaration

varapnsToken:Data?{getset}

Set the APNs token for the application. This token will be used to register with Firebase Messaging, and will be associated with the app’s installation ID in the form of an FCM token.

Declaration

funcsetAPNSToken(_apnsToken:Data,type:MessagingAPNSTokenType)

Parameters

Is Firebase Messaging token auto generation enabled? If this flag is disabled, Firebase Messaging will not generate an FCM token automatically for message delivery.

If this flag is disabled, Firebase Messaging does not generate new tokens automatically for message delivery. If this flag is enabled, FCM generates a registration token on application start when there is no existing valid token and periodically refreshes the token and sends data to the Firebase backend.

This setting is persisted, and is applied on future invocations of your application. Once explicitly set, it overrides any settings in your Info.plist.

By default, FCM automatic initialization is enabled. If you need to change the default (for example, because you want to prompt the user before getting a token), setFirebaseMessagingAutoInitEnabled to NO in your application’s Info.plist.

Declaration

varisAutoInitEnabled:Bool{getset}

The FCM registration token is used to identify this device so that FCM can send notifications to it. It is associated with your APNs token when the APNs token is supplied, so messages sent to the FCM token will be delivered over APNs.

The FCM registration token is sometimes refreshed automatically. In your Messaging delegate, the delegate methodmessaging(_:didReceiveRegistrationToken:) will be called once a token is available, or has been refreshed. Typically it should be called once per app start, but may be called more often if the token is invalidated or updated.

Once you have an FCM registration token, you should send it to your application server, where it can be used to send notifications to your device.

Declaration

varfcmToken:String?{get}

Asynchronously gets the default FCM registration token.

This creates a Firebase Installations ID, if one does not exist, and sends information about the application and the device to the Firebase backend. A network connection is required for the method to succeed. To stop this, seeMessaging.isAutoInitEnabled,Messaging.delete(completion:) andInstallations.delete(completion:).

Declaration

functoken()asyncthrows->String

Parameters

Asynchronously deletes the default FCM registration token.

This does not delete all tokens for non-default sender IDs, SeeMessaging.delete(completion:) for deleting all of them. To prevent token auto generation, seeMessaging.isAutoInitEnabled.

Declaration

funcdeleteToken()asyncthrows

Parameters

Retrieves an FCM registration token for a particular Sender ID. This can be used to allow multiple senders to send notifications to the same device. By providing a different Sender ID than your default when fetching a token, you can create a new FCM token which you can give to a different sender. Both tokens will deliver notifications to your device, and you can revoke a token when you need to.

This registration token is not cached by FIRMessaging. FIRMessaging should have an APNs token set before calling this to ensure that notifications can be delivered via APNs using this FCM token. You may re-retrieve the FCM token once you have the APNs token set, to associate it with the FCM token. The default FCM token is automatically associated with the APNs token, if the APNs token data is available.

This creates a Firebase Installations ID, if one does not exist, and sends information about the application and the device to the Firebase backend.

Declaration

funcretrieveFCMToken(forSenderIDsenderID:String)asyncthrows->String

Parameters

Invalidates an FCM token for a particular Sender ID. That Sender ID cannot no longer send notifications to that FCM token. This does not delete the Firebase Installations ID that may have been created when generating the token. SeeInstallations.delete(completion:).

Declaration

funcdeleteFCMToken(forSenderIDsenderID:String)asyncthrows

Parameters

Asynchronously subscribes to a topic. This uses the default FCM registration token to identify the app instance and periodically sends data to the Firebase backend. To stop this, seeMessaging.delete(completion:) andInstallations.delete(completion:).

Declaration

funcsubscribe(toTopictopic:String)

Parameters

Asynchronously subscribe to the provided topic, retrying on failure. This uses the default FCM registration token to identify the app instance and periodically sends data to the Firebase backend. To stop this, seeMessaging.delete(completion:) andInstallations.delete(completion:).

Declaration

funcsubscribe(toTopictopic:String)asyncthrows

Parameters

Asynchronously unsubscribe from a topic. This uses a FCM Token to identify the app instance and periodically sends data to the Firebase backend. To stop this, seeMessaging.delete(completion:) andInstallations.delete(completion:).

Declaration

funcunsubscribe(fromTopictopic:String)

Parameters

Asynchronously unsubscribe from the provided topic, retrying on failure. This uses a FCM Token to identify the app instance and periodically sends data to the Firebase backend. To stop this, seeMessaging.delete(completion:) andInstallations.delete(completion:).

Declaration

funcunsubscribe(fromTopictopic:String)asyncthrows

Parameters

Use this to track message delivery and analytics for messages, typically when you receive a notification inapplication:didReceiveRemoteNotification:. However, you only need to call this if you set theFirebaseAppDelegateProxyEnabled flag toNO in your Info.plist. IfFirebaseAppDelegateProxyEnabled is either missing or set toYES in your Info.plist, the library will call this automatically.

Declaration

funcappDidReceiveMessage(_message:[AnyHashable:Any])->MessagingMessageInfo

Parameters

Return Value

Information about the downstream message.

Deletes all the tokens and checkin data of the Firebase project and related data on the server side. A network connection is required for the method to succeed.

This does not delete the Firebase Installations ID. SeeInstallations.delete(completion:). To prevent token auto generation, seeMessaging.isAutoInitEnabled.

Declaration

funcdeleteData()asyncthrows

Parameters