Console

AreaStruct 

struct AreaStruct

Data about an area known to the server.

  • The identifier of the area.

    Declaration

    Swift

    let areaID: UInt32

  • The map identifier which the area is associated with. A value of null indicates that the area is not associated with a map. If the supportedMaps attribute is not empty, this field matches the MapID field of an entry from the supportedMaps attribute’s list. If the supportedMaps attribute is empty, this field is null.

    Declaration

    Swift

    let mapID: UInt32?

  • Data describing the area. This field is used by clients to determine the name or the semantics of a certain area.

    Declaration

    Swift

    let areaInfo: Matter.ServiceAreaTrait.AreaInfoStruct

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