Data.Cloud.AmazonAPI.TAmazonQueueService.ChangeMessageVisibility
Delphi
function ChangeMessageVisibility(const QueueURL: string; const PopReceipt: string; const VisibilityTimeout: Integer = 0; ResponseInfo: TCloudResponseInfo = nil): Boolean;
C++
bool __fastcall ChangeMessageVisibility(const System::UnicodeString QueueURL, const System::UnicodeString PopReceipt, const int VisibilityTimeout = 0x0, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo = (Data::Cloud::Cloudapi::TCloudResponseInfo*)(0x0));
Properties
| Type | Visibility | Source | Unit | Parent |
|---|---|---|---|---|
| function | public | Data.Cloud.AmazonAPI.pas Data.Cloud.AmazonAPI.hpp |
Data.Cloud.AmazonAPI | TAmazonQueueService |
Description
Extends or ends the visibility timeout of a message.
If zero is passed in as the VisibilityTimeout, then the message instantly becomes visible by calls to GetMessages. Otherwise, the value passed in as the VisibilityTimeout, which must be in the range from 0 through 43200 seconds (12 hours), will be set as the new value of VisibilityTimeout for the message associated with the given pop receipt, if the message has any.
The method returns True if the deletion was successful, False otherwise.
The following table shows the significance of the parameters:
| Parameter | Description |
|---|---|
|
|
The URL of the queue to get the messages for. |
|
|
The previously obtained pop receipt, associated with a message. |
|
|
Time (in seconds) to have the message hidden for. |
|
|
The optional class for storing response info into. |