class LanguageServer::Protocol::Interface::InitializeParams

Attributes

attributes[R]

Public Class Methods

new(work_done_token: nil, process_id:, client_info: nil, locale: nil, root_path: nil, root_uri:, initialization_options: nil, capabilities:, trace: nil, workspace_folders: nil) click to toggle source
# File lib/language_server/protocol/interface/initialize_params.rb, line 5
def initialize(work_done_token: nil, process_id:, client_info: nil, locale: nil, root_path: nil, root_uri:, initialization_options: nil, capabilities:, trace: nil, workspace_folders: nil)
  @attributes = {}

  @attributes[:workDoneToken] = work_done_token if work_done_token
  @attributes[:processId] = process_id
  @attributes[:clientInfo] = client_info if client_info
  @attributes[:locale] = locale if locale
  @attributes[:rootPath] = root_path if root_path
  @attributes[:rootUri] = root_uri
  @attributes[:initializationOptions] = initialization_options if initialization_options
  @attributes[:capabilities] = capabilities
  @attributes[:trace] = trace if trace
  @attributes[:workspaceFolders] = workspace_folders if workspace_folders

  @attributes.freeze
end

Public Instance Methods

capabilities() click to toggle source

The capabilities provided by the client (editor or tool)

@return [ClientCapabilities]

# File lib/language_server/protocol/interface/initialize_params.rb, line 93
def capabilities
  attributes.fetch(:capabilities)
end
client_info() click to toggle source

Information about the client

@return [{ name: string; version?: string; }]

# File lib/language_server/protocol/interface/initialize_params.rb, line 45
def client_info
  attributes.fetch(:clientInfo)
end
initialization_options() click to toggle source

User provided initialization options.

@return [any]

# File lib/language_server/protocol/interface/initialize_params.rb, line 85
def initialization_options
  attributes.fetch(:initializationOptions)
end
locale() click to toggle source

The locale the client is currently showing the user interface in. This must not necessarily be the locale of the operating system.

Uses IETF language tags as the value's syntax (See en.wikipedia.org/wiki/IETF_language_tag)

@return [string]

# File lib/language_server/protocol/interface/initialize_params.rb, line 58
def locale
  attributes.fetch(:locale)
end
process_id() click to toggle source

The process Id of the parent process that started the server. Is null if the process has not been started by another process. If the parent process is not alive then the server should exit (see exit notification) its process.

@return [number]

# File lib/language_server/protocol/interface/initialize_params.rb, line 37
def process_id
  attributes.fetch(:processId)
end
root_path() click to toggle source

The rootPath of the workspace. Is null if no folder is open.

@return [string]

# File lib/language_server/protocol/interface/initialize_params.rb, line 67
def root_path
  attributes.fetch(:rootPath)
end
root_uri() click to toggle source

The rootUri of the workspace. Is null if no folder is open. If both `rootPath` and `rootUri` are set `rootUri` wins.

@return [string]

# File lib/language_server/protocol/interface/initialize_params.rb, line 77
def root_uri
  attributes.fetch(:rootUri)
end
to_hash() click to toggle source
# File lib/language_server/protocol/interface/initialize_params.rb, line 118
def to_hash
  attributes
end
to_json(*args) click to toggle source
# File lib/language_server/protocol/interface/initialize_params.rb, line 122
def to_json(*args)
  to_hash.to_json(*args)
end
trace() click to toggle source

The initial trace setting. If omitted trace is disabled ('off').

@return [TraceValue]

# File lib/language_server/protocol/interface/initialize_params.rb, line 101
def trace
  attributes.fetch(:trace)
end
work_done_token() click to toggle source

An optional token that a server can use to report work done progress.

@return [ProgressToken]

# File lib/language_server/protocol/interface/initialize_params.rb, line 26
def work_done_token
  attributes.fetch(:workDoneToken)
end
workspace_folders() click to toggle source

The workspace folders configured in the client when the server starts. This property is only available if the client supports workspace folders. It can be `null` if the client supports workspace folders but none are configured.

@return [WorkspaceFolder

# File lib/language_server/protocol/interface/initialize_params.rb, line 112
def workspace_folders
  attributes.fetch(:workspaceFolders)
end