CancelledNotification class final
This notification is sent by the client to indicate that it is cancelling a request it previously issued.
On stdio, the server also sends this notification, solely to terminate a SubscriptionsListenRequestsubscriptions/listen stream: it references the ID of the subscriptions/listen request that opened the stream. Servers MUST NOT use this notification to cancel any other request.
The request SHOULD still be in-flight, but due to communication latency, it is always possible that this notification MAY arrive after the request has already finished.
This notification indicates that the result will be unused, so any associated processing SHOULD cease.
Revisions: 2024-11-05, 2025-03-26, 2025-06-18, 2025-11-25, 2026-07-28.
- Inheritance
- Implemented types
Constructors
-
CancelledNotification({required CancelledNotificationParams params, Map<
String, Object?> ? extra}) -
CancelledNotification.fromJson(Map<
String, Object?> json) -
Wraps
jsonas 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
- jsonrpc → String
-
no setter
- method → String
-
no setter
- params → CancelledNotificationParams
-
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 byread;nullwhen absent or null.inherited -
$required<
T> (String key, T read(Object? value, String path)) → T -
Required property
key, converted byread.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(
{CancelledNotificationParams? params}) → CancelledNotification - A copy with the given properties replaced; everything else, unknown keys included, is kept.
-
has(
String key) → bool -
Whether
keyis present (anullvalue 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