FirebaseInstanceID Framework Reference
Stay organized with collections
Save and categorize content based on your preferences.
Type Definitions
Firebase Instance ID is deprecated. Please use Firebase Installations instead.
The following type definitions are available globally.
-
@related FIRInstanceID
The completion handler invoked when the InstanceID token returns. If
the call fails we return the appropriate error code as described below.
Declaration
Swift
typealias InstanceIDTokenHandler = (String?, Error?) -> Void
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.
|
-
@related FIRInstanceID
The completion handler invoked when the InstanceID deleteToken returns. If
the call fails we return the appropriate error code as described below
Declaration
Swift
typealias InstanceIDDeleteTokenHandler = (Error) -> Void
Parameters
error
|
The error describing why deleting the token failed.
See the error codes below for a more detailed description.
|
-
@related FIRInstanceID
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.
Declaration
Swift
typealias InstanceIDHandler = (String?, Error?) -> Void
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.
|
-
@related FIRInstanceID
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.
Declaration
Swift
typealias InstanceIDDeleteHandler = (Error?) -> Void
Parameters
error
|
The error if deleting the identity and all the tokens associated with
it fails else nil.
|
-
@related FIRInstanceID
The completion handler invoked when the app identity and token are fetched. If the
identity wasn’t created for some reason we return the appropriate error code.
Parameters
result
|
The result containing an identity for the app instance and a valid token,
nil if there was an error while creating the result.
|
error
|
The error if fetching the identity or token fails else nil.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2021-02-11 UTC.
[null,null,["Last updated 2021-02-11 UTC."],[],[],null,["# FirebaseInstanceID Framework Reference\n\nType Definitions\n================\n\n\nFirebase Instance ID is deprecated. Please use Firebase Installations instead.\n\nThe following type definitions are available globally.\n- `\n ``\n ``\n `\n\n ### [InstanceIDTokenHandler](#/c:FIRInstanceID.h@T@FIRInstanceIDTokenHandler)\n\n `\n ` \n @related FIRInstanceID\n\n The completion handler invoked when the InstanceID token returns. If\n the call fails we return the appropriate `error code` as described below. \n\n #### Declaration\n\n Swift \n\n typealias InstanceIDTokenHandler = (String?, Error?) -\u003e Void\n\n #### Parameters\n\n |---------------|--------------------------------------------------------------------------------------------------------------------|\n | ` `*token*` ` | The valid token as returned by InstanceID backend. |\n | ` `*error*` ` | The error describing why generating a new token failed. See the error codes below for a more detailed description. |\n\n- `\n ``\n ``\n `\n\n ### [InstanceIDDeleteTokenHandler](#/c:FIRInstanceID.h@T@FIRInstanceIDDeleteTokenHandler)\n\n `\n ` \n @related FIRInstanceID\n\n The completion handler invoked when the InstanceID `deleteToken` returns. If\n the call fails we return the appropriate `error code` as described below \n\n #### Declaration\n\n Swift \n\n typealias InstanceIDDeleteTokenHandler = (Error) -\u003e Void\n\n #### Parameters\n\n |---------------|----------------------------------------------------------------------------------------------------------------|\n | ` `*error*` ` | The error describing why deleting the token failed. See the error codes below for a more detailed description. |\n\n- `\n ``\n ``\n `\n\n ### [InstanceIDHandler](#/c:FIRInstanceID.h@T@FIRInstanceIDHandler)\n\n `\n ` \n @related FIRInstanceID\n\n The completion handler invoked when the app identity is created. If the\n identity wasn't created for some reason we return the appropriate error code. \n\n #### Declaration\n\n Swift \n\n typealias InstanceIDHandler = (String?, Error?) -\u003e Void\n\n #### Parameters\n\n |------------------|----------------------------------------------------------------------------------------------|\n | ` `*identity*` ` | A valid identity for the app instance, nil if there was an error while creating an identity. |\n | ` `*error*` ` | The error if fetching the identity fails else nil. |\n\n- `\n ``\n ``\n `\n\n ### [InstanceIDDeleteHandler](#/c:FIRInstanceID.h@T@FIRInstanceIDDeleteHandler)\n\n `\n ` \n @related FIRInstanceID\n\n The completion handler invoked when the app identity and all the tokens associated\n with it are deleted. Returns a valid error object in case of failure else nil. \n\n #### Declaration\n\n Swift \n\n typealias InstanceIDDeleteHandler = (Error?) -\u003e Void\n\n #### Parameters\n\n |---------------|------------------------------------------------------------------------------------------|\n | ` `*error*` ` | The error if deleting the identity and all the tokens associated with it fails else nil. |\n\n- `\n ``\n ``\n `\n\n ### [InstanceIDResultHandler](#/c:FIRInstanceID.h@T@FIRInstanceIDResultHandler)\n\n `\n ` \n @related FIRInstanceID\n\n The completion handler invoked when the app identity and token are fetched. If the\n identity wasn't created for some reason we return the appropriate error code. \n\n #### Declaration\n\n Swift \n\n typealias InstanceIDResultHandler = (/docs/reference/swift/firebaseinstanceid/api/reference/Classes/InstanceIDResult?, Error?) -\u003e Void\n\n #### Parameters\n\n |----------------|--------------------------------------------------------------------------------------------------------------------------------|\n | ` `*result*` ` | The result containing an identity for the app instance and a valid token, nil if there was an error while creating the result. |\n | ` `*error*` ` | The error if fetching the identity or token fails else nil. |"]]
