ActionsTrait.ActionStruct

class ActionsTrait.ActionStruct


The details of a single action.

Summary

Public constructors

ActionStruct(
    actionId: UShort,
    name: String,
    type: ActionsTrait.ActionTypeEnum,
    endpointListId: UShort,
    supportedCommands: ActionsTrait.CommandBits,
    state: ActionsTrait.ActionStateEnum
)

Creates the ActionStruct class.

Public properties

UShort
UShort
String

The name as assigned by the user or automatically by the server associated with this action.

ActionsTrait.ActionStateEnum

The current state of this action.

ActionsTrait.CommandBits

A bitmap indicating which of the cluster's commands are supported for this particular action.

ActionsTrait.ActionTypeEnum

The type of endpoint list.

Public constructors

ActionStruct

ActionStruct(
    actionId: UShort,
    name: String = "",
    type: ActionsTrait.ActionTypeEnum = ActionTypeEnum.Other,
    endpointListId: UShort,
    supportedCommands: ActionsTrait.CommandBits = CommandBits(),
    state: ActionsTrait.ActionStateEnum = ActionStateEnum.Inactive
)

Creates the ActionStruct class.

Public properties

actionId

val actionIdUShort

endpointListId

val endpointListIdUShort

name

val nameString

The name as assigned by the user or automatically by the server associated with this action.

state

val stateActionsTrait.ActionStateEnum

The current state of this action.

supportedCommands

val supportedCommandsActionsTrait.CommandBits

A bitmap indicating which of the cluster's commands are supported for this particular action.

type

val typeActionsTrait.ActionTypeEnum

The type of endpoint list.