FormElicitationBuilderBase

Definition

Assembly: CloudNimble.McpEssentials.Core.dll Namespace: CloudNimble.McpEssentials.Core.Tasks.Elicitations Inheritance: System.Object

Syntax

CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilderBase

Summary

Shared fluent implementation for untyped and typed form builders. Field starters return a facade for the current field; the next starter, and FormElicitationBuilderBase.Build, stay on the chain.

Constructors

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

Message

Gets the prompt presented with the form.

Syntax

public string Message { get; }

Property Value

Type: string

Name

Gets or sets the optional keyed-DI name published on the XML island.

Syntax

public string Name { get; set; }

Property Value

Type: string?

Methods

Boolean Virtual

Adds or reconfigures a boolean field named name.

Syntax

public virtual CloudNimble.McpEssentials.Core.Tasks.Elicitations.BooleanFieldBuilder Boolean(string name)

Parameters

Name	Type	Description
`name`	`string`	The field identifier. CamelCased on the wire.

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.BooleanFieldBuilder The boolean field facade.

Build Virtual

Builds SDK ElicitRequestParams for form mode.

Syntax

public virtual ModelContextProtocol.Protocol.ElicitRequestParams Build()

Returns

Type: ModelContextProtocol.Protocol.ElicitRequestParams The elicitation request parameters.

Exceptions

Exception	Description
`InvalidOperationException`	Thrown when the message is blank or a field is invalid.

Choice Virtual

Adds or reconfigures a single-select field named name.

Syntax

public virtual CloudNimble.McpEssentials.Core.Tasks.Elicitations.ChoiceFieldBuilder Choice(string name)

Parameters

Name	Type	Description
`name`	`string`	The field identifier. CamelCased on the wire.

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.ChoiceFieldBuilder The choice field facade.

Date Virtual

Adds or reconfigures a string field with format date.

Syntax

public virtual CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder Date(string name)

Parameters

Name	Type	Description
`name`	`string`	The field identifier. CamelCased on the wire.

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder The string field facade.

DateTime Virtual

Adds or reconfigures a string field with format date-time.

Syntax

public virtual CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder DateTime(string name)

Parameters

Name	Type	Description
`name`	`string`	The field identifier. CamelCased on the wire.

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder The string field facade.

Email Virtual

Adds or reconfigures a string field with format email.

Syntax

public virtual CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder Email(string name)

Parameters

Name	Type	Description
`name`	`string`	The field identifier. CamelCased on the wire.

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder The string field facade.

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

Name	Type	Description
`obj`	`object?`	-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

Integer Virtual

Adds or reconfigures an integer field named name.

Syntax

public virtual CloudNimble.McpEssentials.Core.Tasks.Elicitations.NumberFieldBuilder Integer(string name)

Parameters

Name	Type	Description
`name`	`string`	The field identifier. CamelCased on the wire.

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.NumberFieldBuilder The number field facade.

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

MultiChoice Virtual

Adds or reconfigures a multi-select field named name.

Syntax

public virtual CloudNimble.McpEssentials.Core.Tasks.Elicitations.MultiChoiceFieldBuilder MultiChoice(string name)

Parameters

Name	Type	Description
`name`	`string`	The field identifier. CamelCased on the wire.

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.MultiChoiceFieldBuilder The multi-choice field facade.

Number Virtual

Adds or reconfigures a floating-point field named name.

Syntax

public virtual CloudNimble.McpEssentials.Core.Tasks.Elicitations.NumberFieldBuilder Number(string name)

Parameters

Name	Type	Description
`name`	`string`	The field identifier. CamelCased on the wire.

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.NumberFieldBuilder The number field facade.

ReferenceEquals Inherited

Inherited from object

Syntax

public static bool ReferenceEquals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

String Virtual

Adds or reconfigures a string field named name.

Syntax

public virtual CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder String(string name)

Parameters

Name	Type	Description
`name`	`string`	The field identifier. CamelCased on the wire.

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder The string field facade.

ToDefinition Virtual

Snapshots this form as an immutable definition.

