UNPKG

1.76 kBTypeScriptView Raw
1/*! firebase-admin v10.0.0 */
2/*!
3 * Copyright 2020 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 */
17import { App } from '../app/index';
18/**
19 * The `InstanceId` service enables deleting the Firebase instance IDs
20 * associated with Firebase client app instances.
21 *
22 * @deprecated Use {@link firebase-admin.installations#Installations} instead.
23 */
24export declare class InstanceId {
25 private app_;
26 /**
27 * Deletes the specified instance ID and the associated data from Firebase.
28 *
29 * Note that Google Analytics for Firebase uses its own form of Instance ID to
30 * keep track of analytics data. Therefore deleting a Firebase Instance ID does
31 * not delete Analytics data. See
32 * {@link https://firebase.google.com/support/privacy/manage-iids#delete_an_instance_id |
33 * Delete an Instance ID}
34 * for more information.
35 *
36 * @param instanceId - The instance ID to be deleted.
37 *
38 * @returns A promise fulfilled when the instance ID is deleted.
39 */
40 deleteInstanceId(instanceId: string): Promise<void>;
41 /**
42 * Returns the app associated with this InstanceId instance.
43 *
44 * @returns The app associated with this InstanceId instance.
45 */
46 get app(): App;
47}