ArmDisarmTrait.ArmDisarmCommand.Request

class ArmDisarmTrait.ArmDisarmCommand.Request : ClusterStruct

The request payload for the ArmDisarm command.

Summary

Nested types

Descriptor enum for this command's request fields.

Public constructors
Request(
    arm: Boolean,
    armLevel: OptionalValue<String>,
    cancel: OptionalValue<Boolean>
)

Creates a request payload for the ArmDisarm command.

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
Boolean

Starts the arming or disarming operation.
OptionalValue<String>

The name of the arm level to use.
OptionalValue<Boolean>

Whether to cancel an ongoing arming or disarming operation.

Public constructors

Request

Request(
    arm: Boolean = false,
    armLevel: OptionalValue<String> = OptionalValue.absent(),
    cancel: OptionalValue<Boolean> = OptionalValue.absent()
)

Creates a request payload for the ArmDisarm command.

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

arm

val arm: Boolean

Starts the arming or disarming operation.

armLevel

val armLevel: OptionalValue<String>

The name of the arm level to use.

cancel

val cancel: OptionalValue<Boolean>

Whether to cancel an ongoing arming or disarming operation.