Using WebSockets

The Websockets feature enables bidirectional communication between client and server, facilitating real-time data exchange.

Define a WebSocket

The WebSocket configuration includes settings for connecting to the WebSocket server, handling connection events, and managing data exchange.

spark: Represents the WebSocket connection to the specified URI (wss://spark.ensembleui.com/example/ws/).

Socket:
  spark:
    uri: wss://spark.ensembleui.com/example/ws/
    onSuccess: |
      status.text = "connected";
    onDisconnect: |
      status.text = "disconnected";
    onReconnectAttempt: |
      status.text = "reconnecting";
    onReceive: |
      console.log(spark.data);

Interact with WebSockets

Ensemble supports following actions for WebSockets:

1. Connect Socket: Establishes a connection to the specified socket.

    - Button:
        label: Connect Action
        onTap:
          connectSocket:
            name: spark

2. Disconnect Socket: Terminates the connection to the specified socket.

    - Button:
        label: Disconnect Action
        onTap:
         disconnectSocket:
            name: spark

3. Message Socket: Sends a message over the specified socket.

    - Button:
        label: SendMessage Action
        onTap:
          messageSocket:
            name: spark
            message:
            "content": "Hello there"