L'SDK Web di controllo dell'app Firebase.
Firebase App Check non funziona in un ambiente Node.js utilizzando ReCaptchaV3Provider o ReCaptchaEnterpriseProvider , ma può essere utilizzato in Node.js se utilizzi CustomProvider e scrivi il tuo metodo di attestazione.
Funzioni
| Funzione | Descrizione |
|---|---|
| funzione(app, ...) | |
| inizializzaAppCheck(app, opzioni) | Attiva App Check per l'app specificata. Può essere chiamato solo una volta per app. |
| funzione(appCheckInstance, ...) | |
| getLimitedUseToken(appCheckInstance) | Richiede un token Firebase App Check. Questo metodo dovrebbe essere utilizzato solo se è necessario autorizzare le richieste a un backend non Firebase. Restituisce token a utilizzo limitato destinati all'uso con gli endpoint backend non Firebase protetti con Replay Protection . Questo metodo non influisce sul comportamento di generazione del token del metodo #getAppCheckToken(). |
| getToken(appCheckInstance, forceRefresh) | Ottieni il token App Check corrente. Si allega alla richiesta in volo più recente, se presente. Restituisce null se non è presente alcun token e non sono in corso richieste di token. |
| onTokenChanged(appCheckInstance, osservatore) | Registra un ascoltatore per le modifiche nello stato del token. Può essere registrato più di un ascoltatore contemporaneamente per una o più istanze di App Check. Gli ascoltatori richiamano il thread dell'interfaccia utente ogni volta che cambia il token corrente associato a questa istanza di App Check. |
| onTokenChanged(appCheckInstance, onNext, onError, onCompletion) | Registra un ascoltatore per le modifiche nello stato del token. Può essere registrato più di un ascoltatore contemporaneamente per una o più istanze di App Check. Gli ascoltatori richiamano il thread dell'interfaccia utente ogni volta che cambia il token corrente associato a questa istanza di App Check. |
| setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled) | Imposta se App Check aggiornerà automaticamente i token secondo necessità. |
Classi
| Classe | Descrizione |
|---|---|
| CustomProvider | Classe provider personalizzata. |
| ReCaptchaEnterpriseProvider | Fornitore di App Check che può ottenere un token reCAPTCHA Enterprise e scambiarlo con un token App Check. |
| ReCaptchaV3Provider | Fornitore di App Check che può ottenere un token reCAPTCHA V3 e scambiarlo con un token App Check. |
Interfacce
| Interfaccia | Descrizione |
|---|---|
| AppCheck | L'interfaccia del servizio Firebase App Check. |
| AppCheckOptions | Opzioni per l'inizializzazione di App Check. |
| AppCheckToken | Il token restituito da un provider App Check. |
| AppCheckTokenResult | Risultato restituito da getToken() . |
| CustomProviderOptions | Opzioni durante la creazione di un CustomProvider . |
Digitare Alias
| Digita Alias | Descrizione |
|---|---|
| AppCheckTokenListener | Un listener che viene chiamato ogni volta che cambia il token App Check. |
funzione(app, ...)
inizializzaAppCheck(app, opzioni)
Attiva App Check per l'app specificata. Può essere chiamato solo una volta per app.
Firma:
export declare function initializeAppCheck(app: FirebaseApp | undefined, options: AppCheckOptions): AppCheck;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| app | FirebaseApp | non definito | la FirebaseApp per attivare App Check |
| opzioni | AppCheckOptions | Opzioni di inizializzazione di App Check |
Ritorna:
funzione(appCheckInstance, ...)
getLimitedUseToken(appCheckInstance)
Richiede un token Firebase App Check. Questo metodo dovrebbe essere utilizzato solo se è necessario autorizzare le richieste a un backend non Firebase.
Restituisce token a utilizzo limitato destinati all'uso con gli endpoint backend non Firebase protetti con Replay Protection . Questo metodo non influisce sul comportamento di generazione del token del metodo #getAppCheckToken().
Firma:
export declare function getLimitedUseToken(appCheckInstance: AppCheck): Promise<AppCheckTokenResult>;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| appCheckInstance | AppCheck | L'istanza del servizio App Check. |
Ritorna:
Promessa< AppCheckTokenResult >
Il gettone ad uso limitato.
getToken(appCheckInstance, forceRefresh)
Ottieni il token App Check corrente. Si allega alla richiesta in volo più recente, se presente. Restituisce null se non è presente alcun token e non sono in corso richieste di token.
Firma:
export declare function getToken(appCheckInstance: AppCheck, forceRefresh?: boolean): Promise<AppCheckTokenResult>;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| appCheckInstance | AppCheck | L'istanza del servizio App Check. |
| forceRefresh | booleano | Se vero, proverà sempre a recuperare un nuovo token. Se false, utilizzerà un token memorizzato nella cache se trovato nell'archivio. |
Ritorna:
Promessa< AppCheckTokenResult >
onTokenChanged(appCheckInstance, osservatore)
Registra un ascoltatore per le modifiche nello stato del token. Può essere registrato più di un ascoltatore contemporaneamente per una o più istanze di App Check. Gli ascoltatori richiamano il thread dell'interfaccia utente ogni volta che cambia il token corrente associato a questa istanza di App Check.
Firma:
export declare function onTokenChanged(appCheckInstance: AppCheck, observer: PartialObserver<AppCheckTokenResult>): Unsubscribe;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| appCheckInstance | AppCheck | L'istanza del servizio App Check. |
| osservatore | Osservatore parziale < AppCheckTokenResult > | Un oggetto con le proprietà next , error e complete . next viene chiamato con un AppCheckTokenResult ogni volta che il token cambia. error è facoltativo e viene chiamato se viene generato un errore dal listener (la funzione next ). complete non è utilizzato, poiché il flusso di token è infinito. |
Ritorna:
Una funzione che annulla l'iscrizione a questo ascoltatore.
onTokenChanged(appCheckInstance, onNext, onError, onCompletion)
Registra un ascoltatore per le modifiche nello stato del token. Può essere registrato più di un ascoltatore contemporaneamente per una o più istanze di App Check. Gli ascoltatori richiamano il thread dell'interfaccia utente ogni volta che cambia il token corrente associato a questa istanza di App Check.
Firma:
export declare function onTokenChanged(appCheckInstance: AppCheck, onNext: (tokenResult: AppCheckTokenResult) => void, onError?: (error: Error) => void, onCompletion?: () => void): Unsubscribe;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| appCheckInstance | AppCheck | L'istanza del servizio App Check. |
| suAvanti | (tokenResult: AppCheckTokenResult ) => vuoto | Quando il token cambia, questa funzione viene chiamata con un AppCheckTokenResult . |
| onError | (errore: Errore) => void | Opzionale. Chiamato se viene generato un errore dal listener (la funzione onNext ). |
| al termine | () => vuoto | Attualmente inutilizzato, poiché il flusso di token è infinito. |
Ritorna:
Una funzione che annulla l'iscrizione a questo ascoltatore.
setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled)
Imposta se App Check aggiornerà automaticamente i token secondo necessità.
Firma:
export declare function setTokenAutoRefreshEnabled(appCheckInstance: AppCheck, isTokenAutoRefreshEnabled: boolean): void;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| appCheckInstance | AppCheck | L'istanza del servizio App Check. |
| isTokenAutoRefreshEnabled | booleano | Se true, l'SDK aggiorna automaticamente i token App Check secondo necessità. Ciò sovrascrive qualsiasi valore impostato durante initializeAppCheck() . |
Ritorna:
vuoto
AppCheckTokenListener
Un listener che viene chiamato ogni volta che cambia il token App Check.
Firma:
export declare type AppCheckTokenListener = (token: AppCheckTokenResult) => void;