Firebase App Check Web SDK。
Firebase App Check は、 ReCaptchaV3Provider
またはReCaptchaEnterpriseProvider
を使用する Node.js 環境では機能しませんただしCustomProvider
使用して独自の構成証明メソッドを作成する場合は、Node.js で使用できます。
機能
関数 | 説明 |
---|---|
関数(アプリ、...) | |
InitializeAppCheck(アプリ、オプション) | 指定されたアプリの App Check をアクティブ化します。アプリごとに 1 回だけ呼び出すことができます。 |
関数(appCheckInstance, ...) | |
getLimitedUseToken(appCheckInstance) | Firebase App Check トークンをリクエストします。このメソッドは、Firebase 以外のバックエンドへのリクエストを承認する必要がある場合にのみ使用してください。 Replay Protectionで保護されている非 Firebase バックエンド エンドポイントでの使用を目的とした限定使用トークンを返します。このメソッドは、#getAppCheckToken() メソッドのトークン生成動作には影響しません。 |
getToken(appCheckInstance、forceRefresh) | 現在の App Check トークンを取得します。最新の実行中のリクエストが存在する場合、それに添付されます。トークンが存在せず、進行中のトークン要求がない場合は、null を返します。 |
onTokenChanged(appCheckInstance、オブザーバー) | トークン状態の変更に対してリスナーを登録します。 1 つ以上の App Check インスタンスに対して複数のリスナーを同時に登録できます。この App Check インスタンスに関連付けられた現在のトークンが変更されるたびに、リスナーは UI スレッドでコールバックします。 |
onTokenChanged(appCheckInstance、onNext、onError、onCompletion) | トークン状態の変更に対してリスナーを登録します。 1 つ以上の App Check インスタンスに対して複数のリスナーを同時に登録できます。この App Check インスタンスに関連付けられた現在のトークンが変更されるたびに、リスナーは UI スレッドでコールバックします。 |
setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled) | App Check が必要に応じてトークンを自動的に更新するかどうかを設定します。 |
クラス
クラス | 説明 |
---|---|
カスタムプロバイダー | カスタムプロバイダークラス。 |
ReCaptchaエンタープライズプロバイダー | reCAPTCHA Enterprise トークンを取得し、App Check トークンと交換できる App Check プロバイダー。 |
ReCaptchaV3プロバイダー | reCAPTCHA V3 トークンを取得し、それを App Check トークンと交換できる App Check プロバイダー。 |
インターフェース
インターフェース | 説明 |
---|---|
アプリチェック | Firebase App Check サービス インターフェイス。 |
AppCheckオプション | App Check 初期化のオプション。 |
AppCheckToken | App Check プロバイダーから返されたトークン。 |
AppCheckTokenResult | getToken() によって返される結果。 |
カスタムプロバイダーオプション | CustomProvider作成時のオプション。 |
タイプエイリアス
タイプエイリアス | 説明 |
---|---|
AppCheckTokenListener | App Check トークンが変更されるたびに呼び出されるリスナー。 |
関数(アプリ、...)
InitializeAppCheck(アプリ、オプション)
指定されたアプリの App Check をアクティブ化します。アプリごとに 1 回だけ呼び出すことができます。
サイン:
export declare function initializeAppCheck(app: FirebaseApp | undefined, options: AppCheckOptions): AppCheck;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
アプリ | ファイアベースアプリ|未定義 | App Check を有効にするFirebaseApp |
オプション | AppCheckオプション | App Check の初期化オプション |
戻り値:
関数(appCheckInstance, ...)
getLimitedUseToken(appCheckInstance)
Firebase App Check トークンをリクエストします。このメソッドは、Firebase 以外のバックエンドへのリクエストを承認する必要がある場合にのみ使用してください。
Replay Protectionで保護されている非 Firebase バックエンド エンドポイントでの使用を目的とした限定使用トークンを返します。このメソッドは、#getAppCheckToken() メソッドのトークン生成動作には影響しません。
サイン:
export declare function getLimitedUseToken(appCheckInstance: AppCheck): Promise<AppCheckTokenResult>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
アプリチェックインスタンス | アプリチェック | App Check サービス インスタンス。 |
戻り値:
Promise< AppCheckTokenResult >
使用制限のあるトークン。
getToken(appCheckInstance、forceRefresh)
現在の App Check トークンを取得します。最新の実行中のリクエストが存在する場合、それに添付されます。トークンが存在せず、進行中のトークン要求がない場合は、null を返します。
サイン:
export declare function getToken(appCheckInstance: AppCheck, forceRefresh?: boolean): Promise<AppCheckTokenResult>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
アプリチェックインスタンス | アプリチェック | App Check サービス インスタンス。 |
強制リフレッシュ | ブール値 | true の場合、常に新しいトークンの取得を試みます。 false の場合、ストレージ内で見つかった場合はキャッシュされたトークンを使用します。 |
戻り値:
Promise< AppCheckTokenResult >
onTokenChanged(appCheckInstance、オブザーバー)
トークン状態の変更に対してリスナーを登録します。 1 つ以上の App Check インスタンスに対して複数のリスナーを同時に登録できます。この App Check インスタンスに関連付けられた現在のトークンが変更されるたびに、リスナーは UI スレッドでコールバックします。
サイン:
export declare function onTokenChanged(appCheckInstance: AppCheck, observer: PartialObserver<AppCheckTokenResult>): Unsubscribe;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
アプリチェックインスタンス | アプリチェック | App Check サービス インスタンス。 |
観察者 | 部分観察者< AppCheckTokenResult > | next 、 error 、およびcomplete プロパティを持つオブジェクト。 next トークンが変更されるたびにAppCheckTokenResultで呼び出されます。 error はオプションであり、リスナー ( next 関数) によってエラーがスローされた場合に呼び出されます。トークン ストリームは終わりがないため、 complete は使用されません。 |
戻り値:
このリスナーのサブスクライブを解除する関数。
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;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
アプリチェックインスタンス | アプリチェック | App Check サービス インスタンス。 |
次へ | (トークン結果: AppCheckTokenResult ) => 無効 | トークンが変更されると、 AppCheckTokenResultを使用してこの関数が呼び出されます。 。 |
onError | (エラー: エラー) => 無効 | オプション。リスナー ( onNext 関数) によってスローされたエラーがある場合に呼び出されます。 |
完了時に | () => 無効 | トークン ストリームは終わりがないため、現在は使用されていません。 |
戻り値:
このリスナーのサブスクライブを解除する関数。
setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled)
App Check が必要に応じてトークンを自動的に更新するかどうかを設定します。
サイン:
export declare function setTokenAutoRefreshEnabled(appCheckInstance: AppCheck, isTokenAutoRefreshEnabled: boolean): void;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
アプリチェックインスタンス | アプリチェック | App Check サービス インスタンス。 |
isTokenAutoRefreshEnabled | ブール値 | true の場合、SDK は必要に応じて App Check トークンを自動的に更新します。これは、 initializeAppCheck() 中に設定された値をオーバーライドします。 |
戻り値:
空所
AppCheckTokenListener
App Check トークンが変更されるたびに呼び出されるリスナー。
サイン:
export declare type AppCheckTokenListener = (token: AppCheckTokenResult) => void;