IdleInfo Event

Fires whenever responses from the server are received while idling.

Syntax

class SIMAPIdleInfoEventParams {
public:
  const QString &Message();
  bool Cancel();
  void SetCancel(bool bCancel);
  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void IdleInfo(SIMAPIdleInfoEventParams *e);

// Or, subclass SIMAP and override this emitter function.
virtual int FireIdleInfo(SIMAPIdleInfoEventParams *e) {...}

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