IosApp class

A reference to a Firebase iOS app.

Do not call this constructor directly. Instead, useProjectManagement.iosApp().

Signature:

exportdeclareclassIosApp

Properties

PropertyModifiersTypeDescription
appIdstring

Methods

MethodModifiersDescription
getConfig()Gets the configuration artifact associated with this app.
getMetadata()Retrieves metadata about this iOS app.
setDisplayName(newDisplayName)Sets the optional user-assigned display name of the app.

IosApp.appId

Signature:

readonlyappId:string;

IosApp.getConfig()

Gets the configuration artifact associated with this app.

Signature:

getConfig():Promise<string>;

Returns:

Promise<string>

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.

IosApp.getMetadata()

Retrieves metadata about this iOS app.

Signature:

getMetadata():Promise<IosAppMetadata>;

Returns:

Promise<IosAppMetadata>

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

IosApp.setDisplayName()

Sets the optional user-assigned display name of the app.

Signature:

setDisplayName(newDisplayName:string):Promise<void>;

Parameters

ParameterTypeDescription
newDisplayNamestringThe new display name to set.

Returns:

Promise<void>

A promise that resolves when the display name has been set.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2022-07-29 UTC.