Data.Cloud.AmazonAPI.TAmazonQueueService.PeekMessages
| [–] Properties | |
|---|---|
| Type: function | |
| Visibility: public | |
| Source: Data.Cloud.AmazonAPI.pas Data.Cloud.AmazonAPI.hpp
| |
| Unit: Data.Cloud.AmazonAPI | |
| Parent: TAmazonQueueService | |
Delphi
function PeekMessages(const QueueURL: string; NumOfMessages: Integer;
ResponseInfo: TCloudResponseInfo = nil): TList<TCloudQueueMessage>; deprecated;
C++
System::Generics::Collections::TList__1<Data::Cloud::Cloudapi::TCloudQueueMessage*>* __fastcall PeekMessages _DEPRECATED_ATTRIBUTE0 (const System::UnicodeString QueueURL, int NumOfMessages, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0));
Description
Attention: PeekMessages 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: The maximum number of messages that you want to retrieve. The allowed values forNumOfMessagesare1 - 10.ResponseInfo: Optional. The class that stores the response information.
This method returns a list of messages. These messages do not have the PopReceipt value specified.
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.