class LSProtocol::SignatureHelpContext
- LSProtocol::SignatureHelpContext
- Reference
- Object
Overview
Additional information about the context in which a signature help request was triggered.
@since 3.15.0
Included Modules
- JSON::Serializable
Defined in:
lsprotocol/types.crConstructors
- .new(is_retrigger : Bool | Nil, trigger_kind : SignatureHelpTriggerKind | Nil, active_signature_help : SignatureHelp | Nil = nil, trigger_character : String | Nil = nil)
- .new(pull : JSON::PullParser)
Instance Method Summary
-
#active_signature_help : SignatureHelp | Nil
The currently active
SignatureHelp
. -
#is_retrigger : Bool
true
if signature help was already showing when it was triggered. -
#trigger_character : String | Nil
Character that caused signature help to be triggered.
-
#trigger_kind : SignatureHelpTriggerKind
Action that caused signature help to be triggered.
Constructor Detail
Instance Method Detail
The currently active SignatureHelp
.
The activeSignatureHelp
has its SignatureHelp.activeSignature
field updated based on
the user navigating through available signatures.
true
if signature help was already showing when it was triggered.
Retriggers occurs 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.
Character that caused signature help to be triggered.
This is undefined when triggerKind !== SignatureHelpTriggerKind.TriggerCharacter