Data.Cloud.CloudAPI.TCloudService.IssueGetRequest

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function IssueGetRequest(URL: string; Headers: TStringList;
QueryParameters: TStringList; const QueryPrefix: string;
ResponseInfo: TCloudResponseInfo;
ResponseContent: TStream): TCloudHTTP; overload; virtual;
function IssueGetRequest(URL: string; Headers: TStringList;
QueryParameters: TStringList; const QueryPrefix: string;
ResponseInfo: TCloudResponseInfo;
out ResponseString: string): TCloudHTTP; overload; virtual;
function IssueGetRequest(URL: string; Headers: TStringList;
QueryParameters: TStringList; const QueryPrefix: string;
ResponseInfo: TCloudResponseInfo): TCloudHTTP; overload; virtual;

C++

virtual TCloudHTTP* __fastcall IssueGetRequest(System::UnicodeString URL, System::Classes::TStringList* Headers, System::Classes::TStringList* QueryParameters, const System::UnicodeString QueryPrefix, TCloudResponseInfo* ResponseInfo, System::Classes::TStream* ResponseContent)/* overload */;
virtual TCloudHTTP* __fastcall IssueGetRequest(System::UnicodeString URL, System::Classes::TStringList* Headers, System::Classes::TStringList* QueryParameters, const System::UnicodeString QueryPrefix, TCloudResponseInfo* ResponseInfo, /* out */ System::UnicodeString &ResponseString)/* overload */;
virtual TCloudHTTP* __fastcall IssueGetRequest(System::UnicodeString URL, System::Classes::TStringList* Headers, System::Classes::TStringList* QueryParameters, const System::UnicodeString QueryPrefix, TCloudResponseInfo* ResponseInfo)/* overload */;

Properties

Type Visibility Source Unit Parent
function protected
Data.Cloud.CloudAPI.pas
Data.Cloud.CloudAPI.hpp
Data.Cloud.CloudAPI TCloudService

Description

Executes a GET request with the given parameters.

There are three IssueGetRequest overloaded methods:

  • The first one returns the response as a stream, as well as the TCloudHTTP instance used in the request.
  • The second one returns the response body as a string, as well as the TCloudHTTP instance used in the request.
  • The third only returns the TCloudHTTP instance used to issue the request.

The following table shows the significance of the parameters for all the overloaded methods:

Parameter Description

URL

The URL to issue the request

Headers

The header name/value pairs to use in the request and authentication

QueryParameters

The query parameter name/value pairs to use in the request and authentication

QueryPrefix

The string to prefix the query string with when building the StringToSign

ResponseInfo

The TCloudResponseInfo instance to populate from the response of the request, or nil

ResponseContent

Response stream, to use in the request being made

ResponseString

Output parameter, set to the string content returned in the response

See Also