lock
Locks the electronic lock identified by door identifier or by cash box lock identifier.
Key | Description | Format | Cardinality |
|---|---|---|---|
message | Optional message to display while action is running. | text | 1 |
retry | Controls whether or not the option to retry the action should be available. | boolean (false) | 0..1 |
door | Identifier of the door to lock. For example, COIN_SAFE. Use `$deviceId` for unspecific device ID. | door-identifier | 1 |
cassette | Identifier of the cassette to lock. For example, URT.1:LOCK_GROUP_A. Use `$deviceId` for unspecific device ID. | cash-box-lock-identifier | 1 |
Example 41. Example
<lock>
<door>COIN_DISPENSER</door>
</lock>
<lock>
<cassette>URT.1:LOCK_GROUP_A</cassette>
</lock>
<lock>
<cassette>$deviceId:LOCK_GROUP_A</cassette>
</lock>
<!-- Lock with message, `{}` will be replaced with door name -->
<lock message="locking {}...">
<door>COIN_DISPENSER</door>
</lock>
<!-- Lock with option to retry -->
<lock retry="Unlock">
<door>COIN_DISPENSER</door>
</lock>