TTMSMCPCustomClientConnection.OnElicitationCreate Event

Occurs when the server asks the application to collect input from the user.

API unit family: TMS.MCP.Client.Connection Declaring type: TTMSMCPCustomClientConnection

Syntax

OnElicitationCreate: TTMSMCPClientServerElicitationEvent;

Remarks

Raised on the main thread, so a handler may show a dialog. Without a handler the request is dismissed. The event is only raised for a request kind that is enabled in Capabilities; any other kind is refused with an invalid-parameters error. The answer is sent as soon as the handler returns, so the handler must be synchronous.

Parameters

Name	Description
Sender	Connection that received the request.
AParams	Request parameters, holding at least the requested mode and, for a link request, the url to open. Read them to decide what to present; the object belongs to the request being processed.
AUserResponse	Outcome reported to the server. It enters as urCancel, so the request is dismissed unless the handler changes it; only urAccept sends the collected values on, and for a link request only urAccept opens the address.
AResponseContent	Object the handler fills with the collected values. It is created and released by the caller, so add pairs to it rather than replacing it; its content is sent only for an accepted form request.