app-check package

O SDK da Web do Firebase App Check.

O Firebase App Check não funciona em um ambiente Node.js usando ReCaptchaV3Provider ou ReCaptchaEnterpriseProvider , mas pode ser usado em Node.js se você usar CustomProvider e escrever seu próprio método de atestado.

Funções

Aulas

Interfaces

Aliases de tipo

função (aplicativo, ...)

inicializarAppCheck(aplicativo, opções)

Ative o App Check para o aplicativo fornecido. Pode ser chamado apenas uma vez por aplicativo.

Assinatura:

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

Parâmetros

Retorna:

AppCheck

função(appCheckInstance, ...)

getLimitedUseToken(appCheckInstance)

Solicita um token do Firebase App Check. Este método deve ser usado somente se você precisar autorizar solicitações para um back-end que não seja do Firebase.

Retorna tokens de uso limitado destinados ao uso com endpoints de back-end que não sejam do Firebase e protegidos pelo Replay Protection . Este método não afeta o comportamento de geração de token do método #getAppCheckToken().

Assinatura:

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

Parâmetros

Retorna:

Promessa< AppCheckTokenResult >

O token de uso limitado.

getToken(appCheckInstance, forceRefresh)

Obtenha o token atual do App Check. Anexa à solicitação em andamento mais recente, se houver. Retorna nulo se nenhum token estiver presente e nenhuma solicitação de token estiver em andamento.

Assinatura:

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

Parâmetros

Retorna:

Promessa< AppCheckTokenResult >

onTokenChanged(appCheckInstance, observador)

Registra um ouvinte para alterações no estado do token. Pode haver mais de um ouvinte registrado ao mesmo tempo para uma ou mais instâncias do App Check. Os ouvintes retornam a chamada no thread de UI sempre que o token atual associado a esta instância do App Check muda.

Assinatura:

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

Parâmetros

Retorna:

Cancelar subscrição

Uma função que cancela a assinatura deste ouvinte.

onTokenChanged(appCheckInstance, onNext, onError, onCompletion)

Registra um ouvinte para alterações no estado do token. Pode haver mais de um ouvinte registrado ao mesmo tempo para uma ou mais instâncias do App Check. Os ouvintes retornam a chamada no thread de UI sempre que o token atual associado a esta instância do App Check muda.

Assinatura:

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

Parâmetros

Retorna:

Cancelar subscrição

Uma função que cancela a assinatura deste ouvinte.

setTokenAutoRefreshEnabled(appCheckInstance,isTokenAutoRefreshEnabled)

Defina se o App Check atualizará automaticamente os tokens conforme necessário.

Assinatura:

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

Parâmetros

Retorna:

vazio

AppCheckTokenListener

Um listener que é chamado sempre que o token do App Check é alterado.

Assinatura:

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