ElicitationRequest class

Typed view over an elicitation/create request's params.

Annotations
  • @immutable

Constructors

ElicitationRequest({required String message, required ElicitationMode mode, String? url, Map<String, dynamic>? requestedSchema, Map<String, ElicitationFieldSchema> fields = const {}, List<String> requiredFields = const [], required Map<String, dynamic> raw})
const
ElicitationRequest.fromJson(Map<String, dynamic> params)
factory

Properties

fields Map<String, ElicitationFieldSchema>
Typed parse of requestedSchema.properties, keyed by field name.
final
hashCode int
The hash code for this object.
no setterinherited
isUrlMode bool
Whether this is a URL-mode request (SEP-1036).
no setter
message String
Human-readable prompt shown to the user.
final
mode ElicitationMode
Presentation mode (ElicitationMode.form by default).
final
raw Map<String, dynamic>
The full raw params map, retained for lossless round-tripping.
final
requestedSchema Map<String, dynamic>?
The raw requested schema (form mode). Preserved verbatim so nothing is lost even for shapes this layer does not specialize.
final
requiredFields List<String>
Names of required fields (requestedSchema.required).
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
url String?
Destination URL for ElicitationMode.url requests (SEP-1036); null in form mode.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Map<String, dynamic>
Serialize back to the wire shape. Round-trips raw verbatim so any keys this layer does not model are preserved.
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited