Class TRALClientHTTP

Fields

Unit

Declaration

type TRALClientHTTP = class(TPersistent)

Description

TRALClientHTTP

Hierarchy

TObject
TPersistent
TRALClientHTTP

Overview

Methods

	`constructor Create(AOwner: TRALClient); virtual;`
	`class function EngineName: StringRAL; virtual; abstract;`
	`class function EngineVersion: StringRAL; virtual; abstract;`
	`class function PackageDependency: StringRAL; virtual; abstract;`
	`function GetURL(ARoute: StringRAL; ARequest: TRALRequest = nil; AIndexUrl: IntegerRAL = -1): StringRAL;`
	`function SetAuthToken(AVars: TStringList; ARequest: TRALRequest): IntegerRAL;`
	`function SetTokenBasic(AVars: TStringList; ARequest: TRALRequest): IntegerRAL;`
	`function SetTokenDigest(AVars: TStringList; ARequest: TRALRequest): IntegerRAL;`
	`function SetTokenJWT(AVars: TStringList; ARequest: TRALRequest): IntegerRAL;`
	`function SetTokenOAuth1(AVars: TStringList; ARequest: TRALRequest): IntegerRAL;`
	`function SetTokenOAuth2(AVars: TStringList; ARequest: TRALRequest): IntegerRAL;`
	`procedure SendUrl(AURL: StringRAL; ARequest: TRALRequest; AResponse: TRALResponse; AMethod: TRALMethod); virtual; abstract;`
	`procedure BeforeSendUrl(ARoute: StringRAL; ARequest: TRALRequest; AResponse: TRALResponse; AMethod: TRALMethod);`
	`procedure ResetToken;`

Properties

	`property IndexUrl: IntegerRAL read FIndexUrl write FIndexUrl;`
	`property Parent: TRALClient read FParent write FParent;`

Description

Methods

	`constructor Create(AOwner: TRALClient); virtual;`

	`class function EngineName: StringRAL; virtual; abstract;`

	`class function EngineVersion: StringRAL; virtual; abstract;`

	`class function PackageDependency: StringRAL; virtual; abstract;`

	`function GetURL(ARoute: StringRAL; ARequest: TRALRequest = nil; AIndexUrl: IntegerRAL = -1): StringRAL;`
returns the complete URL of a given route.

	`function SetAuthToken(AVars: TStringList; ARequest: TRALRequest): IntegerRAL;`
Configures the Request header with proper authentication info based on the assigned authenticator.

	`function SetTokenBasic(AVars: TStringList; ARequest: TRALRequest): IntegerRAL;`
used by SetAuthToken to set authentication on the header: Basic.

	`function SetTokenDigest(AVars: TStringList; ARequest: TRALRequest): IntegerRAL;`
used by SetAuthToken to set authentication on the header: DigestAuth.

	`function SetTokenJWT(AVars: TStringList; ARequest: TRALRequest): IntegerRAL;`
used by SetAuthToken to set authentication on the header: JWT.

	`function SetTokenOAuth1(AVars: TStringList; ARequest: TRALRequest): IntegerRAL;`
used by SetAuthToken to set authentication on the header: OAuth1.

	`function SetTokenOAuth2(AVars: TStringList; ARequest: TRALRequest): IntegerRAL;`
placeholder

	`procedure SendUrl(AURL: StringRAL; ARequest: TRALRequest; AResponse: TRALResponse; AMethod: TRALMethod); virtual; abstract;`

	`procedure BeforeSendUrl(ARoute: StringRAL; ARequest: TRALRequest; AResponse: TRALResponse; AMethod: TRALMethod);`
allows manipulation of params before executing request.

	`procedure ResetToken;`
clears authentication token property.

Properties

	`property IndexUrl: IntegerRAL read FIndexUrl write FIndexUrl;`

	`property Parent: TRALClient read FParent write FParent;`

GitHub Repository

Generated by PasDoc 0.16.0.