Messaging

class Messaging : NSObject

Firebase Messaging lets you reliably deliver messages at no cost.

To send or receive messages, the app must get a registration token from FIRInstanceID. This token authorizes an app server to send messages to an app instance.

In order to receive FIRMessaging messages, declare application:didReceiveRemoteNotification::fetchCompletionHandler:.

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

    Declaration

    Swift

    weak var delegate: MessagingDelegate? { get set }
  • When set to YES, Firebase Messaging will automatically establish a socket-based, direct channel to the FCM server. Enable this only if you are sending upstream messages or receiving non-APNS, data-only messages in foregrounded apps. Default is NO.

    Declaration

    Swift

    var shouldEstablishDirectChannel: Bool { get set }
  • Returns YES if the direct channel to the FCM server is active, and NO otherwise.

    Declaration

    Swift

    var isDirectChannelEstablished: Bool { get }
  • Undocumented

    Declaration

    Swift

    var useMessagingDelegateForDirectChannel: Bool { get set }
  • FIRMessaging

    Declaration

    Swift

    class func messaging() -> Self

    Return Value

    An instance of FIRMessaging.

  • Unavailable. Use +messaging instead.

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

    FIRMessaging 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, see: -setAPNSToken:type:.

    Declaration

    Swift

    var apnsToken: Data? { get set }
  • Set APNS token for the application. This APNS token will be used to register with Firebase Messaging using FCMToken or tokenWithAuthorizedEntity:scope:options:handler.

    Declaration

    Swift

    func setAPNSToken(_ apnsToken: Data, type: MessagingAPNSTokenType)

    Parameters

    apnsToken

    The APNS token for the application.

    type

    The type of APNS token. Debug builds should use FIRMessagingAPNSTokenTypeSandbox. Alternatively, you can supply FIRMessagingAPNSTokenTypeUnknown to have the type automatically detected based on your provisioning profile.

  • Is Firebase Messaging token auto generation enabled? If this flag is disabled, Firebase Messaging will not generate 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. FCM also generates a new token when an existing token is deleted.

    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 token) set FirebaseMessagingAutoInitEnabled to false in your application’s Info.plist.

    Declaration

    Swift

    var isAutoInitEnabled: Bool { get set }
  • The FCM 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 that sending messages to the FCM token will be delivered over APNS.

    The FCM token is sometimes refreshed automatically. In your FIRMessaging delegate, the delegate method messaging: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 token is invalidated or updated.

    Once you have an FCM token, you should send it to your application server, so it can use the FCM token to send notifications to your device.

    Declaration

    Swift

    var fcmToken: String? { get }
  • 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.

    Declaration

    Swift

    func retrieveFCMToken(forSenderID senderID: String, completion: @escaping MessagingFCMTokenFetchCompletion)

    Parameters

    senderID

    The Sender ID for a particular Firebase project.

    completion

    The completion handler to handle the token request.

  • Invalidates an FCM token for a particular Sender ID. That Sender ID cannot no longer send notifications to that FCM token.

    Declaration

    Swift

    func deleteFCMToken(forSenderID senderID: String, completion: @escaping MessagingDeleteFCMTokenCompletion)

    Parameters

    senderID

    The senderID for a particular Firebase project.

    completion

    The completion handler to handle the token deletion.

  • Create a FIRMessaging data connection which will be used to send the data notifications sent by your server. It will also be used to send ACKS and other messages based on the FIRMessaging ACKS and other messages based on the FIRMessaging protocol.

    Declaration

    Swift

    func connect(handler: @escaping MessagingConnectCompletion)

    Parameters

    handler

    The handler to be invoked once the connection is established. If the connection fails we invoke the handler with an appropriate error code letting you know why it failed. At the same time, FIRMessaging performs exponential backoff to retry establishing a connection and invoke the handler when successful.

  • Disconnect the current FIRMessaging data connection. This stops any attempts to connect to FIRMessaging. Calling this on an already disconnected client is a no-op.

    Call this before teardown when your app is going to the background. Since the FIRMessaging connection won’t be allowed to live when in the background, it is prudent to close the connection.

    Declaration

    Swift

    func disconnect()
  • Asynchronously subscribes to a topic.

    Declaration

    Swift

    func subscribe(toTopic topic: String)

    Parameters

    topic

    The name of the topic, for example, @sports.

  • Asynchronously subscribe to the provided topic, retrying on failure.

    Declaration

    Swift

    func subscribe(toTopic topic: String, completion: FIRMessagingTopicOperationCompletion? = nil)

    Parameters

    topic

    The topic name to subscribe to, for example, @sports.

    completion

    The completion that is invoked once the subscribe call ends. In case of success, nil error is returned. Otherwise, an appropriate error object is returned.

  • Asynchronously unsubscribe from a topic.

    Declaration

    Swift

    func unsubscribe(fromTopic topic: String)

    Parameters

    topic

    The name of the topic, for example @sports.

  • Asynchronously unsubscribe from the provided topic, retrying on failure.

    Declaration

    Swift

    func unsubscribe(fromTopic topic: String, completion: FIRMessagingTopicOperationCompletion? = nil)

    Parameters

    topic

    The topic name to unsubscribe from, for example @sports.

    completion

    The completion that is invoked once the unsubscribe call ends. In case of success, nil error is returned. Otherwise, an appropriate error object is returned.

  • Sends an upstream (device to cloud) message.

    The message is queued if we don’t have an active connection. You can only use the upstream feature if your FCM implementation uses the XMPP server protocol.

    Declaration

    Swift

    func sendMessage(_ message: [AnyHashable : Any], to receiver: String, withMessageID messageID: String, timeToLive ttl: Int64)

    Parameters

    message

    Key/Value pairs to be sent. Values must be String, any other type will be ignored.

    receiver

    A string identifying the receiver of the message. For FCM project IDs the value is SENDER_ID@gcm.googleapis.com.

    messageID

    The ID of the message. This is generated by the application. It must be unique for each message generated by this application. It allows error callbacks and debugging, to uniquely identify each message.

    ttl

    The time to live for the message. In case we aren’t able to send the message before the TTL expires we will send you a callback. If 0, we’ll attempt to send immediately and return an error if we’re not connected. Otherwise, the message will be queued. As for server-side messages, we don’t return an error if the message has been dropped because of TTL; this can happen on the server side, and it would require extra communication.

  • Use this to track message delivery and analytics for messages, typically when you receive a notification in application:didReceiveRemoteNotification:. However, you only need to call this if you set the FirebaseAppDelegateProxyEnabled flag to NO in your Info.plist. If FirebaseAppDelegateProxyEnabled is either missing or set to YES in your Info.plist, the library will call this automatically.

    Declaration

    Swift

    func appDidReceiveMessage(_ message: [AnyHashable : Any]) -> MessagingMessageInfo

    Parameters

    message

    The downstream message received by the application.

    Return Value

    Information about the downstream message.