Class: DSP::ProgressStartEvent

Inherits:
DSPBase
  • Object
show all
Defined in:
lib/dsp/dsp_protocol.rb

Overview

interface ProgressStartEvent extends Event {

    body: {
        /** 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.
        */
        progressId: string;
        /** Mandatory (short) title of the progress reporting. Shown in the UI to describe the long running operation. */
        title: 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.
        */
        requestId?: 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.
        */
        cancellable?: boolean;
        /** Optional, more detailed progress message. */
        message?: string;
        /** Optional progress percentage to display (value range: 0 to 100). If omitted no percentage will be shown. */
        percentage?: number;
    };
}

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from DSPBase

#initialize, #to_h, #to_json

Constructor Details

This class inherits a constructor from DSP::DSPBase

Instance Attribute Details

#body ⇒ Object

type: {



659
660
661
 
# File 'lib/dsp/dsp_protocol.rb', line 659

def body
  @body
end

#event ⇒ Object

/** 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.
    */
    progressId: string;
    /** Mandatory (short) title of the progress reporting. Shown in the UI to describe the long running operation. */
    title: 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.
    */
    requestId?: 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.
    */
    cancellable?: boolean;
    /** Optional, more detailed progress message. */
    message?: string;
    /** Optional progress percentage to display (value range: 0 to 100). If omitted no percentage will be shown. */
    percentage?: number;
}



681
682
683
 
# File 'lib/dsp/dsp_protocol.rb', line 681

def event
  @event
end

#seq ⇒ Object

type: {



659
660
661
 
# File 'lib/dsp/dsp_protocol.rb', line 659

def seq
  @seq
end

#type ⇒ Object

type: {



659
660
661
 
# File 'lib/dsp/dsp_protocol.rb', line 659

def type
  @type
end

Instance Method Details

#from_h!(value) ⇒ Object 



683
684
685
686
687
688
689
690
 
# File 'lib/dsp/dsp_protocol.rb', line 683

def from_h!(value)
  value = {} if value.nil?
  self.body = value['body'] # Unknown type
  self.event = value['event']
  self.seq = value['seq']
  self.type = value['type']
  self
end