API Reference

LockActions

disableIndicatorBlinkingWhenLockedobject

Sets interior LED Indicator to not blink when device is in locked securedState.

Show child attributes

disablePublishingKeyOverrideEventsobject

Device should not publish optional notification when device is manually unlocked using a mechancial key.

Show child attributes

disablePublishingUnauthorizedUserEventsobject

Device should not publish optional notification when an unauthorized credential is presented to the device and rejected.

Show child attributes

enableIndicatorBlinkingWhenLockedAndSetBlinkSpeedToNormalobject

Sets interior LED Indicator to blink at normal speed when device is in locked securedState.

Show child attributes

enableIndicatorBlinkingWhenLockedAndSetBlinkSpeedToRapidobject

Sets interior LED Indicator to blink at rapid speed when device is in locked securedState.

Show child attributes

enablePublishingKeyOverrideEventsobject

Device should publish optional notification when device is manually unlocked using a mechancial key.

Show child attributes

enablePublishingUnauthorizedUserEventsobject

Device should publish optional notification when an unauthorized credential is presented to the device and rejected.

Show child attributes

setBehaviorOnPowerFailureToRemainAsIsobject

Set device power fail mode such that upon loss of power, device will remain in its current securedState.

Show child attributes

setBehaviorOnPowerFailureToWillLockobject

Set device power fail mode such that upon loss of power, when unlocked, device will automatically change to locked securedState.

Show child attributes

setBehaviorOnPowerFailureToWillUnlockobject

Set device power fail mode such that upon loss of power, when unlocked, device will automatically change to unlocked securedState.

Show child attributes

setFunctionToApartmentobject

Sets lockFunction to Apartment. Upon completion of action, device will behave as follows: Device is normally secure. Inside trim always allows free egress. Inside push button or thumbturn may be used to select a passage or secured status. Opening the door, pressing the inside push button, or turning the thumbturn causes the device to toggle unsecured. While toggled unsecured, the device can only be secured while the door is closed by pressing the interior push button, turning the thumb...

Show child attributes

setFunctionToOfficeobject

Sets lockFunction to Office. Upon completion of action, device will behave as follows: Device is normally secure. Inside trim always allows free egress. Interior push button may be used to select a passage or secured status. Meets need for lockdown function for safety and security. NOTE: Valid toggle credentials on the exterior may also be used to change status.

Show child attributes

setFunctionToPrivacyobject

Sets lockFunction to Privacy. Upon completion of action, device will behave as follows: Device is normally secure. Inside trim always allows free egress. Interior push button or thumbturn may be used to select a privacy status. The interior push button will disable normal electronic access from the exterior. Opening the door, pressing the interior push button a second time, or turning the thumbturn deactivates the privacy status.

Show child attributes

setFunctionToStoreroomobject

Sets lockFunction to Storeroom. Upon completion of action, device will behave as follows: Device is normally secure. Inside trim always allows free egress. Valid toggle credentials on the exterior may be used to change to a passage or secured status.

Show child attributes

setRelockDelayInSecondsForExtendedUnlockobject

Sets the amount of time in seconds that the lock waits before relocking when device is unlocked with an extendedMomentary unlockedMode.

Show child attributes

setRelockDelayInSecondsForStandardUnlockobject

Sets the amount of time in seconds that the lock waits before relocking when device is unlocked with a normalMomentary unlockedMode.

Show child attributes

simulateFreezeCredentialPresentedAtDeviceobject

Initiate device behavior as if a valid FREEZE credential were presented to device.

Standard mode behavior: Device is put into frozen mode, but does not change securedState.
Frozen mode behavior: Device is put into normal mode, but does not change securedState.
Holiday Restricted mode behavior: Device is put into normal mode, but does not change securedState.
Privacy Secured mode behavior: No device change.

Show child attributes

simulateLockDownCredentialPresentedAtDeviceobject

Initiate device behavior as if a valid LOCKDOWN credential were presented to device.

Standard mode behavior: Locks device and puts in frozen mode.
Frozen mode behavior: No device change.
Holiday Restricted mode behavior: Locks device and puts in frozen mode.
Privacy Secured mode behavior: Locks device and puts in frozen mode.

Show child attributes

simulateNormalCredentialPresentedAtDeviceobject

