| 1 | /*! firebase-admin v10.0.0 */
|
| 2 | /*!
|
| 3 | * Copyright 2018 Google Inc.
|
| 4 | *
|
| 5 | * Licensed under the Apache License, Version 2.0 (the "License");
|
| 6 | * you may not use this file except in compliance with the License.
|
| 7 | * You may obtain a copy of the License at
|
| 8 | *
|
| 9 | * http://www.apache.org/licenses/LICENSE-2.0
|
| 10 | *
|
| 11 | * Unless required by applicable law or agreed to in writing, software
|
| 12 | * distributed under the License is distributed on an "AS IS" BASIS,
|
| 13 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
| 14 | * See the License for the specific language governing permissions and
|
| 15 | * limitations under the License.
|
| 16 | */
|
| 17 | import { AppMetadata, AppPlatform } from './app-metadata';
|
| 18 | /**
|
| 19 | * Metadata about a Firebase iOS App.
|
| 20 | */
|
| 21 | export interface IosAppMetadata extends AppMetadata {
|
| 22 | platform: AppPlatform.IOS;
|
| 23 | /**
|
| 24 | * The canonical bundle ID of the iOS App as it would appear in the iOS App Store.
|
| 25 | *
|
| 26 | * @example
|
| 27 | * ```javascript
|
| 28 | * var bundleId = iosAppMetadata.bundleId;
|
| 29 | *```
|
| 30 | */
|
| 31 | bundleId: string;
|
| 32 | }
|
| 33 | /**
|
| 34 | * A reference to a Firebase iOS app.
|
| 35 | *
|
| 36 | * Do not call this constructor directly. Instead, use {@link ProjectManagement.iosApp}.
|
| 37 | */
|
| 38 | export declare class IosApp {
|
| 39 | readonly appId: string;
|
| 40 | private readonly requestHandler;
|
| 41 | private readonly resourceName;
|
| 42 | /**
|
| 43 | * Retrieves metadata about this iOS app.
|
| 44 | *
|
| 45 | * @returns A promise that
|
| 46 | * resolves to the retrieved metadata about this iOS app.
|
| 47 | */
|
| 48 | getMetadata(): Promise<IosAppMetadata>;
|
| 49 | /**
|
| 50 | * Sets the optional user-assigned display name of the app.
|
| 51 | *
|
| 52 | * @param newDisplayName - The new display name to set.
|
| 53 | *
|
| 54 | * @returns A promise that resolves when the display name has
|
| 55 | * been set.
|
| 56 | */
|
| 57 | setDisplayName(newDisplayName: string): Promise<void>;
|
| 58 | /**
|
| 59 | * Gets the configuration artifact associated with this app.
|
| 60 | *
|
| 61 | * @returns A promise that resolves to the iOS app's Firebase
|
| 62 | * config file, in UTF-8 string format. This string is typically intended to
|
| 63 | * be written to a plist file that gets shipped with your iOS app.
|
| 64 | */
|
| 65 | getConfig(): Promise<string>;
|
| 66 | }
|