DoorLockTrait

@Generated(value = ["GoogleHomePlatformCodegen"])
object DoorLockTrait

Attributes for DoorLockTrait.

Summary

Nested types
`enum DoorLockTrait.AlarmCodeEnum : Enum, ClusterEnum` Alarm codes.
`@Generated(value = ["GoogleHomePlatformCodegen"]) interface DoorLockTrait.Attributes : ClusterStruct` Attributes for the DoorLock cluster.
`object DoorLockTrait.ClearAliroReaderConfigCommand : CommandDescriptor`
`class DoorLockTrait.ClearAliroReaderConfigCommand.Request : ClusterStruct`
`@HomeExperimentalApi enum DoorLockTrait.ClearAliroReaderConfigCommand.Request.CommandFields : Enum, Field` Descriptor enum for this command's request fields.
`object DoorLockTrait.ClearCredentialCommand : CommandDescriptor` Clear a single credential, one type of credential, or all credentials except `ProgrammingPIN` credentials.
`class DoorLockTrait.ClearCredentialCommand.Request : ClusterStruct` The request payload for the ClearCredential command.
`@HomeExperimentalApi enum DoorLockTrait.ClearCredentialCommand.Request.CommandFields : Enum, Field` Descriptor enum for this command's request fields.
`object DoorLockTrait.ClearHolidayScheduleCommand : CommandDescriptor` Clear the specified holiday schedule, or all holiday schedules.
`class DoorLockTrait.ClearHolidayScheduleCommand.Request : ClusterStruct` The request payload for the ClearHolidaySchedule command.
`@HomeExperimentalApi enum DoorLockTrait.ClearHolidayScheduleCommand.Request.CommandFields : Enum, Field` Descriptor enum for this command's request fields.
`object DoorLockTrait.ClearUserCommand : CommandDescriptor` Clear the specified user.
`class DoorLockTrait.ClearUserCommand.Request : ClusterStruct` The request payload for the ClearUser command.
`@HomeExperimentalApi enum DoorLockTrait.ClearUserCommand.Request.CommandFields : Enum, Field` Descriptor enum for this command's request fields.
`object DoorLockTrait.ClearWeekDayScheduleCommand : CommandDescriptor` Clear the specified week day schedule or all week day schedules for the specific user.
`class DoorLockTrait.ClearWeekDayScheduleCommand.Request : ClusterStruct` The request payload for the ClearWeekDaySchedule command.
`@HomeExperimentalApi enum DoorLockTrait.ClearWeekDayScheduleCommand.Request.CommandFields : Enum, Field` Descriptor enum for this command's request fields.
`object DoorLockTrait.ClearYearDayScheduleCommand : CommandDescriptor` Clear the specified year day schedule, or all year day schedules for the specific user.
`class DoorLockTrait.ClearYearDayScheduleCommand.Request : ClusterStruct` The request payload for the ClearYearDaySchedule command.
`@HomeExperimentalApi enum DoorLockTrait.ClearYearDayScheduleCommand.Request.CommandFields : Enum, Field` Descriptor enum for this command's request fields.
`enum DoorLockTrait.CredentialRuleEnum : Enum, ClusterEnum` Indicates the credential rule that can be applied to a particular user.
`class DoorLockTrait.CredentialStruct : ClusterStruct` A set of credentials used when operating the door lock.
`@HomeExperimentalApi enum DoorLockTrait.CredentialStruct.StructFields : Enum, Field` Descriptor enum for this struct's fields.
`enum DoorLockTrait.CredentialTypeEnum : Enum, ClusterEnum` Indicates the credential type.
`enum DoorLockTrait.DataOperationTypeEnum : Enum, ClusterEnum` Indicates the data operation performed.
`data class DoorLockTrait.DaysMaskMap` The days of the week.
`data class DoorLockTrait.DlCredentialRuleMask` Credential rules.
`data class DoorLockTrait.DlCredentialRulesSupport` Credential rules.
`data class DoorLockTrait.DlDefaultConfigurationRegister` The default configurations as they are physically set on the device.
`data class DoorLockTrait.DlKeypadOperationEventMask` Event mask used to enable and disable the transmission of keypad operation events.
`data class DoorLockTrait.DlKeypadProgrammingEventMask` Event mask used to enable and disable keypad programming events.
`data class DoorLockTrait.DlLocalProgrammingFeatures` The local programming features that are disabled when the `enableLocalProgramming` attribute is set to `false`.
`enum DoorLockTrait.DlLockState : Enum, ClusterEnum` Door lock states.
`enum DoorLockTrait.DlLockType : Enum, ClusterEnum` Lock types.
`data class DoorLockTrait.DlManualOperationEventMask` Manual operation events.
`data class DoorLockTrait.DlRemoteOperationEventMask` Event mask used to enable and disable the transmission of remote operation events.
`data class DoorLockTrait.DlRemoteProgrammingEventMask` Event mask used to enable and disable remote programming events.
`data class DoorLockTrait.DlRfidOperationEventMask` Event mask used to enable and disable the transmission of RFID events.
`data class DoorLockTrait.DlRfidProgrammingEventMask` Event mask used to enable and disable RFID programming events.
`enum DoorLockTrait.DlStatus : Enum, ClusterEnum` Door lock statuses.
`data class DoorLockTrait.DlSupportedOperatingModes` This bitmap contains all operating bits of the Operating Mode Attribute supported by the lock.
`interface DoorLockTrait.DoorLockAlarm : ClusterStruct` Indicates that there is a critical state on the door lock.
`data class DoorLockTrait.DoorLockDayOfWeek` Days of the week.
`enum DoorLockTrait.DoorLockOperationEventCode : Enum, ClusterEnum` Door lock operation event codes.
`enum DoorLockTrait.DoorLockProgrammingEventCode : Enum, ClusterEnum` Door lock programming event codes.
`enum DoorLockTrait.DoorLockSetPinOrIdStatus : Enum, ClusterEnum` Door lock credential status.
`enum DoorLockTrait.DoorLockUserStatus : Enum, ClusterEnum` The status for a specific user.
`enum DoorLockTrait.DoorLockUserType : Enum, ClusterEnum` The type for a specific user.
`interface DoorLockTrait.DoorStateChange : ClusterStruct` Indicates that the state of the door has changed.
`enum DoorLockTrait.DoorStateEnum : Enum, ClusterEnum` Door states.
`data class DoorLockTrait.Feature` DoorLock cluster FeatureMap.
`object DoorLockTrait.GetCredentialStatusCommand : CommandDescriptor` Retrieve the status of the specified credential.
`class DoorLockTrait.GetCredentialStatusCommand.Request : ClusterStruct` The request payload for the GetCredentialStatus command.
`@HomeExperimentalApi enum DoorLockTrait.GetCredentialStatusCommand.Request.CommandFields : Enum, Field` Descriptor enum for this command's request fields.
`class DoorLockTrait.GetCredentialStatusCommand.Response : ClusterStruct` Returns the status for the specified credential.
`@HomeExperimentalApi enum DoorLockTrait.GetCredentialStatusCommand.Response.CommandFields : Enum, Field` Descriptor enum for this command's request fields.
`object DoorLockTrait.GetHolidayScheduleCommand : CommandDescriptor` Get the holiday schedule for the specified holiday index.
`class DoorLockTrait.GetHolidayScheduleCommand.Request : ClusterStruct` The request payload for the GetHolidaySchedule command.
`@HomeExperimentalApi enum DoorLockTrait.GetHolidayScheduleCommand.Request.CommandFields : Enum, Field` Descriptor enum for this command's request fields.
`class DoorLockTrait.GetHolidayScheduleCommand.Response : ClusterStruct` Returns the holiday schedule entry for the specified holiday ID.
`@HomeExperimentalApi enum DoorLockTrait.GetHolidayScheduleCommand.Response.CommandFields : Enum, Field` Descriptor enum for this command's request fields.
`object DoorLockTrait.GetUserCommand : CommandDescriptor` Retrieve the user type for a specific user.
`class DoorLockTrait.GetUserCommand.Request : ClusterStruct` The request payload for the GetUser command.
`@HomeExperimentalApi enum DoorLockTrait.GetUserCommand.Request.CommandFields : Enum, Field` Descriptor enum for this command's request fields.
`class DoorLockTrait.GetUserCommand.Response : ClusterStruct` Returns the user for the specified `userIndex`.
`@HomeExperimentalApi enum DoorLockTrait.GetUserCommand.Response.CommandFields : Enum, Field` Descriptor enum for this command's request fields.
`object DoorLockTrait.GetWeekDayScheduleCommand : CommandDescriptor` Retrieve the weekly schedule for the specified user.
`class DoorLockTrait.GetWeekDayScheduleCommand.Request : ClusterStruct` The request payload for the GetWeekDaySchedule command.
`@HomeExperimentalApi enum DoorLockTrait.GetWeekDayScheduleCommand.Request.CommandFields : Enum, Field` Descriptor enum for this command's request fields.
`class DoorLockTrait.GetWeekDayScheduleCommand.Response : ClusterStruct` Returns the weekly repeating schedule data for the specified schedule index.
`@HomeExperimentalApi enum DoorLockTrait.GetWeekDayScheduleCommand.Response.CommandFields : Enum, Field` Descriptor enum for this command's request fields.
`object DoorLockTrait.GetYearDayScheduleCommand : CommandDescriptor` Retrieve the specified year day schedule for the specified user.
`class DoorLockTrait.GetYearDayScheduleCommand.Request : ClusterStruct` The request payload for the GetYearDaySchedule command.
`@HomeExperimentalApi enum DoorLockTrait.GetYearDayScheduleCommand.Request.CommandFields : Enum, Field` Descriptor enum for this command's request fields.
`class DoorLockTrait.GetYearDayScheduleCommand.Response : ClusterStruct` Returns the year day schedule data for the specified schedule and user indexes.
`@HomeExperimentalApi enum DoorLockTrait.GetYearDayScheduleCommand.Response.CommandFields : Enum, Field` Descriptor enum for this command's request fields.
`enum DoorLockTrait.LockDataTypeEnum : Enum, ClusterEnum` Data types associated with door locks.
`object DoorLockTrait.LockDoorCommand : CommandDescriptor` Lock the door.
`interface DoorLockTrait.LockDoorCommand.OptionalArgs` Optional arguments for the command LockDoorCommand Request
`class DoorLockTrait.LockDoorCommand.Request : ClusterStruct` The request payload for the LockDoor command.
`@HomeExperimentalApi enum DoorLockTrait.LockDoorCommand.Request.CommandFields : Enum, Field` Descriptor enum for this command's request fields.
`interface DoorLockTrait.LockOperation : ClusterStruct` Indicates that a lock operation has taken place.
`interface DoorLockTrait.LockOperationError : ClusterStruct` Indicates that a lock operation failed.
`enum DoorLockTrait.LockOperationTypeEnum : Enum, ClusterEnum` The type of Lock operation performed.
`interface DoorLockTrait.LockUserChange : ClusterStruct` Indicates that a lock user, schedule, or credential has changed.
`enum DoorLockTrait.OperatingModeEnum : Enum, ClusterEnum` Operating modes.
`enum DoorLockTrait.OperationErrorEnum : Enum, ClusterEnum` Indicates the cause of the Lock or Unlock operation failure.
`enum DoorLockTrait.OperationSourceEnum : Enum, ClusterEnum` Indicates the source of the Lock or Unlock operation.
`object DoorLockTrait.SetAliroReaderConfigCommand : CommandDescriptor`
`interface DoorLockTrait.SetAliroReaderConfigCommand.OptionalArgs` Optional arguments for the command SetAliroReaderConfigCommand Request
`class DoorLockTrait.SetAliroReaderConfigCommand.Request : ClusterStruct`
`@HomeExperimentalApi enum DoorLockTrait.SetAliroReaderConfigCommand.Request.CommandFields : Enum, Field` Descriptor enum for this command's request fields.
`object DoorLockTrait.SetCredentialCommand : CommandDescriptor` Set a credential into the lock for a new or existing user, or for a programming user.
`class DoorLockTrait.SetCredentialCommand.Request : ClusterStruct` The request payload for the SetCredential command.
`@HomeExperimentalApi enum DoorLockTrait.SetCredentialCommand.Request.CommandFields : Enum, Field` Descriptor enum for this command's request fields.
`class DoorLockTrait.SetCredentialCommand.Response : ClusterStruct` The status for setting the specified credential.
`@HomeExperimentalApi enum DoorLockTrait.SetCredentialCommand.Response.CommandFields : Enum, Field` Descriptor enum for this command's request fields.
`object DoorLockTrait.SetHolidayScheduleCommand : CommandDescriptor` Set the holiday schedule by specifying the local start and end time with respect to a specific lock operating mode.
`class DoorLockTrait.SetHolidayScheduleCommand.Request : ClusterStruct` The request payload for the SetHolidaySchedule command.
`@HomeExperimentalApi enum DoorLockTrait.SetHolidayScheduleCommand.Request.CommandFields : Enum, Field` Descriptor enum for this command's request fields.
`object DoorLockTrait.SetUserCommand : CommandDescriptor` Set the user on the lock.
`class DoorLockTrait.SetUserCommand.Request : ClusterStruct` The request payload for the SetUser command.
`@HomeExperimentalApi enum DoorLockTrait.SetUserCommand.Request.CommandFields : Enum, Field` Descriptor enum for this command's request fields.
`object DoorLockTrait.SetWeekDayScheduleCommand : CommandDescriptor` Set a weekly repeating schedule for the specified user.
`class DoorLockTrait.SetWeekDayScheduleCommand.Request : ClusterStruct` The request payload for the SetWeekDaySchedule command.
`@HomeExperimentalApi enum DoorLockTrait.SetWeekDayScheduleCommand.Request.CommandFields : Enum, Field` Descriptor enum for this command's request fields.
`object DoorLockTrait.SetYearDayScheduleCommand : CommandDescriptor` Set a time-specific schedule ID for a specified user.
`class DoorLockTrait.SetYearDayScheduleCommand.Request : ClusterStruct` The request payload for the SetYearDaySchedule command.
`@HomeExperimentalApi enum DoorLockTrait.SetYearDayScheduleCommand.Request.CommandFields : Enum, Field` Descriptor enum for this command's request fields.
`object DoorLockTrait.UnboltDoorCommand : CommandDescriptor` Disengage the deadbolt.
`interface DoorLockTrait.UnboltDoorCommand.OptionalArgs` Optional arguments for the command UnboltDoorCommand Request
`class DoorLockTrait.UnboltDoorCommand.Request : ClusterStruct` The request payload for the UnboltDoor command.
`@HomeExperimentalApi enum DoorLockTrait.UnboltDoorCommand.Request.CommandFields : Enum, Field` Descriptor enum for this command's request fields.
`object DoorLockTrait.UnlockDoorCommand : CommandDescriptor` Unlock the door.
`interface DoorLockTrait.UnlockDoorCommand.OptionalArgs` Optional arguments for the command UnlockDoorCommand Request
`class DoorLockTrait.UnlockDoorCommand.Request : ClusterStruct` The request payload for the UnlockDoor command.
`@HomeExperimentalApi enum DoorLockTrait.UnlockDoorCommand.Request.CommandFields : Enum, Field` Descriptor enum for this command's request fields.
`object DoorLockTrait.UnlockWithTimeoutCommand : CommandDescriptor` Unlock the door with a timeout parameter.
`interface DoorLockTrait.UnlockWithTimeoutCommand.OptionalArgs` Optional arguments for the command UnlockWithTimeoutCommand Request
`class DoorLockTrait.UnlockWithTimeoutCommand.Request : ClusterStruct` The request payload for the UnlockWithTimeout command.
`@HomeExperimentalApi enum DoorLockTrait.UnlockWithTimeoutCommand.Request.CommandFields : Enum, Field` Descriptor enum for this command's request fields.
`enum DoorLockTrait.UserStatusEnum : Enum, ClusterEnum` The status for a specific user.
`enum DoorLockTrait.UserTypeEnum : Enum, ClusterEnum` The type of a specific user.

Public properties
`ClusterId`	`Id`

Public properties

Id

val Id: ClusterId

DoorLockTrait

Summary

Nested types

Public properties

Public properties

Id