Interface SetUserRequest

Input to the DoorLock setUser command

See

MatterSpecification.v13.Cluster § 5.2.10.34

interface SetUserRequest {
    credentialRule: null | DoorLock.CredentialRule;
    operationType: DoorLock.DataOperationType;
    userIndex: number;
    userName: null | string;
    userStatus: null | DoorLock.UserStatus;
    userType: null | DoorLock.UserType;
    userUniqueId: null | number;
}

Hierarchy (view full)

Properties

credentialRule operationType userIndex userName userStatus userType userUniqueId

Properties

credentialRule

credentialRule: null | DoorLock.CredentialRule

This field shall indicate the CredentialRule to use for this user.

The valid CredentialRule enumeration values depends on the bits in the CredentialRulesBitmap map. Each bit in the map identifies a valid CredentialRule that can be used.

If CredentialRule is null then:

• If the OperationType is Add, the CredentialRule in the resulting user record shall be set to default value specified above.

• If the OperationType is Modify, the CredentialRule in the user record shall NOT be changed from the current value.

If CredentialRule is not null, the CredentialRule in the user record shall be set to the provided value.

See

MatterSpecification.v13.Cluster § 5.2.10.34.7

operationType

operationType: DoorLock.DataOperationType

This field shall indicate the type of operation.

See

MatterSpecification.v13.Cluster § 5.2.10.34.1

userIndex

userIndex: number

This field shall indicate the user ID.

See

MatterSpecification.v13.Cluster § 5.2.10.34.2

userName

userName: null | string

This field shall contain a string to use as a human readable identifier for the user. If UserName is null then:

• If the OperationType is Add, the UserName in the resulting user record shall be set to an empty string.

• If the OperationType is Modify, the UserName in the user record shall NOT be changed from the current value.

If UserName is not null, the UserName in the user record shall be set to the provided value.

See

MatterSpecification.v13.Cluster § 5.2.10.34.3

userStatus

userStatus: null | DoorLock.UserStatus

This field shall indicate the UserStatus to assign to this user when created or modified. If UserStatus is null then:

• If the OperationType is Add, the UserStatus in the resulting user record shall be set to default value specified above.

• If the OperationType is Modify, the UserStatus in the user record shall NOT be changed from the current value.

If UserStatus is not null, the UserStatus in the user record shall be set to the provided value.

See

MatterSpecification.v13.Cluster § 5.2.10.34.5

userType

userType: null | DoorLock.UserType

This field shall indicate the UserType to assign to this user when created or modified. If UserType is null then:

• If the OperationType is Add, the UserType in the resulting user record shall be set to default value specified above.

• If the OperationType is Modify, the UserType in the user record shall NOT be changed from the current value.

If UserType is not null, the UserType in the user record shall be set to the provided value.

See

MatterSpecification.v13.Cluster § 5.2.10.34.6

userUniqueId

userUniqueId: null | number

This field shall indicate the fabric assigned number to use for connecting this user to other users on other devices from the fabric’s perspective.

If UserUniqueID is null then:

• If the OperationType is Add, the UserUniqueID in the resulting user record shall be set to default value specified above.

• If the OperationType is Modify, the UserUniqueID in the user record shall NOT be changed from the current value.

If UserUniqueID is not null, the UserUniqueID in the user record shall be set to the provided value.

See

MatterSpecification.v13.Cluster § 5.2.10.34.4

Settings

Member Visibility

On This Page

Properties