Data.Cloud.AmazonAPI.TAmazonQueueService.GetMessages
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));
プロパティ
種類 | 可視性 | ソース | ユニット | 親 |
---|---|---|---|---|
function | public | Data.Cloud.AmazonAPI.pas Data.Cloud.AmazonAPI.hpp |
Data.Cloud.AmazonAPI | TAmazonQueueService |
説明
警告: GetMessages は非推奨になっています。 ReceiveMessage を使用してください。
メッセージのリストをキューから取得します。
このメソッドは、次のパラメータを受け付けます:
QueueURL
: キューの URL。NumOfMessages
: 省略可能。 受け取るメッセージの最大数。NumOfMessages
を指定しない場合、メソッドは1
メッセージを返します。NumOfMessages
の最大指定可能値は10
です。VisibilityTimeout
: 省略可能。 メッセージから他のリクエストから隠ぺいされる時間(秒数)です。VisibilityTimeout
を指定しない場合、相当するキューのデフォルト値がが適用されます(SetQueueProperty 参照)。最大値は 12 時間(43200
秒)です。ResponseInfo
: 省略可能。 レスポンス情報を格納するクラス。
このメソッドは、メッセージのリストを返します。 各メッセージには指定された値 PopReceipt があり、メッセージを削除するために使用できます。
PeekMessages は、GetMessages と同様です。 主な違いは、PeekMessages はメッセージを他のリクエストに対して隠ぺいしない点です。 0
を VisibilityTimeout
パラメータとして、GetMessages に渡すと、同じ結果になります。