Class: LanguageServer::Protocol::Interface::SignatureHelpClientCapabilities

Inherits:
Object
  • Object
show all
Defined in:
lib/language_server/protocol/interface/signature_help_client_capabilities.rb,
sig/language_server/protocol/interface/signature_help_client_capabilities.rbs

Overview

Client Capabilities for a SignatureHelpRequest.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(dynamic_registration: nil, signature_information: nil, context_support: nil) ⇒ SignatureHelpClientCapabilities

Returns a new instance of SignatureHelpClientCapabilities.

Parameters:

  • dynamic_registration: (Boolean) (defaults to: nil)
  • signature_information: (Object) (defaults to: nil)
  • context_support: (Boolean) (defaults to: nil) 


8
9
10
11
12
13
14
15
16
 
# File 'lib/language_server/protocol/interface/signature_help_client_capabilities.rb', line 8

def initialize(dynamic_registration: nil, signature_information: nil, context_support: nil)
  @attributes = {}

  @attributes[:dynamicRegistration] = dynamic_registration if dynamic_registration
  @attributes[:signatureInformation] = signature_information if signature_information
  @attributes[:contextSupport] = context_support if context_support

  @attributes.freeze
end

Instance Attribute Details

#attributes ⇒ Hash[Symbol, untyped] (readonly)

Returns the value of attribute attributes.

Returns:

  • (Hash[Symbol, untyped]) 


48
49
50
 
# File 'lib/language_server/protocol/interface/signature_help_client_capabilities.rb', line 48

def attributes
  @attributes
end

Instance Method Details

#context_support ⇒ boolean

The client supports to send additional context information for a textDocument/signatureHelp request. A client that opts into contextSupport will also support the retriggerCharacters on SignatureHelpOptions.

Returns:

  • (boolean)

Since:

  • 3.15.0



44
45
46
 
# File 'lib/language_server/protocol/interface/signature_help_client_capabilities.rb', line 44

def context_support
  attributes.fetch(:contextSupport)
end

#dynamic_registration ⇒ boolean

Whether signature help supports dynamic registration.

Returns:

  • (boolean) 


22
23
24
 
# File 'lib/language_server/protocol/interface/signature_help_client_capabilities.rb', line 22

def dynamic_registration
  attributes.fetch(:dynamicRegistration)
end

#signature_information ⇒ { documentationFormat?: MarkupKind[]; parameterInformation?: { labelOffsetSupport?: boolean; }; activeParameterSupport?: boolean; }

The client supports the following SignatureInformation specific properties.

Returns:

  • ({ documentationFormat?: MarkupKind[]; parameterInformation?: { labelOffsetSupport?: boolean; }; activeParameterSupport?: boolean; }) 


31
32
33
 
# File 'lib/language_server/protocol/interface/signature_help_client_capabilities.rb', line 31

def signature_information
  attributes.fetch(:signatureInformation)
end

#to_hash ⇒ Hash[Symbol, untyped]

Returns:

  • (Hash[Symbol, untyped]) 


50
51
52
 
# File 'lib/language_server/protocol/interface/signature_help_client_capabilities.rb', line 50

def to_hash
  attributes
end

#to_json(*args) ⇒ String

Parameters:

  • (Object)

Returns:

  • (String) 


54
55
56
 
# File 'lib/language_server/protocol/interface/signature_help_client_capabilities.rb', line 54

def to_json(*args)
  to_hash.to_json(*args)
end