Interface CancelledNotificationParams

Parameters for a notifications/cancelled notification.

interface CancelledNotificationParams {
    _meta?: { [key: string]: unknown };
    reason?: string;
    requestId: RequestId;
}

Properties

_meta?: { [key: string]: unknown }

See General fields: _meta for notes on _meta usage.

reason?: string

An optional string describing the reason for the cancellation. This MAY be logged or presented to the user.

requestId: RequestId

The ID of the request to cancel.

This MUST correspond to the ID of a request previously issued in the same direction.