Pakiet internetowy Sprawdzania aplikacji Firebase.
Sprawdzanie aplikacji Firebase nie działa w środowisku Node.js używającym ReCaptchaV3Provider lub ReCaptchaEnterpriseProvider, ale możesz go używać w Node.js, jeśli używasz CustomProvider i napiszesz własną metodę poświadczania.
Funkcje
| Funkcja | Opis |
|---|---|
| function(aplikacja, ...) | |
| initializeAppCheck(aplikacja, opcje) | Aktywuj Sprawdzanie aplikacji dla danej aplikacji. Może być wywoływane tylko raz dla danej aplikacji. |
| function(appCheckInstance, ...) | |
| getlimitedUseToken(appCheckInstance) | Wysyłam żądanie tokena Sprawdzania aplikacji Firebase. Tej metody należy używać tylko wtedy, gdy musisz autoryzować żądania wysyłane do backendu spoza Firebase.Zwraca tokeny o ograniczonym wykorzystaniu, które są przeznaczone do użycia z punktami końcowymi backendu spoza Firebase, które są chronione przez ochronę przed ponownym odtwarzaniem. Ta metoda nie ma wpływu na generowanie tokenów przez metodę #getAppCheckToken(). |
| getToken(appCheckInstance, forceRefresh) | Pobierz bieżący token Sprawdzania aplikacji. Jeśli forceRefresh ma wartość fałsz, ta funkcja najpierw sprawdza, czy w pamięci znajduje się prawidłowy token, a następnie sprawdza trwałość lokalną (IndexedDB). Jeśli nie zostanie znaleziony lub forceRefresh ma wartość prawda, wysyła żądanie do punktu końcowego Sprawdzania aplikacji o nowy token. Prośba ta jest dołączana do najnowszego przesłanego żądania, o ile taka istnieje. |
| onTokenChanged(appCheckInstance, obserwator) | Rejestruje detektor w zmianach stanu tokena. Na potrzeby co najmniej 1 instancji Sprawdzania aplikacji może być jednocześnie zarejestrowany więcej niż jeden detektor. Detektory oddzwaniają w wątku interfejsu użytkownika za każdym razem, gdy zmieni się bieżący token powiązany z tą instancją Sprawdzania aplikacji. |
| onTokenChanged(appCheckInstance, onNext, onError, onComplete) | Rejestruje detektor w zmianach stanu tokena. Na potrzeby co najmniej 1 instancji Sprawdzania aplikacji może być jednocześnie zarejestrowany więcej niż jeden detektor. Detektory oddzwaniają w wątku interfejsu użytkownika za każdym razem, gdy zmieni się bieżący token powiązany z tą instancją Sprawdzania aplikacji. |
| setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled) | Określ, czy Sprawdzanie aplikacji ma automatycznie odświeżać tokeny w razie potrzeby. |
Zajęcia
| Klasa | Opis |
|---|---|
| CustomProvider, | Niestandardowa klasa dostawcy. |
| ReCaptchaEnterpriseProvider (w języku angielskim) | Dostawca Sprawdzania aplikacji, który może uzyskać token reCAPTCHA Enterprise i wymienić go na token Sprawdzania aplikacji. |
| Dostawca ReCaptchaV3Provider | Dostawca Sprawdzania aplikacji, który może uzyskać token reCAPTCHA V3 i wymienić go na token Sprawdzania aplikacji. |
Interfejsy
| Interfejs | Opis |
|---|---|
| Sprawdzanie aplikacji | Interfejs usługi Sprawdzanie aplikacji Firebase. |
| AppCheckOptions | Opcje inicjowania Sprawdzania aplikacji. |
| AppCheckToken | Token zwrócony przez dostawcę Sprawdzania aplikacji. |
| AppCheckTokenResult | Wynik zwrócony przez getToken(). |
| CustomProviderOptions, | Opcje dostępne podczas tworzenia komponentu CustomProvider. |
Aliasy typu
| Wpisz alias | Opis |
|---|---|
| AppCheckTokenListener | Detektor, który jest wywoływany za każdym razem, gdy zmieni się token Sprawdzania aplikacji. |
funkcja(aplikacja, ...)
inicjujAppCheck(aplikacja; opcje)
Aktywuj Sprawdzanie aplikacji dla danej aplikacji. Może być wywoływane tylko raz dla danej aplikacji.
Podpis:
export declare function initializeAppCheck(app: FirebaseApp | undefined, options: AppCheckOptions): AppCheck;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| aplikacja | Aplikacja Firebase | nie zdefiniowano | FirebaseApp, aby aktywować Sprawdzanie aplikacji |
| opcje | AppCheckOptions | Opcje inicjowania Sprawdzania aplikacji |
Zwroty:
function(appCheckInstance, ...)
getlimitedUseToken(appCheckInstance)
Wysyłam żądanie tokena Sprawdzania aplikacji Firebase. Tej metody należy używać tylko wtedy, gdy musisz autoryzować żądania wysyłane do backendu systemów innych niż Firebase.
Zwraca tokeny o ograniczonym wykorzystaniu, które są przeznaczone do użycia z punktami końcowymi backendu spoza Firebase, które są chronione przez ochronę przed ponownym odtwarzaniem. Ta metoda nie ma wpływu na generowanie tokenów przez metodę #getAppCheckToken().
Podpis:
export declare function getLimitedUseToken(appCheckInstance: AppCheck): Promise<AppCheckTokenResult>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| Instancja appCheck | Sprawdzanie aplikacji | Instancja usługi Sprawdzanie aplikacji. |
Zwroty:
Obietnica<AppCheckTokenResult>
Token do ograniczonego użycia.
getToken(appCheckInstance, forceRefresh)
Pobierz bieżący token Sprawdzania aplikacji. Jeśli forceRefresh ma wartość fałsz, ta funkcja najpierw sprawdza, czy w pamięci znajduje się prawidłowy token, a następnie sprawdza trwałość lokalną (IndexedDB). Jeśli nie zostanie znaleziony lub forceRefresh ma wartość prawda, wysyła żądanie do punktu końcowego Sprawdzania aplikacji o nowy token. Prośba ta jest dołączana do najnowszego przesłanego żądania, o ile taka istnieje.
Podpis:
export declare function getToken(appCheckInstance: AppCheck, forceRefresh?: boolean): Promise<AppCheckTokenResult>;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| Instancja appCheck | Sprawdzanie aplikacji | Instancja usługi Sprawdzanie aplikacji. |
| wymuszanie odświeżania | wartość logiczna | Jeśli ma wartość true (prawda), będzie zawsze próbował pobrać nowy token. W przypadku wartości false (fałsz) używany będzie token z pamięci podręcznej, jeśli znajduje się on w pamięci. |
Zwroty:
Obietnica<AppCheckTokenResult>
onTokenChanged(appCheckInstance, obserwator)
Rejestruje detektor w zmianach stanu tokena. Na potrzeby co najmniej 1 instancji Sprawdzania aplikacji może być jednocześnie zarejestrowany więcej niż jeden detektor. Detektory oddzwaniają w wątku interfejsu użytkownika za każdym razem, gdy zmieni 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 |
|---|---|---|
| Instancja appCheck | Sprawdzanie aplikacji | Instancja usługi Sprawdzanie aplikacji. |
| obserwator | PartialObserver<AppCheckTokenResult> | Obiekt z właściwościami next, error i complete. Funkcja next jest wywoływana za pomocą AppCheckTokenResult przy każdej zmianie tokena. Funkcja error jest opcjonalna i wywoływana, jeśli detektor (funkcja next) wywoła błąd. Element complete nie jest używany, ponieważ strumień tokenów nie kończy się. |
Zwroty:
Funkcja anulująca subskrypcję tego odbiornika.
onTokenChanged(appCheckInstance, onNext, onError, onComplete)
Rejestruje detektor w zmianach stanu tokena. Na potrzeby co najmniej 1 instancji Sprawdzania aplikacji może być jednocześnie zarejestrowany więcej niż jeden detektor. Detektory oddzwaniają w wątku interfejsu użytkownika za każdym razem, gdy zmieni 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 |
|---|---|---|
| Instancja appCheck | Sprawdzanie aplikacji | Instancja usługi Sprawdzanie aplikacji. |
| onNext | (tokenResult: AppCheckTokenResult) => nieważne | W przypadku zmiany tokena ta funkcja jest wywoływana z AppCheckTokenResult. |
| onError | (Błąd: Błąd) => nieważne | Opcjonalnie. Wywoływana w przypadku wystąpienia błędu przez odbiornik (funkcja onNext). |
| w momencie zakończenia | () => nieważne | Obecnie nieużywany, ponieważ strumień tokenów nie kończy się. |
Zwroty:
Funkcja anulująca subskrypcję tego odbiornika.
setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled)
Określ, czy Sprawdzanie aplikacji ma automatycznie odświeżać tokeny w razie potrzeby.
Podpis:
export declare function setTokenAutoRefreshEnabled(appCheckInstance: AppCheck, isTokenAutoRefreshEnabled: boolean): void;
Parametry
| Parametr | Typ | Opis |
|---|---|---|
| Instancja appCheck | Sprawdzanie aplikacji | Instancja usługi Sprawdzanie aplikacji. |
| isTokenAutoRefreshEnabled | wartość logiczna | Jeśli ma wartość prawda, w razie potrzeby pakiet SDK automatycznie odświeża tokeny Sprawdzania aplikacji. Spowoduje to zastąpienie wartości ustawionej w polu initializeAppCheck(). |
Zwroty:
nieważne
AppCheckTokenListener
Detektor, który jest wywoływany za każdym razem, gdy zmieni się token Sprawdzania aplikacji.
Podpis:
export declare type AppCheckTokenListener = (token: AppCheckTokenResult) => void;