Le SDK Web Firebase App Check.
Firebase App Check ne fonctionne pas dans un environnement Node.js utilisant ReCaptchaV3Provider ou ReCaptchaEnterpriseProvider , mais peut être utilisé dans Node.js si vous utilisez CustomProvider et écrivez votre propre méthode d'attestation.
Les fonctions
| Fonction | Description |
|---|---|
| fonction(application, ...) | |
| initializeAppCheck (application, options) | Activez App Check pour l’application donnée. Ne peut être appelé qu’une seule fois par application. |
| fonction(appCheckInstance, ...) | |
| getLimitedUseToken(appCheckInstance) | Demande un jeton Firebase App Check. Cette méthode ne doit être utilisée que si vous devez autoriser les requêtes vers un backend non-Firebase. Renvoie les jetons à usage limité destinés à être utilisés avec vos points de terminaison backend non Firebase protégés par Replay Protection . Cette méthode n'affecte pas le comportement de génération de jetons de la méthode #getAppCheckToken(). |
| getToken (appCheckInstance, forceRefresh) | Obtenez le jeton App Check actuel. Se joint à la demande en vol la plus récente, le cas échéant. Renvoie null si aucun jeton n’est présent et qu’aucune demande de jeton n’est en cours. |
| onTokenChanged (appCheckInstance, observateur) | Enregistre un écouteur aux changements dans l’état du jeton. Plusieurs auditeurs peuvent être enregistrés en même temps pour une ou plusieurs instances App Check. Les écouteurs rappellent le thread de l'interface utilisateur chaque fois que le jeton actuel associé à cette instance App Check change. |
| onTokenChanged (appCheckInstance, onNext, onError, onCompletion) | Enregistre un écouteur aux changements dans l’état du jeton. Plusieurs auditeurs peuvent être enregistrés en même temps pour une ou plusieurs instances App Check. Les écouteurs rappellent le thread de l'interface utilisateur chaque fois que le jeton actuel associé à cette instance App Check change. |
| setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled) | Définissez si App Check actualisera automatiquement les jetons si nécessaire. |
Des classes
| Classe | Description |
|---|---|
| Fournisseur personnalisé | Classe de fournisseur personnalisée. |
| ReCaptchaEnterpriseProvider | Fournisseur App Check qui peut obtenir un jeton reCAPTCHA Enterprise et l'échanger contre un jeton App Check. |
| Fournisseur ReCaptchaV3 | Fournisseur App Check qui peut obtenir un jeton reCAPTCHA V3 et l'échanger contre un jeton App Check. |
Interfaces
| Interface | Description |
|---|---|
| AppCheck | L'interface du service Firebase App Check. |
| Options AppCheck | Options d’initialisation d’App Check. |
| AppCheckToken | Jeton renvoyé par un fournisseur App Check. |
| AppCheckTokenResult | Résultat renvoyé par getToken() . |
| Options du fournisseur personnalisé | Options lors de la création d'un CustomProvider . |
Tapez les alias
| Tapez l'alias | Description |
|---|---|
| AppCheckTokenListener | Un écouteur qui est appelé chaque fois que le jeton App Check change. |
fonction(application, ...)
initializeAppCheck (application, options)
Activez App Check pour l’application donnée. Ne peut être appelé qu’une seule fois par application.
Signature:
export declare function initializeAppCheck(app: FirebaseApp | undefined, options: AppCheckOptions): AppCheck;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| application | FirebaseApp | indéfini | la FirebaseApp pour activer App Check pour |
| choix | Options AppCheck | Options d'initialisation d'App Check |
Retour:
fonction(appCheckInstance, ...)
getLimitedUseToken(appCheckInstance)
Demande un jeton Firebase App Check. Cette méthode ne doit être utilisée que si vous devez autoriser les requêtes vers un backend non-Firebase.
Renvoie les jetons à usage limité destinés à être utilisés avec vos points de terminaison backend non Firebase protégés par Replay Protection . Cette méthode n'affecte pas le comportement de génération de jetons de la méthode #getAppCheckToken().
Signature:
export declare function getLimitedUseToken(appCheckInstance: AppCheck): Promise<AppCheckTokenResult>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| appCheckInstance | AppCheck | Instance du service App Check. |
Retour:
Promesse < AppCheckTokenResult >
Le jeton à usage limité.
getToken (appCheckInstance, forceRefresh)
Obtenez le jeton App Check actuel. Se joint à la demande en vol la plus récente, le cas échéant. Renvoie null si aucun jeton n’est présent et qu’aucune demande de jeton n’est en cours.
Signature:
export declare function getToken(appCheckInstance: AppCheck, forceRefresh?: boolean): Promise<AppCheckTokenResult>;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| appCheckInstance | AppCheck | Instance du service App Check. |
| forceActualiser | booléen | Si c'est vrai, il essaiera toujours de récupérer un nouveau jeton. Si faux, utilisera un jeton mis en cache s’il est trouvé dans le stockage. |
Retour:
Promesse < AppCheckTokenResult >
onTokenChanged (appCheckInstance, observateur)
Enregistre un écouteur aux changements dans l’état du jeton. Plusieurs auditeurs peuvent être enregistrés en même temps pour une ou plusieurs instances App Check. Les écouteurs rappellent le thread de l'interface utilisateur chaque fois que le jeton actuel associé à cette instance App Check change.
Signature:
export declare function onTokenChanged(appCheckInstance: AppCheck, observer: PartialObserver<AppCheckTokenResult>): Unsubscribe;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| appCheckInstance | AppCheck | Instance du service App Check. |
| observateur | Observateur partiel < AppCheckTokenRésultat > | Un objet avec les propriétés next , error et complete . next est appelé avec un AppCheckTokenResult chaque fois que le jeton change. error est facultatif et est appelé si une erreur est renvoyée par l'écouteur (la fonction next ). complete n'est pas utilisé, car le flux de jetons est sans fin. |
Retour:
Une fonction qui désabonne cet auditeur.
onTokenChanged (appCheckInstance, onNext, onError, onCompletion)
Enregistre un écouteur aux changements dans l’état du jeton. Plusieurs auditeurs peuvent être enregistrés en même temps pour une ou plusieurs instances App Check. Les écouteurs rappellent le thread de l'interface utilisateur chaque fois que le jeton actuel associé à cette instance App Check change.
Signature:
export declare function onTokenChanged(appCheckInstance: AppCheck, onNext: (tokenResult: AppCheckTokenResult) => void, onError?: (error: Error) => void, onCompletion?: () => void): Unsubscribe;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| appCheckInstance | AppCheck | Instance du service App Check. |
| surSuivant | (tokenResult : AppCheckTokenResult ) => nul | Lorsque le jeton change, cette fonction est appelée avec un AppCheckTokenResult . |
| surErreur | (erreur : Erreur) => annuler | Facultatif. Appelé s'il y a une erreur renvoyée par l'écouteur (la fonction onNext ). |
| en complément | () => vide | Actuellement inutilisé, car le flux de jetons est sans fin. |
Retour:
Une fonction qui désabonne cet auditeur.
setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled)
Définissez si App Check actualisera automatiquement les jetons si nécessaire.
Signature:
export declare function setTokenAutoRefreshEnabled(appCheckInstance: AppCheck, isTokenAutoRefreshEnabled: boolean): void;
Paramètres
| Paramètre | Taper | Description |
|---|---|---|
| appCheckInstance | AppCheck | Instance du service App Check. |
| isTokenAutoRefreshEnabled | booléen | Si cela est vrai, le SDK actualise automatiquement les jetons App Check selon les besoins. Cela remplace toute valeur définie lors initializeAppCheck() . |
Retour:
vide
AppCheckTokenListener
Un écouteur qui est appelé chaque fois que le jeton App Check change.
Signature:
export declare type AppCheckTokenListener = (token: AppCheckTokenResult) => void;