Contents

# The event signals that a long running operation is about to start and provides
# additional information for the client to set up a corresponding progress and
# cancellation UI. The client is free to delay the showing of the UI in order to
# reduce flicker. This event should only be sent if the client has passed the
# value true for the ‘supportsProgressReporting’ capability of the ‘initialize’
# request.
class DAP::ProgressStartEventBody < DAP::Base
  # An ID that must 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.
  property :progressId, as: 'string'

  # Mandatory (short) title of the progress reporting. Shown in the UI to describe the long running operation.
  property :title, as: 'string'

  # 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.
  property :requestId, required: false, as: 'number'

  # If true, the request that reports progress may be canceled 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.
  property :cancellable, required: false, as: 'boolean'

  # Optional, more detailed progress message.
  property :message, required: false, as: 'string'

  # Optional progress percentage to display (value range: 0 to 100). If omitted no percentage will be shown.
  property :percentage, required: false, as: 'number'
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
ruby-dap-0.1.3	lib/dap/progress_start_event_body.rb