ElicitRequestURLParams class final

The parameters for a request to elicit information from the user via a URL in the client.

Revisions: 2025-11-25, 2026-07-28, ext-tasks/2026-07-28.

Inheritance

Implemented types

Constructors

ElicitRequestURLParams({ElicitRequestURLParamsMeta? meta, String? elicitationId, required String message, TaskMetadata? task, required String url, Map<String, Object?>? extra})
ElicitRequestURLParams.fromJson(Map<String, Object?> json): Wraps json as received; nothing is dropped.

elicitationId → String?: The ID of the elicitation, which must be unique within the context of the server. The client MUST treat this ID as an opaque value.
no setter
extra → Map<String, Object?>: Keys outside the schema (newer revisions, extensions, applications).
no setterinherited
hashCode → int: The hash code for this object.
no setterinherited
message → String: The message to present to the user explaining why the interaction is needed.
no setter
meta → ElicitRequestURLParamsMeta?: See General fields: _meta for notes on _meta usage.
no setter
mode → String: The elicitation mode.
no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
schemaKeys → Set<String>: Property names the schema defines for this type.
no setteroverride
task → TaskMetadata?: If specified, the caller is requesting task-augmented execution for this request. The request will return a CreateTaskResult immediately, and the actual result can be retrieved later via tasks/result.
no setter
url → String: The URL that the user should navigate to.
no setter

$optional<T>(String key, T? read(Object? value, String path)) → T?: Optional property key, converted by read; null when absent or null.
inherited
$required<T>(String key, T read(Object? value, String path)) → T: Required property key, converted by read.
inherited
check() → List<String>: Reads every property this type defines and returns what could not be read (missing required properties, wrong types), nested types included. Empty = the JSON matches the schema's shape for this type.
override
copyWith({ElicitRequestURLParamsMeta? meta, String? elicitationId, String? message, TaskMetadata? task, String? url}) → ElicitRequestURLParams: A copy with the given properties replaced; everything else, unknown keys included, is kept.
has(String key) → bool: Whether key is present (a null value counts as present).
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, Object?>: The JSON form of this value.
inherited
toString() → String: A string representation of this object.
inherited

operator ==(Object other) → bool: Equal when the JSON is equal; key order does not matter.
inherited
operator [](String key) → Object?: The raw JSON value of key.
inherited