installations package

Firebase インストール Web SDK。この SDK は Node.js 環境では動作しません。

機能

インターフェース

タイプエイリアス

関数(アプリ、...)

getインストール(アプリ)

指定されたFirebaseAppインスタンスに関連付けられたインストールのインスタンスを返します。

サイン：

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

パラメーター

戻り値：

インスタレーション

機能(インストールなど)

deleteインストール(インストール)

Firebase インストールとすべての関連データを削除します。

サイン：

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

パラメーター

戻り値：

約束<無効>

getId(インストール)

アプリ用の Firebase インストールがない場合は Firebase インストールを作成し、インストール ID を返します。

サイン：

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

パラメーター

戻り値：

約束<文字列>

getToken(インストール、forceRefresh)

現在の Firebase インストールを識別する Firebase インストール認証トークンを返します。

サイン：

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

パラメーター

戻り値：

約束<文字列>

onIdChange(インストール、コールバック)

インストール ID が変更されたときに呼び出される新しいコールバックを設定します。呼び出されたときにコールバックを削除する unsubscribe 関数を返します。

サイン：

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

パラメーター

戻り値：

IdChangeUnsubscribeFn

購読を解除するために呼び出すことができる関数。

IdChangeCallbackFn

インストール ID が変更されたときに呼び出されるユーザー定義のコールバック関数。

サイン：

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

IdChangeUnsubscribeFn

IdChangeCallbackFn経由で以前に追加されたコールバック関数のサブスクライブを解除する。

サイン：

export declare type IdChangeUnsubscribeFn = () => void;