Hérite de : : Object

Défini dans : : lib/opentok/signals.rb

Vue d'ensemble

Une classe permettant de manipuler les signaux OpenTok.

Résumé des méthodes d'instance

Détails de la méthode d'instance

#envoyer(session_id, connectionId = "", options = {}) ⇒ Objet

Envoie un signal aux clients connectés à une session OpenTok.

Vous pouvez envoyer un signal à toutes les connexions valides d'une session ou à une connexion spécifique de cette session.

Pour plus d'informations sur la signalisation, consultez <https://tokbox.com/developer/rest/#send_signal>.

champ permettant de regrouper et de filtrer les signaux. Il s'agit d'une propriété de l'objet Signal reçu par le ou les clients.

Contient les principales informations à transmettre dans le signal. Il s'agit d'une propriété de l'objet Signal reçu par le ou les clients.

Paramètres :

  • session_id (Chaîne de caractères) —

    L'identifiant de la session OpenTok.

  • connection_id (Chaîne de caractères) —

    Lorsqu'un `connection_id` est spécifié, seule cette connexion reçoit le signal. Dans le cas contraire, le signal est envoyé à tous les clients connectés à la session.

  • options (Hash) (valeur par défaut : {}) —

    un ensemble d'options personnalisables

Table de hachage des options (options) :

  • :type (Chaîne de caractères)

    -

    Il s'agit du type du signal. Vous pouvez l'utiliser

  • :data (Chaîne de caractères)

    -

    Il s'agit des données contenues dans le signal ou de la charge utile.

Augmentations :

  • (ArgumentError) —

    L'une des propriétés du signal (données, type, session_id ou connection_id) n'est pas valide.

  • (OpenTokAuthenticationError) —

    Vous n'êtes pas autorisé(e) à envoyer ce signal. Vérifiez vos identifiants d'authentification.

  • (OpenTokError) —

    Le client spécifié par la propriété connection_id n'est pas connecté à la session.

  • (OpenTokError) —

    La chaîne de caractères de type dépasse la longueur maximale (128 octets), ou la chaîne de données dépasse la taille maximale (8 ko).