Console

AutomationExecutionTrait 

struct AutomationExecutionTrait
 
extension AutomationExecutionTrait : Copyable, CustomStringConvertible, Equatable, Escapable, Hashable, Sendable, SendableMetatype, Trait, TraitEncodable

Platform trait carrying attributes and events related to automation execution status.

  • List of the events that are supported.

    Declaration

    Swift

    static let supportedEventTypes: [any Event.Type]

  • List of the commands that are supported.

    Declaration

    Swift

    static let supportedCommandTypes: [any Command.Type]

  • The trait identifier.

    Declaration

    Swift

    static let identifier: String

  • Metadata about this Trait.

    Declaration

    Swift

    let metadata: TraitMetadata

  • Undocumented

    Declaration

    Swift

    let attributes: AutomationExecutionTrait.Attributes

  • Undocumented

    Declaration

    Swift

    init(decoder: TraitDecoder, interactionProxy: (any InteractionProxy)? = nil) throws

  • Creates a new Trait instance using data read from the given TraitDecoder.

    Throws

    HomeError.parseError when parsing fails.

    Declaration

    Swift

    init(decoder: TraitDecoder, interactionProxy: (any InteractionProxy)? = nil, metadata: TraitMetadata) throws

    Parameters

    decoder

    The raw data representing this Trait.
    interactionProxy

    Proxy to the Interaction Client.
    metadata

    Metadata about this Trait.

  • Writes this object to the given TraitEncoder. Throws HomeError.encodingFailed if the data could not be encoded.

    Declaration

    Swift

    func encode(with encoder: TraitEncoder) throws

  • 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: AutomationExecutionTrait, rhs: AutomationExecutionTrait) -> Bool

    Parameters

    lhs

    A value to compare.
    rhs

    Another value to compare.

  • Hashes the essential components of this value by feeding them into the given hasher.

    Implement this method to conform to the Hashable protocol. The components used for hashing must be the same as the components compared in your type’s == operator implementation. Call hasher.combine(_:) with each of these components.

    Important

    In your implementation of hash(into:), don’t call finalize() on the hasher instance provided, or replace it with a different instance. Doing so may become a compile-time error in the future.

    Declaration

    Swift

    func hash(into hasher: inout Hasher)

  • Undocumented

    Declaration

    Swift

    struct Attributes
     
    extension AutomationExecutionTrait.Attributes : Decodable, Encodable, Equatable, Hashable, Sendable, SendableMetatype

  • Event emitted when an automation execution occurs, containing details and metadata of the executed automation.

    Declaration

    Swift

    struct AutomationExecutionEvent
     
    extension AutomationExecutionTrait.AutomationExecutionEvent : CustomDebugStringConvertible, Equatable, Event, Hashable, Sendable, SendableMetatype