class OpenTok::Signals
A class for working with OpenTok
signals.
Public Class Methods
@private
# File lib/opentok/signals.rb, line 5 def initialize(client) @client = client end
Public Instance Methods
Sends a signal to clients connected to an OpenTok
session.
You can send a signal to all valid connections in a session or to a specific connection of a session.
For more information on signaling, see {tokbox.com/developer/rest/#send_signal}.
@param [String] session_id The session ID of the OpenTok
session.
@param [String] connection_id
When a connection_id is specified, only that connection recieves the signal. Otherwise, the signal is sent to all clients connected to the session.
@option options [String] :type This is the type of the signal. You can use this field to group and filter signals. It is a property of the Signal object received by the client(s).
@option options [String] :data This is the data within the signal or the payload. Contains the main information to be sent in the signal. It is a property of the Signal object received by the client(s).
@raise [ArgumentError]
One of the signal properties — data, type, session_id, or connection_id — is invalid.
@raise [OpenTokAuthenticationError]
You are not authorized to send the signal. Check your authentication credentials.
@raise [OpenTokError]
The client specified by the connection_id property is not connected to the session.
@raise [OpenTokError]
The type string exceeds the maximum length (128 bytes), or the data string exceeds the maximum size (8 kB).
# File lib/opentok/signals.rb, line 40 def send(session_id, connectionId = "", options = {}) raise ArgumentError, "session_id not provided" if session_id.to_s.empty? response = @client.signal(session_id, connectionId, options) (200..300).include? response.code end