AutomationCommand

struct AutomationCommand
extension AutomationCommand : ActionBehavior, Copyable, Copyable, CustomStringConvertible, Equatable, Escapable, Escapable, Sendable

A trait command used in an automation action.

  • The trait associated with the command.

    Declaration

    Swift

    let trait: any Trait.Type
  • The unique identifier for the command.

    Declaration

    Swift

    let command: any Command.Type
  • The string-based identifier for the command. If the command is UnknownCommand it will refer to the original Command ID provided.

    Declaration

    Swift

    let commandID: String
  • The parameters for the command.

    Declaration

    Swift

    let parameters: [Parameter]
  • Undocumented

    Declaration

    Swift

    @_spi(Unknown)
    init(trait: any Trait.Type, command: any Command.Type, commandID: String, parameters: [Parameter] = [])
  • Returns true if the action behaviors are equal, false otherwise.

    Declaration

    Swift

    func isEqualTo(_ other: any ActionBehavior) -> Bool
  • 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: AutomationCommand, rhs: AutomationCommand) -> Bool

    Parameters

    lhs

    A value to compare.

    rhs

    Another value to compare.

  • A textual representation of this instance.

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

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

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

    Declaration

    Swift

    var description: String { get }