PascalRAL

Class TRALHTTPHeaderInfo

Description
Hierarchy
Fields
Methods
Properties

Unit

RALCustomObjects

Declaration

type TRALHTTPHeaderInfo = class(TObject)

Description

Base class of REQUEST and RESPONSE classes

Hierarchy

Overview

Methods

Public constructor Create(AOwner : TObject); virtual;
Public destructor Destroy; override;
Public function AddBody(const AText: StringRAL; const AContextType: StringRAL = rctAPPLICATIONJSON): TRALHTTPHeaderInfo; virtual;
Public function AddCookie(const AName: StringRAL; const AValue: StringRAL): TRALHTTPHeaderInfo; virtual;
Public function AddCookies(ACookies: StringRAL): TRALHTTPHeaderInfo; virtual;
Public function AddField(const AName: StringRAL; const AValue: StringRAL): TRALHTTPHeaderInfo; virtual;
Public function AddFile(AStream: TStream; const AFileName: StringRAL = ''): TRALHTTPHeaderInfo; overload; virtual;
Public function AddFile(const AFileName: StringRAL): TRALHTTPHeaderInfo; overload; virtual;
Public function AddHeader(const AName: StringRAL; const AValue: StringRAL): TRALHTTPHeaderInfo; virtual;
Public function AddQuery(const AName: StringRAL; const AValue: StringRAL): TRALHTTPHeaderInfo; virtual;
Public function Body: TRALParam;
Public function GetBody(AIdx: IntegerRAL): TRALParam; virtual;
Public function GetCookie(const AName: StringRAL): StringRAL; virtual;
Public function GetField(const AName: StringRAL): StringRAL; virtual;
Public function GetHeader(const AName: StringRAL): StringRAL; virtual;
Public function GetQuery(const AName: StringRAL): StringRAL; virtual;
Public function HasValidAcceptEncoding: boolean;
Public function HasValidContentEncoding: boolean;
Public function ParamByName(const AParamName: StringRAL): TRALParam;
Protected function GetAcceptCompress: TRALCompressType;
Protected function GetAcceptCripto: TRALCriptoType;
Protected function GetContentCompress: TRALCompressType;
Protected function GetContentCripto: TRALCriptoType;
Protected function GetParams: TRALParams;
Public procedure Clear; virtual;
Public procedure Clone(ASource: TRALHTTPHeaderInfo);
Public procedure SetBody(AContent: TStream); overload; virtual;
Public procedure SetBody(AContent: StringRAL); overload; virtual;
Protected procedure SetContentCompress(const AValue: TRALCompressType);
Protected procedure SetContentCripto(AValue: TRALCriptoType);
Protected procedure SetContentType(const AValue: StringRAL);

Properties

Published property AcceptCompress: TRALCompressType read GetAcceptCompress;
Published property AcceptCripto: TRALCriptoType read GetAcceptCripto;
Published property AcceptEncoding: StringRAL read FAcceptEncoding write FAcceptEncoding;
Published property AcceptEncription: StringRAL read FAcceptEncription write FAcceptEncription;
Published property ContentCompress: TRALCompressType read GetContentCompress write SetContentCompress;
Published property ContentCripto: TRALCriptoType read GetContentCripto write SetContentCripto;
Published property ContentDisposition: StringRAL read FContentDisposition write FContentDisposition;
Published property ContentDispositionInline: boolean read FContentDispositionInline write FContentDispositionInline;
Published property ContentEncoding: StringRAL read FContentEncoding write FContentEncoding;
Published property ContentEncription: StringRAL read FContentEncription write FContentEncription;
Published property ContentType: StringRAL read FContentType write SetContentType;
Published property CriptoKey: StringRAL read FCriptoKey write FCriptoKey;
Published property Params: TRALParams read GetParams;
Published property Parent: TObject read FParent;

Description

Methods

Public constructor Create(AOwner : TObject); virtual;
 
Public destructor Destroy; override;
 
