IdleInfo Event

Fires whenever responses from the server are received while idling.

Syntax

simap.on('IdleInfo', [callback])

Callback

The 'callback' is called when the 'IdleInfo' event is emited.

function(e){ }

The argument 'e' has the following properties:

e.message
e.cancel

Remarks

This event fires each time a response is received from the server after calling StartIdle. This will fire with information from the server intended to update the client. The type of data sent by the server may vary.

Message holds the response received from the server.

Cancel may be set to stop idling from within the event. This is equivalent to calling StopIdle.

Some possible values returned by the server are:

+ idling
* 43 EXISTS
* 1 RECENT