DoorLockTrait.SetUserCommand.Request

class DoorLockTrait.SetUserCommand.Request


The request payload for the SetUser command.

Summary

Public constructors

Request(
    operationType: DoorLockTrait.DataOperationTypeEnum,
    userIndex: UShort,
    userName: String?,
    userUniqueId: UInt?,
    userStatus: DoorLockTrait.UserStatusEnum?,
    userType: DoorLockTrait.UserTypeEnum?,
    credentialRule: DoorLockTrait.CredentialRuleEnum?
)

Creates a request payload for the SetUser command.

Public properties

DoorLockTrait.CredentialRuleEnum?

The credential rule.

DoorLockTrait.DataOperationTypeEnum

The operation to perform.

UShort

The unique identifier for the user to set on the lock.

String?

The user name of the user to set on the lock.

DoorLockTrait.UserStatusEnum?

The status of the user to set on the lock.

DoorLockTrait.UserTypeEnum?

The type of the user.

UInt?

The unique user id of the user to set on the lock.

Public constructors

Request

Request(
    operationType: DoorLockTrait.DataOperationTypeEnum = DataOperationTypeEnum.Add,
    userIndex: UShort,
    userName: String? = null,
    userUniqueId: UInt? = null,
    userStatus: DoorLockTrait.UserStatusEnum? = null,
    userType: DoorLockTrait.UserTypeEnum? = null,
    credentialRule: DoorLockTrait.CredentialRuleEnum? = null
)

Creates a request payload for the SetUser command.

Public properties

credentialRule

val credentialRuleDoorLockTrait.CredentialRuleEnum?

The credential rule. Valid values are defined by CredentialRuleEnum.

operationType

val operationTypeDoorLockTrait.DataOperationTypeEnum

The operation to perform. Valid values are defined by DataOperationTypeEnum.

userIndex

val userIndexUShort

The unique identifier for the user to set on the lock.

userName

val userNameString?

The user name of the user to set on the lock.

userStatus

val userStatusDoorLockTrait.UserStatusEnum?

The status of the user to set on the lock. Valid values are defined by UserStatusEnum.

userType

val userTypeDoorLockTrait.UserTypeEnum?

The type of the user. Valid values are defined by UserTypeEnum.

userUniqueId

val userUniqueIdUInt?

The unique user id of the user to set on the lock.