L'objet `Session` déclenche un événement `SessionDisconnectEvent` lorsqu'une session a été déconnectée. Cet événement peut être déclenché de manière asynchrone à la suite d'un appel réussi à la méthode disconnect() méthode de l'objet « session ».

Exemple

Le code suivant initialise une session et met en place un écouteur d'événement pour détecter la déconnexion d'une session.

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

Propriétés

Nom Type Description
reason Chaîne Description de la raison pour laquelle la session a été interrompue. Cette propriété peut prendre les valeurs suivantes : - "clientDisconnected" — Un client s'est déconnecté de la session en appelant la fonction disconnect() méthode de l'objet `Session` ou en fermant le navigateur. (Voir Session.disconnect().) - "forceDisconnected" — Un modérateur vous a déconnecté de la session en lançant la commande forceDisconnect() méthode de l'objet `Session`. (Voir Session.forceDisconnect().) - "mediaIdle" — Le client a été déconnecté de la 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 Video API Vonage. Avant d'envoyer un sessionDisconnected événement pour cette raison, l'objet Session déclenche un reconnecting événement, et le client tente de se reconnecter à la session de la Video API. Si la reconnexion échoue, l'objet Session déclenche un sessionDisconnected événement avec le reason est définie comme étant la propriété "networkDisconnected". - "serverRotation" — Le client a été déconnecté de la session en raison de Rotation des serveurs de la Video API.

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 les sessionDisconnectEvent, par défaut, tous les objets `Subscriber` sont désabonnés et supprimés du DOM HTML. Chaque objet `Subscriber` déclenche un destroyed événement déclenché lorsque l'élément est supprimé du DOM HTML. Si vous appelez la méthode preventDefault() méthode dans l'écouteur d'événement pour le sessionDisconnect événement, le comportement par défaut est désactivé, et vous pouvez, si vous le souhaitez, nettoyer les objets `Subscriber` à l'aide de votre propre code).

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 d'écoute d'événement pour cet événement.