Define connectionCreated y connectionDestroyed eventos emitidos por el Sesión objeto.

El objeto «Session» envía un connectionCreated evento que se produce cuando un cliente (incluido el tuyo propio) se conecta a una sesión. También dispara un connectionCreated evento para cada cliente de la sesión en el momento de la primera conexión. (Cuando tu cliente local se conecta, el objeto Session también dispara un sessionConnected evento, definido por el SessionConnectEvent (clase.)

Mientras estés conectado a la sesión, el objeto Session envía un connectionDestroyed evento cuando otro cliente se desconecta de la sesión. (Al desconectarte, el objeto «Session» también envía un sessionDisconnected evento, definido por el SessionDisconnectEvent (clase.)

Ejemplo

El siguiente código mantiene un recuento acumulado del número de conexiones a una sesión mediante la supervisión del connections propiedad del sessionConnect, connectionCreated y connectionDestroyed eventos:

var apiKey = ""; // Replace with your API key. See https://tokbox.com/account
var sessionID = ""; // Replace with your own session ID.
                    // See https://tokbox.com/developer/guides/create-session/.
var token = ""; // Replace with a generated token that has been assigned the moderator role.
                // See https://tokbox.com/developer/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();
}

En este ejemplo se da por hecho que hay un campo de texto de entrada en el DOM HTML con el id ajustado a "connectionCountField":

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

Propiedades

Nombre Tipo Descripción
connection Conexión Un objeto «Connection» correspondiente a la conexión que se ha creado o eliminado.
connections Matriz Obsoleto. Utiliza el connection propiedad. A connectionCreated o connectionDestroyed Se envía un evento cada vez que se crea o se cierra una conexión en la sesión.
reason Cadena Para un connectionDestroyed evento, una descripción del motivo por el que se interrumpió la conexión. Esta propiedad puede adoptar los siguientes valores: - "clientDisconnected" — Un cliente se ha desconectado de la sesión llamando a la disconnect() método del objeto Session o al cerrar el navegador. (Véase Session.disconnect().) - "forceDisconnected" — Un moderador ha desconectado al editor de la sesión, llamando a la función forceDisconnect() método del objeto `Session`. (Véase Session.forceDisconnect().) - "mediaIdle" — El cliente se ha desconectado de una sesión porque no ha publicado ni se ha suscrito a flujos en las 4 horas siguientes a su conexión - "networkDisconnected" — La conexión de red se interrumpió de forma repentina (por ejemplo, el cliente perdió la conexión a Internet) y la plataforma Vonage Video API lo detectó. - "serverRotation" — El cliente se ha desconectado de la sesión debido a Rotación de servidores de la Video API. Dependiendo del contexto, esta descripción puede permitir al desarrollador ajustar las medidas que adopte en respuesta a un suceso. Para un connectionCreated evento, esta cadena no está definida.

Métodos

Nombre Descripción
isDefaultPrevented() → {Boolean} Si se ha impedido el comportamiento predeterminado del evento mediante una llamada a preventDefault() (true) o no (false).
preventDefault() Evita que se produzca el comportamiento predeterminado asociado al evento.

isDefaultPrevented() → {Boolean}

Si se ha impedido el comportamiento predeterminado del evento mediante una llamada a preventDefault() (true) o no (false). Véase preventDefault().

Devoluciones:

preventDefault()

Evita que se produzca el comportamiento predeterminado asociado al evento.

Para comprobar si un evento tiene un comportamiento predeterminado, consulta el cancelable propiedad del objeto de evento.

Llame al preventDefault() método en la función de devolución de llamada del evento.

Los siguientes eventos tienen comportamientos predeterminados: