firebase-admin
Version:
Firebase admin SDK for Node.js
84 lines (83 loc) • 2.94 kB
TypeScript
/*! firebase-admin v9.12.0 */
/*!
* Copyright 2020 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { app } from '../firebase-namespace-api';
/**
* Gets the {@link instanceId.InstanceId `InstanceId`} service for the
* default app or a given app.
*
* `admin.instanceId()` can be called with no arguments to access the default
* app's {@link instanceId.InstanceId `InstanceId`} service or as
* `admin.instanceId(app)` to access the
* {@link instanceId.InstanceId `InstanceId`} service associated with a
* specific app.
*
* @example
* ```javascript
* // Get the Instance ID service for the default app
* var defaultInstanceId = admin.instanceId();
* ```
*
* @example
* ```javascript
* // Get the Instance ID service for a given app
* var otherInstanceId = admin.instanceId(otherApp);
*```
*
* This API is deprecated. Developers are advised to use the `admin.installations()`
* API to delete their instance IDs and Firebase installation IDs.
*
* @param app Optional app whose `InstanceId` service to
* return. If not provided, the default `InstanceId` service will be
* returned.
*
* @return The default `InstanceId` service if
* no app is provided or the `InstanceId` service associated with the
* provided app.
*
* @deprecated
*/
export declare function instanceId(app?: app.App): instanceId.InstanceId;
export declare namespace instanceId {
/**
* The {@link InstanceId `InstanceId`} service for the
* current app.
*
* @deprecated
*/
interface InstanceId {
app: app.App;
/**
* Deletes the specified instance ID and the associated data from Firebase.
*
* Note that Google Analytics for Firebase uses its own form of Instance ID to
* keep track of analytics data. Therefore deleting a Firebase Instance ID does
* not delete Analytics data. See
* [Delete an Instance ID](/support/privacy/manage-iids#delete_an_instance_id)
* for more information.
*
* This API is deprecated. Developers are advised to use the `Installations.deleteInstallation()`
* API instead.
*
* @param instanceId The instance ID to be deleted.
*
* @return A promise fulfilled when the instance ID is deleted.
*
* @deprecated
*/
deleteInstanceId(instanceId: string): Promise<void>;
}
}