firebase-admin.extensions package

Rozszerzenia w Firebase.

Funkcje

Funkcja Opis
getExtensions(aplikacja) Pobiera usługę Rozszerzenia dla domyślnej aplikacji lub aplikacji.getExtensions() można wywołać bez argumentów, aby uzyskać dostęp do usługi Extensions domyślnej aplikacji, lub jako getExtensions(app), aby uzyskać dostęp do usługi Extensions powiązanej z konkretną aplikacją.

Zajęcia

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

Typ aliasów

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

getExtensions(aplikacja)

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

Funkcję getExtensions() można wywołać bez argumentów, aby uzyskać dostęp do usługi Extensions domyślnej aplikacji, lub jako getExtensions(app), aby uzyskać dostęp 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, dla której ma zostać zwrócona usługa Extensions. Jeśli nie zostanie podana, zwracana jest domyślna usługa Extensions.

Zwroty:

Rozszerzenia

Domyślna usługa Extensions, jeśli nie podano żadnej 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);

SettableProcessingState

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

Możesz ustawić te stany:

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

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

  • PROCESSING_WARNING: działanie związane ze zdarzeniami w cyklu życia zostało częściowo ukończone lub wystąpiła sytuacja, o której użytkownik powinien otrzymać ostrzeżenie.

  • PROCESSING_FAILED: działanie zdarzenia cyklu życia nie powiodło się, ale wystąpienie nadal będzie działać prawidłowo.

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

Stan „przetwarzanie” jest ustawiany automatycznie po uruchomieniu modułu obsługi zdarzeń cyklu życia. Nie można go ustawić bezpośrednio. Aby zgłosić bieżący stan funkcji rozszerzenia, użyj pakietu SDK console.log lub pakietu SDK Cloud Functions.

Podpis:

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