installations package

Firebase Installations Web SDK。這個 SDK 無法在 Node.js 環境中運作。

函式

函式	說明
功能(應用程式, ...)
getInstallations(應用程式)	傳回與指定 FirebaseApp 執行個體相關聯的 Installations 例項。
function(安裝, ...)
deleteInstallations(installations)	刪除 Firebase 安裝作業和所有相關資料。
getId(installations)	如果應用程式沒有 Firebase 安裝項目，則建立一個安裝並傳回安裝 ID。
getToken(installations, forceRefresh)	傳回 Firebase 安裝驗證權杖，識別目前的 Firebase 安裝。
onIdChange(安裝, 回呼)	設定新的回呼，以便在安裝 ID 變更時呼叫。傳回取消訂閱函式，在呼叫時移除回呼。

介面

介面	說明
安裝	Firebase Installations SDK 的公開介面。

型別別名

類型別名	說明
IdChangeCallbackFn	使用者定義的回呼函式，會在安裝 ID 變更時呼叫。
IdChangeUnsubscribeFn	取消訂閱先前透過 IdChangeCallbackFn 新增的回呼函式。

function(應用程式, ...)

getInstallations(應用程式)

傳回與指定 FirebaseApp 執行個體相關聯的 Installations 例項。

簽名：

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

參數

參數	類型	說明
應用程式	Firebase 應用程式	FirebaseApp 執行個體。

傳回：

安裝

function(安裝, ...)

deleteInstallations(安裝)

刪除 Firebase 安裝作業和所有相關資料。

簽名：

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

參數

參數	類型	說明
安裝	安裝	Installations 例項。

傳回：

承諾<void>

getId(installations)

如果應用程式沒有 Firebase 安裝項目，則建立一個安裝並傳回安裝 ID。

簽名：

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

參數

參數	類型	說明
安裝	安裝	Installations 例項。

傳回：

承諾<字串>

getToken(installations, forceRefresh)

傳回 Firebase 安裝驗證權杖，識別目前的 Firebase 安裝。

簽名：

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

參數

參數	類型	說明
安裝	安裝	Installations 例項。
強制重新整理	布林值	無論權杖過期為何，一律強制重新整理。

傳回：

承諾<字串>

onIdChange(installations, 回呼)

設定新的回呼，以便在安裝 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;