IdleInfo Event

Fires whenever responses from the server are received while idling.

Syntax

• C#
• VB.NET

public event OnIdleInfoHandler OnIdleInfo;

public delegate void OnIdleInfoHandler(object sender, PimapIdleInfoEventArgs e);

public class PimapIdleInfoEventArgs : EventArgs {
  public string Message { get; }
  public bool Cancel { get; set; }
}

Public Event OnIdleInfo As OnIdleInfoHandler

Public Delegate Sub OnIdleInfoHandler(sender As Object, e As PimapIdleInfoEventArgs)

Public Class PimapIdleInfoEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
  Public Property Cancel As Boolean
End Class

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