ssCore.Keyboard.clearNotify

Cancels notifications for the specified event.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

event - The event you want to disable notifications for. Valid values include: onKey and onHotKey.

keyName - [Optional] - Used with the OnHotKey event to identify the key to clear notifications for


Output Parameters:

No output parameters.


Asynchronous Mode:

When this method is called asynchronously, a return object containing the output parameters is passed to the specified callback function.

ssCore.Keyboard.clearNotify( paramsObject [, callbackParamsObject] [, errorParamsObject] );


Synchronous Mode:

When this method is called synchronously, a return object containing the output parameters is returned to the caller immediately.

var returnObject = ssCore.Keyboard.clearNotify( paramsObject );


Notes:

None.


Examples:

The following example clears an event notification setup previously by ssCore.Keyboard.setNotify.

ssCore.Keyboard.clearNotify({event:"onKey"});