//MLBluetoothSDK/com.masterlock.mlbluetoothsdk.lockstate/MechanismStateOptions
MechanismStateOptions¶
[androidJvm]\ enum MechanismStateOptions : Enum<MechanismStateOptions>
Enumeration of possible locking mechanism states
Entries¶
| Unknown | [androidJvm] Unknown The state of the locking mechanism has not been read, or the mechanism’s Lock is no longer visible to the BLE scanner |
| Locked | [androidJvm] Locked The locking mechanism has most recently been read returning a locked state |
| PendingUnlock | [androidJvm] PendingUnlock An Unlock command has been issued to this mechanism |
| Open | [androidJvm] Open The locking mechanism has most recently been read returning an open state, the mechanism is also Unlocked in this state |
| Unlocked | [androidJvm] Unlocked The locking mechanism has most recently been read returning an unlocked state |
| PendingRelock | [androidJvm] PendingRelock A Relock command has been issued to this lock (Currently deadbolt only) |
| OpenLocked | [androidJvm] OpenLocked The locking mechanism has most recently been read returning an open state, the mechanism is also Locked in this state |
Properties¶
| Name | Summary |
|---|---|
| entries | [androidJvm] val entries: EnumEntries<MechanismStateOptions> Returns a representation of an immutable list of all enum entries, in the order they’re declared. |
Functions¶
| Name | Summary |
|---|---|
| valueOf | [androidJvm] fun valueOf(value: String): MechanismStateOptions Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.) |
| values | [androidJvm] fun values(): Array<MechanismStateOptions> Returns an array containing the constants of this enum type, in the order they’re declared. |