Runtime class

Runtime bietet Methoden zum Ändern der Laufzeitdaten einer Erweiterungsinstanz.

Unterschrift:

export declare class Runtime 

Methoden

Methode Modifikatoren Beschreibung
setFatalError(errorMessage) Meldet einen schwerwiegenden Fehler beim Ausführen eines Lebenszyklus-Ereignishandlers.
setProcessingState(state, detailMessage) Legt den Verarbeitungsstatus einer Erweiterungsinstanz fest.

Runtime.setFatalError()

Meldet einen schwerwiegenden Fehler beim Ausführen eines Lebenszyklus-Ereignishandlers.

Rufen Sie diese Methode auf, wenn ein Lebenszyklus-Ereignishandler so ausfällt, dass die Instanz nicht mehr funktionsfähig ist. Wenn das Lebenszyklusereignis fehlgeschlagen ist, die Instanz aber weiterhin wie erwartet funktioniert, rufen Sie stattdessen setProcessingState mit dem Status „PROCESSING_WARNING“ oder „PROCESSING_FAILED“ auf.

Unterschrift:

setFatalError(errorMessage: string): Promise<void>;

Parameter

Parameter Typ Beschreibung
Fehlermeldung Zeichenfolge Eine Nachricht, die erklärt, was schief gelaufen ist und wie man es beheben kann.

Kehrt zurück:

Versprechen<void>

Runtime.setProcessingState()

Legt den Verarbeitungsstatus einer Erweiterungsinstanz fest.

Verwenden Sie diese Methode, um die Ergebnisse eines Lebenszyklus-Ereignishandlers zu melden.

Wenn das Lebenszyklusereignis fehlgeschlagen ist und die Erweiterungsinstanz nicht mehr ordnungsgemäß funktioniert, verwenden Sie stattdessen Runtime.setFatalError() .

Um den Status anderer Funktionsaufrufe als Lebenszyklus-Ereignishandler zu melden, verwenden Sie console.log oder das Cloud Functions-Logger-SDK.

Unterschrift:

setProcessingState(state: SettableProcessingState, detailMessage: string): Promise<void>;

Parameter

Parameter Typ Beschreibung
Zustand SettableProcessingState Der Status, auf den die Instanz festgelegt werden soll.
detailMessage Zeichenfolge Eine Nachricht, die die Ergebnisse der Lebenszyklusfunktion erläutert.

Kehrt zurück:

Versprechen<void>