Runtime provides methods to modify an extension instance's runtime data.

Signature:

exportdeclareclassRuntime

Methods

Runtime.setFatalError()

Reports a fatal error while running a lifecycle event handler.

Call this method when a lifecycle event handler fails in a way that makes the Instance inoperable. If the lifecycle event failed but the instance will still work as expected, callsetProcessingState with the "PROCESSING_WARNING" or "PROCESSING_FAILED" state instead.

Signature:

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

Parameters

Returns:

Promise<void>

Runtime.setProcessingState()

Sets the processing state of an extension instance.

Use this method to report the results of a lifecycle event handler.

If the lifecycle event failed & the extension instance will no longer work correctly, useRuntime.setFatalError() instead.

To report the status of function calls other than lifecycle event handlers, useconsole.log or the Cloud Functions logger SDK.

Signature:

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

Parameters

Returns:

Promise<void>