O objeto Session dispara o objeto SessionDisconnectEvent quando uma sessão é desconectada. Esse evento pode ser disparado de forma assíncrona em resposta a uma chamada bem-sucedida à função disconnect() método do objeto de sessão.

Exemplo

O código a seguir inicializa uma sessão e configura um ouvinte de eventos para quando a sessão for desconectada.

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);

Propriedades

Nome Tipo Descrição
reason String Uma descrição do motivo pelo qual a sessão foi desconectada. Essa propriedade pode assumir os seguintes valores: - "clientDisconnected" — Um cliente se desconectou da sessão chamando a função disconnect() método do objeto `Session` ou ao fechar o navegador. (Veja Session.disconnect().) - "forceDisconnected" — Um moderador desconectou você da sessão ao chamar o forceDisconnect() método do objeto `Session`. (Veja Session.forceDisconnect().) - "mediaIdle" — O cliente foi desconectado da sessão porque não publicou nem se inscreveu em fluxos nas 4 horas seguintes à conexão. - "networkDisconnected" — A conexão de rede foi interrompida abruptamente (por exemplo, o cliente perdeu a conexão com a internet) e isso foi detectado pela plataforma da Video API da Vonage. Antes de enviar uma sessionDisconnected evento por esse motivo, o objeto Session dispara um reconnecting evento, e o cliente tenta se reconectar à sessão da Video API do Vonage. Se a reconexão falhar, o objeto Session dispara um sessionDisconnected evento com o reason propriedade definida como "networkDisconnected". - "serverRotation" — O cliente foi desconectado da sessão devido a Rotação do servidor da Video API.

Métodos

Nome Descrição
isDefaultPrevented() → {Boolean} Se o comportamento padrão do evento foi impedido por meio de uma chamada para preventDefault() (true) ou não (false).
preventDefault() Impede que o comportamento padrão associado ao evento ocorra.

isDefaultPrevented() → {Boolean}

Se o comportamento padrão do evento foi impedido por meio de uma chamada para preventDefault() (true) ou não (false). Veja preventDefault().

Devoluções:

preventDefault()

Impede que o comportamento padrão associado ao evento ocorra.

Para o sessionDisconnectEvent, o comportamento padrão é que todos os objetos `Subscriber` tenham sua assinatura cancelada e sejam removidos do DOM HTML. Cada objeto `Subscriber` dispara um destroyed evento que ocorre quando o elemento é removido do DOM HTML. Se você chamar o preventDefault() método no ouvinte de eventos para o sessionDisconnect evento, o comportamento padrão é impedido, e você pode, opcionalmente, limpar os objetos Subscriber usando seu próprio código).

Para verificar se um evento possui um comportamento padrão, verifique o cancelable propriedade do objeto do evento.

Ligue para o preventDefault() método na função do ouvinte de eventos para o evento.