ActionsTrait.ActionFailed

interface ActionsTrait.ActionFailed : ClusterStruct

Indicates that the action failed to complete as intended.

Summary

Public functions
open StructDescriptor

Returns the descriptor for the struct.
open Any?

Returns the value of the field for the given tag ID.

Public properties
UShort?
ActionsTrait.ActionErrorEnum?

The reason for the action's failure.
UInt?
ActionsTrait.ActionStateEnum?

The state that the action was in at the time of the event.

Public functions

getDescriptor

@HomeExperimentalApi
open fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

getFieldValueById

@HomeExperimentalApi
open fun getFieldValueById(tagId: UInt): Any?

Returns the value of the field for the given tag ID.

Public properties

actionId

val actionId: UShort?

error

val error: ActionsTrait.ActionErrorEnum?

The reason for the action's failure.

invokeId

val invokeId: UInt?

newState

val newState: ActionsTrait.ActionStateEnum?

The state that the action was in at the time of the event.