installations package

Firebase 安装 Web SDK。此 SDK 不适用于 Node.js 环境。

功能

功能描述
函数（应用程序，...）
获取安装（应用程序）返回与给定FirebaseApp实例关联的Installations实例。
功能（安装，...）
删除安装（安装）删除 Firebase 安装和所有关联数据。
getId(安装)如果应用没有 Firebase 安装，则创建一个 Firebase 安装并返回安装 ID。
getToken（安装，forceRefresh）返回 Firebase 安装身份验证令牌，标识当前的 Firebase 安装。
onIdChange（安装，回调）设置一个新的回调，当安装 ID 更改时将调用该回调。返回一个取消订阅函数，该函数将在调用时删除回调。

接口

界面描述
装置Firebase Installations SDK 的公共接口。

类型别名

类型别名描述
IdChangeCallbackFn用户定义的回调函数，当安装 ID 更改时调用。
IdChangeUnsubscribeFn取消订阅之前通过IdChangeCallbackFn添加的回调函数。

函数（应用程序，...）

获取安装（应用程序）

返回与给定FirebaseApp实例关联的Installations实例。

签名：

export declare function getInstallations(app?: FirebaseApp): Installations;

参数

范围类型描述
应用程序Firebase应用程序FirebaseApp实例。

返回：

装置

功能（安装，...）

删除安装（安装）

删除 Firebase 安装和所有关联数据。

签名：

export declare function deleteInstallations(installations: Installations): Promise<void>;

参数

范围类型描述
装置装置Installations实例。

返回：

承诺<无效>

getId(安装)

如果应用没有 Firebase 安装，则创建一个 Firebase 安装并返回安装 ID。

签名：

export declare function getId(installations: Installations): Promise<string>;

参数

范围类型描述
装置装置Installations实例。

返回：

承诺<字符串>

getToken（安装，forceRefresh）

返回 Firebase 安装身份验证令牌，标识当前的 Firebase 安装。

签名：

export declare function getToken(installations: Installations, forceRefresh?: boolean): Promise<string>;

参数

范围类型描述
装置装置Installations实例。
强制刷新布尔值无论令牌是否过期，都强制刷新。

返回：

承诺<字符串>

onIdChange（安装，回调）

设置一个新的回调，当安装 ID 更改时将调用该回调。返回一个取消订阅函数，该函数将在调用时删除回调。

签名：

export declare function onIdChange(installations: Installations, callback: IdChangeCallbackFn): IdChangeUnsubscribeFn;

参数

范围类型描述
装置装置Installations实例。
打回来IdChangeCallbackFn当FID改变时调用的回调函数。

返回：

IdChangeUnsubscribeFn

可以调用取消订阅的函数。

IdChangeCallbackFn

用户定义的回调函数，当安装 ID 更改时调用。

签名：

export declare type IdChangeCallbackFn = (installationId: string) => void;

IdChangeUnsubscribeFn

取消订阅之前通过IdChangeCallbackFn添加的回调函数。

签名：

export declare type IdChangeUnsubscribeFn = () => void;