Queue API MessageQueue external object

The MessageQueue External Object is under the GeneXusMessagingQueue.SimpleQueue module, and allows you to send and process messages of a Message queue using the Queue API.

Properties

It doesn't have any.

Methods

GetQueueLength

Gets the approximate number of messages in the queue.

Return value   None
Parameters     ErrorMessages:GeneXus.Common.Messages, Success:Boolean.

SendMessage

Sends a message to the queue.

Return value   MessageResult
Parameters     Message:Message, ErrorMessages: GeneXus.Common.Messages, Success:Boolean.

SendMessages

 Sends a list of messages to the queue, using options.

Return value   MessageResult (Collection)
Parameters     Message:Message (Collection), Options:MessageOptions,  ErrorMessages: GeneXus.Common.Messages, Success:Boolean.

Clear

Clears the queue.

Return value   None
Parameters     ErrorMessages: GeneXus.Common.Messages, Success:Boolean.

DeleteMessage

Deletes the message.

Return value   MessageResult
Parameters     Message: Message, ErrorMessages: GeneXus.Common.Messages, Succes:Boolean.

ReceiveMessages

Receives one or more messages from the front of the queue.

Return value   MessageResult (Collection)
Parameters     ErrorMessages: GeneXus.Common.Messages, Success:Boolean.

Receives one or more messages from the front of the queue with advanced options.

Return value   None
Parameters     Options: MessagesOptions, ErrorMessages: GeneXus.Common.Messages, Success:Boolean.

DeleteMessages

Deletes a list of messages.

Return value   MessageResult
Parameters     Messages: Message (Collection), ErrorMessages: GeneXus.Common.Messages, Success:Boolean

Events

It doesn't have any.

See Also

HowTo: Send a message to an Azure Storage Queue
HowTo: Connect to a Queue
HowTo: Send and receive messages from SQS

Availability

This feature is available since GeneXus 18.