app-check package

Das Firebase App Check Web SDK.

Firebase App Check funktioniert nicht in einer Node.js-Umgebung mit ReCaptchaV3Provider oder ReCaptchaEnterpriseProvider , kann aber in Node.js verwendet werden, wenn Sie CustomProvider verwenden und Ihre eigene Nachweismethode schreiben.

Funktionen

Klassen

Schnittstellen

Geben Sie Aliase ein

Funktion(App, ...)

initializeAppCheck(app, Optionen)

Aktivieren Sie die App-Prüfung für die angegebene App. Kann pro App nur einmal aufgerufen werden.

Unterschrift:

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

Parameter

Kehrt zurück:

AppCheck

Funktion(appCheckInstance, ...)

getLimitedUseToken(appCheckInstance)

Fordert ein Firebase App Check-Token an. Diese Methode sollte nur verwendet werden, wenn Sie Anfragen an ein Nicht-Firebase-Backend autorisieren müssen.

Gibt Token mit eingeschränkter Verwendung zurück, die für die Verwendung mit Ihren Nicht-Firebase-Backend-Endpunkten vorgesehen sind, die durch Replay Protection geschützt sind. Diese Methode hat keinen Einfluss auf das Token-Generierungsverhalten der #getAppCheckToken()-Methode.

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen< AppCheckTokenResult >

Der Token mit eingeschränkter Nutzung.

getToken(appCheckInstance, forceRefresh)

Holen Sie sich das aktuelle App Check-Token. Wird an die letzte Fluganfrage angehängt, sofern vorhanden. Gibt null zurück, wenn kein Token vorhanden ist und keine Token-Anfragen im Umlauf sind.

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen< AppCheckTokenResult >

onTokenChanged(appCheckInstance, Beobachter)

Registriert einen Listener für Änderungen im Token-Status. Es kann mehr als ein Listener gleichzeitig für eine oder mehrere App Check-Instanzen registriert sein. Die Listener rufen den UI-Thread immer dann zurück, wenn sich das aktuelle Token ändert, das dieser App Check-Instanz zugeordnet ist.

Unterschrift:

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

Parameter

Kehrt zurück:

Abbestellen

Eine Funktion, die diesen Listener abmeldet.

onTokenChanged(appCheckInstance, onNext, onError, onCompletion)

Registriert einen Listener für Änderungen im Token-Status. Es kann mehr als ein Listener gleichzeitig für eine oder mehrere App Check-Instanzen registriert sein. Die Listener rufen den UI-Thread immer dann zurück, wenn sich das aktuelle Token ändert, das dieser App Check-Instanz zugeordnet ist.

Unterschrift:

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

Parameter

Kehrt zurück:

Abbestellen

Eine Funktion, die diesen Listener abmeldet.

setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled)

Legen Sie fest, ob App Check Token nach Bedarf automatisch aktualisieren soll.

Unterschrift:

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

Parameter

Kehrt zurück:

Leere

AppCheckTokenListener

Ein Listener, der immer dann aufgerufen wird, wenn sich das App Check-Token ändert.

Unterschrift:

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