ArmDisarmTrait.ArmDisarmArmState

interface ArmDisarmTrait.ArmDisarmArmState


Proactive notification when the device enters a specific arm state.

Summary

Public properties

ArmDisarmTrait.ArmState?

The current arm state of the device.

String?

The level name of the current security level if multiple security levels exist.

Long?

The Epoch Unix timestamp of when an active entry allowance expires, before which the user must enter a pin to prevent the alarm from sounding.

ArmDisarmTrait.ErrorCode?

The status of the device that triggered the event.

Long?

The Epoch Unix timestamp of when an active exit allowance expires, before which the user must leave the house if the device is arming.

UInt?

The notification level.

String?

The level from availableArmLevels that the device will enter after an exit countdown completes.

String?

The ID of the device that triggered the event, which may be different from the device that sent the notification.

Public properties

armState

val armStateArmDisarmTrait.ArmState?

The current arm state of the device.

currentArmLevel

val currentArmLevelString?

The level name of the current security level if multiple security levels exist.

entryAllowanceEndTimeSeconds

val entryAllowanceEndTimeSecondsLong?

The Epoch Unix timestamp of when an active entry allowance expires, before which the user must enter a pin to prevent the alarm from sounding. The timestamp is a long integer, such as 1710825433. Once the exact time represented by the timestamp has been reached, the alarm sounds. In the meantime, the device provides a time countdown to the user.

errorCode

val errorCodeArmDisarmTrait.ErrorCode?

The status of the device that triggered the event.

exitAllowanceEndTimeSeconds

val exitAllowanceEndTimeSecondsLong?

The Epoch Unix timestamp of when an active exit allowance expires, before which the user must leave the house if the device is arming. The timestamp is a long integer, such as 1710825433. Once the exact time represented by the timestamp has been reached, the alarm sounds. The user may cancel arming or disarming while this countdown is active.

priority

val priorityUInt?

The notification level. The currently supported value is 0, which indicates that the notification should be spoken aloud.

targetArmLevel

val targetArmLevelString?

The level from availableArmLevels that the device will enter after an exit countdown completes.

triggeredDeviceId

val triggeredDeviceIdString?

The ID of the device that triggered the event, which may be different from the device that sent the notification.