firebase-admin.installations package
Stay organized with collections
Save and categorize content based on your preferences.
Firebase Instance ID service.
Functions
| Function |
Description |
| getInstallations(app) |
Gets the Installations service for the default app or a given app.getInstallations() can be called with no arguments to access the default app's Installations service or as getInstallations(app) to access the Installations service associated with a specific app. |
Classes
getInstallations(app)
Gets the Installations service for the default app or a given app.
getInstallations() can be called with no arguments to access the default app's Installations service or as getInstallations(app) to access the Installations service associated with a specific app.
Signature:
export declare function getInstallations(app?: App): Installations;
Parameters
| Parameter |
Type |
Description |
| app |
App |
Optional app whose Installations service to return. If not provided, the default Installations service will be returned. |
Returns:
Installations
The default Installations service if no app is provided or the Installations service associated with the provided app.
Example 1
// Get the Installations service for the default app
const defaultInstallations = getInstallations();
Example 2
// Get the Installations service for a given app
const otherInstallations = getInstallations(otherApp);
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 2024-05-21 UTC.
[null,null,["Last updated 2024-05-21 UTC."],[],[],null,["# firebase-admin.installations package\n\nFirebase Instance ID service.\n\nFunctions\n---------\n\n| Function | Description |\n|-------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [getInstallations(app)](./firebase-admin.installations.md#getinstallations_8a40afc) | Gets the [Installations](./firebase-admin.installations.installations.md#installations_class) service for the default app or a given app.`getInstallations()` can be called with no arguments to access the default app's `Installations` service or as `getInstallations(app)` to access the `Installations` service associated with a specific app. |\n\nClasses\n-------\n\n| Class | Description |\n|-----------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------|\n| [FirebaseInstallationsError](./firebase-admin.installations.firebaseinstallationserror.md#firebaseinstallationserror_class) | Firebase Installations service error code structure. This extends `FirebaseError`. |\n| [Installations](./firebase-admin.installations.installations.md#installations_class) | The `Installations` service for the current app. |\n| [InstallationsClientErrorCode](./firebase-admin.installations.installationsclienterrorcode.md#installationsclienterrorcode_class) | |\n\ngetInstallations(app)\n---------------------\n\nGets the [Installations](./firebase-admin.installations.installations.md#installations_class) service for the default app or a given app.\n\n`getInstallations()` can be called with no arguments to access the default app's `Installations` service or as `getInstallations(app)` to access the `Installations` service associated with a specific app.\n\n**Signature:** \n\n export declare function getInstallations(app?: App): Installations;\n\n### Parameters\n\n| Parameter | Type | Description |\n|-----------|------|------------------------------------------------------------------------------------------------------------------------------|\n| app | App | Optional app whose `Installations` service to return. If not provided, the default `Installations` service will be returned. |\n\n**Returns:**\n\n[Installations](./firebase-admin.installations.installations.md#installations_class)\n\nThe default `Installations` service if no app is provided or the `Installations` service associated with the provided app.\n\n### Example 1\n\n // Get the Installations service for the default app\n const defaultInstallations = getInstallations();\n\n### Example 2\n\n // Get the Installations service for a given app\n const otherInstallations = getInstallations(otherApp);"]]
