//MLBluetoothSDK/com.masterlock.mlbluetoothsdk.lockstate/LockState

LockState

[androidJvm]\ class LockState(val visibility: Visibility, val primary: MechanismState, val secondary: MechanismState, val keypadActive: Boolean, val isTampered: Boolean, val isJammed: Boolean)

the LockState Represents the State of the Lock and its component locking MechanismState(s). Most locks have only one mechanism (e.g. the shackle on a padlock, the open switch on a door controller, the door on a wall mounted lockbox, the bolt on a deadbolt)

A Portable Lock Box has two: the door on a is primary and the removable shackle is secondary. For devices that only have one MechanismState secondary will always have a MechanismState of ‘Unknown’. Devices that support tamper and jammed sensors (i.e. deadbolt) also will update this state with isTampered and isJammed properties.

Constructors

LockState	[androidJvm] constructor(visibility: Visibility, primary: MechanismState, secondary: MechanismState, keypadActive: Boolean, isTampered: Boolean, isJammed: Boolean)

Properties

Name	Summary
isJammed	[androidJvm] val isJammed: Boolean
isTampered	[androidJvm] val isTampered: Boolean
keypadActive	[androidJvm] val keypadActive: Boolean
primary	[androidJvm] val primary: MechanismState
secondary	[androidJvm] val secondary: MechanismState
visibility	[androidJvm] val visibility: Visibility

Functions

Name	Summary
equals	[androidJvm] open operator override fun equals(other: Any?): Boolean
hashCode	[androidJvm] open override fun hashCode(): Int
isVisible	[androidJvm] fun isVisible(): Boolean returns true if the lock is inferred to be available for SDK interactions based on Lock advertising broadcasts and previous SDK interactions with the lock