UNPKG

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