InputRequiredResult class final

An InputRequiredResult sent by the server to indicate that additional input is needed before the request can be completed.

At least one of inputRequests or requestState MUST be present.

Revisions: 2026-07-28.

Inheritance

Constructors

InputRequiredResult({ResultMetaObject? meta, Map<String, InputRequest>? inputRequests, String? requestState, required String resultType, Map<String, Object?>? extra})
InputRequiredResult.fromJson(Map<String, Object?> json)
Wraps json as received; nothing is dropped.

Properties

extra → Map<String, Object?>
Keys outside the schema (newer revisions, extensions, applications).
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
inputRequests → Map<String, InputRequest>?
no setter
meta → ResultMetaObject?
no setter
requestState → String?
no setter
resultType → String
Indicates the type of the result, which allows the client to determine how to parse the result object.
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({ResultMetaObject? meta, Map<String, InputRequest>? inputRequests, String? requestState, String? resultType}) → InputRequiredResult
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>