class LanguageServer::Protocol::Interface::SignatureHelpContext

Additional information about the context in which a signature help request was triggered.

Attributes

attributes[R]

Public Class Methods

new(trigger_kind:, trigger_character: nil, is_retrigger:, active_signature_help: nil) click to toggle source
# File lib/language_server/protocol/interface/signature_help_context.rb, line 9
def initialize(trigger_kind:, trigger_character: nil, is_retrigger:, active_signature_help: nil)
  @attributes = {}

  @attributes[:triggerKind] = trigger_kind
  @attributes[:triggerCharacter] = trigger_character if trigger_character
  @attributes[:isRetrigger] = is_retrigger
  @attributes[:activeSignatureHelp] = active_signature_help if active_signature_help

  @attributes.freeze
end

Public Instance Methods

active_signature_help() click to toggle source

The currently active `SignatureHelp`.

The `activeSignatureHelp` has its `SignatureHelp.activeSignature` field updated based on the user navigating through available signatures.

@return [SignatureHelp]

# File lib/language_server/protocol/interface/signature_help_context.rb, line 58
def active_signature_help
  attributes.fetch(:activeSignatureHelp)
end
is_retrigger() click to toggle source

`true` if signature help was already showing when it was triggered.

Retriggers occur when the signature help is already active and can be caused by actions such as typing a trigger character, a cursor move, or document content changes.

@return [boolean]

# File lib/language_server/protocol/interface/signature_help_context.rb, line 47
def is_retrigger
  attributes.fetch(:isRetrigger)
end
to_hash() click to toggle source
# File lib/language_server/protocol/interface/signature_help_context.rb, line 64
def to_hash
  attributes
end
to_json(*args) click to toggle source
# File lib/language_server/protocol/interface/signature_help_context.rb, line 68
def to_json(*args)
  to_hash.to_json(*args)
end
trigger_character() click to toggle source

Character that caused signature help to be triggered.

This is undefined when triggerKind !== SignatureHelpTriggerKind.TriggerCharacter

@return [string]

# File lib/language_server/protocol/interface/signature_help_context.rb, line 35
def trigger_character
  attributes.fetch(:triggerCharacter)
end
trigger_kind() click to toggle source

Action that caused signature help to be triggered.

@return [SignatureHelpTriggerKind]

# File lib/language_server/protocol/interface/signature_help_context.rb, line 24
def trigger_kind
  attributes.fetch(:triggerKind)
end