継承元: : Object

定義場所: : lib/opentok/connections.rb

概要

OpenTok接続を扱うためのクラス。

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

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

#forceDisconnect(session_id, connection_id) ⇒ オブジェクト

クライアントをOpenTokセッションから強制的に切断させる。

クライアントを切断するには、そのクライアントがOpenTokセッションにアクティブに接続されている必要があります。

パラメータ:

  • session_id (文字列) —

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

  • connection_id (文字列) —

    セッション内のクライアントの接続ID。

引き上げ:

  • (ArgumentError) —

    connection_id または session_id が無効です。

  • (OpenTok認証エラー) —

    この接続を切断する権限がありません。認証情報を確認してください。

  • (OpenTokConnectionError) —

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