TTMSMCPElicitField Class

Describes a single value that a server asks the connected client application to supply.

API unit family: TMS.MCP.Elicitation Inherits from: TPersistent

Syntax

TTMSMCPElicitField = class(TPersistent)

Remarks

A field is created through TTMSMCPElicitSchema.AddField and is rendered by the client as one input of the form it presents to its user. Each field becomes one property of the schema that travels with the elicitation request.

Properties

Name	Description
DefaultValue	Value the client should preselect when it presents this field.
Description	Longer explanation of what should be entered, shown by the client as help text.
EnumValues	Permitted values for a field of type eftEnum, one value per line.
FieldType	Data type asked for. Defaults to eftString.
Name	Key under which the value supplied for this field is returned in the result.
Required	When True, the client must have a value for this field before the user can accept the request; when False, the field may be left out of the response.
Title	Caption the client displays for this field.

Methods

Name	Description
ToJSON	Builds the schema property object that describes this field.