firebase-admin.extensions package

Usługa Rozszerzenia w Firebase.

Funkcje

Funkcja Opis
getExtensions(aplikacja) Pobiera usługę Rozszerzenia dla aplikacji domyślnej lub danej.Aplikacja getExtensions() może być wywoływana bez argumentów umożliwiających dostęp do usługi Extensions domyślnej aplikacji lub jako getExtensions(app) w celu uzyskania dostępu do usługi Extensions powiązanej z konkretną aplikacją.

Zajęcia

Klasa Opis
Rozszerzenia Interfejs usługi Firebase Extensions.
Środowisko wykonawcze Środowisko wykonawcze udostępnia metody modyfikowania danych środowiska wykonawczego instancji rozszerzenia.

Aliasy typu

Wpisz alias Opis
SettableProcessingState SettableProcessingState reprezentuje wszystkie stany przetwarzania, które można ustawić w danych środowiska wykonawczego instancji rozszerzenia.

getExtensions(aplikacja)

Pobiera usługę Rozszerzenia dla aplikacji domyślnej lub danej.

Funkcja getExtensions() może być wywoływana bez argumentów umożliwiających dostęp do usługi Extensions domyślnej aplikacji lub jako getExtensions(app) w celu uzyskania dostępu do usługi Extensions powiązanej z konkretną aplikacją.

Podpis:

export declare function getExtensions(app?: App): Extensions;

Parametry

Parametr Typ Opis
aplikacja Aplikacja Opcjonalna aplikacja, w przypadku której ma zostać zwrócona usługa Extensions. Jeśli nie zostanie podana, zwrócona zostanie domyślna usługa Extensions.

Zwroty:

Rozszerzenia

Domyślna usługa Extensions w przypadku braku aplikacji lub usługa Extensions powiązana z udostępnioną aplikacją.

Przykład 1

// Get the `Extensions` service for the default app
const defaultExtensions = getExtensions();

Przykład 2

// Get the `Extensions` service for a given app
const otherExtensions = getExtensions(otherApp);

Parametr SettableProcessingState

SettableProcessingState reprezentuje wszystkie stany przetwarzania, które można ustawić w danych środowiska wykonawczego instancji rozszerzenia.

Możesz ustawić te stany:

  • NONE: nie wykonano odpowiednich działań związanych ze zdarzeniami cyklu życia. Ustaw tę opcję, aby usunąć stare stany.

  • PROCESSING_COMPLETE: zadania związane ze zdarzeniami cyklu życia zostały ukończone bez błędów.

  • PROCESSING_WARNING: część działań związanych ze zdarzeniami cyklu życia została częściowo przeprowadzona lub wystąpiła sytuacja, przed którą użytkownik powinien otrzymać ostrzeżenie.

  • PROCESSING_FAILED: nie udało się wykonać zdarzenia cyklu życia, ale instancja będzie działać prawidłowo.

Jeśli wystąpienie rozszerzenia jest uszkodzone z powodu błędów, wywołaj Runtime.setFatalError().

„Przetwarzanie” stan jest ustawiany automatycznie po uruchomieniu modułu obsługi zdarzeń cyklu życia; nie możesz go ustawić. Aby raportować obecny stan funkcji rozszerzenia, użyj pakietu SDK console.log lub pakietu SDK rejestrowania funkcji Cloud Functions.

Podpis:

export type SettableProcessingState = 'NONE' | 'PROCESSING_COMPLETE' | 'PROCESSING_WARNING' | 'PROCESSING_FAILED';