Firebase App Check ウェブ SDK。
Firebase App Check は、ReCaptchaV3Provider または ReCaptchaEnterpriseProvider を使用する Node.js 環境では動作しませんが、CustomProvider を使用して独自の証明書メソッドを記述すれば、Node.js で使用できます。
関数
| 関数 | 説明 |
|---|---|
| function(app, ...) | |
| terraformAppCheck(アプリ, オプション) | 指定したアプリに対して App Check を有効にします。アプリごとに 1 回だけ呼び出すことができます。 |
| function(appCheckInstance, ...) | |
| getLimitedUseToken(appCheckInstance) | Firebase App Check トークンをリクエストします。このメソッドは、Firebase 以外のバックエンドへのリクエストを承認する必要がある場合にのみ使用してください。 リプレイ保護で保護されている Firebase 以外のバックエンド エンドポイントで使用することを目的とした、限定使用トークンを返します。このメソッドは、#getAppCheckToken() メソッドのトークン生成の動作には影響しません。 |
| getToken(appCheckInstance, forceRefresh) | 現在の App Check トークンを取得します。forceRefresh が false の場合、この関数は最初にメモリ内の有効なトークンを確認し、次にローカル永続性（IndexedDB）を確認します。見つからない場合、または forceRefresh が true の場合、App Check エンドポイントに新しいトークンをリクエストします。実行中のリクエストが存在する場合、そのリクエストは最新の処理中のリクエストに関連付けられます。 |
| onTokenChanged(appCheckInstance, observr) | トークン状態の変化に対応するリスナーを登録します。1 つ以上の App Check インスタンスに同時に複数のリスナーを登録できます。この App Check インスタンスに関連付けられている現在のトークンが変更されるたびに、リスナーは UI スレッドにコールバックします。 |
| onTokenChanged(appCheckInstance, onNext, onError, oncompletion) | トークン状態の変化に対応するリスナーを登録します。1 つ以上の App Check インスタンスに同時に複数のリスナーを登録できます。この App Check インスタンスに関連付けられている現在のトークンが変更されるたびに、リスナーは UI スレッドにコールバックします。 |
| setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled) | App Check で必要に応じてトークンを自動更新するかどうかを設定します。 |
クラス
| クラス | 説明 |
|---|---|
| CustomProvider | カスタム プロバイダ クラス。 |
| ReCaptchaEnterpriseProvider | reCAPTCHA Enterprise トークンを取得して App Check トークンと交換できる App Check プロバイダ。 |
| ReCaptchaV3Provider | reCAPTCHA V3 トークンを取得して App Check トークンと交換できる App Check プロバイダ。 |
インターフェース
| インターフェース | 説明 |
|---|---|
| AppCheck | Firebase App Check サービス インターフェース。 |
| AppCheckOptions | App Check の初期化オプション。 |
| AppCheckToken | App Check プロバイダから返されたトークン。 |
| AppCheckTokenResult | getToken() から返された結果。 |
| CustomProviderOptions | CustomProvider を作成する際のオプション。 |
型エイリアス
| 型エイリアス | 説明 |
|---|---|
| AppCheckTokenListener | App Check トークンが変更されるたびに呼び出されるリスナー。 |
関数（アプリ、...）
初期化 AppCheck(アプリ, オプション)
指定したアプリに対して App Check を有効にします。アプリごとに 1 回だけ呼び出すことができます。
署名:
export declare function initializeAppCheck(app: FirebaseApp | undefined, options: AppCheckOptions): AppCheck;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| アプリ | FirebaseApp |未定義 | FirebaseApp: |
| オプション | AppCheckOptions | App Check の初期化オプション |
戻り値:
function（appCheckInstance, ...）
getLimitedUseToken(appCheckInstance)
Firebase App Check トークンをリクエストします。このメソッドは、Firebase 以外のバックエンドへのリクエストを承認する必要がある場合にのみ使用してください。
リプレイ保護で保護されている Firebase 以外のバックエンド エンドポイントで使用することを目的とした、限定使用トークンを返します。このメソッドは、#getAppCheckToken() メソッドのトークン生成の動作には影響しません。
署名:
export declare function getLimitedUseToken(appCheckInstance: AppCheck): Promise<AppCheckTokenResult>;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| appCheckInstance | AppCheck | App Check サービス インスタンス。 |
戻り値:
Promise<AppCheckTokenResult>
限定使用トークン。
getToken(appCheckInstance, forceRefresh)
現在の App Check トークンを取得します。forceRefresh が false の場合、この関数は最初にメモリ内の有効なトークンを確認し、次にローカル永続性（IndexedDB）を確認します。見つからない場合、または forceRefresh が true の場合、App Check エンドポイントに新しいトークンをリクエストします。実行中のリクエストが存在する場合、そのリクエストは最新の処理中のリクエストに関連付けられます。
署名:
export declare function getToken(appCheckInstance: AppCheck, forceRefresh?: boolean): Promise<AppCheckTokenResult>;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| appCheckInstance | AppCheck | App Check サービス インスタンス。 |
| forceRefresh | ブール値 | true の場合、常に新しいトークンの取得を試みます。false の場合、ストレージでキャッシュ内のトークンが見つかった場合、それを使用します。 |
戻り値:
Promise<AppCheckTokenResult>
onTokenChanged(appCheckInstance, オブザーバー)
トークン状態の変化に対応するリスナーを登録します。1 つ以上の App Check インスタンスに同時に複数のリスナーを登録できます。この App Check インスタンスに関連付けられている現在のトークンが変更されるたびに、リスナーは UI スレッドにコールバックします。
署名:
export declare function onTokenChanged(appCheckInstance: AppCheck, observer: PartialObserver<AppCheckTokenResult>): Unsubscribe;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| appCheckInstance | AppCheck | App Check サービス インスタンス。 |
| observer | PartialObserver<AppCheckTokenResult> | next、error、complete プロパティを持つオブジェクト。トークンが変更されるたびに、AppCheckTokenResult とともに next が呼び出されます。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;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| appCheckInstance | AppCheck | App Check サービス インスタンス。 |
| onNext | (tokenResult: AppCheckTokenResult) =>無効 | トークンが変更されると、この関数は AppCheckTokenResult で呼び出されます。 |
| onError | （エラー: エラー）=>無効 | 省略可。リスナー（onNext 関数）からエラーがスローされた場合に呼び出されます。 |
| 完了時 | () =>無効 | トークン ストリームが終了しないため、現在使用されていません。 |
戻り値:
このリスナーの登録を解除する関数。
setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled)
App Check で必要に応じてトークンを自動更新するかどうかを設定します。
署名:
export declare function setTokenAutoRefreshEnabled(appCheckInstance: AppCheck, isTokenAutoRefreshEnabled: boolean): void;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| appCheckInstance | AppCheck | App Check サービス インスタンス。 |
| isTokenAutoRefreshEnabled | ブール値 | true の場合、SDK は必要に応じて App Check トークンを自動的に更新します。これは、initializeAppCheck() で設定した値をオーバーライドします。 |
戻り値:
void
AppCheckTokenListener
App Check トークンが変更されるたびに呼び出されるリスナー。
署名:
export declare type AppCheckTokenListener = (token: AppCheckTokenResult) => void;