Interface User

interface User {
    clearCredential(request: DoorLock.ClearCredentialRequest): MaybePromise;
    clearUser(request: DoorLock.ClearUserRequest): MaybePromise;
    getCredentialStatus(request: DoorLock.GetCredentialStatusRequest): MaybePromise<DoorLock.GetCredentialStatusResponse>;
    getUser(request: DoorLock.GetUserRequest): MaybePromise<DoorLock.GetUserResponse>;
    setCredential(request: DoorLock.SetCredentialRequest): MaybePromise<DoorLock.SetCredentialResponse>;
    setUser(request: DoorLock.SetUserRequest): MaybePromise;
}

Methods

clearCredential clearUser getCredentialStatus getUser setCredential setUser

Methods

clearCredential

  • clearCredential(request): MaybePromise

  • Clear one, one type, or all credentials except ProgrammingPIN credential.

    Fields used for different use cases:

    For each credential cleared whose user doesn’t have another valid credential, the corresponding user record shall be reset back to default values and its UserStatus value shall be set to Available and UserType value shall be set to UnrestrictedUser and all schedules shall be cleared. In

    this case a LockUserChange event shall be generated for the user being cleared. Return status shall be one of the following values:

    Parameters

    Returns MaybePromise

    See

    MatterSpecification.v13.Cluster § 5.2.10.44

clearUser

  • clearUser(request): MaybePromise

  • Clears a user or all Users.

    For each user to clear, all associated credentials (e.g. PIN, RFID, fingerprint, etc.) shall be cleared and the user entry values shall be reset to their default values (e.g. UserStatus shall be Available, UserType shall be UnrestrictedUser) and all associated schedules shall be cleared.

    A LockUserChange event with the provided UserIndex shall be generated after successfully clearing users.

    Parameters

    Returns MaybePromise

    See

    MatterSpecification.v13.Cluster § 5.2.10.37

getCredentialStatus

getUser

setCredential

setUser

  • setUser(request): MaybePromise

  • Set user into the lock.

    Fields used for different use cases:

    Return status is a global status code or a cluster-specific status code from the Status Codes table and

    shall be one of the following values:

    • SUCCESS, if setting User was successful.

    • FAILURE, if some unexpected internal error occurred setting User.

    • OCCUPIED, if OperationType is Add and UserIndex points to an occupied slot.

    • INVALID_COMMAND, if one or more fields violate constraints or are invalid or if OperationType is Modify and UserIndex points to an available slot.

    Parameters

    Returns MaybePromise

    See

    MatterSpecification.v13.Cluster § 5.2.10.34

Settings

Member Visibility

On This Page

Methods