Event Object

Overview

This object is passed as the parameter to event handlers in apps, providing some information about the event and the device that produced it.

Properties

archivable

Boolean

Not used

descriptionText

String

Driver-provided description of event, often including device name, attribute name, new value, and (if applicable) unit as human-friendly string (e.g., "Living Room dimmer level is 50%"). Not mandatory.

displayed

boolean

Not used

source

String

isStateChange

Boolean

If true, platform will generate an event even if the new value is the same as the old value. The default behavior filters out events that do not represent a change in value.

name

String

The name of the device attribute represented by this event (e.g., "switch" or "temperature")

value

String

The new value of the specified attribute

unit

String

The units for the new value, (e.g., "%" or "°F"; optional)

description

String

translatable

Boolean

Not used

type

String

May be "physical" (if event was generated by user action on the device itself, e.g., pressing a button/switch) or "digital" (if generated as a result of a command sent from the hub), or null (default and very common)

locationId

Long

hubId

Long

installedAppId

Long

Methods

getData

getJsonData

isPhysical

isDigital

getDate

getUnixTime

getDisplayName

getDeviceId

getDevice

getLocation

getDoubleValue

getFloatValue

getDateValue

getIntegerValue

getLongValue

getNumberValue

getNumericValue