app-check package

Internetowy pakiet SDK Firebase App Check.

Sprawdzanie aplikacji Firebase nie działa w środowisku Node.js przy użyciu ReCaptchaV3Provider lub ReCaptchaEnterpriseProvider , ale można go używać w Node.js, jeśli używasz CustomProvider i napiszesz własną metodę zaświadczania.

Funkcje

Zajęcia

Interfejsy

Wpisz aliasy

funkcja (aplikacja, ...)

zainicjujAppCheck(aplikacja, opcje)

Aktywuj sprawdzanie aplikacji dla danej aplikacji. Można wywołać tylko raz na aplikację.

Podpis:

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

Parametry

Zwroty:

Kontrola aplikacji

funkcja(appCheckInstance, ...)

getLimitedUseToken (instancja czeku aplikacji)

Żąda tokena sprawdzania aplikacji Firebase. Tej metody należy używać tylko wtedy, gdy musisz autoryzować żądania do zaplecza innego niż Firebase.

Zwraca tokeny o ograniczonym użyciu, które są przeznaczone do użytku z punktami końcowymi zaplecza innymi niż Firebase i chronionymi za pomocą funkcji Replay Protection . Ta metoda nie wpływa na zachowanie generowania tokenów przez metodę #getAppCheckToken().

Podpis:

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

Parametry

Zwroty:

Obietnica< AppCheckTokenResult >

Token ograniczonego użycia.

getToken(appCheckInstance, forceRefresh)

Zdobądź aktualny token sprawdzania aplikacji. Dołączany do najnowszego żądania podczas lotu, jeśli takie istnieje. Zwraca wartość null, jeśli nie ma żadnego tokenu i nie są przesyłane żadne żądania tokenu.

Podpis:

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

Parametry

Zwroty:

Obietnica< AppCheckTokenResult >

onTokenChanged(appCheckInstance, obserwator)

Rejestruje słuchacza zmian w stanie tokenu. Dla jednej lub większej liczby instancji Sprawdzania aplikacji może być jednocześnie zarejestrowanych więcej niż jeden słuchacz. Słuchacze odwołują się do wątku interfejsu użytkownika za każdym razem, gdy zmienia się bieżący token powiązany z tą instancją sprawdzania aplikacji.

Podpis:

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

Parametry

Zwroty:

Zrezygnuj z subskrypcji

Funkcja, która anuluje subskrypcję tego słuchacza.

onTokenChanged(appCheckInstance, onNext, onError, onCompletion)

Rejestruje słuchacza zmian w stanie tokenu. Dla jednej lub większej liczby instancji Sprawdzania aplikacji może być jednocześnie zarejestrowanych więcej niż jeden słuchacz. Słuchacze odwołują się do wątku interfejsu użytkownika za każdym razem, gdy zmienia się bieżący token powiązany z tą instancją sprawdzania aplikacji.

Podpis:

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

Parametry

Zwroty:

Zrezygnuj z subskrypcji

Funkcja, która anuluje subskrypcję tego słuchacza.

setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled)

Ustaw, czy Sprawdzanie aplikacji będzie automatycznie odświeżać tokeny w razie potrzeby.

Podpis:

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

Parametry

Zwroty:

próżnia

AppCheckTokenListener

Odbiornik wywoływany za każdym razem, gdy zmienia się token sprawdzania aplikacji.

Podpis:

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