firebase-admin.project-management package
Stay organized with collections
Save and categorize content based on your preferences.
Firebase project management.
Functions
| Function |
Description |
| getProjectManagement(app) |
Gets the ProjectManagement service for the default app or a given app.getProjectManagement() can be called with no arguments to access the default app's ProjectManagement service, or as getProjectManagement(app) to access the ProjectManagement service associated with a specific app. |
Classes
Enumerations
| Enumeration |
Description |
| AppPlatform |
Platforms with which a Firebase App can be associated. |
Interfaces
Type Aliases
getProjectManagement(app)
Gets the ProjectManagement service for the default app or a given app.
getProjectManagement() can be called with no arguments to access the default app's ProjectManagement service, or as getProjectManagement(app) to access the ProjectManagement service associated with a specific app.
Signature:
export declare function getProjectManagement(app?: App): ProjectManagement;
Parameters
| Parameter |
Type |
Description |
| app |
App |
Optional app whose ProjectManagement service to return. If not provided, the default ProjectManagement service will be returned. * |
Returns:
ProjectManagement
The default ProjectManagement service if no app is provided or the ProjectManagement service associated with the provided app.
Example 1
// Get the ProjectManagement service for the default app
const defaultProjectManagement = getProjectManagement();
Example 2
// Get the ProjectManagement service for a given app
const otherProjectManagement = getProjectManagement(otherApp);
ProjectManagementErrorCode
Signature:
export type ProjectManagementErrorCode = 'already-exists' | 'authentication-error' | 'internal-error' | 'invalid-argument' | 'invalid-project-id' | 'invalid-server-response' | 'not-found' | 'service-unavailable' | 'unknown-error';
Platforms with which a Firebase App can be associated.
Signature:
export declare enum AppPlatform
Enumeration Members
| Member |
Value |
Description |
| ANDROID |
"ANDROID" |
The Firebase App is associated with Android. |
| IOS |
"IOS" |
The Firebase App is associated with iOS. |
| PLATFORM_UNKNOWN |
"PLATFORM_UNKNOWN" |
Unknown state. This is only used for distinguishing unset values. |
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.project-management package\n\nFirebase project management.\n\nFunctions\n---------\n\n| Function | Description |\n|--------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [getProjectManagement(app)](./firebase-admin.project-management.md#getprojectmanagement_8a40afc) | Gets the [ProjectManagement](./firebase-admin.project-management.projectmanagement.md#projectmanagement_class) service for the default app or a given app.`getProjectManagement()` can be called with no arguments to access the default app's `ProjectManagement` service, or as `getProjectManagement(app)` to access the `ProjectManagement` service associated with a specific app. |\n\nClasses\n-------\n\n| Class | Description |\n|----------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [AndroidApp](./firebase-admin.project-management.androidapp.md#androidapp_class) | A reference to a Firebase Android app.Do not call this constructor directly. Instead, use [ProjectManagement.androidApp()](./firebase-admin.project-management.projectmanagement.md#projectmanagementandroidapp). |\n| [FirebaseProjectManagementError](./firebase-admin.project-management.firebaseprojectmanagementerror.md#firebaseprojectmanagementerror_class) | Firebase project management error code structure. This extends PrefixedFirebaseError. |\n| [IosApp](./firebase-admin.project-management.iosapp.md#iosapp_class) | A reference to a Firebase iOS app.Do not call this constructor directly. Instead, use [ProjectManagement.iosApp()](./firebase-admin.project-management.projectmanagement.md#projectmanagementiosapp). |\n| [ProjectManagement](./firebase-admin.project-management.projectmanagement.md#projectmanagement_class) | The Firebase ProjectManagement service interface. |\n| [ShaCertificate](./firebase-admin.project-management.shacertificate.md#shacertificate_class) | A SHA-1 or SHA-256 certificate.Do not call this constructor directly. Instead, use \\[`projectManagement.shaCertificate()`\\](projectManagement.ProjectManagement#shaCertificate). |\n\nEnumerations\n------------\n\n| Enumeration | Description |\n|-------------------------------------------------------------------|--------------------------------------------------------|\n| [AppPlatform](./firebase-admin.project-management.md#appplatform) | Platforms with which a Firebase App can be associated. |\n\nInterfaces\n----------\n\n| Interface | Description |\n|--------------------------------------------------------------------------------------------------------------|----------------------------------------|\n| [AndroidAppMetadata](./firebase-admin.project-management.androidappmetadata.md#androidappmetadata_interface) | Metadata about a Firebase Android App. |\n| [AppMetadata](./firebase-admin.project-management.appmetadata.md#appmetadata_interface) | Metadata about a Firebase app. |\n| [IosAppMetadata](./firebase-admin.project-management.iosappmetadata.md#iosappmetadata_interface) | Metadata about a Firebase iOS App. |\n\nType Aliases\n------------\n\n| Type Alias | Description |\n|-------------------------------------------------------------------------------------------------|-------------|\n| [ProjectManagementErrorCode](./firebase-admin.project-management.md#projectmanagementerrorcode) | |\n\ngetProjectManagement(app)\n-------------------------\n\nGets the [ProjectManagement](./firebase-admin.project-management.projectmanagement.md#projectmanagement_class) service for the default app or a given app.\n\n`getProjectManagement()` can be called with no arguments to access the default app's `ProjectManagement` service, or as `getProjectManagement(app)` to access the `ProjectManagement` service associated with a specific app.\n\n**Signature:** \n\n export declare function getProjectManagement(app?: App): ProjectManagement;\n\n### Parameters\n\n| Parameter | Type | Description |\n|-----------|------|-----------------------------------------------------------------------------------------------------------------------------------------|\n| app | App | Optional app whose `ProjectManagement` service to return. If not provided, the default `ProjectManagement` service will be returned. \\* |\n\n**Returns:**\n\n[ProjectManagement](./firebase-admin.project-management.projectmanagement.md#projectmanagement_class)\n\nThe default `ProjectManagement` service if no app is provided or the `ProjectManagement` service associated with the provided app.\n\n### Example 1\n\n // Get the ProjectManagement service for the default app\n const defaultProjectManagement = getProjectManagement();\n\n### Example 2\n\n // Get the ProjectManagement service for a given app\n const otherProjectManagement = getProjectManagement(otherApp);\n\nProjectManagementErrorCode\n--------------------------\n\n**Signature:** \n\n export type ProjectManagementErrorCode = 'already-exists' | 'authentication-error' | 'internal-error' | 'invalid-argument' | 'invalid-project-id' | 'invalid-server-response' | 'not-found' | 'service-unavailable' | 'unknown-error';\n\nAppPlatform\n-----------\n\nPlatforms with which a Firebase App can be associated.\n\n**Signature:** \n\n export declare enum AppPlatform \n\nEnumeration Members\n-------------------\n\n| Member | Value | Description |\n|------------------|----------------------|-------------------------------------------------------------------|\n| ANDROID | `\"ANDROID\"` | The Firebase App is associated with Android. |\n| IOS | `\"IOS\"` | The Firebase App is associated with iOS. |\n| PLATFORM_UNKNOWN | `\"PLATFORM_UNKNOWN\"` | Unknown state. This is only used for distinguishing unset values. |"]]
