Class: ConnectionEvent

Defines connectionCreated and connectionDestroyed events dispatched by the Session object.

The Session object dispatches a connectionCreated event when a client (including your own) connects to a Session. It also dispatches a connectionCreated event for every client in the session when you first connect. (when your local client connects, the Session object also dispatches a sessionConnected event, defined by the SessionConnectEvent class.)

While you are connected to the session, the Session object dispatches a connectionDestroyed event when another client disconnects from the Session. (When you disconnect, the Session object also dispatches a sessionDisconnected event, defined by the SessionDisconnectEvent class.)

Example

The following code keeps a running total of the number of connections to a session by monitoring the connections property of the sessionConnect , connectionCreated and connectionDestroyed events:

var apiKey = ""; // Replace with your API key. See https://dashboard.nexmo.com
var sessionID = ""; // Replace with your own session ID.
                    // See https://developer.vonage.com/en/video/guides/create-session/.
var token = ""; // Replace with a generated token that has been assigned the moderator role.
                // See https://developer.vonage.com/en/video/guides/create-token/.
var connectionCount = 0;

var session = OT.initSession(apiKey, sessionID);
session.on("connectionCreated", function(event) {
   connectionCount++;
   displayConnectionCount();
});
session.on("connectionDestroyed", function(event) {
   connectionCount--;
   displayConnectionCount();
});
session.connect(token);

function displayConnectionCount() {
    document.getElementById("connectionCountField").value = connectionCount.toString();
}

This example assumes that there is an input text field in the HTML DOM with the id set to "connectionCountField" :

<input type="text" id="connectionCountField" value="0"></input>