ILanguageClient Schnittstelle

Definition

Namespace:

Microsoft.VisualStudio.LanguageServer.Client

Assembly:

Microsoft.VisualStudio.LanguageServer.Client.dll

Paket:

Microsoft.VisualStudio.LanguageServer.Client v17.11.32

Schnittstelle, die einen Sprachclient darstellt, der eine Verbindung mit einem language sever-protokollbasierten Sprachserver herstellt.

public interface class ILanguageClient

public interface ILanguageClient

type ILanguageClient = interface

Public Interface ILanguageClient

Hinweise

Eine normale Sequenz der Aktivierung für folgt ILanguageClient diesem Muster:

1. Visual Studio ruft auf OnLoadedAsync(),
2. Die Erweiterung ruft auf und wartet InvokeAsync<TEventArgs>(AsyncEventHandler<TEventArgs>, Object, TEventArgs) auf das StartAsync Ereignis, bevor sie von zurückgegeben wird OnLoadedAsync().
3. Visual Studio ruft auf und wartet, ActivateAsync(CancellationToken) bevor von zurückgegeben wird OnLoadedAsync().
4. Die Erweiterung startet den LSP-Server und gibt einen Connection an Visual Studio zurück.
5. Visual Studio beginnt mit der asynchronen Initialisierung des Servers mithilfe der LSP-Nachrichten "initialisieren" und "initialisiert".
6. Visual Studio schließt die StartAsync Ereignisbehandlung ab.
7. Die Erweiterung schließt die OnLoadedAsync() Ausführung ab.
8. Visual Studio ruft die OnServerInitializedAsync() -Methode auf, nachdem die LSP-Nachrichten "initialisieren" und "initialisiert" ausgetauscht wurden (oder die OnServerInitializeFailedAsync(ILanguageClientInitializationInfo) Methode im Falle eines Fehlers).

Eigenschaften

ConfigurationSections	Ruft die Konfigurationsabschnittsnamen für den Sprachclient ab. Dies kann NULL sein, wenn der Sprachclient keine Einstellungen bereitstellt.
FilesToWatch	Ruft die Liste der Dateinamen ab, die für Änderungen watch werden sollen. Änderungen werden über die Nachricht "workspace/didChangeWatchedFiles" an den Server gesendet. Die dateien, die watch müssen sich unter dem aktuellen aktiven Arbeitsbereich befinden. Die Dateinamen können als relativer Pfad zur genauen Datei angegeben werden, oder als Globmuster, die dem Standard in GITIGNORE folgen, siehe https://www.kernel.org/pub/software/scm/git/docs/gitignore.html Dateien.
InitializationOptions	Ruft das Objekt der Initialisierungsoptionen ab, das der Client senden möchte, wenn die Nachricht "initialisieren" gesendet wird. Dies kann NULL sein, wenn der Client keine benutzerdefinierten Initialisierungsoptionen benötigt.
Name	Ruft den Namen des Sprachclients ab (dem Benutzer angezeigt).
ShowNotificationOnInitializeFailed	Ruft einen Wert ab, der angibt, ob eine Benachrichtigungsblase angezeigt wird, wenn der Sprachserver nicht initialisiert werden kann.

Methoden

ActivateAsync(CancellationToken)	Diese Methode wird von Visual Studio aufgerufen, um die Erweiterung darüber zu benachrichtigen, dass der LSP-Server gestartet werden soll.
OnLoadedAsync()	Diese Methode wird von Visual Studio aufgerufen, um die Erweiterung zu benachrichtigen, dass der Sprachclient geladen wurde. Die Erweiterung kann den LSP-Server sofort starten oder warten, bis die Benutzeraktion gestartet wird. Um den Server zu starten, rufen Sie auf das StartAsync Ereignis ab, InvokeAsync<TEventArgs>(AsyncEventHandler<TEventArgs>, Object, TEventArgs) bevor sie von dieser Methode zurückgegeben werden.
OnServerInitializedAsync()	Diese Methode wird von Visual Studio aufgerufen, um die Erweiterung darüber zu benachrichtigen, dass der LSP-Server initialisiert wurde: LSP"initialisieren" und "initialisierte" Nachrichten wurden ausgetauscht.
OnServerInitializeFailedAsync(ILanguageClientInitializationInfo)	Diese Methode wird von Visual Studio aufgerufen, um die Erweiterung darüber zu benachrichtigen, dass bei der Initialisierung des LSP-Servers ein Fehler aufgetreten ist.

Ereignisse

StartAsync	Asynchrones Ereignis, um Visual Studio anzugeben, dass der Server gestartet werden soll, indem aufgerufen ActivateAsync(CancellationToken)wird. Wenn der Server bereits gestartet wurde, wird dieses Ereignis ignoriert.
StopAsync	Asynchrones Ereignis, um Visual Studio anzuzeigen, dass der Server beendet werden soll, indem eine LSP-Anforderung zum Herunterfahren gesendet wird. Wenn der Server nicht gestartet wird, wird dieses Ereignis ignoriert.