Interface OperationCompletionEvent

Body of the OperationalState operationCompletion event

See

MatterSpecification.v13.Cluster § 1.14.7.2

interface OperationCompletionEvent {
    completionErrorCode: number;
    pausedTime?: null | number;
    totalOperationalTime?: null | number;
}

Hierarchy (view full)

Properties

completionErrorCode pausedTime? totalOperationalTime?

Properties

completionErrorCode

completionErrorCode: number

This field provides an indication of the state at the end of the operation. This field shall have a value from the ErrorStateEnum set. A value of NoError indicates success, that is, no error has been detected.

See

MatterSpecification.v13.Cluster § 1.14.7.2.1

OptionalpausedTime

pausedTime?: null | number

The total time spent in the paused state, in seconds. There may be cases whereby the total paused time exceeds the maximum value that can be conveyed by this attribute, in such instances, this attribute shall be populated with null.

See

MatterSpecification.v13.Cluster § 1.14.7.2.3

OptionaltotalOperationalTime

totalOperationalTime?: null | number

The total operational time, in seconds, from when the operation was started via an initial Start command or manual action, until the operation completed. This includes any time spent while paused. There may be cases whereby the total operational time exceeds the maximum value that can be conveyed by this attribute, in such instances, this attribute shall be populated with null.

See

MatterSpecification.v13.Cluster § 1.14.7.2.2

Settings

Member Visibility

On This Page

Properties