app-check package

Firebase App Check Web SDK。

Firebase App Check は、 ReCaptchaV3ProviderまたはReCaptchaEnterpriseProviderを使用する Node.js 環境では機能しませんただしCustomProvider使用して独自の構成証明メソッドを作成する場合は、Node.js で使用できます。

機能

クラス

インターフェース

タイプエイリアス

関数(アプリ、...)

InitializeAppCheck(アプリ、オプション)

指定されたアプリの App Check をアクティブ化します。アプリごとに 1 回だけ呼び出すことができます。

サイン：

export declare function initializeAppCheck(app: FirebaseApp | undefined, options: AppCheckOptions): AppCheck;

パラメーター

戻り値：

アプリチェック

関数(appCheckInstance, ...)

getLimitedUseToken(appCheckInstance)

Firebase App Check トークンをリクエストします。このメソッドは、Firebase 以外のバックエンドへのリクエストを承認する必要がある場合にのみ使用してください。

Replay Protectionで保護されている非 Firebase バックエンド エンドポイントでの使用を目的とした限定使用トークンを返します。このメソッドは、#getAppCheckToken() メソッドのトークン生成動作には影響しません。

サイン：

export declare function getLimitedUseToken(appCheckInstance: AppCheck): Promise<AppCheckTokenResult>;

パラメーター

戻り値：

Promise< AppCheckTokenResult >

使用制限のあるトークン。

getToken(appCheckInstance、forceRefresh)

現在の App Check トークンを取得します。最新の実行中のリクエストが存在する場合、それに添付されます。トークンが存在せず、進行中のトークン要求がない場合は、null を返します。

サイン：

export declare function getToken(appCheckInstance: AppCheck, forceRefresh?: boolean): Promise<AppCheckTokenResult>;

パラメーター

戻り値：

Promise< AppCheckTokenResult >

onTokenChanged(appCheckInstance、オブザーバー)

トークン状態の変更に対してリスナーを登録します。 1 つ以上の App Check インスタンスに対して複数のリスナーを同時に登録できます。この App Check インスタンスに関連付けられた現在のトークンが変更されるたびに、リスナーは UI スレッドでコールバックします。

サイン：

export declare function onTokenChanged(appCheckInstance: AppCheck, observer: PartialObserver<AppCheckTokenResult>): Unsubscribe;

パラメーター

戻り値：

購読を解除する

このリスナーのサブスクライブを解除する関数。

onTokenChanged(appCheckInstance、onNext、onError、onCompletion)

トークン状態の変更に対してリスナーを登録します。 1 つ以上の App Check インスタンスに対して複数のリスナーを同時に登録できます。この App Check インスタンスに関連付けられた現在のトークンが変更されるたびに、リスナーは UI スレッドでコールバックします。

サイン：

export declare function onTokenChanged(appCheckInstance: AppCheck, onNext: (tokenResult: AppCheckTokenResult) => void, onError?: (error: Error) => void, onCompletion?: () => void): Unsubscribe;

パラメーター

戻り値：

購読を解除する

このリスナーのサブスクライブを解除する関数。

setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled)

App Check が必要に応じてトークンを自動的に更新するかどうかを設定します。

サイン：

export declare function setTokenAutoRefreshEnabled(appCheckInstance: AppCheck, isTokenAutoRefreshEnabled: boolean): void;

パラメーター

戻り値：

空所

AppCheckTokenListener

App Check トークンが変更されるたびに呼び出されるリスナー。

サイン：

export declare type AppCheckTokenListener = (token: AppCheckTokenResult) => void;