firebase-admin.instance-id package

Firebase 实例 ID 服务。

函数

函数 说明
getInstanceId(应用) 获取默认应用或指定应用的 InstanceId 服务。此 API 已弃用。建议使用 getInstallations() API 来删除其实例 ID 和 Firebase 安装 ID。调用 getInstanceId() 时无需参数即可访问默认应用的 InstanceId 服务,也可调用 getInstanceId(app) 来访问与特定应用关联的 InstanceId 服务。

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

getInstanceId(应用)

<ph type="x-smartling-placeholder">
</ph>

请改用 getInstallations()

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

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

可以在不使用任何参数的情况下调用 getInstanceId(),以访问默认应用的 InstanceId 服务;也可以作为 getInstanceId(app) 调用,以便访问与特定应用关联的 InstanceId 服务。

签名

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

参数

参数 类型 说明
应用 应用 要返回其 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。