Data.Cloud.CloudAPI.TCloudService.BuildStringToSign

From RAD Studio API Documentation
Jump to: navigation, search

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

Delphi

function BuildStringToSign(const HTTPVerb: string; Headers, QueryParameters: TStringList;
const QueryPrefix, URL: string): string; virtual;

C++

virtual System::UnicodeString __fastcall BuildStringToSign(const System::UnicodeString HTTPVerb, System::Classes::TStringList* Headers, System::Classes::TStringList* QueryParameters, const System::UnicodeString QueryPrefix, const System::UnicodeString URL);

Description

Builds and encodes a string value based on the given information.

BuildStringToSign returns an encoded string that is used for authentication.

The following table shows the significance of the parameters:

Parameter Description

HTTPVerb

The HTTP verb (for example, GET, POST) of the request type.

Headers

The list of headers in the request, or nil.

QueryParameters

The list of query parameters for the request, or nil.

QueryPrefix

The string to prefix the query parameter string with.

URL

The URL of the request.


See Also