ProgressStartEventBody class

Inheritance

Constructors

ProgressStartEventBody({bool? cancellable, String? message, num? percentage, required String progressId, int? requestId, required String title})
ProgressStartEventBody.fromMap(Map<String, Object?> obj)

Properties

cancellable bool?
If true, the request that reports progress may be cancelled with a cancel request. So this property basically controls whether the client should use UX that supports cancellation. Clients that don't support cancellation are allowed to ignore the setting.
final
hashCode int
The hash code for this object.
no setterinherited
message String?
More detailed progress message.
final
percentage num?
Progress percentage to display (value range: 0 to 100). If omitted no percentage is shown.
final
progressId String
An ID that can be used in subsequent progressUpdate and progressEnd events to make them refer to the same progress reporting. IDs must be unique within a debug session.
final
requestId int?
The request ID that this progress report is related to. If specified a debug adapter is expected to emit progress events for the long running request until the request has been either completed or cancelled. If the request ID is omitted, the progress report is assumed to be related to some general activity of the debug adapter.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
title String
Short title of the progress reporting. Shown in the UI to describe the long running operation.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Map<String, Object?>
toString() String
A string representation of this object.
inherited

Operators

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

Static Methods

canParse(Object? obj) bool
override
fromJson(Map<String, Object?> obj) ProgressStartEventBody