| 1 | /*! firebase-admin v10.0.0 */
|
| 2 | /*!
|
| 3 | * Copyright 2021 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 { App } from '../app/index';
|
| 18 | import { Installations as TInstallations } from './installations';
|
| 19 | /**
|
| 20 | * Gets the {@link firebase-admin.installations#Installations} service for the
|
| 21 | * default app or a given app.
|
| 22 | *
|
| 23 | * `admin.installations()` can be called with no arguments to access the default
|
| 24 | * app's {@link firebase-admin.installations#Installations} service or as
|
| 25 | * `admin.installations(app)` to access the
|
| 26 | * {@link firebase-admin.installations#Installations} service associated with a
|
| 27 | * specific app.
|
| 28 | *
|
| 29 | * @example
|
| 30 | * ```javascript
|
| 31 | * // Get the Installations service for the default app
|
| 32 | * var defaultInstallations = admin.installations();
|
| 33 | * ```
|
| 34 | *
|
| 35 | * @example
|
| 36 | * ```javascript
|
| 37 | * // Get the Installations service for a given app
|
| 38 | * var otherInstallations = admin.installations(otherApp);
|
| 39 | *```
|
| 40 | *
|
| 41 | * @param app - Optional app whose `Installations` service to
|
| 42 | * return. If not provided, the default `Installations` service is
|
| 43 | * returned.
|
| 44 | *
|
| 45 | * @returns The default `Installations` service if
|
| 46 | * no app is provided or the `Installations` service associated with the
|
| 47 | * provided app.
|
| 48 | */
|
| 49 | export declare function installations(app?: App): installations.Installations;
|
| 50 | export declare namespace installations {
|
| 51 | /**
|
| 52 | * Type alias to {@link firebase-admin.installations#Installations}.
|
| 53 | */
|
| 54 | type Installations = TInstallations;
|
| 55 | }
|