Data.Cloud.AmazonAPI.TAmazonQueueService.GetMessages
| [–] Properties | |
|---|---|
| Type: function | |
| Visibility: public | |
| Source: Data.Cloud.AmazonAPI.pas Data.Cloud.AmazonAPI.hpp
| |
| Unit: Data.Cloud.AmazonAPI | |
| Parent: TAmazonQueueService | |
Delphi
function GetMessages(const QueueURL: string;
NumOfMessages: Integer = 0;
VisibilityTimeout: Integer = -1;
ResponseInfo: TCloudResponseInfo = nil): TList<TCloudQueueMessage>; deprecated;
C++
System::Generics::Collections::TList__1<Data::Cloud::Cloudapi::TCloudQueueMessage*>* __fastcall GetMessages _DEPRECATED_ATTRIBUTE0 (const System::UnicodeString QueueURL, int NumOfMessages = 0x0, int VisibilityTimeout = 0xffffffff, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0));
Description
Attention: GetMessages is deprecated. Please use ReceiveMessage.
Retrieves a list of messages from a queue.
This method accepts the following parameters:
QueueURL: The URL of the queue.NumOfMessages: Optional. The maximum number of messages that you want to retrieve. If you do not specifyNumOfMessages, the method returns1message. The maximum allowed value forNumOfMessagesis10.VisibilityTimeout: Optional. The time in seconds that the messages are hidden from other requests. If you do not setVisibilityTimeout, the default value of the corresponding queue applies (see SetQueueProperty). The maximum value is 12 hours (43200seconds).ResponseInfo: Optional. The class that stores the response information.
This method returns a list of messages. Each message has the value PopReceipt specified, which you can use to delete that message.
PeekMessages is similar to GetMessages. The main difference is that PeekMessages does not hide the messages from other requests. You can achieve the same result if you pass 0 as VisibilityTimeout parameter to GetMessages.