WebSocketClient.TextReceived

event · WebSocketClient · cAlgo.API

DesktopCLICloud

Occurs when WebSocketClient receives text data.

Environment behaviour

Cloud — not supported. Connect, Send and Close do nothing: "WebSocket is not supported in cloud environment." is written to the log, State stays None and no events are raised.

Definition

C#Python

public event Action<WebSocketClientTextReceivedEventArgs> TextReceived;

webSocketClient.TextReceived += handler  # handler(obj: WebSocketClientTextReceivedEventArgs)

Examples

C#Python

private WebSocketClient _client;

protected override void OnStart()
{
    _client = new WebSocketClient();
    _client.TextReceived += OnTextReceived;
    _client.Connect(new Uri("wss://stream.example.com/quotes"));
}

private void OnTextReceived(WebSocketClientTextReceivedEventArgs args)
{
    Print("Received: {0}", args.Text);
}

from System import Uri

def on_start(self):
    self.client = WebSocketClient()
    self.client.TextReceived += self.on_text_received
    self.client.Connect(Uri("wss://stream.example.com/quotes"))

def on_text_received(self, args):
    api.Print(f"Received: {args.Text}")