This class is the entry point for all server-side Firebase Instance ID actions.
Enables deleting instance IDs associated with Firebase projects.
Public Method Summary
void |
deleteInstanceId(String instanceId)
Deletes the specified instance ID and the associated data from Firebase.
|
ApiFuture<Void> |
deleteInstanceIdAsync(String instanceId)
Similar to
deleteInstanceId(String) but performs the operation asynchronously. |
static FirebaseInstanceId |
getInstance()
Gets the
FirebaseInstanceId instance for the default FirebaseApp . |
synchronized static FirebaseInstanceId |
Inherited Method Summary
Public Methods
public void deleteInstanceId (String instanceId)
Deletes the specified instance ID and the associated data from Firebase.
Note that Google Analytics for Firebase uses its own form of Instance ID to keep track of analytics data. Therefore deleting a regular Instance ID does not delete Analytics data. See Delete an Instance ID for more information.
Parameters
instanceId | A non-null, non-empty instance ID string. |
---|
Throws
IllegalArgumentException | If the instance ID is null or empty. |
---|---|
FirebaseInstanceIdException | If an error occurs while deleting the instance ID. |
public ApiFuture<Void> deleteInstanceIdAsync (String instanceId)
Similar to deleteInstanceId(String)
but performs the operation asynchronously.
Parameters
instanceId | A non-null, non-empty instance ID string. |
---|
Returns
- An
ApiFuture
which will complete successfully when the instance ID is deleted, or unsuccessfully with the failure Exception.
Throws
IllegalArgumentException | If the instance ID is null or empty. |
---|
public static FirebaseInstanceId getInstance ()
Gets the FirebaseInstanceId
instance for the default FirebaseApp
.
Returns
- The
FirebaseInstanceId
instance for the defaultFirebaseApp
.
public static synchronized FirebaseInstanceId getInstance (FirebaseApp app)
Gets the FirebaseInstanceId
instance for the specified FirebaseApp
.
Returns
- The
FirebaseInstanceId
instance for the specifiedFirebaseApp
.