Message Event

Fired for every message when ListMessages or PeekMessages is called.

Syntax

[VB.NET]
Public Event OnMessage As OnMessageHandler

[C#]
public event OnMessageHandler OnMessage;

public delegate void OnMessageHandler(object sender, QueueMessageEventArgs e);

class QueueMessageEventArgs : EventArgs {
  string Id {get;}
  string InsertionTime {get;}
  string ExpirationTime {get;}
  string PopReceipt {get;}
  string TimeNextVisible {get;}
  int DequeueCount {get;}
  string Text {get;}
}

Remarks

This event fires once for each returned message when ListMessages or PeekMessages is called.

Id contains the Id of the message. This value is used when calling DeleteMessage

InsertionTime contains the time at which the message was first inserted into the queue.

ExpirationTime contains the time at which the message will be automatically removed from the queue.

PopReceipt contains the pop receipt. This value is used when calling DeleteMessage

TimeNextVisible contains the time when the message will be visible to other clients. When ListMessages is called, the message will not be visible by other clients until VisibilityTimeout has expired. This parameter represents the time at which the timeout will expire.

DequeueCount contains the number of times the message has been dequeued. When ListMessages is called this value is incremented. This value is not incremented when PeekMessages is called.

Text contains up to 8KB of XML compliant text.