Firebase Instance ID provides a unique identifier for each app instance and a mechanism to authenticate and authorize actions (example: sending FCM messages).
Instance ID is stable except when:
Once an Instance ID is generated, the library periodically sends information about the
application and the device where it's running to the Firebase backend. To stop this, see
deleteInstanceId().
To prove ownership of Instance ID and to allow servers to access data or services
associated with the app, call
getToken(String, String).
| void |
deleteInstanceId()
Delete the Instance ID and the data associated with it.
|
| void |
deleteToken(String senderId,
String
scope)
Revokes access to a scope (action) for a sender ID previously authorized by
getToken().
|
| long |
getCreationTime()
Returns time when instance ID was created.
|
| String |
getId()
Returns a stable identifier that uniquely identifies the app instance.
|
| static FirebaseInstanceId |
getInstance()
Returns an instance of this class.
|
| static FirebaseInstanceId | |
| Task<InstanceIdResult> |
getInstanceId()
Returns the ID and automatically generated token for this Firebase project.
|
| String | |
| String |
getToken()
This method is deprecated. In favour of
getInstanceId().
|
Delete the Instance ID and the data associated with it.
This stops the periodic sending of data to the Firebase backend started when the Instance ID was generated, unless another library that requires InstanceId (like FCM, RemoteConfig or Analytics) is used or it's configured to be executed automatically.
A new Instance ID is generated asynchronously if Firebase Cloud Messaging auto-init is enabled.
This is a blocking function so do not call it on the main thread.
| IOException |
|---|
Revokes access to a scope (action) for a sender ID previously authorized by
getToken().
This is a blocking function so do not call it on the main thread.
| senderId | ID of the sender that must no longer have access. |
|---|---|
| scope | Action that the sender ID is no longer authorized to perform. Set the scope to
FCM to revoke the authorization to send messages via
FirebaseMessaging. |
| IOException | if the request fails. |
|---|
Returns time when instance ID was created.
Returns a stable identifier that uniquely identifies the app instance.
Once an Instance ID is generated, the library periodically sends information about
the application and the device where it's running to the Firebase backend. To stop
this, see
deleteInstanceId().
Returns an instance of this class.
Returns an instance for the given FirebaseApp.
| app | FirebaseApp instance. |
|---|
Returns the ID and automatically generated token for this Firebase project.
This generates an Instance ID if it does not exist yet, which starts periodically
sending information to the Firebase backend (see getId()).
Task
which you can use to see the result via the InstanceIdResult
which holds the ID and token.Returns a token that authorizes a sender ID to perform an action on behalf of the application identified by Instance ID.
This generates an Instance ID if it does not exist yet, which starts periodically
sending information to the Firebase backend (see getId()).
This is similar to an OAuth2 token except, it applies to the application instance instead of a user.
This is a blocking function so do not call it on the main thread.
| senderId | ID of the sender that is authorized by the token. |
|---|---|
| scope | Action authorized for senderId. Set the scope to FCM to get
authorization to send messages via FirebaseMessaging. |
| IOException | if the request fails. |
|---|
This method is deprecated.
In favour of
getInstanceId().
Returns the automatically generated token for the default Firebase project.
This generates an Instance ID if it does not exist yet, which starts periodically
sending information to the Firebase backend (see getId()).