Console

CommandCandidate 

struct CommandCandidate
 
extension CommandCandidate : ActionCandidate, Copyable, Equatable, Equatable, Escapable, Hashable, Hashable, NodeCandidate, NodeCandidate, Sendable, Sendable

Represents automation candidate nodes corresponding to a command. These can be used in actions.

  • Undocumented

    Declaration

    Swift

    let homeObject: any HomeObject

  • Undocumented

    Declaration

    Swift

    let deviceTypes: [any DeviceType.Type]

  • Undocumented

    Declaration

    Swift

    let trait: any Trait.Type

  • Undocumented

    Declaration

    Swift

    let command: any Command.Type

  • Undocumented

    Declaration

    Swift

    let fieldDetails: [AnyField : CommandFieldDetails]

  • Undocumented

    Declaration

    Swift

    let unsupportedReasons: [UnsupportedCandidateReason]

  • Undocumented

    Declaration

    Swift

    init(homeObject: any HomeObject, deviceTypes: [any DeviceType.Type], trait: any Trait.Type, command: any Command.Type, fieldDetails: [AnyField : CommandFieldDetails], unsupportedReasons: [UnsupportedCandidateReason])

  • 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)

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

    Parameters

    lhs

    A value to compare.
    rhs

    Another value to compare.