Skip to main content

Definition

Assembly: CloudNimble.McpEssentials.Core.dll Namespace: CloudNimble.McpEssentials.Core.Tasks.Elicitations Inheritance: CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder

Syntax

Summary

Typed form builder. String) seeds mappable properties, then expression starters reconfigure them and string starters add extra fields.

Type Parameters

  • T - The form type.

Constructors

.ctor

Initializes a builder seeded from T.

Syntax

Parameters

.ctor Inherited

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder
Initializes a builder with message as the prompt.

Syntax

Parameters

Exceptions

.ctor Inherited

Inherited from object

Syntax

Properties

Fields Inherited

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder
Gets the fields accumulated so far, in insertion order.

Syntax

Property Value

Type: System.Collections.Generic.List<CloudNimble.McpEssentials.Core.Tasks.Elicitations.ElicitationField>

IsSealed Inherited

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder
Gets whether field changes are refused because an output method has already run.

Syntax

Property Value

Type: bool

Message Inherited

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder
Gets the prompt presented with the form.

Syntax

Property Value

Type: string

Name Inherited

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder
Gets or sets the optional keyed-DI name published on the XML island.

Syntax

Property Value

Type: string?

Methods

ApplyCommon Inherited

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder
Applies common title, description, and required facets, overwriting Titleize defaults.

Syntax

Parameters

ApplyField Inherited

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder
Applies one snapshot field onto this builder using the public starters.

Syntax

Parameters

Exceptions

Boolean

Syntax

Parameters

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.BooleanFieldBuilder<T>

Boolean Virtual

Adds or reconfigures a boolean field for property.

Syntax

Parameters

Returns

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

Type Parameters

  • TProp - The property type.

Boolean Inherited Virtual

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder
Adds or reconfigures a boolean field named name.

Syntax

Parameters

Returns

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

Build Inherited Virtual

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder
Builds SDK ElicitRequestParams for form mode.

Syntax

Returns

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

Exceptions

Choice

Syntax

Parameters

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.ChoiceFieldBuilder<T>

Choice Virtual

Adds or reconfigures a single-select field for property.

Syntax

Parameters

Returns

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

Type Parameters

  • TProp - The property type.

Choice Inherited Virtual

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder
Adds or reconfigures a single-select field named name.

Syntax

Parameters

Returns

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

Date

Syntax

Parameters

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder<T>

Date Virtual

Adds or reconfigures a date field for property.

Syntax

Parameters

Returns

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

Type Parameters

  • TProp - The property type.

Date Inherited Virtual

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder
Adds or reconfigures a string field with format date.

Syntax

Parameters

Returns

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

DateTime

Syntax

Parameters

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder<T>

DateTime Virtual

Adds or reconfigures a date-time field for property.

Syntax

Parameters

Returns

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

Type Parameters

  • TProp - The property type.

DateTime Inherited Virtual

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder
Adds or reconfigures a string field with format date-time.

Syntax

Parameters

Returns

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

Email

Syntax

Parameters

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder<T>

Email Virtual

Adds or reconfigures an email field for property.

Syntax

Parameters

Returns

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

Type Parameters

  • TProp - The property type.

Email Inherited Virtual

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder
Adds or reconfigures a string field with format email.

Syntax

Parameters

Returns

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

Equals Inherited Virtual

Inherited from object

Syntax

Parameters

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

Parameters

Returns

Type: bool

Exclude Virtual

Removes the field for property if it was seeded or added. No-ops when the property was unmappable or never added.

Syntax

Parameters

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder<T> This builder.

Type Parameters

  • TProp - The property type.

GetHashCode Inherited Virtual

Inherited from object

Syntax

Returns

Type: int

GetOrAdd Inherited

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder
Gets the field with camelCase name name, adding it when missing. Reconfiguring a different kind resets kind-specific constraints.

Syntax

Parameters

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.ElicitationField The field.

Exceptions

GetType Inherited

Inherited from object

Syntax

Returns

Type: System.Type

Integer

Syntax

Parameters

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.NumberFieldBuilder<T>

Integer Virtual

Adds or reconfigures an integer field for property.

Syntax

Parameters

Returns

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

Type Parameters

  • TProp - The property type.

Integer Inherited Virtual

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder
Adds or reconfigures an integer field named name.

Syntax

Parameters

Returns

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

MemberwiseClone Inherited

Inherited from object

Syntax

Returns

Type: object

MultiChoice

Syntax

Parameters

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.MultiChoiceFieldBuilder<T>

MultiChoice Virtual

Adds or reconfigures a multi-select field for property.

Syntax

Parameters

Returns

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

Type Parameters

  • TProp - The property type.

MultiChoice Inherited Virtual

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder
Adds or reconfigures a multi-select field named name.

Syntax

Parameters

Returns

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

Number

Syntax

Parameters

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.NumberFieldBuilder<T>

Number Virtual

Adds or reconfigures a number field for property.

Syntax

Parameters

Returns

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

Type Parameters

  • TProp - The property type.

Number Inherited Virtual

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder
Adds or reconfigures a floating-point field named name.

Syntax

Parameters

Returns

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

ReferenceEquals Inherited

Inherited from object

Syntax

Parameters

Returns

Type: bool

Remove Inherited

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder
Removes the field whose wire name matches name, if present.

Syntax

Parameters

String

Syntax

Parameters

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder<T>

String Virtual

Adds or reconfigures a string field for property.

Syntax

Parameters

Returns

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

Type Parameters

  • TProp - The property type.

String Inherited Virtual

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder
Adds or reconfigures a string field named name.

Syntax

Parameters

Returns

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

ThrowIfSealed Inherited

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder
Throws when an output method has already materialized this form.

Syntax

Exceptions

ToDefinition Inherited Virtual

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder
Snapshots this form as an immutable definition.

Syntax

Returns

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

Exceptions

ToFieldDefinition Inherited

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder
Projects a live field onto an immutable snapshot, marking default options as selected.

Syntax

Parameters

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormFieldDefinition The snapshot field.

ToFieldType Inherited

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder
Maps a live kind onto the public snapshot type.

Syntax

Parameters

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormFieldType The snapshot type.

Exceptions

ToInputRequest Inherited Virtual

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder
Builds an InputRequest wrapping FormElicitationBuilder.Build.

Syntax

Returns

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

ToJson Inherited Virtual

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder
Returns the elicitation JSON already stored on Params.

Syntax

Returns

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

ToString Inherited Virtual

Inherited from object

Syntax

Returns

Type: string?

ToXml Inherited Virtual

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder
Serializes this form as a compact XML island.

Syntax

Parameters

Returns

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

Uri

Syntax

Parameters

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder<T>

Uri Virtual

Adds or reconfigures a URI field for property.

Syntax

Parameters

Returns

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

Type Parameters

  • TProp - The property type.

Uri Inherited Virtual

Inherited from CloudNimble.McpEssentials.Core.Tasks.Elicitations.FormElicitationBuilder
Adds or reconfigures a string field with format uri.

Syntax

Parameters

Returns

Type: CloudNimble.McpEssentials.Core.Tasks.Elicitations.StringFieldBuilder The string field facade.
  • CloudNimble.McpEssentials.Core.Tasks.Elicitations.IFormElicitationSource<T>
  • CloudNimble.McpEssentials.Core.Tasks.Elicitations.IFormElicitationSource