Firebase App Check Web SDK。
Firebase App Check 無法在採用 ReCaptchaV3Provider 或 ReCaptchaEnterpriseProvider 的 Node.js 環境中運作，但如果您使用 CustomProvider 並自行撰寫認證方法，則可在 Node.js 中使用 App Check。
函式
| 函式 | 說明 |
|---|---|
| 功能(應用程式, ...) | |
| InitialAppCheck(應用程式, 選項) | 為指定應用程式啟用 App Check。每個應用程式只能呼叫一次。 |
| function(appCheckInstance, ...) | |
| getLimitedUseToken(appCheckInstance) | 要求 Firebase App Check 權杖。這個方法應僅在您需要授權給非 Firebase 後端時，才使用這個方法。傳回適用於您非 Firebase 後端端點且受到 重播防護保護的非 Firebase 後端端點的限定用途權杖。這個方法不會影響 #getAppCheckToken() 方法的權杖產生行為。 |
| getToken(appCheckInstance, forceRefresh) | 取得目前的 App Check 權杖。如果 forceRefresh 為 false，此函式會先檢查記憶體中的有效符記，然後檢查本機持續性 (IndexedDB)。如果找不到，或 forceRefresh 為 true，系統會要求 App Check 端點提供最新權杖。該要求會附加到最新的處理中要求 (如有)。 |
| onTokenChanged(appCheckInstance, 觀察 r) | 註冊監聽器，變更權杖狀態變更。一或多個 App Check 執行個體可以同時註冊多個事件監聽器。每當與此 App Check 執行個體相關聯的目前權杖有所變更時，事件監聽器會在 UI 執行緒上呼叫。 |
| onTokenChanged(appCheckInstance, onNext, onError, onComplete) | 註冊監聽器，變更權杖狀態變更。一或多個 App Check 執行個體可以同時註冊多個事件監聽器。每當與此 App Check 執行個體相關聯的目前權杖有所變更時，事件監聽器會在 UI 執行緒上呼叫。 |
| setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled) | 設定 App Check 是否會在需要時自動更新權杖。 |
類別
| 類別 | 說明 |
|---|---|
| CustomProvider | 自訂提供者類別。 |
| ReCaptchaEnterpriseProvider | App Check 供應商可以取得 reCAPTCHA Enterprise 權杖，並將其交換以取得 App Check 權杖。 |
| ReCaptchaV3Provider | App Check 供應商可以取得 reCAPTCHA V3 權杖，並將其交換以取得 App Check 權杖。 |
介面
| 介面 | 說明 |
|---|---|
| AppCheck | Firebase App Check 服務介面。 |
| AppCheckOptions | App Check 初始化選項。 |
| AppCheckToken | App Check 供應商傳回的權杖。 |
| AppCheckTokenResult | getToken() 傳回的結果。 |
| CustomProvider 選項 | 建立 CustomProvider 時的選項。 |
型別別名
| 類型別名 | 說明 |
|---|---|
| AppCheckTokenListener | 每當 App Check 權杖變更時就會呼叫的事件監聽器。 |
function(應用程式, ...)
InitialAppCheck(應用程式, 選項)
為指定應用程式啟用 App Check。每個應用程式只能呼叫一次。
簽名：
export declare function initializeAppCheck(app: FirebaseApp | undefined, options: AppCheckOptions): AppCheck;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| 應用程式 | Firebase 應用程式 |未定義 | 用來啟用 App Check 的 FirebaseApp |
| 選項 | AppCheckOptions | App Check 初始化選項 |
傳回：
function(appCheckInstance, ...)
getLimitedUseToken(appCheckInstance)
要求 Firebase App Check 權杖。只有在您需要授權對非 Firebase 後端的要求時，才應使用這個方法。
傳回適用於 Replay 保護保護的非 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 服務執行個體。 |
| 強制重新整理 | 布林值 | 若為 true，系統會一律嘗試擷取新的權杖。設為 false 時，將使用儲存空間中的快取符記。 |
傳回：
Promise<AppCheckTokenResult>
onTokenChanged(appCheckInstance, 觀察器)
註冊監聽器，變更權杖狀態變更。一或多個 App Check 執行個體可以同時註冊多個事件監聽器。每當與此 App Check 執行個體相關聯的目前權杖有所變更時，事件監聽器會在 UI 執行緒上呼叫。
簽名：
export declare function onTokenChanged(appCheckInstance: AppCheck, observer: PartialObserver<AppCheckTokenResult>): Unsubscribe;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| appCheckInstance | AppCheck | App Check 服務執行個體。 |
| 觀察者 | PartialObserver<AppCheckTokenResult> | 具有 next、error 和 complete 屬性的物件。每當權杖變更時，系統會使用 AppCheckTokenResult 呼叫 next。error 是選用項目，如果事件監聽器 (next 函式) 擲回錯誤，就會呼叫此方法。系統即將取消憑證串流，因此未使用 complete。 |
傳回：
取消訂閱這個事件監聽器的函式。
onTokenChanged(appCheckInstance, onNext, onError, onComplete)
註冊監聽器，變更權杖狀態變更。一或多個 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 服務執行個體。 |
| 下一本 | (tokenResult：AppCheckTokenResult) =>void | 權杖變更時，系統會使用 AppCheckTokenResult 呼叫這個函式。 |
| onError | (錯誤：錯誤) =>void | 選用設定。如果事件監聽器 (onNext 函式) 擲回錯誤，就會呼叫此方法。 |
| 完成時 | () =>void | 系統即將停用權杖串流，因此目前未使用。 |
傳回：
取消訂閱這個事件監聽器的函式。
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;