CompletionItem

case class CompletionItem(label: String, kind: Option[CompletionItemKind] = None, detail: Option[String] = None, documentation: Option[String] = None, deprecated: Option[Boolean] = None, preselect: Option[Boolean] = None, sortText: Option[String] = None, filterText: Option[String] = None, insertText: Option[String] = None, insertTextFormat: Option[InsertTextFormat] = None, textEdit: Option[TextEdit] = None, additionalTextEdits: Option[Seq[TextEdit]] = None, commitCharacters: Option[Seq[Char]] = None, command: Option[Command] = None) extends Product with Serializable

label: The label of this completion item. By default also the text that is inserted when selecting this completion.
kind: The kind of this completion item. Based of the kind an icon is chosen by the editor.
detail: A human-readable string with additional information about this item, like type or symbol information.
documentation: A human-readable string that represents a doc-comment.
deprecated: Indicates if this item is deprecated.
preselect: Select this item when showing. *Note* that only one completion item can be selected and that the tool / client decides which item that is. The rule is that the *first* item of those that match best is selected.
sortText: A string that should be used when comparing this item with other items. When falsy the label is used.
filterText: A string that should be used when filtering a set of completion items. When falsy the label is used.
insertText: A string that should be inserted into a document when selecting this completion. When falsy the label is used. The insertText is subject to interpretation by the client side. Some tools might not take the string literally. For example VS Code when code complete is requested in this example con<cursor position> and a completion item with an insertText of console is provided it will only insert sole. Therefore it is recommended to use textEdit instead since it avoids additional client side interpretation.
insertTextFormat: The format of the insert text. The format applies to both the insertText property and the newText property of a provided textEdit.
textEdit: An edit which is applied to a document when selecting this completion. When an edit is provided the value of insertText is ignored. *Note:* The range of the edit must be a single line range and it must contain the position at which completion has been requested.
additionalTextEdits: An optional array of additional text edits that are applied when selecting this completion. Edits must not overlap (including the same insert position) with the main edit nor with themselves. Additional text edits should be used to change text unrelated to the current cursor position (for example adding an import statement at the top of the file if the completion item will insert an unqualified type).
commitCharacters: An optional set of characters that when pressed while this completion is active will accept it first and then type that character. *Note* that all commit characters should have length=1 and that superfluous characters will be ignored.
command: An optional command that is executed *after* inserting this completion. *Note* that additional modifications to the current document should be described with the additionalTextEdits-property.

Linear Supertypes

Serializable, Serializable, Product, Equals, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

CompletionItem
Serializable
Serializable
Product
Equals
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Instance Constructors

new CompletionItem(label: String, kind: Option[CompletionItemKind] = None, detail: Option[String] = None, documentation: Option[String] = None, deprecated: Option[Boolean] = None, preselect: Option[Boolean] = None, sortText: Option[String] = None, filterText: Option[String] = None, insertText: Option[String] = None, insertTextFormat: Option[InsertTextFormat] = None, textEdit: Option[TextEdit] = None, additionalTextEdits: Option[Seq[TextEdit]] = None, commitCharacters: Option[Seq[Char]] = None, command: Option[Command] = None)
label
The label of this completion item. By default also the text that is inserted when selecting this completion.
kind
The kind of this completion item. Based of the kind an icon is chosen by the editor.
detail
A human-readable string with additional information about this item, like type or symbol information.
documentation
A human-readable string that represents a doc-comment.
deprecated
Indicates if this item is deprecated.
preselect
Select this item when showing. *Note* that only one completion item can be selected and that the tool / client decides which item that is. The rule is that the *first* item of those that match best is selected.
sortText
A string that should be used when comparing this item with other items. When falsy the label is used.
filterText
A string that should be used when filtering a set of completion items. When falsy the label is used.
insertText
A string that should be inserted into a document when selecting this completion. When falsy the label is used. The insertText is subject to interpretation by the client side. Some tools might not take the string literally. For example VS Code when code complete is requested in this example con<cursor position> and a completion item with an insertText of console is provided it will only insert sole. Therefore it is recommended to use textEdit instead since it avoids additional client side interpretation.
insertTextFormat
The format of the insert text. The format applies to both the insertText property and the newText property of a provided textEdit.
textEdit
An edit which is applied to a document when selecting this completion. When an edit is provided the value of insertText is ignored. *Note:* The range of the edit must be a single line range and it must contain the position at which completion has been requested.
additionalTextEdits
An optional array of additional text edits that are applied when selecting this completion. Edits must not overlap (including the same insert position) with the main edit nor with themselves. Additional text edits should be used to change text unrelated to the current cursor position (for example adding an import statement at the top of the file if the completion item will insert an unqualified type).
commitCharacters
An optional set of characters that when pressed while this completion is active will accept it first and then type that character. *Note* that all commit characters should have length=1 and that superfluous characters will be ignored.
command
An optional command that is executed *after* inserting this completion. *Note* that additional modifications to the current document should be described with the additionalTextEdits-property.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val additionalTextEdits: Option[Seq[TextEdit]]
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@native() @throws( ... )
val command: Option[Command]
val commitCharacters: Option[Seq[Char]]
val deprecated: Option[Boolean]
val detail: Option[String]
val documentation: Option[String]
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val filterText: Option[String]
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@native()
val insertText: Option[String]
val insertTextFormat: Option[InsertTextFormat]
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val kind: Option[CompletionItemKind]
val label: String
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native()
val preselect: Option[Boolean]
val sortText: Option[String]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val textEdit: Option[TextEdit]
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@native() @throws( ... )

Packages

CompletionItem

Instance Constructors

Value Members

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

CompletionItem 

Instance Constructors

Value Members

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped

CompletionItem