FIRInstanceID Class Reference

#import <FIRInstanceID.h>

Inheritance diagram for FIRInstanceID:

Instance Methods
((unavailable("Use +instanceID instead.")	- __attribute__
(void)	- setAPNSToken:type:
(nullable NSString *)	- token
(void)	- tokenWithAuthorizedEntity:scope:options:handler:
(void)	- deleteTokenWithAuthorizedEntity:scope:handler:
(void)	- getIDWithHandler:
(void)	- deleteIDWithHandler:

Class Methods
(instanceID()	+ NS_SWIFT_NAME

Public Attributes
FOUNDATION_EXPORT NSString *__nonnull const	kFIRInstanceIDScopeFirebaseMessaging

Related Functions
(Note that these are not member functions.)
typedef void(^	FIRInstanceIDTokenHandler) (NSString *__nullable token, NSError *__nullable error)
typedef void(^	FIRInstanceIDDeleteTokenHandler) (NSError *__nullable error)
typedef void(^	FIRInstanceIDHandler) (NSString *__nullable identity, NSError *__nullable error)
typedef void(^	FIRInstanceIDDeleteHandler) (NSError *__nullable error)

Detailed Description

Instance ID provides a unique identifier for each app instance and a mechanism to authenticate and authorize actions (for example, sending a GCM message).

Instance ID is long lived but, may be reset if the device is not used for a long time or the Instance ID service detects a problem. If Instance ID is reset, the app will be notified with a com.firebase.iid.token-refresh notification.

If the Instance ID has become invalid, the app can request a new one and send it to the app server. To prove ownership of Instance ID and to allow servers to access data or services associated with the app, call [FIRInstanceID tokenWithAuthorizedEntity:scope:options:handler].

Method Documentation

- ((unavailable("Use +instanceID instead.") __attribute__

Unavailable. Use +instanceID instead.

- (void) deleteIDWithHandler:

(nonnull FIRInstanceIDDeleteHandler)

handler

Resets Instance ID and revokes all tokens.

- (void) deleteTokenWithAuthorizedEntity:		(nonnull NSString *)	authorizedEntity
scope:		(nonnull NSString *)	scope
handler:		(nonnull FIRInstanceIDDeleteTokenHandler)	handler

Revokes access to a scope (action) for an entity previously authorized by [FIRInstanceID tokenWithAuthorizedEntity:scope:options:handler].

This is an asynchronous call. Call this on the main thread since InstanceID lib is not thread safe. In case token deletion fails for some reason we invoke the handler callback passed in with the appropriate error code.

Note, you can only have one token or deleteToken call for a given authorizedEntity and scope at a point of time. Making another such call with the same authorizedEntity and scope before the last one finishes will result in an error with code OperationInProgress.

Parameters

authorizedEntity	Entity that must no longer have access.
scope	Action that entity is no longer authorized to perform.
handler	The handler that is invoked once the unsubscribe call ends. In case of error an appropriate error object is returned else error is nil.

- (void) getIDWithHandler:

(nonnull FIRInstanceIDHandler)

handler

Asynchronously fetch a stable identifier that uniquely identifies the app instance. If the identifier has been revoked or has expired, this method will return a new identifier.

Parameters

handler

The handler to invoke once the identifier has been fetched. In case of error an appropriate error object is returned else a valid identifier is returned and a valid identifier for the application instance.

+ (instanceID() NS_SWIFT_NAME

FIRInstanceID.

Returns

A shared instance of FIRInstanceID.

- (void) setAPNSToken:		(nonnull NSData *)	token
type:		(FIRInstanceIDAPNSTokenType)	type

Set APNS token for the application. This APNS token will be used to register with Firebase Messaging using token or tokenWithAuthorizedEntity:scope:options:handler. If the token type is set to FIRInstanceIDAPNSTokenTypeUnknown InstanceID will read the provisioning profile to find out the token type.

Parameters

token	The APNS token for the application.
type	The APNS token type for the above token.

- (nullable NSString *) token

Returns a Firebase Messaging scoped token for the firebase app.

Returns

Null Returns null if the device has not yet been registerd with Firebase Message else returns a valid token.

- (void) tokenWithAuthorizedEntity:		(nonnull NSString *)	authorizedEntity
scope:		(nonnull NSString *)	scope
options:		(nullable NSDictionary *)	options
handler:		(nonnull FIRInstanceIDTokenHandler)	handler

Returns a token that authorizes an Entity (example: cloud service) to perform an action on behalf of the application identified by Instance ID.

This is similar to an OAuth2 token except, it applies to the application instance instead of a user.

This is an asynchronous call. If the token fetching fails for some reason we invoke the completion callback with nil token and the appropriate error.

Note, you can only have one token or deleteToken call for a given authorizedEntity and scope at any point of time. Making another such call with the same authorizedEntity and scope before the last one finishes will result in an error with code OperationInProgress.

See also

FIRInstanceID - deleteTokenWithAuthorizedEntity:scope:handler:

Parameters

authorizedEntity	Entity authorized by the token.
scope	Action authorized for authorizedEntity.
options	The extra options to be sent with your token request. The value for the apns_token should be the NSData object passed to UIApplication's didRegisterForRemoteNotificationsWithDeviceToken method. All other keys and values in the options dict need to be instances of NSString or else they will be discarded. Bundle keys starting with 'GCM.' and 'GOOGLE.' are reserved.
handler	The callback handler which is invoked when the token is successfully fetched. In case of success a valid token and nil error are returned. In case of any error the token is nil and a valid error is returned. The valid error codes have been documented above.

Friends And Related Function Documentation

- (typedef void(^ FIRInstanceIDDeleteHandler) (NSError *__nullable error))

related

The completion handler invoked when the app identity and all the tokens associated with it are deleted. Returns a valid error object in case of failure else nil.

Parameters

error

The error if deleting the identity and all the tokens associated with it fails else nil.

- (typedef void(^ FIRInstanceIDDeleteTokenHandler) (NSError *__nullable error))

related

The completion handler invoked when the InstanceID deleteToken returns. If the call fails we return the appropriate error code as described below

Parameters

error

The error describing why deleting the token failed. See the error codes below for a more detailed description.

- (typedef void(^ FIRInstanceIDHandler) (NSString *__nullable identity, NSError *__nullable error))

related

The completion handler invoked when the app identity is created. If the identity wasn't created for some reason we return the appropriate error code.

Parameters

identity	A valid identity for the app instance, nil if there was an error while creating an identity.
error	The error if fetching the identity fails else nil.

- (typedef void(^ FIRInstanceIDTokenHandler) (NSString *__nullable token, NSError *__nullable error))

related

The completion handler invoked when the InstanceID token returns. If the call fails we return the appropriate error code as described below.

Parameters

token	The valid token as returned by InstanceID backend.
error	The error describing why generating a new token failed. See the error codes below for a more detailed description.

Member Data Documentation

- (FOUNDATION_EXPORT NSString* __nonnull const) kFIRInstanceIDScopeFirebaseMessaging

The scope to be used when fetching/deleting a token for Firebase Messaging.

---

The documentation for this class was generated from the following file:

• Frameworks/FirebaseInstanceID.framework/Headers/FIRInstanceID.h