Console

ActionStruct 

struct ActionStruct

The details of a single action.

  • The name as assigned by the user or automatically by the server associated with this action.

    Declaration

    Swift

    let name: String

  • The type of endpoint list.

    Declaration

    Swift

    let type: Matter.ActionsTrait.ActionTypeEnum

  • A bitmap indicating which of the cluster’s commands are supported for this particular action.

    Declaration

    Swift

    let supportedCommands: Matter.ActionsTrait.CommandBits

  • The current state of this action.

    Declaration

    Swift

    let state: Matter.ActionsTrait.ActionStateEnum

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

    Throws

    HomeError.parseError when parsing fails.

    Declaration

    Swift

    init(decoder: TraitDecoder) throws

    Parameters

    decoder

    The raw data representing this Struct.

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

    Declaration

    Swift

    func encode(with encoder: TraitEncoder) throws

  • Returns the field corresponding to the given field ID.

    Declaration

    Swift

    static func structField(id: UInt32) -> (any Field)?