app-check package

Firebase 应用检查 Web SDK。

Firebase App Check 无法在使用ReCaptchaV3ProviderReCaptchaEnterpriseProvider 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 令牌并将其交换为 App Check 令牌的 App Check 提供商。

接口

界面描述
应用检查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;

参数

范围类型描述
应用检查实例应用检查应用程序检查服务实例。
观察者部分观察者<应用程序检查令牌结果>具有nexterrorcomplete属性的对象。每当令牌更改时,都会使用AppCheckTokenResult调用nexterror是可选的,如果侦听器( 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;