EventStarter

struct EventStarter
extension EventStarter : Equatable, Hashable, Identifiable, Node, NodeWithOutput, Sendable, Starter

Struct for all Event based starters, relying on an event to trigger the automation.

  • id

    The stable identity of the entity associated with this instance.

    Declaration

    Swift

    let id: String
  • Data that uniquely identifies a Node. Must be unique per Automation.

    Declaration

    Swift

    let output: String
  • The unique entity for the HomeDevice or Structure entity associated with the StateReader.

    Declaration

    Swift

    let entity: any HomeObject
  • The identifier for the DeviceType associated with the StateReader, if the entity is a device.

    Declaration

    Swift

    let deviceType: (any DeviceType.Type)?
  • The string-based identifier for the DeviceType. If the deviceType is UnknownDeviceType it will refer to the original DeviceType ID provided.

    Declaration

    Swift

    let deviceTypeID: String?
  • The identifier of the trait event associated with the Starter.

    Declaration

    Swift

    let event: any Event.Type
  • The string-based identifier for the event. If the event is UnknownEvent it will refer to the original Event ID provided.

    Declaration

    Swift

    let eventID: String
  • The parameters for the event associated with the starter.

    Declaration

    Swift

    let parameters: [Parameter]
  • Returns a Boolean value indicating whether two values are equal.

    Equality is the inverse of inequality. For any values a and b, a == b implies that a != b is false.

    Declaration

    Swift

    static func == (lhs: EventStarter, rhs: EventStarter) -> Bool

    Parameters

    lhs

    A value to compare.

    rhs

    Another value to compare.

  • Returns true if the nodes are equal, false otherwise.

    Declaration

    Swift

    func isEqual(to other: any Node) -> Bool