A reference to a Firebase Android app.
Do not call this constructor directly. Instead, use [projectManagement.androidApp()](projectManagement.ProjectManagement#androidApp).
Signature:
export declare class AndroidApp
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| appId | string |
Methods
| Method | Modifiers | Description |
|---|---|---|
| addShaCertificate(certificateToAdd) | Adds the given SHA certificate to this Android app. | |
| deleteShaCertificate(certificateToDelete) | Deletes the specified SHA certificate from this Android app. | |
| getConfig() | Gets the configuration artifact associated with this app. A promise that resolves to the Android app's Firebase config file, in UTF-8 string format. This string is typically intended to be written to a JSON file that gets shipped with your Android app. | |
| getMetadata() | Retrieves metadata about this Android app. A promise that resolves to the retrieved metadata about this Android app. | |
| getShaCertificates() | Gets the list of SHA certificates associated with this Android app in Firebase. The list of SHA-1 and SHA-256 certificates associated with this Android app in Firebase. | |
| setDisplayName(newDisplayName) | Sets the optional user-assigned display name of the app. |
AndroidApp.appId
Signature:
readonly appId: string;
AndroidApp.addShaCertificate()
Adds the given SHA certificate to this Android app.
Signature:
addShaCertificate(certificateToAdd: ShaCertificate): Promise<void>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| certificateToAdd | ShaCertificate | The SHA certificate to add. A promise that resolves when the given certificate has been added to the Android app. |
Returns:
Promise<void>
AndroidApp.deleteShaCertificate()
Deletes the specified SHA certificate from this Android app.
Signature:
deleteShaCertificate(certificateToDelete: ShaCertificate): Promise<void>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| certificateToDelete | ShaCertificate | The SHA certificate to delete. A promise that resolves when the specified certificate has been removed from the Android app. |
Returns:
Promise<void>
AndroidApp.getConfig()
Gets the configuration artifact associated with this app.
A promise that resolves to the Android app's Firebase config file, in UTF-8 string format. This string is typically intended to be written to a JSON file that gets shipped with your Android app.
Signature:
getConfig(): Promise<string>;
Returns:
Promise<string>
AndroidApp.getMetadata()
Retrieves metadata about this Android app.
A promise that resolves to the retrieved metadata about this Android app.
Signature:
getMetadata(): Promise<AndroidAppMetadata>;
Returns:
Promise<AndroidAppMetadata>
AndroidApp.getShaCertificates()
Gets the list of SHA certificates associated with this Android app in Firebase.
The list of SHA-1 and SHA-256 certificates associated with this Android app in Firebase.
Signature:
getShaCertificates(): Promise<ShaCertificate[]>;
Returns:
Promise<ShaCertificate[]>
AndroidApp.setDisplayName()
Sets the optional user-assigned display name of the app.
Signature:
setDisplayName(newDisplayName: string): Promise<void>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| newDisplayName | string | The new display name to set. A promise that resolves when the display name has been set. |
Returns:
Promise<void>