ReadResourceResult class final

The result returned by the server for a ReadResourceRequestresources/read request.

Revisions: 2024-11-05, 2025-03-26, 2025-06-18, 2025-11-25, 2026-07-28.

Inheritance

Constructors

ReadResourceResult({ResultMetaObject? meta, required List<ResourceContents> contents, ReadResourceResultCacheScope? cacheScope, String? resultType, int? ttlMs, Map<String, Object?>? extra})
ReadResourceResult.fromJson(Map<String, Object?> json): Wraps json as received; nothing is dropped.

cacheScope → ReadResourceResultCacheScope?: Indicates the intended scope of the cached response, analogous to HTTP Cache-Control: public vs Cache-Control: private.
no setter
contents → List<ResourceContents>: 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
meta → ResultMetaObject?: 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
ttlMs → int?: A hint from the server indicating how long (in milliseconds) the client MAY cache this response before re-fetching. Semantics are analogous to HTTP Cache-Control max-age.
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({ResultMetaObject? meta, List<ResourceContents>? contents, ReadResourceResultCacheScope? cacheScope, String? resultType, int? ttlMs}) → ReadResourceResult: 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