firebase-admin.instance-id package

Firebase 实例 ID 服务。

Functions

函数 说明
getInstanceId(app) 获取默认应用或给定应用的 InstanceId 服务。此 API 已废弃。我们建议开发者使用 get 安装 s() API 来删除其实例 ID 和 Firebase 安装 ID。可以不使用任何参数调用 getInstanceId() 以访问默认应用的 InstanceId 服务,或者以 getInstanceId(app) 的形式调用以访问与特定应用关联的 InstanceId 服务。

说明
FirebaseInstanceIdError Firebase 实例 ID 错误代码结构。这会扩展 FirebaseError。
InstanceId 借助 InstanceId 服务,您可以删除与 Firebase 客户端应用实例关联的 Firebase 实例 ID。
InstanceIdClientErrorCode

getInstanceId(应用)

请改用 get 安装 s()

获取默认应用或指定应用的 InstanceId 服务。

此 API 已废弃。建议开发者使用 get 安装 s() API 删除其实例 ID 和 Firebase 安装 ID。

可以不使用任何参数调用 getInstanceId(),以访问默认应用的 InstanceId 服务,或者以 getInstanceId(app) 的形式调用,以访问与特定应用相关联的 InstanceId 服务。

签名

export declare function getInstanceId(app?: App): InstanceId;

参数

参数 类型 说明
app 应用 要返回其 InstanceId 服务的可选应用。如果未提供,系统将返回默认的 InstanceId 服务。

返回

InstanceId

如果未提供应用,或与提供的应用关联的 InstanceId 服务,则为默认的 InstanceId 服务。

示例 1

// Get the Instance ID service for the default app
const defaultInstanceId = getInstanceId();

示例 2

// Get the Instance ID service for a given app
const otherInstanceId = getInstanceId(otherApp);

此 API 已废弃。建议开发者使用 admin.installations() API 删除其实例 ID 和 Firebase 安装 ID。