A reference to a Firebase iOS app.

Do not call this constructor directly. Instead, use [projectManagement.iosApp()](projectManagement.ProjectManagement#iosApp).

Signature:

export declare class IosApp 

Properties

Property Modifiers Type Description
appId string

Methods

Method Modifiers Description
getConfig() Gets the configuration artifact associated with this app. A promise that resolves to the iOS app's Firebase config file, in UTF-8 string format. This string is typically intended to be written to a plist file that gets shipped with your iOS app.
getMetadata() Retrieves metadata about this iOS app. A promise that resolves to the retrieved metadata about this iOS app.
setDisplayName(newDisplayName) Sets the optional user-assigned display name of the app.

IosApp.appId

Signature:

readonly appId: string;

IosApp.getConfig()

Gets the configuration artifact associated with this app.

A promise that resolves to the iOS app's Firebase config file, in UTF-8 string format. This string is typically intended to be written to a plist file that gets shipped with your iOS app.

Signature:

getConfig(): Promise<string>;

Returns:

Promise<string>

IosApp.getMetadata()

Retrieves metadata about this iOS app.

A promise that resolves to the retrieved metadata about this iOS app.

Signature:

getMetadata(): Promise<IosAppMetadata>;

Returns:

Promise<IosAppMetadata>

IosApp.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>