Class: QueueMessageResult

QueueMessageResult

The QueueMessageResult class is used to store the queue message information.


new QueueMessageResult( [queue] [, messageId] [, popReceipt])

Creates a new QueueMessageResult object.

Parameters:
Name Type Argument Description
queue string <optional>

The queue name.

messageId string <optional>

The message id.

popReceipt string <optional>

The pop receipt.

Properties:
Name Type Description
queue string

The queue name.

messageId string

The message id.

popReceipt string

The pop receipt.

messageText string

The message text.

timeNextVisible string

The time next visible.

insertionTime string

The insertion time.

expirationTime string

The expiration time.

dequeueCount number

The dequeue count.

Source:

Methods


<static> parse(messageXml, The)

Pase the XML representation of a queue message to a QueueMessageResult object.

Parameters:
Name Type Description
messageXml Object

The XML representation of the queue message.

The QueueMessageEncoder

message encoder.

Source:
Returns:

The QueueMessageResult object.

Type
QueueMessageResult

<static> serialize(messageJs, The)

Builds an XML representation for a queue message

Parameters:
Name Type Description
messageJs string

The queue message.

The QueueMessageEncoder

message encoder.

Source:
Returns:

The XML queue message.

Type
string