Class TRALClientHTTP

Unit

Declaration

type TRALClientHTTP = class(TPersistent)

Description

TRALClientHTTP

Hierarchy

Overview

Methods

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

Properties

Published property IndexUrl: IntegerRAL read FIndexUrl write FIndexUrl;
Protected property Parent: TRALClient read FParent write FParent;

Description

Methods

Public constructor Create(AOwner: TRALClient); virtual;

This item has no description.

Public class function EngineName: StringRAL; virtual; abstract;

This item has no description.

Public class function EngineVersion: StringRAL; virtual; abstract;

This item has no description.

Public class function PackageDependency: StringRAL; virtual; abstract;

This item has no description.

Protected function GetURL(ARoute: StringRAL; ARequest: TRALRequest = nil; AIndexUrl: IntegerRAL = -1): StringRAL;

returns the complete URL of a given route.

Protected function SetAuthToken(AVars: TStringList; ARequest: TRALRequest): IntegerRAL;

Configures the Request header with proper authentication info based on the assigned authenticator.

Protected function SetTokenBasic(AVars: TStringList; ARequest: TRALRequest): IntegerRAL;

used by SetAuthToken to set authentication on the header: Basic.

Protected function SetTokenDigest(AVars: TStringList; ARequest: TRALRequest): IntegerRAL;

used by SetAuthToken to set authentication on the header: DigestAuth.

Protected function SetTokenJWT(AVars: TStringList; ARequest: TRALRequest): IntegerRAL;

used by SetAuthToken to set authentication on the header: JWT.

Protected function SetTokenOAuth1(AVars: TStringList; ARequest: TRALRequest): IntegerRAL;

used by SetAuthToken to set authentication on the header: OAuth1.

Protected function SetTokenOAuth2(AVars: TStringList; ARequest: TRALRequest): IntegerRAL;

placeholder

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

This item has no description.

Protected procedure BeforeSendUrl(ARoute: StringRAL; ARequest: TRALRequest; AResponse: TRALResponse; AMethod: TRALMethod);

allows manipulation of params before executing request.

Protected procedure ResetToken;

clears authentication token property.

Properties

Published property IndexUrl: IntegerRAL read FIndexUrl write FIndexUrl;

This item has no description.

Protected property Parent: TRALClient read FParent write FParent;

This item has no description.



PascalRAL - GitHub Repository
Generated by PasDoc 1.0.4.