API Reference

Sections

Lock

autoRelockDelayInSecondsobject

Indicates amount of time, in seconds, that the lock waits before relocking when a credential is presented

Show child attributes

behaviorOnPowerFailureobject

Indicates the behavior that device will take upon loss of power.

Show child attributes

deadboltobject

Indicates whether the device has a deadbolt and what it's position is.

Show child attributes

eventPreferencesobject

Indicates whether device should opt in to publishing notifications to user for specific optional event scenarios.

Show child attributes

functionobject

Indicates the currently set lock function (e.g. Office).

Show child attributes

indicatorBlinksWhenLockedobject

Indicates behavior of interior LED indicator light when device is in locked securedState.

Show child attributes

interiorPushButtonobject

Indicates if devices has an interior push button and what its activation state is.

Show child attributes

isLockedboolean

When true, device is locked.

modeobject

Deprecated: Use lock.state field.

Show child attributes

stateobject

Indicates the current lock state of the device which is used to determine device behavior when credentials and events occur at the device. Refer to published device documentation for expected device behavior for each state use case.

Show child attributes

{
  "autoRelockDelayInSeconds": {
    "extendedUnlock": null,
    "standardUnlock": null
  },
  "behaviorOnPowerFailure": {
    "willLock": false,
    "willRemainAsIs": false,
    "willUnlock": false
  },
  "deadbolt": {
    "position": {
      "isExtended": false,
      "isJammed": false,
      "isRetracted": false
    }
  },
  "eventPreferences": {
    "publishKeyOverrideEvents": false,
    "publishUnauthorizedUserEvents": false
  },
  "function": {
    "isApartment": false,
    "isManualThrowApartment": false,
    "isOffice": false,
    "isPrivacy": false,
    "isStoreroom": false
  },
  "indicatorBlinksWhenLocked": {
    "blinkSpeed": {
      "isNormal": false,
      "isRapid": false
    },
    "isEnabled": false
  },
  "interiorPushButton": {
    "isActivated": false
  },
  "isLocked": false,
  "mode": {
    "isFrozen": false,
    "isHolidayRestricted": false,
    "isPrivacySecured": false,
    "isStandard": false
  },
  "state": {
    "isFrozenNormal": false,
    "isFrozenPassage": false,
    "isFrozenSecured": false,
    "isHolidayRestricted": false,
    "isMomentaryUnlocked": false,
    "isPassage": false,
    "isPrivacySecured": false,
    "isSecured": false
  }
}

Sections

Lock

LockExpand all

Lock