Erbt von: : Object

Definiert in: : lib/opentok/signals.rb

Übersicht

Eine Klasse zur Arbeit mit OpenTok-Signalen.

Zusammenfassung der Instanzmethoden

Details zur Instanzmethode

#senden(session_id, connectionId = "", options = {}) ⇒ Objekt

Sendet ein Signal an die Clients, die mit einer OpenTok-Sitzung verbunden sind.

Sie können ein Signal an alle gültigen Verbindungen einer Sitzung oder an eine bestimmte Verbindung einer Sitzung senden.

Weitere Informationen zur Signalübertragung finden Sie unter <https://tokbox.com/developer/rest/#send_signal>.

Feld zum Gruppieren und Filtern von Signalen. Es handelt sich um eine Eigenschaft des Signal-Objekts, das vom/von den Client(s) empfangen wird.

Enthält die wichtigsten Informationen, die im Signal gesendet werden sollen. Es handelt sich um eine Eigenschaft des Signal-Objekts, das vom/von den Client(s) empfangen wird.

Parameter:

  • session_id (Zeichenkette) —

    Die Sitzungs-ID der OpenTok-Sitzung.

  • connection_id (Zeichenkette) —

    Wenn eine `connection_id` angegeben wird, erhält nur diese Verbindung das Signal. Andernfalls wird das Signal an alle mit der Sitzung verbundenen Clients gesendet.

  • Optionen (Hash) (Standardwert: {}) —

    eine individuell anpassbare Auswahl an Optionen

Options-Hash (options):

  • :type (Zeichenkette)

    -

    Dies ist der Typ des Signals. Sie können dies verwenden

  • :data (Zeichenkette)

    -

    Dies sind die Daten innerhalb des Signals bzw. die Nutzdaten.

Erhöht:

  • (ArgumentError) —

    Eine der Signaleigenschaften – „data“, „type“, „session_id“ oder „connection_id“ – ist ungültig.

  • (OpenTokAuthenticationError) —

    Sie sind nicht berechtigt, das Signal zu senden. Überprüfen Sie Ihre Anmeldedaten.

  • (OpenTok-Fehler) —

    Der durch die Eigenschaft „connection_id“ angegebene Client ist nicht mit der Sitzung verbunden.

  • (OpenTok-Fehler) —

    Die Typzeichenfolge überschreitet die maximale Länge (128 Byte) oder die Datenzeichenfolge überschreitet die maximale Größe (8 kB).