Interface GetUserResponse

Returns the user for the specified UserIndex.

If the requested UserIndex is valid and the UserStatus is Available for the requested UserIndex then UserName, UserUniqueID, UserStatus, UserType, CredentialRule, Credentials, CreatorFabricIndex, and LastModifiedFabricIndex shall all be null in the response.

See

MatterSpecification.v13.Cluster § 5.2.10.36

interface GetUserResponse {
    creatorFabricIndex: null | FabricIndex;
    credentialRule: null | DoorLock.CredentialRule;
    credentials: null | TypeFromFields<{
        credentialIndex: FieldType<number>;
        credentialType: FieldType<DoorLock.CredentialType>;
    }>[];
    lastModifiedFabricIndex: null | FabricIndex;
    nextUserIndex: null | number;
    userIndex: number;
    userName: null | string;
    userStatus: null | DoorLock.UserStatus;
    userType: null | DoorLock.UserType;
    userUniqueId: null | number;
}

Hierarchy (view full)

Properties

creatorFabricIndex credentialRule credentials lastModifiedFabricIndex nextUserIndex userIndex userName userStatus userType userUniqueId

Properties

creatorFabricIndex

creatorFabricIndex: null | FabricIndex

This field shall indicate the user’s creator fabric index. CreatorFabricIndex shall be null if UserStatus is set to Available or when the creator fabric cannot be determined (for example, when user was created outside the Interaction Model) and shall NOT be null otherwise. This value shall be set to 0 if the original creator fabric was deleted.

See

MatterSpecification.v13.Cluster § 5.2.10.36.8

credentialRule

credentialRule: null | DoorLock.CredentialRule

This field shall indicate the CredentialRule set for this user.

See

MatterSpecification.v13.Cluster § 5.2.10.36.6

credentials

credentials: null | TypeFromFields<{
    credentialIndex: FieldType<number>;
    credentialType: FieldType<DoorLock.CredentialType>;
}>[]

This field shall contain a list of credentials for this user.

See

MatterSpecification.v13.Cluster § 5.2.10.36.7

lastModifiedFabricIndex

lastModifiedFabricIndex: null | FabricIndex

This field shall indicate the user’s last modifier fabric index. LastModifiedFabricIndex shall be null if UserStatus is set to Available or when the modifier fabric cannot be determined (for example, when user was modified outside the Interaction Model) and shall NOT be null otherwise. This value shall be set to 0 if the last modifier fabric was deleted.

See

MatterSpecification.v13.Cluster § 5.2.10.36.9

nextUserIndex

nextUserIndex: null | number

This field shall indicate the next occupied UserIndex in the database which is useful for quickly identifying occupied user slots in the database. This shall NOT be null if there is at least one occupied entry after the requested UserIndex in the User database and shall be null if there are no more occupied entries.

See

MatterSpecification.v13.Cluster § 5.2.10.36.10

userIndex

userIndex: number

This field shall indicate the user ID.

See

MatterSpecification.v13.Cluster § 5.2.10.36.1

userName

userName: null | string

This field shall contain a string to use as a human readable identifier for the user.

See

MatterSpecification.v13.Cluster § 5.2.10.36.2

userStatus

userStatus: null | DoorLock.UserStatus

This field shall indicate the UserStatus assigned to the user when created or modified.

See

MatterSpecification.v13.Cluster § 5.2.10.36.4

userType

userType: null | DoorLock.UserType

This field shall indicate the UserType assigned to this user when created or modified.

See

MatterSpecification.v13.Cluster § 5.2.10.36.5

userUniqueId

userUniqueId: null | number

See UserUniqueID field.

See

MatterSpecification.v13.Cluster § 5.2.10.36.3

Settings

Member Visibility

On This Page

Properties