Heredan de: : Object

Definido en: : lib/opentok/signals.rb

Visión general

Una clase para trabajar con señales de OpenTok.

Resumen de los métodos de instancia

Detalles del método de instancia

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

Envía una señal a los clientes conectados a una sesión de OpenTok.

Puedes enviar una señal a todas las conexiones válidas de una sesión o a una conexión concreta de una sesión.

Para obtener más información sobre la señalización, consulta <https://tokbox.com/developer/rest/#send_signal>.

Campo para agrupar y filtrar señales. Es una propiedad del objeto «Signal» recibido por los clientes.

Contiene la información principal que se va a enviar en la señal. Es una propiedad del objeto Signal que reciben los clientes.

Parámetros:

  • session_id (Cadena) —

    El identificador de la sesión de OpenTok.

  • connection_id (Cadena) —

    Cuando se especifica un `connection_id`, solo esa conexión recibe la señal. En caso contrario, la señal se envía a todos los clientes conectados a la sesión.

  • opciones (Hash) (valor por defecto: {}) —

    un conjunto de opciones personalizables

Hash de opciones (options):

  • :tipo (Cadena)

    -

    Este es el tipo de señal. Puedes utilizar esto

  • :data (Cadena)

    -

    Estos son los datos que contiene la señal o la carga útil.

Aumentos:

  • (ArgumentError) —

    Una de las propiedades de la señal —datos, tipo, session_id o connection_id— no es válida.

  • (OpenTokAuthenticationError) —

    No estás autorizado a enviar la señal. Comprueba tus credenciales de autenticación.

  • (OpenTokError) —

    El cliente especificado por la propiedad «connection_id» no está conectado a la sesión.

  • (OpenTokError) —

    La cadena de tipo supera la longitud máxima (128 bytes) o la cadena de datos supera el tamaño máximo (8 kB).