LockUnlock

@Generated(value = ["GoogleHomePlatformCodegen"])
interface LockUnlock : LockUnlockTrait.Attributes, MatterTrait, LockUnlockCommands

API for the LockUnlock trait. This trait belongs to any devices that support locking and unlocking, or reporting a locked state, except door locks, which are covered by the Matter standard DoorLock cluster.

Summary

Nested types

Descriptor enum for this trait's attributes.

Descriptor enum for this trait's commands.

Public functions
Boolean
Boolean

Public properties
open TraitFactory<LockUnlock>

Inherited functions
From com.google.home.google.LockUnlockCommands
suspend Unit
lock(followUpToken: String)

Lock the device.
BatchableCommand<Unit>
lockBatchable(followUpToken: String)

The batchable version of lock command.
suspend Unit
unlock(followUpToken: String)

Unlock the device.
BatchableCommand<Unit>
unlockBatchable(followUpToken: String)

The batchable version of unlock command.
From com.google.home.TraitStateInvalidation
suspend Unit

Inherited properties
From com.google.home.google.LockUnlockTrait.Attributes
List<UInt>

A list of client-generated commands which are supported by this cluster server instance.
List<UInt>

A list of the attribute IDs of the attributes supported by the cluster instance.
UShort

The revision of the server cluster specification supported by the cluster instance.
UInt

Whether the server supports zero or more optional cluster features.
List<UInt>

A list of server-generated commands (server to client) which are supported by this cluster server instance.
LockUnlockTrait.LockState?

The current lock state of the device.
From com.google.home.Trait
Trait.TraitMetadata

Public functions

supports

fun supports(attribute: LockUnlock.Attribute): Boolean

supports

fun supports(command: LockUnlock.Command): Boolean

Public properties

factory

open val factory: TraitFactory<LockUnlock>