Firebase Instance ID service.
Functions
| Function | Description |
|---|---|
| getInstanceId(app) | Gets the InstanceId service for the default app or a given app.This API is deprecated. Developers are advised to use the getInstallations() API to delete their instance IDs and Firebase installation IDs.getInstanceId() can be called with no arguments to access the default app's InstanceId service or as getInstanceId(app) to access the InstanceId service associated with a specific app. |
Classes
| Class | Description |
|---|---|
| InstanceId | The InstanceId service enables deleting the Firebase instance IDs associated with Firebase client app instances. |
getInstanceId(app)
Use getInstallations() instead.
Gets the InstanceId service for the default app or a given app.
This API is deprecated. Developers are advised to use the getInstallations() API to delete their instance IDs and Firebase installation IDs.
getInstanceId() can be called with no arguments to access the default app's InstanceId service or as getInstanceId(app) to access the InstanceId service associated with a specific app.
Signature:
export declare function getInstanceId(app?: App): InstanceId;
Parameters
| Parameter | Type | Description |
|---|---|---|
| app | App | Optional app whose InstanceId service to return. If not provided, the default InstanceId service will be returned. |
Returns:
The default InstanceId service if no app is provided or the InstanceId service associated with the provided app.
Example 1
// Get the Instance ID service for the default app
const defaultInstanceId = getInstanceId();
Example 2
// Get the Instance ID service for a given app
const otherInstanceId = getInstanceId(otherApp);
This API is deprecated. Developers are advised to use the admin.installations() API to delete their instance IDs and Firebase installation IDs.