El objeto `Session` envía un objeto `SessionDisconnectEvent` cuando se desconecta una sesión.
Este evento puede enviarse de forma asíncrona en respuesta a una llamada correcta a la función
disconnect() método del objeto «session».
Ejemplo
El siguiente código inicializa una sesión y configura un detector de eventos para cuando la sesión se desconecte.
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 session = OT.initSession(apiKey, sessionID);
session.on("sessionDisconnected", function(event) {
alert("The session disconnected. " + event.reason);
});
session.connect(token);
Propiedades
| Nombre | Tipo | Descripción |
|---|---|---|
reason |
Cadena | Una descripción del motivo por el que se ha desconectado la sesión. Esta propiedad puede adoptar los siguientes valores: - "clientDisconnected" — Un cliente se ha desconectado de la sesión llamando a la función disconnect() método del objeto `Session` o cerrando el navegador. (Véase Session.disconnect().) - "forceDisconnected" — Un moderador te ha desconectado de la sesión al llamar al forceDisconnect() método del objeto `Session`. (Véase Session.forceDisconnect().) - "mediaIdle" — El cliente se ha desconectado de la 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 de la Video API de Vonage lo detectó. Antes de enviar una sessionDisconnected Por este motivo, el objeto Session envía un reconnecting evento, y el cliente intenta volver a conectarse a la sesión de la Video API de Vonage. Si la reconexión falla, el objeto Session envía un sessionDisconnected evento con el reason con el valor "networkDisconnected". - "serverRotation" — El cliente se ha desconectado de la sesión debido a Rotación de servidores de la Video API. |
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 el sessionDisconnectEvent, el comportamiento predeterminado es que todos los
objetos «Subscriber» se den de baja y se eliminen del DOM HTML. Cada
objeto «Subscriber» envía un destroyed evento que se produce cuando el elemento
se elimina del DOM HTML. Si llamas a la función preventDefault()
método en el oyente de eventos para el sessionDisconnect evento,
se impide el comportamiento predeterminado y, si lo deseas, puedes limpiar
los objetos Subscriber mediante tu propio código).
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 escucha de eventos
para dicho evento.