Network.deregisterForEscapeSequence()
Overview
Deregister an escape sequence handler.
Added in version 2.0.0
Format
var result = Network.deregisterForEscapeSequence(sequenceToken);
| Parameter | Description | Type | Required |
|---|---|---|---|
| sequenceToken | Returns an opaque object that represents the registered escape sequence. Returns null if registration failed. Must be the same object returned from Network.registerForEscapeSequence()). | Object | Required |
| result | Returns true to indicate that the sequence was successfully deregistered. Returns false if the parameter is invalid or the sequence was not registered. | Boolean | Return |
Example
Copy
/* Registers for BEL character to play warning sound.
* Deregisters when scope is exited.
*/
function onBel(sequence) {
Device.beepPlayFile("bel.wav");
}
var token = Network.registerForEscapeSequence('\x07', null, false, onBel);
if(token) {
WLEvent.onExitScope(function () {
Network.deregisterForEscapeSequence(token);
});
}