Syntax

public virtual CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormDefinition ToDefinition()

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormDefinition The field graph independent of the fluent builder.

Exceptions

Exception	Description
`InvalidOperationException`	Thrown when the message is blank or a field is invalid.

ToInputRequest Virtual

Builds an InputRequest wrapping FormElicitationBuilderBase.Build.

Syntax

public virtual ModelContextProtocol.Protocol.InputRequest ToInputRequest()

Returns

Type: ModelContextProtocol.Protocol.InputRequest An elicitation input request for task attachment.

ToJson Virtual

Returns the elicitation JSON already stored on Params.

Syntax

public virtual System.Nullable<System.Text.Json.JsonElement> ToJson()

Returns

Type: System.Nullable<System.Text.Json.JsonElement> The cached request parameters as JSON.

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?

ToXml Virtual

Serializes this form as a compact XML island.

Syntax

public virtual string ToXml(string xmlNamespace = null)

Parameters

Name	Type	Description
`xmlNamespace`	`string?`	Optional xmlns on the `Form` element.

Returns

Type: string The island text, with no XML declaration.

Uri Virtual

Adds or reconfigures a string field with format uri.

Syntax

public virtual CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder Uri(string name)

Parameters

Name	Type	Description
`name`	`string`	The field identifier. CamelCased on the wire.

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder The string field facade.

CloudNimble.McpEssentials.Core.Tasks.Elicitations.IFormElicitationSource

​Definition

​Syntax

​Summary

​Constructors

​ .ctor Inherited

​Syntax

​Properties

​ Message

​Syntax

​Property Value

​ Name

​Syntax

​Property Value

​Methods

​ Boolean Virtual

​Syntax

​Parameters

​Returns

​ Build Virtual

​Syntax

​Returns

​Exceptions

​ Choice Virtual

​Syntax

​Parameters

​Returns

​ Date Virtual

​Syntax

​Parameters

​Returns

​ DateTime Virtual

​Syntax

​Parameters

​Returns

​ Email Virtual

​Syntax

​Parameters

​Returns

​ Equals Inherited Virtual

​Syntax

​Parameters

​Returns

​ Equals Inherited

​Syntax

​Parameters

​Returns

​ GetHashCode Inherited Virtual

​Syntax

​Returns

​ GetType Inherited

​Syntax

​Returns

​ Integer Virtual

​Syntax

​Parameters

​Returns

​ MemberwiseClone Inherited

​Syntax

​Returns

​ MultiChoice Virtual

​Syntax

​Parameters

​Returns

​ Number Virtual

​Syntax

​Parameters

​Returns

​ ReferenceEquals Inherited

​Syntax

​Parameters

​Returns

​ String Virtual

​Syntax

​Parameters

​Returns

​ ToDefinition Virtual

​Syntax

​Returns

​Exceptions

​ ToInputRequest Virtual

Definition

Syntax

Summary

Constructors

.ctor Inherited

Syntax

Properties

Message

Syntax

Property Value

Name

Syntax

Property Value

Methods

Boolean Virtual

Syntax

Parameters

Returns

Build Virtual

Syntax

Returns

Exceptions

Choice Virtual

Syntax

Parameters

Returns

Date Virtual

Syntax

Parameters

Returns

DateTime Virtual

Syntax

Parameters

Returns

Email Virtual

Syntax

Parameters

Returns

Equals Inherited Virtual

Syntax

Parameters

Returns

Equals Inherited

Syntax

Parameters

Returns

GetHashCode Inherited Virtual

Syntax

Returns

GetType Inherited

Syntax

Returns

Integer Virtual

Syntax

Parameters

Returns

MemberwiseClone Inherited

Syntax

Returns

MultiChoice Virtual

Syntax

Parameters

Returns

Number Virtual

Syntax

Parameters

Returns

ReferenceEquals Inherited

Syntax

Parameters

Returns

String Virtual

Syntax

Parameters

Returns

ToDefinition Virtual

Syntax

Returns

Exceptions

ToInputRequest Virtual