API Reference

Sections

Theme switcher

LockActions

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

secureDoorobject

Forces device into a secured state.

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. Refer to published device documentation for behavior details for this function.

Show child attributes

setFunctionToManualThrowApartmentobject

Sets lockFunction to Manual Throw Apartment. Refer to published device documentation for behavior details for this function.

Show child attributes

setFunctionToOfficeobject

Sets lockFunction to Office. Refer to published device documentation for behavior details for this function.

Show child attributes

setFunctionToPrivacyobject

Sets lockFunction to Privacy. Refer to published device documentation for behavior details for this function.

Show child attributes

setFunctionToStoreroomobject

Sets lockFunction to Storeroom. Refer to published device documentation for behavior details for this function.

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. Refer to published device documentation for expected device behavior based on current device state.

Show child attributes

simulateLockDownCredentialPresentedAtDeviceobject

Initiate device behavior as if a valid LOCKDOWN credential were presented to device. Refer to published device documentation for expected device behavior based on current device state.

Show child attributes

simulateNormalCredentialPresentedAtDeviceobject

Initiate device behavior as if a valid NORMAL credential were presented to device. Refer to published device documentation for expected device behavior based on current device state.

Show child attributes

simulateNormalExtendedCredentialPresentedAtDeviceobject

Initiate device behavior as if a valid NORMAL_EXTENDED credential were presented to device. Refer to published device documentation for expected device behavior based on current device state.

Show child attributes

simulatePassThruCredentialPresentedAtDeviceobject

Initiate device behavior as if a valid PASS_THRU credential were presented to device. Refer to published device documentation for expected device behavior based on current device state.

Show child attributes

simulatePassThruExtendedCredentialPresentedAtDeviceobject

Initiate device behavior as if a valid PASS_THRU_EXTENDED credential were presented to device. Refer to published device documentation for expected device behavior based on current device state.

Show child attributes

simulateToggleCredentialPresentedAtDeviceobject

Initiate device behavior as if a valid TOGGLE credential were presented to device. Refer to published device documentation for expected device behavior based on current device state.

Show child attributes

Was this section helpful?
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 { "disableIndicatorBlinkingWhenLocked": { "actionId": null }, "disablePublishingKeyOverrideEvents": { "actionId": null }, "disablePublishingUnauthorizedUserEvents": { "actionId": null }, "enableIndicatorBlinkingWhenLockedAndSetBlinkSpeedToNormal": { "actionId": null }, "enableIndicatorBlinkingWhenLockedAndSetBlinkSpeedToRapid": { "actionId": null }, "enablePublishingKeyOverrideEvents": { "actionId": null }, "enablePublishingUnauthorizedUserEvents": { "actionId": null }, "secureDoor": { "actionId": null }, "setBehaviorOnPowerFailureToRemainAsIs": { "actionId": null }, "setBehaviorOnPowerFailureToWillLock": { "actionId": null }, "setBehaviorOnPowerFailureToWillUnlock": { "actionId": null }, "setFunctionToApartment": { "actionId": null }, "setFunctionToManualThrowApartment": { "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 } }
Was this section helpful?