Public function AddBody(const AText: StringRAL; const AContextType: StringRAL = rctAPPLICATIONJSON): TRALHTTPHeaderInfo; virtual;
 
Public function AddCookie(const AName: StringRAL; const AValue: StringRAL): TRALHTTPHeaderInfo; virtual;
 
Public function AddCookies(ACookies: StringRAL): TRALHTTPHeaderInfo; virtual;
 
Public function AddField(const AName: StringRAL; const AValue: StringRAL): TRALHTTPHeaderInfo; virtual;
 
Public function AddFile(AStream: TStream; const AFileName: StringRAL = ''): TRALHTTPHeaderInfo; overload; virtual;
 
Public function AddFile(const AFileName: StringRAL): TRALHTTPHeaderInfo; overload; virtual;
 
Public function AddHeader(const AName: StringRAL; const AValue: StringRAL): TRALHTTPHeaderInfo; virtual;
 
Public function AddQuery(const AName: StringRAL; const AValue: StringRAL): TRALHTTPHeaderInfo; virtual;
 
Public function Body: TRALParam;

Grabs the body of either the request or the response

Public function GetBody(AIdx: IntegerRAL): TRALParam; virtual;
 
Public function GetCookie(const AName: StringRAL): StringRAL; virtual;
 
Public function GetField(const AName: StringRAL): StringRAL; virtual;
 
Public function GetHeader(const AName: StringRAL): StringRAL; virtual;
 
Public function GetQuery(const AName: StringRAL): StringRAL; virtual;
 
Public function HasValidAcceptEncoding: boolean;
 
Public function HasValidContentEncoding: boolean;
 
Public function ParamByName(const AParamName: StringRAL): TRALParam;

Grabs the param either on request or response by its name

Protected function GetAcceptCompress: TRALCompressType;

Grabs the kind of compression that will be accepted on the traffic

Protected function GetAcceptCripto: TRALCriptoType;

Grabs the kind of criptography that will be accepted on the traffic

Protected function GetContentCompress: TRALCompressType;

Grabs the kind of compression that will be used on the traffic

Protected function GetContentCripto: TRALCriptoType;

Grabs the kind of criptography that will be used on the traffic

Protected function GetParams: TRALParams;
 
Public procedure Clear; virtual;
 
Public procedure Clone(ASource: TRALHTTPHeaderInfo);
 
Public procedure SetBody(AContent: TStream); overload; virtual;

fills the body with the Stream AContent

Public procedure SetBody(AContent: StringRAL); overload; virtual;

fills the body with the String AContent

Protected procedure SetContentCompress(const AValue: TRALCompressType);
 
Protected procedure SetContentCripto(AValue: TRALCriptoType);
 
Protected procedure SetContentType(const AValue: StringRAL);
 

Properties

Published property AcceptCompress: TRALCompressType read GetAcceptCompress;
 
Published property AcceptCripto: TRALCriptoType read GetAcceptCripto;
 
Published property AcceptEncoding: StringRAL read FAcceptEncoding write FAcceptEncoding;
 
Published property AcceptEncription: StringRAL read FAcceptEncription write FAcceptEncription;
 
Published property ContentCompress: TRALCompressType read GetContentCompress write SetContentCompress;
 
Published property ContentCripto: TRALCriptoType read GetContentCripto write SetContentCripto;
 
Published property ContentDisposition: StringRAL read FContentDisposition write FContentDisposition;
 
Published property ContentDispositionInline: boolean read FContentDispositionInline write FContentDispositionInline;
 
Published property ContentEncoding: StringRAL read FContentEncoding write FContentEncoding;
 
Published property ContentEncription: StringRAL read FContentEncription write FContentEncription;
 
Published property ContentType: StringRAL read FContentType write SetContentType;
 
Published property CriptoKey: StringRAL read FCriptoKey write FCriptoKey;
 
Published property Params: TRALParams read GetParams;
 
Published property Parent: TObject read FParent;
 


GitHub Repository
Generated by PasDoc 0.16.0.