Console

CredentialStruct 

struct CredentialStruct

A set of credentials used when operating the door lock.

  • The type of credentials, as enumerated by CredentialTypeEnum.

    Declaration

    Swift

    let credentialType: Matter.DoorLockTrait.CredentialTypeEnum

  • The unique identifier for the credentials.

    Declaration

    Swift

    let credentialIndex: UInt16

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