installations package

Firebase 安装 Web SDK。此 SDK 无法在 Node.js 环境中工作。

函数

函数	说明
function(应用, ...)
getInstallations(app)	返回与给定 FirebaseApp 实例相关联的 Installations 实例。
function(安装, ...)
delete 安装（安装）	删除 Firebase 安装和所有关联数据。
getId(安装)	如果应用没有 Firebase 安装，则创建 Firebase 安装并返回安装 ID。
getToken(installations, forceRefresh)	返回 Firebase 安装身份验证令牌，标识当前的 Firebase 安装。
onIdChange(installations, callback)	设置将在安装 ID 发生更改时调用的新回调。返回一个退订函数，该函数会在调用时移除回调函数。

接口

接口	说明
安装次数	Firebase 安装 SDK 的公共接口。

类型别名

类型别名	说明
IdChangeCallbackFn	用户定义的回调函数，当安装 ID 发生更改时调用。
IdChangeUnsubscribeFn	退订之前通过 IdChangeCallbackFn 添加的回调函数。

function(应用, ...)

getInstallations(应用)

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

签名：

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

参数

参数	类型	说明
应用	FirebaseApp	FirebaseApp 实例。

返回：

安装次数

function(安装次数, ...)

delete 安装（安装）

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

签名：

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

参数

参数	类型	说明
安装	安装次数	Installations 实例。

返回：

承诺<void>

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 实例。
callback	IdChangeCallbackFn	在 FID 发生更改时调用的回调函数。

返回：

IdChangeUnsubscribeFn

可调用以退订的函数。

IdChangeCallbackFn

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

签名：

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

IdChangeUnsubscribeFn

退订之前通过 IdChangeCallbackFn 添加的回调函数。

签名：

export declare type IdChangeUnsubscribeFn = () => void;