DoorLockTrait.SetCredentialCommand.Response

class DoorLockTrait.SetCredentialCommand.Response : ClusterStruct


The status for setting the specified credential.

Summary

Nested types

Descriptor enum for this command's request fields.

Public constructors

Response(
    status: DoorLockTrait.DlStatus,
    userIndex: UShort?,
    nextCredentialIndex: UShort?
)

Creates a response payload from the SetCredential command.

Public functions

open StructDescriptor

Returns the descriptor for the struct.

open Any?

Returns the value of the field for the given tag ID.

Public properties

UShort?

The next available index in the database for the credential type set, which is useful for quickly identifying available credential slots in the database.

DoorLockTrait.DlStatus

The status of the SetCredential command.

UShort?

The user index that was created with the new credential.

Public constructors

Response

Response(
    status: DoorLockTrait.DlStatus = DlStatus.Success,
    userIndex: UShort? = null,
    nextCredentialIndex: UShort? = null
)

Creates a response payload from the SetCredential command.

Public functions

getDescriptor

@HomeExperimentalApi
open fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

getFieldValueById

@HomeExperimentalApi
open fun getFieldValueById(tagId: UInt): Any?

Returns the value of the field for the given tag ID.

Public properties

nextCredentialIndex

val nextCredentialIndexUShort?

The next available index in the database for the credential type set, which is useful for quickly identifying available credential slots in the database.

status

val statusDoorLockTrait.DlStatus

The status of the SetCredential command.

userIndex

val userIndexUShort?

The user index that was created with the new credential.