Payload

struct Payload

Payload for the ArmDisarmArmStateEvent.

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

    Declaration

    Swift

    let priority: UInt32?
  • The current arm state of the device.

    Declaration

    Swift

    let armState: Google.ArmDisarmTrait.ArmState?
  • 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.

    Declaration

    Swift

    let exitAllowanceEndTimeSeconds: Int64?
  • 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.

    Declaration

    Swift

    let entryAllowanceEndTimeSeconds: Int64?
  • The level name of the current security level if multiple security levels exist.

    Declaration

    Swift

    let currentArmLevel: String?
  • The level from availableArmLevels that the device will enter after an exit countdown completes.

    Declaration

    Swift

    let targetArmLevel: String?
  • The ID of the device that triggered the event, which may be different from the device that sent the notification.

    Declaration

    Swift

    let triggeredDeviceId: String?
  • The status of the device that triggered the event.

    Declaration

    Swift

    let errorCode: Google.ArmDisarmTrait.ErrorCode?
  • A textual representation of this instance, suitable for debugging.

    Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the String(reflecting:) initializer. This initializer works with any type, and uses the custom debugDescription property for types that conform to CustomDebugStringConvertible:

    struct Point: CustomDebugStringConvertible {
        let x: Int, y: Int
    
        var debugDescription: String {
            return "(\(x), \(y))"
        }
    }
    
    let p = Point(x: 21, y: 30)
    let s = String(reflecting: p)
    print(s)
    // Prints "(21, 30)"
    

    The conversion of p to a string in the assignment to s uses the Point type’s debugDescription property.

    Declaration

    Swift

    var debugDescription: String { get }