Data.Cloud.AmazonAPI.TAmazonBasicService.IssueRequest

From RAD Studio API Documentation
Jump to: navigation, search

[–] Properties
Type: function
Visibility: protected
Source:
Data.Cloud.AmazonAPI.pas
Data.Cloud.AmazonAPI.hpp
Unit: Data.Cloud.AmazonAPI
Parent: TAmazonBasicService

Delphi

function IssueRequest(const URL: string; QueryParams: TStringList; ResponseInfo: TCloudResponseInfo;
out ResultString: string; RequestStream: TStream = nil): TCloudHTTP; overload;
function IssueRequest(URL: string; QueryParams: TStringList; ResponseInfo: TCloudResponseInfo;
RequestStream: TStream = nil): TCloudHTTP; overload;

C++

Data::Cloud::Cloudapi::TCloudHTTP* __fastcall IssueRequest(const System::UnicodeString URL, System::Classes::TStringList* QueryParams, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo, /* out */ System::UnicodeString &ResultString, System::Classes::TStream* RequestStream = (System::Classes::TStream*)(0x0))/* overload */;
Data::Cloud::Cloudapi::TCloudHTTP* __fastcall IssueRequest(System::UnicodeString URL, System::Classes::TStringList* QueryParams, Data::Cloud::Cloudapi::TCloudResponseInfo* ResponseInfo, System::Classes::TStream* RequestStream = (System::Classes::TStream*)(0x0))/* overload */;

Description

Issues the HTTP request, as either a GET or a POST.

There are two IssueRequest overloaded methods. With the first one you can obtain the string representation of the response content, using ResultString.

If the RequestStream is specified, then a POST request is issued, the stream is used in the HTTP request as the body, and the query parameters are placed in the URL of the request. Otherwise, if it is nil, then the CanonicalizedQueryString is built from the given information and is placed in the body of the request, which is issued as a GET.

The following table shows the significance of the parameters:

Parameter Description

URL

The request URL, without any query parameters

QueryParameters

The query parameters of the request

ResponseInfo

The optional response info to populate, or nil

ResultString

The string representation of the response content

RequestStream

The request stream to set as the body of the request, or nil

See Also