class LSProtocol::ShowDocumentParams
- LSProtocol::ShowDocumentParams
- Reference
- Object
Overview
Params to show a resource in the UI.
@since 3.16.0
Included Modules
- JSON::Serializable
Defined in:
lsprotocol/types.crConstructors
- .new(pull : JSON::PullParser)
- .new(uri : URI | Nil, external : Bool | Nil = nil, selection : Range | Nil = nil, take_focus : Bool | Nil = nil)
Instance Method Summary
-
#external : Bool | Nil
Indicates to show the resource in an external program.
-
#selection : Range | Nil
An optional selection range if the document is a text document.
-
#take_focus : Bool | Nil
An optional property to indicate whether the editor showing the document should take focus or not.
-
#uri : URI
The uri to show.
Constructor Detail
Instance Method Detail
Indicates to show the resource in an external program.
To show, for example, https://code.visualstudio.com/
in the default WEB browser set #external to true.
An optional selection range if the document is a text document. Clients might ignore the property if an external program is started or the file is not a text file.
An optional property to indicate whether the editor showing the document should take focus or not. Clients might ignore this property if an external program is started.