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
Funkcjonować | Opis |
---|---|
funkcja (aplikacja, ...) | |
zainicjujAppCheck(aplikacja, opcje) | Aktywuj sprawdzanie aplikacji dla danej aplikacji. Można wywołać tylko raz na aplikację. |
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(). |
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. |
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. |
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. |
setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled) | Ustaw, czy Sprawdzanie aplikacji będzie automatycznie odświeżać tokeny w razie potrzeby. |
Zajęcia
Klasa | Opis |
---|---|
Dostawca niestandardowy | Niestandardowa klasa dostawcy. |
Dostawca ReCaptchaEnterprise | Dostawca sprawdzania aplikacji, który może uzyskać token reCAPTCHA Enterprise i wymieniać go na token sprawdzania aplikacji. |
Dostawca ReCaptchaV3 | Dostawca sprawdzania aplikacji, który może uzyskać token reCAPTCHA V3 i wymieniać go na token sprawdzania aplikacji. |
Interfejsy
Interfejs | Opis |
---|---|
Kontrola aplikacji | Interfejs usługi Firebase App Check. |
Opcje sprawdzania aplikacji | Opcje inicjalizacji App Check. |
Token sprawdzania aplikacji | Token zwrócony od dostawcy sprawdzania aplikacji. |
Wynik AppCheckToken | Wynik zwrócony przez getToken() . |
Opcje dostawcy niestandardowego | Opcje podczas tworzenia CustomProvider . |
Wpisz aliasy
Wpisz Alias | Opis |
---|---|
AppCheckTokenListener | Odbiornik wywoływany za każdym razem, gdy zmienia się token sprawdzania aplikacji. |
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
Parametr | Typ | Opis |
---|---|---|
aplikacja | Aplikacja Firebase | nieokreślony | aplikację Firebase, dla której chcesz aktywować Sprawdzanie aplikacji |
opcje | Opcje sprawdzania aplikacji | Aplikacja Sprawdź opcje inicjalizacji |
Zwroty:
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
Parametr | Typ | Opis |
---|---|---|
aplikacjaCheckInstancja | Kontrola aplikacji | Instancja usługi App Check. |
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
Parametr | Typ | Opis |
---|---|---|
aplikacjaCheckInstancja | Kontrola aplikacji | Instancja usługi App Check. |
wymuśOdśwież | wartość logiczna | Jeśli to prawda, zawsze będzie próbował pobrać nowy token. Jeśli false, użyje tokena z pamięci podręcznej, jeśli zostanie znaleziony w magazynie. |
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
Parametr | Typ | Opis |
---|---|---|
aplikacjaCheckInstancja | Kontrola aplikacji | Instancja usługi App Check. |
obserwator | Częściowy obserwator < Wynik AppCheckToken > | Obiekt z właściwościami next , error complete . next jest wywoływany z AppCheckTokenResult za każdym razem, gdy token ulega zmianie. error jest opcjonalny i jest wywoływany, jeśli słuchacz zgłosi błąd ( next funkcja). complete jest nieużywana, ponieważ strumień tokenów nie ma końca. |
Zwroty:
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
Parametr | Typ | Opis |
---|---|---|
aplikacjaCheckInstancja | Kontrola aplikacji | Instancja usługi App Check. |
naDalej | (tokenResult: AppCheckTokenResult ) => pustka | Gdy token ulegnie zmianie, ta funkcja jest wywoływana z AppCheckTokenResult . |
naBłąd | (błąd: Błąd) => nieważne | Opcjonalny. Wywoływane, jeśli słuchacz zgłosił błąd (funkcja onNext ). |
po zakończeniu | () => pustka | Obecnie nieużywany, ponieważ strumień tokenów nie ma końca. |
Zwroty:
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
Parametr | Typ | Opis |
---|---|---|
aplikacjaCheckInstancja | Kontrola aplikacji | Instancja usługi App Check. |
isTokenAutoRefreshEnabled | wartość logiczna | Jeśli ma wartość true, zestaw SDK automatycznie odświeża tokeny sprawdzania aplikacji w razie potrzeby. Zastępuje to dowolną wartość ustawioną podczas initializeAppCheck() . |
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;