Data.Cloud.AmazonAPI.TAmazonQueueService.AddMessage

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function AddMessage(const QueueURL: string; const MessageText: string;  ResponseInfo: TCloudResponseInfo = nil): Boolean; overload; deprecated;
function AddMessage(const QueueURL: string; const MessageText: string; out MessageId: string;  ResponseInfo: TCloudResponseInfo = nil): Boolean; overload; deprecated;

C++

bool __fastcall AddMessage _DEPRECATED_ATTRIBUTE0 (const System::UnicodeString QueueURL, const System::UnicodeString MessageText, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0))/* overload */;
bool __fastcall AddMessage _DEPRECATED_ATTRIBUTE0 (const System::UnicodeString QueueURL, const System::UnicodeString MessageText, /* out */ System::UnicodeString &MessageId, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0))/* overload */;

Properties

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

Description

Warning: AddMessage is deprecated. Please use SendMessage.

Adds a message to the given queue.

There are two AddMessage overloaded methods. For the second overloaded method, you can get the ID of the message in the queue.

The method returns True if the operation was successful, False otherwise.

The following table shows the significance of the parameters:

Parameter Description

QueueURL

The URL of the queue to add the message to.

MessageText

The text of the message.

MessageId

The ID of the message in the queue, or an empty string if the addition failed.

ResponseInfo

The optional class for storing response info into.

See Also