API Reference

Sections

Theme switcher

LockActions

LockActions

disableIndicatorBlinkingWhenLockedobject

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

disablePublishingKeyOverrideEventsobject

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

disablePublishingUnauthorizedUserEventsobject

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

enableIndicatorBlinkingWhenLockedAndSetBlinkSpeedToNormalobject

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

enableIndicatorBlinkingWhenLockedAndSetBlinkSpeedToRapidobject

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

enablePublishingKeyOverrideEventsobject

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

enablePublishingUnauthorizedUserEventsobject

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

secureDoorobject

Forces device into a secured state.

setBehaviorOnPowerFailureToRemainAsIsobject

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

setBehaviorOnPowerFailureToWillLockobject

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

setBehaviorOnPowerFailureToWillUnlockobject

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

setFunctionToApartmentobject

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

setFunctionToManualThrowApartmentobject

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

setFunctionToOfficeobject

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

setFunctionToPrivacyobject

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

setFunctionToStoreroomobject

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

setRelockDelayInSecondsForExtendedUnlockobject

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

setRelockDelayInSecondsForStandardUnlockobject

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

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.

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.

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.

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.

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.

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.

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.

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?