unlock
Unlocks 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 | 0..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 unlock. For example, COIN_SAFE. Use `$deviceId` for unspecific device ID. | door-identifier | 1 |
cassette | Identifier of the cassette to unlock. For example, URT.1:LOCK_GROUP_A. Use `$deviceId` for unspecific device ID. | cash-box-lock-identifier | 1 |
Example 42. Example
<unlock>
<door>COIN_DISPENSER</door>
</unlock>
<unlock>
<cassette>URT.1:LOCK_GROUP_A</cassette>
</unlock>
<unlock>
<cassette>$deviceId:LOCK_GROUP_A</cassette>
</unlock>
<!-- unlock with message, `{}` will be replaced with door name -->
<unlock message="unlocking {}...">
<door>COIN_DISPENSER</door>
</unlock>
<!-- unlock with option to retry -->
<unlock retry="Unlock">
<door>COIN_DISPENSER</door>
</unlock>