Initiate device behavior as if a valid NORMAL credential were presented to device. Standard mode behavior: Momentarily unlocks device. Device will relock in amount of time defined by lock.autoRelockDelayInSeconds.standardCredential value. Frozen mode behavior: No device change. Holiday Restricted mode behavior: No device change. Privacy Secured mode behavior: No device change.

Show child attributes

simulateNormalExtendedCredentialPresentedAtDeviceobject

Initiate device behavior as if a valid NORMAL_EXTENDED credential were presented to device.

Standard mode behavior: Momentarily unlocks device. Device will relock in amount of time defined by lock.autoRelockDelayInSeconds.extendedCredential value.
Frozen mode behavior: No device change.
Holiday Restricted mode behavior: No device change.
Privacy Secured mode behavior: No device change.

Show child attributes

simulatePassThruCredentialPresentedAtDeviceobject

Initiate device behavior as if a valid PASS_THRU credential were presented to device. Regardless what mode device is in, momentarily unlocks device. Device will relock in amount of time defined by lock.autoRelockDelayInSeconds.standardCredential value.

Show child attributes

simulatePassThruExtendedCredentialPresentedAtDeviceobject

Initiate device behavior as if a valid PASS_THRU_EXTENDED credential were presented to device. Regardless what mode device is in, momentarily unlocks device. Device will relock in amount of time defined by lock.autoRelockDelayInSeconds.extendedCredential value.

Show child attributes

simulateToggleCredentialPresentedAtDeviceobject

Initiate device behavior as if a valid TOGGLE credential were presented to device.

Standard mode behavior: Toggles device from locked to unlocked or from unlocked to locked. Device remains locked/unlocked until another credential presentation occurs or is simulated.
Frozen mode behavior: No device change.
Holiday Restricted mode behavior: No device change.
Privacy Secured mode behavior: No device change.

Show child attributes

{
  "disableIndicatorBlinkingWhenLocked": {
    "actionId": null
  },
  "disablePublishingKeyOverrideEvents": {
    "actionId": null
  },
  "disablePublishingUnauthorizedUserEvents": {
    "actionId": null
  },
  "enableIndicatorBlinkingWhenLockedAndSetBlinkSpeedToNormal": {
    "actionId": null
  },
  "enableIndicatorBlinkingWhenLockedAndSetBlinkSpeedToRapid": {
    "actionId": null
  },
  "enablePublishingKeyOverrideEvents": {
    "actionId": null
  },
  "enablePublishingUnauthorizedUserEvents": {
    "actionId": null
  },
  "setBehaviorOnPowerFailureToRemainAsIs": {
    "actionId": null
  },
  "setBehaviorOnPowerFailureToWillLock": {
    "actionId": null
  },
  "setBehaviorOnPowerFailureToWillUnlock": {
    "actionId": null
  },
  "setFunctionToApartment": {
    "actionId": null
  },
  "setFunctionToOffice": {
    "actionId": null
  },
  "setFunctionToPrivacy": {
    "actionId": null
  },
  "setFunctionToStoreroom": {
    "actionId": null
  },
  "setRelockDelayInSecondsForExtendedUnlock": {
    "actionId": null
  },
  "setRelockDelayInSecondsForStandardUnlock": {
    "actionId": null
  },
  "simulateFreezeCredentialPresentedAtDevice": {
    "actionId": null
  },
  "simulateLockDownCredentialPresentedAtDevice": {
    "actionId": null
  },
  "simulateNormalCredentialPresentedAtDevice": {
    "actionId": null
  },
  "simulateNormalExtendedCredentialPresentedAtDevice": {
    "actionId": null
  },
  "simulatePassThruCredentialPresentedAtDevice": {
    "actionId": null
  },
  "simulatePassThruExtendedCredentialPresentedAtDevice": {
    "actionId": null
  },
  "simulateToggleCredentialPresentedAtDevice": {
    "actionId": null
  }
}

Sections

LockActions

LockActions

What made this section helpful for you?

What made this section unhelpful for you?

What made this section helpful for you?

What made this section unhelpful for you?

Sections

LockActions

LockActionsExpand all

What made this section helpful for you?

What made this section unhelpful for you?

What made this section helpful for you?

What made this section unhelpful for you?

LockActions