ILanguageClient Rozhraní

Reference

Definice

Obor názvů:: Microsoft.VisualStudio.LanguageServer.Client

Sestavení:: Microsoft.VisualStudio.LanguageServer.Client.dll

Balíček:: Microsoft.VisualStudio.LanguageServer.Client v17.11.32

Důležité

Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.

Rozhraní představujícího klienta jazyka, který se připojuje k jazykovému serveru založenému na protokolu jazyka.

public interface class ILanguageClient

public interface ILanguageClient

type ILanguageClient = interface

Public Interface ILanguageClient

Poznámky

Normální posloupnost aktivace pro ILanguageClient tento vzor:

Volání sady OnLoadedAsync()Visual Studio
Rozšíření volá a čeká InvokeAsync<TEventArgs>(AsyncEventHandler<TEventArgs>, Object, TEventArgs) na StartAsync událost, než se vrátí z OnLoadedAsync(),
Visual Studio volá a čeká ActivateAsync(CancellationToken) , než se vrátí z OnLoadedAsync(),
Rozšíření spustí server LSP a vrátí Connection do sady Visual Studio
Visual Studio spustí asynchronně inicializaci serveru pomocí zpráv "initialize" a "initialized" LSP.
Visual Studio dokončí StartAsync zpracování událostí.
Rozšíření dokončí OnLoadedAsync() provádění.
Visual Studio volá metodu OnServerInitializedAsync() po výměně zpráv LSP "initialize" a "initialized" (nebo OnServerInitializeFailedAsync(ILanguageClientInitializationInfo) metody v případě selhání).

Vlastnosti

ConfigurationSections	Získá názvy konfiguračních oddílů pro klienta jazyka. Tato hodnota může být null, pokud jazykový klient neposkytuje nastavení.
FilesToWatch	Získá seznam názvů souborů pro watch pro změny. Změny se odešlou na server prostřednictvím zprávy workspace/didChangeWatchedFiles. Soubory, které chcete watch, musí být v aktuálním aktivním pracovním prostoru. Názvy souborů je možné zadat jako relativní cestu k přesnému souboru nebo jako vzory globů za standardem v souboru .gitignore viz https://www.kernel.org/pub/software/scm/git/docs/gitignore.html soubory.
InitializationOptions	Získá inicializační možnosti objektu klient chce odeslat při "initialize" zpráva je odeslána. Tato hodnota může být null, pokud klient nepotřebuje vlastní možnosti inicializace.
Name	Získá název jazykového klienta (zobrazí se uživateli).
ShowNotificationOnInitializeFailed	Získá hodnotu označující, zda se zobrazí bublina oznámení při selhání inicializace jazykového serveru.

Metody

ActivateAsync(CancellationToken)	Tato metoda je volána sadou Visual Studio, aby oznámila rozšíření, že by se měl spustit server LSP.
OnLoadedAsync()	Tato metoda je volána sadou Visual Studio oznámit rozšíření, že byl načten klient jazyka. Rozšíření může okamžitě spustit server LSP nebo počkat na spuštění akce uživatele. Chcete-li spustit volání serveru a čekat InvokeAsync<TEventArgs>(AsyncEventHandler<TEventArgs>, Object, TEventArgs) na StartAsync událost před návratem z této metody.
OnServerInitializedAsync()	Tato metoda je volána sadou Visual Studio k oznámení rozšíření, že server LSP byl inicializován: LSP "initialize" a "initialized" zprávy byly vyměněny.
OnServerInitializeFailedAsync(Exception)	Signalizuje rozšíření, že se jazykovému serveru nepodařilo inicializovat.
OnServerInitializeFailedAsync(ILanguageClientInitializationInfo)	Tato metoda je volána sadou Visual Studio, aby oznámila rozšíření, že inicializace serveru LSP selhala.

Událost

StartAsync	Asynchronní událost, která značí sadě Visual Studio, že server by se měl spustit voláním ActivateAsync(CancellationToken). Pokud je server již spuštěný, bude tato událost ignorována.
StopAsync	Asynchronní událost indikuje sadě Visual Studio, že server by se měl zastavit odesláním požadavku na vypnutí LSP. Pokud server není spuštěný, bude tato událost ignorována.

Platí pro

Sdílet prostřednictvím