GetPromptRequestParams class final

Parameters for a prompts/get request.

Revisions: 2025-11-25, 2026-07-28.

Inheritance

Constructors

GetPromptRequestParams({RequestMetaObject? meta, Map<String, Object?>? arguments, required String name, Map<String, Map<String, Object?>>? inputResponses, String? requestState, Map<String, Object?>? extra})
GetPromptRequestParams.fromJson(Map<String, Object?> json)
Wraps json as received; nothing is dropped.

Properties

arguments → Map<String, Object?>?
Arguments to use for templating the prompt.
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
inputResponses → Map<String, Map<String, Object?>>?
no setter
meta → RequestMetaObject?
no setter
name → String
The name of the prompt or prompt template.
no setter
requestState → String?
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

Methods

$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({RequestMetaObject? meta, Map<String, Object?>? arguments, String? name, Map<String, Map<String, Object?>>? inputResponses, String? requestState}) → GetPromptRequestParams
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

Operators

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

Constants

keys → const Set<String>