Data.Cloud.AmazonAPI.TAmazonQueueService.GetMessages

De RAD Studio API Documentation
Aller à : navigation, rechercher

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));

Propriétés

Type Visibilité  Source Unité  Parent
function public
Data.Cloud.AmazonAPI.pas
Data.Cloud.AmazonAPI.hpp
Data.Cloud.AmazonAPI TAmazonQueueService


Description

Avertissement : GetMessages est obsolète. Veuillez utiliser ReceiveMessage.

Récupère une liste de messages d'une file d'attente.

Cette méthode accepte les paramètres suivants :

  • QueueURL : L'URL de la file d'attente.
  • NumOfMessages : Facultatif. Le nombre maximal de messages à récupérer. Si vous ne spécifiez pas NumOfMessages, cette méthode renvoie le message 1. La valeur maximale autorisée pour NumOfMessages est 10.
  • VisibilityTimeout : Facultatif. La durée (en secondes) pendant laquelle les messages sont masqués des autres requêtes. Si vous ne définissez pas VisibilityTimeout, la valeur par défaut de la file d'attente correspondante s'applique (voir SetQueueProperty). La valeur maximale est de 12 heures (43200 secondes).
  • ResponseInfo : Facultatif. La classe qui stocke les informations sur la réponse.

Cette méthode renvoie une liste de messages. Chaque message a la valeur PopReceipt spécifiée ; elle peut être utilisée pour supprimer ce message.

PeekMessages est semblable à GetMessages. La principale différence est que PeekMessages ne masque pas les messages des autres requêtes. Vous pouvez obtenir le même résultat si vous transmettez 0 en tant que paramètre VisibilityTimeout à GetMessages.

Voir aussi