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;