SessionDisconnectEvent

Das Session-Objekt löst ein SessionDisconnectEvent-Objekt aus, wenn eine Sitzung getrennt wurde. Dieses Ereignis kann asynchron als Reaktion auf einen erfolgreichen Aufruf der disconnect() Methode des Session-Objekts.

Beispiel

Der folgende Code initialisiert eine Sitzung und richtet einen Ereignis-Listener für den Fall ein, dass die Verbindung zur Sitzung unterbrochen wird.

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

Eigenschaften

Name	Typ	Beschreibung
`reason`	Zeichenfolge	Eine Beschreibung, warum die Sitzung unterbrochen wurde. Diese Eigenschaft kann folgende Werte annehmen: - `"clientDisconnected"` — Ein Client hat die Verbindung zur Sitzung durch Aufruf der Funktion `disconnect()` Methode des `Session`-Objekts oder durch Schließen des Browsers. (Siehe Session.disconnect().) – `"forceDisconnected"` — Ein Moderator hat Sie aus der Sitzung ausgeschlossen, indem er den `forceDisconnect()` Methode des Session-Objekts. (Siehe Session.forceDisconnect().) – `"mediaIdle"` — Der Client wurde von der Sitzung getrennt, da er innerhalb von 4 Stunden nach dem Verbindungsaufbau keine Streams veröffentlicht oder abonniert hat. - `"networkDisconnected"` — Die Netzwerkverbindung wurde plötzlich unterbrochen (beispielsweise weil der Client seine Internetverbindung verloren hat) und von der Vonage Video API-Plattform erkannt. Vor dem Versenden einer `sessionDisconnected` Aus diesem Grund löst das Session-Objekt ein `reconnecting` Ereignis, und der Client versucht, die Verbindung zur Vonage Video API-Sitzung wiederherzustellen. Wenn die Wiederherstellung der Verbindung fehlschlägt, löst das Session-Objekt ein `sessionDisconnected` Veranstaltung mit dem `reason` Eigenschaft eingestellt auf `"networkDisconnected"`. - `"serverRotation"` — Der Client wurde aus der Sitzung getrennt, weil Rotation der Video API-Server.

Methoden

Name	Beschreibung
`isDefaultPrevented() → {Boolean}`	Ob das Standardverhalten des Ereignisses durch einen Aufruf von `preventDefault()` (`true`) oder nicht (`false`).
`preventDefault()`	Verhindert, dass das mit dem Ereignis verbundene Standardverhalten ausgeführt wird.

isDefaultPrevented() → {Boolean}

Ob das Standardverhalten des Ereignisses durch einen Aufruf von preventDefault() (true) oder nicht (false). Siehe preventDefault().

Rückgabe:

preventDefault()

Verhindert, dass das mit dem Ereignis verbundene Standardverhalten ausgeführt wird.

Für die sessionDisconnectEvent, standardmäßig werden alle Subscriber-Objekte abgemeldet und aus dem HTML-DOM entfernt. Jedes Subscriber-Objekt löst ein destroyed Ereignis, wenn das Element aus dem HTML-DOM entfernt wird. Wenn Sie die preventDefault() Methode im Ereignis-Listener für die sessionDisconnect Ereignis, wird das Standardverhalten unterbunden, und Sie können optional Subscriber-Objekte mithilfe Ihres eigenen Codes bereinigen).

Um festzustellen, ob ein Ereignis ein Standardverhalten aufweist, überprüfen Sie die cancelable Eigenschaft des Ereignisobjekts.

Rufen Sie die preventDefault() Methode in der Ereignisbehandlungsfunktion für das Ereignis.