ArmDisarmTrait.ArmDisarmCommand.Request

class ArmDisarmTrait.ArmDisarmCommand.Request


The request payload for the ArmDisarm command.

Summary

Public constructors

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

Creates a request payload for the ArmDisarm command.

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 properties

arm

val armBoolean

Starts the arming or disarming operation.

armLevel

val armLevelOptionalValue<String>

The name of the arm level to use.

cancel

val cancelOptionalValue<Boolean>

Whether to cancel an ongoing arming or disarming operation.