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
| Função | Descrição |
|---|---|
| função (aplicativo, ...) | |
| inicializarAppCheck(aplicativo, opções) | Ative o App Check para o aplicativo fornecido. Pode ser chamado apenas uma vez por aplicativo. |
| 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(). |
| 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. |
| 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. |
| 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. |
| setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled) | Defina se o App Check atualizará automaticamente os tokens conforme necessário. |
Aulas
| Aula | Descrição |
|---|---|
| Provedor Personalizado | Classe de provedor personalizada. |
| ReCaptchaEnterpriseProvider | Provedor do App Check que pode obter um token reCAPTCHA Enterprise e trocá-lo por um token do App Check. |
| Provedor ReCaptchaV3 | Provedor de App Check que pode obter um token reCAPTCHA V3 e trocá-lo por um token de App Check. |
Interfaces
| Interface | Descrição |
|---|---|
| AppCheck | A interface do serviço Firebase App Check. |
| Opções de AppCheck | Opções para inicialização do App Check. |
| AppCheckToken | O token retornado de um provedor do App Check. |
| AppCheckTokenResult | Resultado retornado por getToken() . |
| Opções de provedor personalizado | Opções ao criar um CustomProvider . |
Aliases de tipo
| Digite Alias | Descrição |
|---|---|
| AppCheckTokenListener | Um listener que é chamado sempre que o token do App Check é alterado. |
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
| Parâmetro | Tipo | Descrição |
|---|---|---|
| aplicativo | FirebaseApp | indefinido | o FirebaseApp para ativar o App Check para |
| opções | Opções de AppCheck | Opções de inicialização do App Check |
Retorna:
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
| Parâmetro | Tipo | Descrição |
|---|---|---|
| appCheckInstance | AppCheck | A instância do serviço App Check. |
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
| Parâmetro | Tipo | Descrição |
|---|---|---|
| appCheckInstance | AppCheck | A instância do serviço App Check. |
| forçar atualização | boleano | Se for verdade, sempre tentará buscar um token novo. Se for falso, usará um token em cache se for encontrado no armazenamento. |
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
| Parâmetro | Tipo | Descrição |
|---|---|---|
| appCheckInstance | AppCheck | A instância do serviço App Check. |
| observador | Observador Parcial < AppCheckTokenResult > | Um objeto com propriedades next , error e complete . next é chamado com um AppCheckTokenResult sempre que o token é alterado. error é opcional e é chamado se um erro for lançado pelo ouvinte (a next função). complete não é utilizado, pois o fluxo de token é interminável. |
Retorna:
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
| Parâmetro | Tipo | Descrição |
|---|---|---|
| appCheckInstance | AppCheck | A instância do serviço App Check. |
| emPróximo | (tokenResult: AppCheckTokenResult ) => nulo | Quando o token muda, esta função é chamada com um AppCheckTokenResult . |
| onError | (erro: Erro) => nulo | Opcional. Chamado se houver um erro gerado pelo ouvinte (a função onNext ). |
| onCompletion | () => nulo | Atualmente não utilizado, pois o fluxo de tokens é interminável. |
Retorna:
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
| Parâmetro | Tipo | Descrição |
|---|---|---|
| appCheckInstance | AppCheck | A instância do serviço App Check. |
| isTokenAutoRefreshEnabled | boleano | Se for verdade, o SDK atualiza automaticamente os tokens do App Check conforme necessário. Isso substitui qualquer valor definido durante initializeAppCheck() . |
Retorna:
vazio
AppCheckTokenListener
Um listener que é chamado sempre que o token do App Check é alterado.
Assinatura:
export declare type AppCheckTokenListener = (token: AppCheckTokenResult) => void;