Преглед на файлове

doc(testing/actions): fill missing in 'setConnectionState'

master
paweldomas преди 7 години
родител
ревизия
8f142d5ec4
променени са 1 файла, в които са добавени 11 реда и са изтрити 1 реда
  1. 11
    1
      react/features/testing/actions.js

+ 11
- 1
react/features/testing/actions.js Целия файл

@@ -2,11 +2,21 @@
2 2
 
3 3
 import { SET_CONNECTION_STATE } from './actionTypes';
4 4
 
5
+// eslint-disable-next-line jsdoc/require-description-complete-sentence
5 6
 /**
6 7
  * Sets the conference connection state of the testing feature.
7 8
  *
8 9
  * @param {string} connectionState - This is the lib-jitsi-meet event name. Can
9
- * be on of:
10
+ * be one of (with the string values at the time of this writing):
11
+ * <li>{@link JitsiConferenceEvents.CONNECTION_ESTABLISHED}
12
+ * - ("conference.connectionEstablished"</li>
13
+ * <li>{@link JitsiConferenceEvents.CONNECTION_INTERRUPTED}
14
+ * - ("conference.connectionInterrupted")</li>
15
+ * <li>{@link JitsiConferenceEvents.CONNECTION_RESTORED}
16
+ * - ("conference.connectionRestored")</li>
17
+ * In the reducer the value will be an empty string until first event is
18
+ * received.
19
+ *
10 20
  * @returns {{
11 21
  *     type: SET_CONNECTION_STATE,
12 22
  *     connectionState: string

Loading…
Отказ
Запис