Define connectionCreated e connectionDestroyed eventos disparados pelo Sessão objeto.

O objeto Session despacha um connectionCreated evento que ocorre quando um cliente (incluindo o seu próprio) se conecta a uma sessão. Ele também dispara um connectionCreated evento para cada cliente na sessão quando você se conecta pela primeira vez. (Quando seu cliente local se conecta, o objeto Session também dispara um sessionConnected evento, definido pelo SessionConnectEvent (classe.)

Enquanto você estiver conectado à sessão, o objeto Session dispara um connectionDestroyed evento quando outro cliente se desconecta da sessão. (Quando você se desconecta, o objeto Session também dispara um sessionDisconnected evento, definido pelo Event de Desconexão de Sessão (classe.)

Exemplo

O código a seguir mantém um total acumulado do número de conexões em uma sessão ao monitorar o connections propriedade do sessionConnect, connectionCreated e 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();
}

Este exemplo pressupõe que há um campo de texto de entrada no DOM HTML com o id definir como "connectionCountField":

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

Propriedades

Nome Tipo Descrição
connection Conexão Um objeto Connection correspondente à conexão que foi criada ou excluída.
connections Matriz Obsoleto. Use o connection propriedade. A connectionCreated ou connectionDestroyed O evento é disparado para cada conexão criada e encerrada na sessão.
reason String Para um connectionDestroyed evento, uma descrição do motivo pelo qual a conexão foi encerrada. Essa propriedade pode assumir os seguintes valores: - "clientDisconnected" — Um cliente se desconectou da sessão chamando o disconnect() método do objeto Session ou ao fechar o navegador. (Veja Session.disconnect().) - "forceDisconnected" — Um moderador desconectou o palestrante da sessão, chamando o forceDisconnect() método do objeto `Session`. (Veja Session.forceDisconnect().) - "mediaIdle" — O cliente foi desconectado de uma 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 foi detectada pela plataforma da Video API da Vonage. - "serverRotation" — O cliente foi desconectado da sessão devido a Rotação do servidor da Video API. Dependendo do contexto, essa descrição pode permitir que o desenvolvedor refine o curso de ação que adotará em resposta a um evento. Para um connectionCreated evento, essa string não está definida.

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 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 de retorno de chamada do evento.

Os eventos a seguir possuem comportamentos padrão: