The Firebase ProjectManagement service interface.
Do not call this constructor directly. Instead, use [admin.projectManagement()](projectManagement#projectManagement).
Signature:
export declare class ProjectManagement
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| app | App |
Methods
| Method | Modifiers | Description |
|---|---|---|
| androidApp(appId) | Creates an AndroidApp object, referencing the specified Android app within this Firebase project.This method does not perform an RPC. |
|
| createAndroidApp(packageName, displayName) | Creates a new Firebase Android app associated with this Firebase project. | |
| createIosApp(bundleId, displayName) | Creates a new Firebase iOS app associated with this Firebase project. | |
| iosApp(appId) | Creates an iOSApp object, referencing the specified iOS app within this Firebase project.This method does not perform an RPC. |
|
| listAndroidApps() | Lists up to 100 Firebase Android apps associated with this Firebase project. The list of Android apps. | |
| listAppMetadata() | Lists up to 100 Firebase apps associated with this Firebase project. A promise that resolves to the metadata list of the apps. | |
| listIosApps() | Lists up to 100 Firebase iOS apps associated with this Firebase project. The list of iOS apps. | |
| setDisplayName(newDisplayName) | Update the display name of this Firebase project. | |
| shaCertificate(shaHash) | Creates a ShaCertificate object.This method does not perform an RPC. |
ProjectManagement.app
Signature:
readonly app: App;
ProjectManagement.androidApp()
Creates an AndroidApp object, referencing the specified Android app within this Firebase project.
This method does not perform an RPC.
Signature:
androidApp(appId: string): AndroidApp;
Parameters
| Parameter | Type | Description |
|---|---|---|
| appId | string | The appId of the Android app to reference. An AndroidApp object that references the specified Firebase Android app. |
Returns:
ProjectManagement.createAndroidApp()
Creates a new Firebase Android app associated with this Firebase project.
Signature:
createAndroidApp(packageName: string, displayName?: string): Promise<AndroidApp>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| packageName | string | The canonical package name of the Android App, as would appear in the Google Play Developer Console. |
| displayName | string | An optional user-assigned display name for this new app. A promise that resolves to the newly created Android app. |
Returns:
Promise<AndroidApp>
ProjectManagement.createIosApp()
Creates a new Firebase iOS app associated with this Firebase project.
Signature:
createIosApp(bundleId: string, displayName?: string): Promise<IosApp>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| bundleId | string | The iOS app bundle ID to use for this new app. |
| displayName | string | An optional user-assigned display name for this new app. A promise that resolves to the newly created iOS app. |
Returns:
Promise<IosApp>
ProjectManagement.iosApp()
Creates an iOSApp object, referencing the specified iOS app within this Firebase project.
This method does not perform an RPC.
Signature:
iosApp(appId: string): IosApp;
Parameters
| Parameter | Type | Description |
|---|---|---|
| appId | string | The appId of the iOS app to reference. An iOSApp object that references the specified Firebase iOS app. |
Returns:
ProjectManagement.listAndroidApps()
Lists up to 100 Firebase Android apps associated with this Firebase project.
The list of Android apps.
Signature:
listAndroidApps(): Promise<AndroidApp[]>;
Returns:
Promise<AndroidApp[]>
ProjectManagement.listAppMetadata()
Lists up to 100 Firebase apps associated with this Firebase project.
A promise that resolves to the metadata list of the apps.
Signature:
listAppMetadata(): Promise<AppMetadata[]>;
Returns:
Promise<AppMetadata[]>
ProjectManagement.listIosApps()
Lists up to 100 Firebase iOS apps associated with this Firebase project.
The list of iOS apps.
Signature:
listIosApps(): Promise<IosApp[]>;
Returns:
Promise<IosApp[]>
ProjectManagement.setDisplayName()
Update the display name of this Firebase project.
Signature:
setDisplayName(newDisplayName: string): Promise<void>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| newDisplayName | string | The new display name to be updated. A promise that resolves when the project display name has been updated. |
Returns:
Promise<void>
ProjectManagement.shaCertificate()
Creates a ShaCertificate object.
This method does not perform an RPC.
Signature:
shaCertificate(shaHash: string): ShaCertificate;
Parameters
| Parameter | Type | Description |
|---|---|---|
| shaHash | string | The SHA-1 or SHA-256 hash for this certificate. A ShaCertificate object contains the specified SHA hash. |
Returns: