firebase-admin.extensions package

Firebase-Erweiterungsdienst.

Funktionen

Funktion Beschreibung
getExtensions(app) Ruft den Erweiterungsdienst für die Standard-App oder eine bestimmte App ab. getExtensions() kann ohne Argumente aufgerufen werden, um auf den Extensions der Standard-App zuzugreifen, oder als getExtensions(app) um auf den Extensions zuzugreifen, der einer bestimmten App zugeordnet ist.

Klassen

Klasse Beschreibung
Erweiterungen Die Firebase Extensions Dienstschnittstelle.
Laufzeit Runtime bietet Methoden zum Ändern der Laufzeitdaten einer Erweiterungsinstanz.

Geben Sie Aliase ein

Geben Sie Alias ​​ein Beschreibung
SettableProcessingState SettableProcessingState stellt alle Verarbeitungszustände dar, die für die Laufzeitdaten einer Erweiterungsinstanz festgelegt werden können.

getExtensions()

Ruft den Erweiterungsdienst für die Standard-App oder eine bestimmte App ab.

getExtensions() kann ohne Argumente aufgerufen werden, um auf den Extensions der Standard-App zuzugreifen, oder als getExtensions(app) um auf den Extensions zuzugreifen, der einer bestimmten App zugeordnet ist.

Unterschrift:

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

Parameter

Parameter Typ Beschreibung
App App Optionale App, für die der Extensions zurückgegeben werden soll. Wenn nicht angegeben, wird der Extensions zurückgegeben.

Kehrt zurück:

Erweiterungen

Der standardmäßige Extensions , wenn keine App bereitgestellt wird, oder der Extensions , der der bereitgestellten App zugeordnet ist.

Beispiel 1

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

Beispiel 2

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

SettableProcessingState

SettableProcessingState stellt alle Verarbeitungszustände dar, die für die Laufzeitdaten einer Erweiterungsinstanz festgelegt werden können.

Sie können folgende Zustände einstellen:

  • NONE : Es wurden keine relevanten Arbeiten zu Lebenszyklusereignissen durchgeführt. Legen Sie dies fest, um alte Status zu löschen.

  • PROCESSING_COMPLETE : Lebenszyklus-Ereignisarbeit ohne Fehler abgeschlossen.

  • PROCESSING_WARNING : Die Arbeit mit dem Lebenszyklusereignis war teilweise erfolgreich oder es ist etwas passiert, vor dem der Benutzer gewarnt werden sollte.

  • PROCESSING_FAILED : Die Arbeit am Lebenszyklusereignis ist vollständig fehlgeschlagen, aber die Instanz wird auch in Zukunft weiterhin ordnungsgemäß funktionieren.

Wenn sich die Erweiterungsinstanz aufgrund von Fehlern in einem fehlerhaften Zustand befindet, rufen Sie stattdessen Runtime.setFatalError() auf. .

Der Status „Verarbeitung“ wird automatisch festgelegt, wenn ein Lebenszyklus-Ereignishandler startet. Sie können es nicht explizit festlegen. Um den aktuellen Status der Funktion einer Erweiterung zu melden, verwenden Sie console.log oder das Cloud Functions Logger SDK.

Unterschrift:

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