PascalRAL

Class TRALBaseRoute

Description
Hierarchy
Fields
Methods
Properties

Unit

RALRoutes

Declaration

type TRALBaseRoute = class(TCollectionItem)

Description

Base class for individual route definition

Hierarchy

Overview

Methods

Public constructor Create(ACollection: TCollection); override;
Public destructor Destroy; override;
Public function GetAllowMethods: StringRAL;
Public function GetFullRoute: StringRAL;
Public function GetNamePath: string; override;
Public function IsMethodAllowed(const AMethod: TRALMethod): boolean;
Public function IsMethodSkipped(const AMethod: TRALMethod): boolean;
Protected function GetDisplayName: string; override;
Public procedure Execute(ARequest: TRALRequest; AResponse: TRALResponse);
Protected procedure AssignTo(Dest: TPersistent); override;
Protected procedure SetAllowedMethods(const AValue: TRALMethods);
Protected procedure SetDescription(const AValue: TStrings);
Protected procedure SetDisplayName(const AValue: string); override;
Protected procedure SetRoute(AValue: StringRAL);
Protected procedure SetSkipAuthMethods(const AValue: TRALMethods);

Properties

Public property AllowedMethods: TRALMethods read FAllowedMethods write SetAllowedMethods;
Public property AllowURIParams: Boolean read FAllowURIParams write FAllowURIParams;
Public property Callback: boolean read FCallback write FCallback;
Published property Description: TStrings read FDescription write SetDescription;
Published property InputParams: TRALRouteParams read FInputParams write FInputParams;
Public property Name: StringRAL read FName write FName;
Public property OnReply: TRALOnReply read FOnReply write FOnReply;
Public property OnReplyGen: TRALOnReplyGen read FOnReplyGen write FOnReplyGen;
Published property Route: StringRAL read FRoute write SetRoute;
Public property SkipAuthMethods: TRALMethods read FSkipAuthMethods write SetSkipAuthMethods;
Public property URIParams: TRALRouteParams read FURIParams write FURIParams;

Description

Methods

Public constructor Create(ACollection: TCollection); override;
 
Public destructor Destroy; override;
 
Public function GetAllowMethods: StringRAL;

Returns methods that this route will answer

Public function GetFullRoute: StringRAL;
 
Public function GetNamePath: string; override;

Returns internal name of the route

Public function IsMethodAllowed(const AMethod: TRALMethod): boolean;

Returns true or false wether the method is allowed in route

Public function IsMethodSkipped(const AMethod: TRALMethod): boolean;

Returns true or false wether the method is skipped in authentication

Protected function GetDisplayName: string; override;
 
Public procedure Execute(ARequest: TRALRequest; AResponse: TRALResponse);

Runs the OnReply event

Protected procedure AssignTo(Dest: TPersistent); override;
 
Protected procedure SetAllowedMethods(const AValue: TRALMethods);

checks if the route already exists on the list

Protected procedure SetDescription(const AValue: TStrings);
 
Protected procedure SetDisplayName(const AValue: string); override;
 
Protected procedure SetRoute(AValue: StringRAL);
 
Protected procedure SetSkipAuthMethods(const AValue: TRALMethods);
 

Properties

Public property AllowedMethods: TRALMethods read FAllowedMethods write SetAllowedMethods;
 
Public property AllowURIParams: Boolean read FAllowURIParams write FAllowURIParams;
 
Public property Callback: boolean read FCallback write FCallback;
 
Published property Description: TStrings read FDescription write SetDescription;
 
Published property InputParams: TRALRouteParams read FInputParams write FInputParams;
 
Public property Name: StringRAL read FName write FName;
 
Public property OnReply: TRALOnReply read FOnReply write FOnReply;
 
Public property OnReplyGen: TRALOnReplyGen read FOnReplyGen write FOnReplyGen;
 
Published property Route: StringRAL read FRoute write SetRoute;
 
Public property SkipAuthMethods: TRALMethods read FSkipAuthMethods write SetSkipAuthMethods;
 
Public property URIParams: TRALRouteParams read FURIParams write FURIParams;
 


GitHub Repository
Generated by PasDoc 0.16.0.