Définit connectionCreated et connectionDestroyed événements déclenchés par le Session objet.

L'objet Session envoie un connectionCreated événement déclenché lorsqu'un client (y compris le vôtre) se connecte à une session. Il déclenche également un connectionCreated événement pour chaque client de la session lors de la première connexion. (Lorsque votre client local se connecte, l’ objet Session déclenche également un sessionConnected événement, défini par le SessionConnectEvent (classe.)

Tant que vous êtes connecté à la session, l'objet Session déclenche un connectionDestroyed événement lorsqu'un autre client se déconnecte de la session. (Lorsque vous vous déconnectez, l'objet Session déclenche également un sessionDisconnected événement, défini par le SessionDisconnectEvent (classe.)

Exemple

Le code suivant calcule le total cumulé du nombre de connexions à une session en surveillant le connections de la propriété sessionConnect, connectionCreated et connectionDestroyed événements :

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

Cet exemple part du principe qu'il existe un champ de saisie dans le DOM HTML avec l'attribut id fixé à "connectionCountField":

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

Propriétés

Nom Type Description
connection Connexion Un objet « Connection » correspondant à la connexion qui a été créée ou supprimée.
connections Tableau Obsolète. Utilisez la fonction connection propriété. A connectionCreated ou connectionDestroyed Cet événement est déclenché à chaque fois qu'une connexion est établie ou fermée au cours de la session.
reason Chaîne Pour un connectionDestroyed événement, une description expliquant pourquoi la connexion a été interrompue. Cette propriété peut prendre les valeurs suivantes : - "clientDisconnected" — Un client s'est déconnecté de la session en appelant la disconnect() méthode de l'objet Session ou en fermant le navigateur. (Voir Session.disconnect().) - "forceDisconnected" — Un modérateur a déconnecté l'éditeur de la session en appelant la forceDisconnect() méthode de l'objet `Session`. (Voir Session.forceDisconnect().) - "mediaIdle" — Le client a été déconnecté d'une session car il n'a ni publié ni souscrit à des flux dans les 4 heures suivant sa connexion - "networkDisconnected" — La connexion réseau a été interrompue brusquement (par exemple, le client a perdu sa connexion Internet) et cela a été détecté par la plateforme Vonage Video API. - "serverRotation" — Le client a été déconnecté de la session en raison de Rotation des serveurs de la Video API. Selon le contexte, cette description peut permettre au développeur d'affiner la ligne de conduite qu'il adopte en réponse à un événement. Pour un connectionCreated événement, cette chaîne n'est pas définie.

Méthodes

Nom Description
isDefaultPrevented() → {Boolean} Que le comportement par défaut de l'événement ait été désactivé ou non par un appel à preventDefault() (true) ou non (false).
preventDefault() Empêche le comportement par défaut associé à l'événement de se produire.

isDefaultPrevented() → {Boolean}

Que le comportement par défaut de l'événement ait été empêché ou non par un appel à preventDefault() (true) ou non (false). Voir preventDefault().

Retours :

preventDefault()

Empêche le comportement par défaut associé à l'événement de se produire.

Pour savoir si un événement a un comportement par défaut, vérifiez le cancelable propriété de l'objet événement.

Appeler le preventDefault() méthode dans la fonction de rappel associée à l'événement.

Les événements suivants ont des comportements par défaut :