应用检查包

Firebase 应用检查

职能

功能描述
getToken(appCheckInstance, forceRefresh)获取当前的 App Check 令牌。附加到最近的飞行请求(如果存在)。如果不存在令牌并且没有令牌请求正在进行中,则返回 null。
initializeAppCheck(应用程序,选项)为给定的应用程序激活应用程序检查。每个应用程序只能调用一次。
onTokenChanged(appCheckInstance, 观察者)注册一个监听器来改变令牌状态。一个或多个 App Check 实例可以同时注册多个监听器。每当与此 App Check 实例关联的当前令牌发生更改时,侦听器都会在 UI 线程上回调。
onTokenChanged(appCheckInstance, onNext, onError, onCompletion)注册一个监听器来改变令牌状态。一个或多个 App Check 实例可以同时注册多个监听器。每当与此 App Check 实例关联的当前令牌发生更改时,侦听器都会在 UI 线程上回调。
setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled)设置 App Check 是否会根据需要自动刷新令牌。

班级

班级描述
自定义提供者自定义提供程序类。
ReCaptchaV3Provider可以获取 reCAPTCHA V3 令牌并将其交换为 App Check 令牌的 App Check 提供程序。

接口

界面描述
应用检查Firebase 应用检查服务接口。
应用检查选项App Check 初始化选项。
应用检查令牌从 App Check 提供程序返回的令牌。
AppCheckToken结果结果被返回getToken()
自定义提供者选项创建时的选项CustomProvider .

类型别名

类型别名描述
应用检查令牌监听器每当 App Check 令牌更改时调用的侦听器。

获取令牌()

获取当前的 App Check 令牌。附加到最近的飞行请求(如果存在)。如果不存在令牌并且没有令牌请求正在进行中,则返回 null。

签名:

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

参数

范围类型描述
应用检查实例应用检查App Check 服务实例。
强制刷新布尔值如果为 true,将始终尝试获取新令牌。如果为 false,则在存储中找到时将使用缓存的令牌。

返回:

无极< AppCheckTokenResult >

初始化应用检查()

为给定的应用程序激活应用程序检查。每个应用程序只能调用一次。

签名:

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

参数

范围类型描述
应用程序FirebaseApp |不明确的FirebaseApp激活应用程序检查
选项应用检查选项应用检查初始化选项

返回:

应用检查

onTokenChanged()

注册一个监听器来改变令牌状态。一个或多个 App Check 实例可以同时注册多个监听器。每当与此 App Check 实例关联的当前令牌发生更改时,侦听器都会在 UI 线程上回调。

签名:

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

参数

范围类型描述
应用检查实例应用检查App Check 服务实例。
观察者PartialObserver < AppCheckTokenResult >与对象nexterrorcomplete性质。 next被称为与AppCheckTokenResult每当令牌变化。 error是可选的,如果错误被收听(抛出的被称为next功能)。 complete未使用,作为记号流是无止境的。

返回:

退订

取消订阅此侦听器的函数。

onTokenChanged()

注册一个监听器来改变令牌状态。一个或多个 App Check 实例可以同时注册多个监听器。每当与此 App Check 实例关联的当前令牌发生更改时,侦听器都会在 UI 线程上回调。

签名:

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

参数

范围类型描述
应用检查实例应用检查App Check 服务实例。
下一个(tokenResult: AppCheckTokenResult ) => 无效当令牌的变化,这种功能被称为与AA AppCheckTokenResult .
出错时(错误:错误)=> 无效可选的。所谓的如果有在监听器(抛出一个错误onNext功能)。
在结束的时候() => 无效目前未使用,因为令牌流是无止境的。

返回:

退订

取消订阅此侦听器的函数。

setTokenAutoRefreshEnabled()

设置 App Check 是否会根据需要自动刷新令牌。

签名:

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

参数

范围类型描述
应用检查实例应用检查App Check 服务实例。
isTokenAutoRefreshEnabled布尔值如果为 true,SDK 会根据需要自动刷新 App Check 令牌。这在覆盖任何值集合initializeAppCheck()

返回:

空白

应用检查令牌监听器

每当 App Check 令牌更改时调用的侦听器。

签名:

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