app-check package

La aplicación Firebase comprueba el SDK web.

Firebase App Check no funciona en un entorno Node.js usando ReCaptchaV3Provider o ReCaptchaEnterpriseProvider , pero se puede usar en Node.js si usa CustomProvider y escribe su propio método de certificación.

Funciones

Clases

Interfaces

Tipo de alias

función (aplicación, ...)

inicializarAppCheck(aplicación, opciones)

Active App Check para la aplicación dada. Solo se puede llamar una vez por aplicación.

Firma:

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

Parámetros

Devoluciones:

AppCheck

función (appCheckInstance, ...)

getLimitedUseToken(appCheckInstance)

Solicita un token de verificación de aplicación de Firebase. Este método debe usarse solo si necesita autorizar solicitudes a un backend que no sea de Firebase.

Devuelve tokens de uso limitado destinados a usarse con sus puntos finales de backend que no son de Firebase y que están protegidos con Replay Protection . Este método no afecta el comportamiento de generación de tokens del método #getAppCheckToken().

Firma:

export declare function getLimitedUseToken(appCheckInstance: AppCheck): Promise<AppCheckTokenResult>;

Parámetros

Devoluciones:

Promesa < AppCheckTokenResult >

El token de uso limitado.

getToken(appCheckInstance, forceRefresh)

Obtenga el token de verificación de aplicaciones actual. Se adjunta a la solicitud en vuelo más reciente, si hay alguna presente. Devuelve nulo si no hay ningún token presente y no hay solicitudes de token en curso.

Firma:

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

Parámetros

Devoluciones:

Promesa < AppCheckTokenResult >

onTokenChanged(appCheckInstance, observador)

Registra un oyente para los cambios en el estado del token. Puede haber más de un oyente registrado al mismo tiempo para una o más instancias de App Check. Los oyentes vuelven a llamar al subproceso de la interfaz de usuario cada vez que cambia el token actual asociado con esta instancia de App Check.

Firma:

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

Parámetros

Devoluciones:

Darse de baja

Una función que da de baja a este oyente.

onTokenChanged (appCheckInstance, onNext, onError, onCompletion)

Registra un oyente para los cambios en el estado del token. Puede haber más de un oyente registrado al mismo tiempo para una o más instancias de App Check. Los oyentes vuelven a llamar al subproceso de la interfaz de usuario cada vez que cambia el token actual asociado con esta instancia de App Check.

Firma:

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

Parámetros

Devoluciones:

Darse de baja

Una función que da de baja a este oyente.

setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled)

Establezca si App Check actualizará automáticamente los tokens según sea necesario.

Firma:

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

Parámetros

Devoluciones:

vacío

AppCheckTokenListener

Un oyente al que se llama cada vez que cambia el token de verificación de la aplicación.

Firma:

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