Console

AreaInfoStruct 

struct AreaInfoStruct

The name and semantic data describing an area.

  • The name of the area, floor number or area type. Area-type values come from the Matter Common Area Type Namespace.

    Declaration

    Swift

    let locationInfo: Matter.ServiceAreaTrait.LocationDescriptorStruct?

  • Indicates an association with a landmark. For example, this may indicate that the area refers to a zone next to a table. A value of null indicates that the information is not available or known.

    Declaration

    Swift

    let landmarkInfo: Matter.ServiceAreaTrait.LandmarkInfoStruct?

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