Interface GetCredentialStatusRequest

Input to the DoorLock getCredentialStatus command

See

MatterSpecification.v13.Cluster § 5.2.10.42

interface GetCredentialStatusRequest {
    credential: TypeFromFields<{
        credentialIndex: FieldType<number>;
        credentialType: FieldType<DoorLock.CredentialType>;
    }>;
}

Hierarchy (view full)

Properties

credential

Properties

credential

credential: TypeFromFields<{
    credentialIndex: FieldType<number>;
    credentialType: FieldType<DoorLock.CredentialType>;
}>

This field shall contain a credential structure that contains the CredentialTypeEnum and the credential index (if applicable or 0 if not) to retrieve the status for.

Type declaration

  • credentialIndex: FieldType<number>

    This field shall indicate the index of the specific credential used to authorize the lock operation in the list of credentials identified by CredentialType (e.g. PIN, RFID, etc.). This field shall be set to 0 if CredentialType is ProgrammingPIN or does not correspond to a list that can be indexed into.

    See

    MatterSpecification.v13.Cluster § 5.2.6.26.2

  • credentialType: FieldType<DoorLock.CredentialType>

    This field shall indicate the credential field used to authorize the lock operation.

    See

    MatterSpecification.v13.Cluster § 5.2.6.26.1

See

MatterSpecification.v13.Cluster § 5.2.10.42.1

Settings

Member Visibility

On This Page

Properties