Firebase 應用程式檢查 Web SDK。
Firebase App Check 無法在使用ReCaptchaV3Provider
或ReCaptchaEnterpriseProvider
Node.js 環境中運作,但如果您使用CustomProvider
並編寫自己的證明方法,則可以在 Node.js 中使用。
功能
功能 | 描述 |
---|---|
函數(應用程序,...) | |
初始化AppCheck(應用程序,選項) | 啟動給定應用程式的應用程式檢查。每個應用程式只能呼叫一次。 |
函數(appCheckInstance,...) | |
getLimitedUseToken(appCheckInstance) | 請求 Firebase 應用檢查令牌。僅當您需要向非 Firebase 後端授權請求時才應使用此方法。傳回旨在與受Replay Protection保護的非 Firebase 後端端點一起使用的限制使用令牌。此方法不會影響 #getAppCheckToken() 方法的令牌產生行為。 |
getToken(appCheckInstance, 強制刷新) | 取得目前的應用程式檢查令牌。附加到最近的飛行請求(如果存在)。如果不存在令牌且沒有正在進行的令牌請求,則傳回 null。 |
onTokenChanged(appCheckInstance,觀察者) | 註冊一個監聽器來監聽令牌狀態的變化。一個或多個 App Check 執行個體可以同時註冊多個偵聽器。每當與此 App Check 實例關聯的目前令牌發生變更時,偵聽器都會在 UI 執行緒上回呼。 |
onTokenChanged(appCheckInstance,onNext,onError,onCompletion) | 註冊一個監聽器來監聽令牌狀態的變化。一個或多個 App Check 執行個體可以同時註冊多個偵聽器。每當與此 App Check 實例關聯的目前令牌發生變更時,偵聽器都會在 UI 執行緒上回呼。 |
setTokenAutoRefreshEnabled(appCheckInstance,isTokenAutoRefreshEnabled) | 設定App Check是否根據需要自動刷新令牌。 |
課程
班級 | 描述 |
---|---|
客製化提供者 | 自訂提供者類別。 |
ReCaptcha企業供應商 | 可以取得 reCAPTCHA Enterprise 令牌並將其交換為應用程式檢查令牌的應用程式檢查提供者。 |
ReCaptchaV3Provider | 可以取得 reCAPTCHA V3 令牌並將其交換為應用程式檢查令牌的應用程式檢查提供者。 |
介面
介面 | 描述 |
---|---|
應用檢查 | Firebase App Check 服務介面。 |
應用程式檢查選項 | App Check 初始化的選項。 |
應用檢查令牌 | 從 App Check 提供者傳回的令牌。 |
AppCheckToken結果 | getToken() 傳回的結果。 |
自訂提供者選項 | 建立CustomProvider時的選項。 |
類型別名
類型別名 | 描述 |
---|---|
AppCheckToken監聽器 | 每當 App Check 令牌發生變更時呼叫的偵聽器。 |
函數(應用程序,...)
初始化AppCheck(應用程序,選項)
啟動給定應用程式的應用程式檢查。每個應用程式只能呼叫一次。
簽名:
export declare function initializeAppCheck(app: FirebaseApp | undefined, options: AppCheckOptions): AppCheck;
參數
範圍 | 類型 | 描述 |
---|---|---|
應用程式 | Firebase 應用程式|不明確的 | 用於啟動應用程式檢查的FirebaseApp |
選項 | 應用程式檢查選項 | 應用程式檢查初始化選項 |
返回:
函數(appCheckInstance,...)
getLimitedUseToken(appCheckInstance)
請求 Firebase 應用檢查令牌。僅當您需要向非 Firebase 後端授權請求時才應使用此方法。
傳回旨在與受Replay Protection保護的非 Firebase 後端端點一起使用的限制使用令牌。此方法不會影響 #getAppCheckToken() 方法的令牌產生行為。
簽名:
export declare function getLimitedUseToken(appCheckInstance: AppCheck): Promise<AppCheckTokenResult>;
參數
範圍 | 類型 | 描述 |
---|---|---|
應用檢查實例 | 應用檢查 | 應用程式檢查服務實例。 |
返回:
Promise< AppCheckTokenResult >
有限使用令牌。
getToken(appCheckInstance, 強制刷新)
取得目前的應用程式檢查令牌。附加到最近的飛行請求(如果存在)。如果不存在令牌且沒有正在進行的令牌請求,則傳回 null。
簽名:
export declare function getToken(appCheckInstance: AppCheck, forceRefresh?: boolean): Promise<AppCheckTokenResult>;
參數
範圍 | 類型 | 描述 |
---|---|---|
應用檢查實例 | 應用檢查 | 應用程式檢查服務實例。 |
強制刷新 | 布林值 | 如果為 true,將始終嘗試取得新的令牌。如果為 false,則將使用在儲存中找到的快取令牌。 |
返回:
Promise< AppCheckTokenResult >
onTokenChanged(appCheckInstance,觀察者)
註冊一個監聽器來監聽令牌狀態的變化。一個或多個 App Check 執行個體可以同時註冊多個偵聽器。每當與此 App Check 實例關聯的目前令牌發生變更時,偵聽器都會在 UI 執行緒上回呼。
簽名:
export declare function onTokenChanged(appCheckInstance: AppCheck, observer: PartialObserver<AppCheckTokenResult>): Unsubscribe;
參數
範圍 | 類型 | 描述 |
---|---|---|
應用檢查實例 | 應用檢查 | 應用程式檢查服務實例。 |
觀察者 | 部分觀察者<應用程式檢查令牌結果> | 具有next 、 error 和complete 屬性的物件。每當令牌變更時,都會使用AppCheckTokenResult呼叫next 。 error 是可選的,如果偵聽器( next 函數)拋出錯誤,則呼叫該錯誤。 complete 未使用,因為令牌流是無止境的。 |
返回:
取消訂閱此偵聽器的函數。
onTokenChanged(appCheckInstance,onNext,onError,onCompletion)
註冊一個監聽器來監聽令牌狀態的變化。可以同時為一個或多個 App Check 執行個體註冊多個偵聽器。每當與此 App Check 實例關聯的目前令牌發生變更時,偵聽器都會在 UI 執行緒上回呼。
簽名:
export declare function onTokenChanged(appCheckInstance: AppCheck, onNext: (tokenResult: AppCheckTokenResult) => void, onError?: (error: Error) => void, onCompletion?: () => void): Unsubscribe;
參數
範圍 | 類型 | 描述 |
---|---|---|
應用檢查實例 | 應用檢查 | 應用程式檢查服務實例。 |
下一個 | (令牌結果: AppCheckTokenResult ) => 無效 | 當令牌變更時,將使用AppCheckTokenResult呼叫此函數。 |
錯誤時 | (錯誤:錯誤)=>無效 | 選修的。如果偵聽器( onNext 函數)拋出錯誤,則呼叫。 |
在完成的時候 | () => 無效 | 目前未使用,因為令牌流是無止境的。 |
返回:
取消訂閱此偵聽器的函數。
setTokenAutoRefreshEnabled(appCheckInstance,isTokenAutoRefreshEnabled)
設定App Check是否根據需要自動刷新令牌。
簽名:
export declare function setTokenAutoRefreshEnabled(appCheckInstance: AppCheck, isTokenAutoRefreshEnabled: boolean): void;
參數
範圍 | 類型 | 描述 |
---|---|---|
應用檢查實例 | 應用檢查 | 應用程式檢查服務實例。 |
isTokenAutoRefreshEnabled | 布林值 | 如果為 true,SDK 將根據需要自動刷新 App Check 令牌。這會覆蓋在initializeAppCheck() 期間設定的任何值。 |
返回:
空白
AppCheckToken監聽器
每當 App Check 令牌發生變更時呼叫的偵聽器。
簽名:
export declare type AppCheckTokenListener = (token: AppCheckTokenResult) => void;