installations package

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

関数

インターフェース

型エイリアス

関数（アプリ、...）

getInstallations（アプリ）

指定した FirebaseApp インスタンスに関連付けられている Installations のインスタンスを返します。

署名:

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

パラメータ

戻り値:

インストール

関数（インストール、...）

deleteInstallations（インストール）

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

署名:

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

パラメータ

戻り値:

約束 <void>

getId（インストール）

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

署名:

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

パラメータ

戻り値:

Promise<文字列>

getToken（インストール、forceRefresh）

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

署名:

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

パラメータ

戻り値:

Promise<文字列>

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

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

署名:

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;