Ver código fonte

Adds some docs.

j8
Boris Grozev 9 anos atrás
pai
commit
82c45a2e38
1 arquivos alterados com 9 adições e 1 exclusões
  1. 9
    1
      service/xmpp/XMPPEvents.js

+ 9
- 1
service/xmpp/XMPPEvents.js Ver arquivo

@@ -15,6 +15,8 @@ var XMPPEvents = {
15 15
     KICKED: "xmpp.kicked",
16 16
     // Designates an event indicating that the userID for a specific JID has
17 17
     // changed.
18
+    // Note: currently this event fires every time we receive presence from
19
+    // someone (regardless of whether or not the "userID" changed).
18 20
     USER_ID_CHANGED: "xmpp.user_id_changed",
19 21
     // Designates an event indicating that we have joined the XMPP MUC.
20 22
     MUC_JOINED: "xmpp.muc_joined",
@@ -45,6 +47,8 @@ var XMPPEvents = {
45 47
     SENDING_CHAT_MESSAGE: "xmpp.sending_chat_message",
46 48
     // Designates an event indicating that the video type (e.g. 'camera' or
47 49
     // 'screen') for a participant has changed.
50
+    // Note: currently this event fires every time we receive presence from
51
+    // someone (regardless of whether or not the "video type" changed).
48 52
     PARTICIPANT_VIDEO_TYPE_CHANGED: "xmpp.video_type",
49 53
     // Designates an event indicating that a participant in the XMPP MUC has
50 54
     // advertised that they have audio muted (or unmuted).
@@ -61,6 +65,11 @@ var XMPPEvents = {
61 65
     // Designates an event indicating that we should join the conference with
62 66
     // audio and/or video muted.
63 67
     START_MUTED_FROM_FOCUS: "xmpp.start_muted_from_focus",
68
+    // Designates an event indicating that a remote participant's available
69
+    // devices (whether he supports a audio and/or video) changed.
70
+    // Note: currently this event fires every time we receive presence from
71
+    // someone (regardless of whether or not the devices changed).
72
+    DEVICE_AVAILABLE: "xmpp.device_available",
64 73
 
65 74
 
66 75
     PEERCONNECTION_READY: "xmpp.peerconnection_ready",
@@ -69,7 +78,6 @@ var XMPPEvents = {
69 78
     AUTHENTICATION_REQUIRED: "xmpp.authentication_required",
70 79
     CHAT_ERROR_RECEIVED: "xmpp.chat_error_received",
71 80
     ETHERPAD: "xmpp.etherpad",
72
-    DEVICE_AVAILABLE: "xmpp.device_available",
73 81
     BRIDGE_DOWN: "xmpp.bridge_down",
74 82
     PRESENCE_STATUS: "xmpp.presence_status",
75 83
     RESERVATION_ERROR: "xmpp.room_reservation_error",

Carregando…
Cancelar
Salvar