ソースを参照

Adds some docs.

j8
Boris Grozev 9年前
コミット
82c45a2e38
1個のファイルの変更9行の追加1行の削除
  1. 9
    1
      service/xmpp/XMPPEvents.js

+ 9
- 1
service/xmpp/XMPPEvents.js ファイルの表示

15
     KICKED: "xmpp.kicked",
15
     KICKED: "xmpp.kicked",
16
     // Designates an event indicating that the userID for a specific JID has
16
     // Designates an event indicating that the userID for a specific JID has
17
     // changed.
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
     USER_ID_CHANGED: "xmpp.user_id_changed",
20
     USER_ID_CHANGED: "xmpp.user_id_changed",
19
     // Designates an event indicating that we have joined the XMPP MUC.
21
     // Designates an event indicating that we have joined the XMPP MUC.
20
     MUC_JOINED: "xmpp.muc_joined",
22
     MUC_JOINED: "xmpp.muc_joined",
45
     SENDING_CHAT_MESSAGE: "xmpp.sending_chat_message",
47
     SENDING_CHAT_MESSAGE: "xmpp.sending_chat_message",
46
     // Designates an event indicating that the video type (e.g. 'camera' or
48
     // Designates an event indicating that the video type (e.g. 'camera' or
47
     // 'screen') for a participant has changed.
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
     PARTICIPANT_VIDEO_TYPE_CHANGED: "xmpp.video_type",
52
     PARTICIPANT_VIDEO_TYPE_CHANGED: "xmpp.video_type",
49
     // Designates an event indicating that a participant in the XMPP MUC has
53
     // Designates an event indicating that a participant in the XMPP MUC has
50
     // advertised that they have audio muted (or unmuted).
54
     // advertised that they have audio muted (or unmuted).
61
     // Designates an event indicating that we should join the conference with
65
     // Designates an event indicating that we should join the conference with
62
     // audio and/or video muted.
66
     // audio and/or video muted.
63
     START_MUTED_FROM_FOCUS: "xmpp.start_muted_from_focus",
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
     PEERCONNECTION_READY: "xmpp.peerconnection_ready",
75
     PEERCONNECTION_READY: "xmpp.peerconnection_ready",
69
     AUTHENTICATION_REQUIRED: "xmpp.authentication_required",
78
     AUTHENTICATION_REQUIRED: "xmpp.authentication_required",
70
     CHAT_ERROR_RECEIVED: "xmpp.chat_error_received",
79
     CHAT_ERROR_RECEIVED: "xmpp.chat_error_received",
71
     ETHERPAD: "xmpp.etherpad",
80
     ETHERPAD: "xmpp.etherpad",
72
-    DEVICE_AVAILABLE: "xmpp.device_available",
73
     BRIDGE_DOWN: "xmpp.bridge_down",
81
     BRIDGE_DOWN: "xmpp.bridge_down",
74
     PRESENCE_STATUS: "xmpp.presence_status",
82
     PRESENCE_STATUS: "xmpp.presence_status",
75
     RESERVATION_ERROR: "xmpp.room_reservation_error",
83
     RESERVATION_ERROR: "xmpp.room_reservation_error",

読み込み中…
キャンセル
保存