Platoo ISAPI Components TISAPIActionItem

Contents - Events - Methods - Properties

Request handler for predefined request path


Description
Put these components into the dispatcher-module at design time and the dispatcher calls them automatically, when the request path matches the actionitem's PathInfo .


TISAPIActionItem - Events

Contents - TISAPIActionItem - Properties - Methods

OnAction
Request handling event

Delphi declaration
property OnAction: TOnNewRequestEvent read FOnAction write FOnAction;
C++ declaration
__property TOnNewRequestEvent OnAction={ read=FOnAction, write=FOnAction }

Description
Set Handled to true, if the request is handled.

OnCheckUserRights
Checking user rights for this action

Delphi declaration
property OnCheckUserRights: TFRChItemUserRights read FOnCheckUserRights write FOnCheckUserRights;
C++ declaration
__property TFRChItemUserRights OnCheckUserRights={ read=FOnCheckUserRights, write=FOnCheckUserRights }

Description
This event will be called before the OnAction event. Set Accept to FALSE, then the request will be rejected.


TISAPIActionItem - Methods

Contents - TISAPIActionItem - Properties - Events

~TISAPIActionItem
Destructor

C++ declaration
__fastcall virtual ~TISAPIActionItem(void)

Description
You usually never need to free TISAPIActionItem objects by yourself.

Create
Constructor

Delphi declaration
constructor Create(AOwner: TComponent);

Description
You usually never need to create TISAPIActionItem objects by yourself.

Destroy
Destructor

Delphi declaration
destructor Destroy;

Description
You usually never need to free TISAPIActionItem objects by yourself.

DoAction
Internal request handler

Delphi declaration
function DoAction(Request: TFRISAPIRequest; Response: TFRISAPIResponse): Boolean;
C++ declaration
bool __fastcall DoAction(TFRISAPIRequest *Request, TFRISAPIResponse *Response)

Description
Called by the dispatcher. Forces the OnCheckUserRights and OnAction events.

TISAPIActionItem
Constructor

C++ declaration
__fastcall virtual TISAPIActionItem(Classes::TComponent *AOwner)

Description
You usually never need to create TISAPIActionItem objects by yourself.


TISAPIActionItem - Properties

Contents - TISAPIActionItem - Methods - Events

Enabled
Enable/disable using this actionitem

Delphi declaration
property Enabled: Boolean read FEnabled write FEnabled default true;
C++ declaration
__property bool Enabled={ read=FEnabled, write=FEnabled, default=1 }

Description
Default enabled.

PathInfo
Request path to which this actionitem must response

Delphi declaration
property PathInfo: AnsiString read FPathInfo write FPathInfo;
C++ declaration
__property System::AnsiString PathInfo={ read=FPathInfo, write=FPathInfo, nodefault }

Description
Only the first part of the path (Request->PathList->Strings[0]) is used to find the appropriate actionitem.

Request
Currently active request object

Delphi declaration
property Request: TFRISAPIRequest read FRequest;
C++ declaration
__property TFRISAPIRequest *Request={ read=FRequest, nodefault }

Response
Currently active response object

Delphi declaration
property Response: TFRISAPIResponse read FResponse;
C++ declaration
__property TFRISAPIResponse *Response={ read=FResponse, nodefault }