WebSocketClient Klasse

Referenz

Definition

Namespace:: Microsoft.Bot.Streaming.Transport.WebSockets

Assembly:: Microsoft.Bot.Streaming.dll

Paket:: Microsoft.Bot.Streaming v4.18.1

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Ein Client zur Verwendung mit dem Bot Framework-Protokoll V3 mit Streamingerweiterungen und einem zugrunde liegenden WebSocket-Transport.

public class WebSocketClient : IDisposable, Microsoft.Bot.Streaming.Transport.IStreamingTransportClient

type WebSocketClient = class
    interface IStreamingTransportClient
    interface IDisposable

Public Class WebSocketClient
Implements IDisposable, IStreamingTransportClient

Vererbung: Object
WebSocketClient

Implementiert: IStreamingTransportClient IDisposable

Konstruktoren

WebSocketClient(String, RequestHandler, Object)

Initialisiert eine neue Instanz der WebSocketClient-Klasse. Löst aus ArgumentNullException , wenn DIE URL NULL, leer oder Leerzeichen ist.

Eigenschaften

IsConnected	Ruft einen Wert ab, der angibt, ob dieser Client derzeit verbunden ist.
LastMessageSendTime	Ruft die UTC-Zeit des letzten Sendevorgangs auf diesem Client ab. Wird für die Verwendung beim Bereinigen von Clients im Leerlauf zur Verfügung gestellt.

Methoden

ConnectAsync()	Stellen Sie eine Verbindung ohne benutzerdefinierte Header her.
ConnectAsync(IDictionary<String,String>)	Stellen Sie eine Verbindung mit optionalen benutzerdefinierten Headern her.
ConnectAsyncEx(IDictionary<String,String>, CancellationToken)	Stellen Sie eine Verbindung mit optionalen benutzerdefinierten Headern her.
Disconnect()	Methode, die verwendet wird, um diesen Client zu trennen.
Dispose()	Trennt den Client und gibt alle zugehörigen Objekte frei, die sich im Besitz der -Klasse befinden.
Dispose(Boolean)	Löscht das von der -Klasse verwendete Objekt.
SendAsync(StreamingRequest, CancellationToken)	Aufgabe, die zum Senden von Daten über diese Clientverbindung verwendet wird. Löst aus InvalidOperationException , wenn aufgerufen wird, wenn der Client getrennt wird. Löst aus ArgumentNullException , wenn die Nachricht NULL ist.

Ereignisse

Disconnected

Ein Ereignis, das ausgelöst wird, wenn der zugrunde liegende Transport getrennt wird. Jede Anwendung, die mit diesem Client kommuniziert, sollte dieses Ereignis abonnieren.

Gilt für: