継承元： : Object

定義場所： : lib/opentok/signals.rb

概要

OpenTokシグナルを扱うためのクラス。

インスタンスメソッドの概要

インスタンスメソッドの詳細

#送信(session_id, connectionId = "", options = {}) ⇒ Object

OpenTokセッションに接続しているクライアントにシグナルを送信します。

セッション内のすべての有効な接続に対して、あるいはセッション内の特定の接続に対して、シグナルを送信することができます。

シグナリングに関する詳細については、<https://tokbox.com/developer/rest/#send_signal>.

信号をグループ化およびフィルタリングするためのフィールドです。これは、クライアントが受信するSignalオブジェクトのプロパティです。

シグナルで送信される主要な情報を格納します。これは、クライアントが受信する Signal オブジェクトのプロパティです。

パラメータ：

  • session_id (文字列) —

    OpenTok セッションのセッション ID。

  • connection_id (文字列) —

    connection_id が指定された場合、その接続のみがシグナルを受信します。指定がない場合は、そのセッションに接続しているすべてのクライアントにシグナルが送信されます。

  • オプション (ハッシュ) （デフォルトは：{}） —

    カスタマイズ可能なオプションのセット

オプションハッシュ (options):

  • :type (文字列)

    -

    これはシグナルのタイプです。これを使用できます

  • :data (文字列)

    -

    これは、信号またはペイロードに含まれるデータです。

引き上げ：

  • (ArgumentError) —

    シグナルのプロパティ（data、type、session_id、または connection_id）のいずれかが無効です。

  • (OpenTok認証エラー) —

    この信号を送信する権限がありません。認証情報を確認してください。

  • (OpenTokエラー) —

    connection_id プロパティで指定されたクライアントは、このセッションに接続されていません。

  • (OpenTokエラー) —

    型文字列が最大長（128 バイト）を超えているか、データ文字列が最大サイズ（8 kB）を超えています。