Sfoglia il codice sorgente

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

master
paweldomas 7 anni fa
parent
commit
8f142d5ec4
1 ha cambiato i file con 11 aggiunte e 1 eliminazioni
  1. 11
    1
      react/features/testing/actions.js

+ 11
- 1
react/features/testing/actions.js Vedi File

2
 
2
 
3
 import { SET_CONNECTION_STATE } from './actionTypes';
3
 import { SET_CONNECTION_STATE } from './actionTypes';
4
 
4
 
5
+// eslint-disable-next-line jsdoc/require-description-complete-sentence
5
 /**
6
 /**
6
  * Sets the conference connection state of the testing feature.
7
  * Sets the conference connection state of the testing feature.
7
  *
8
  *
8
  * @param {string} connectionState - This is the lib-jitsi-meet event name. Can
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
  * @returns {{
20
  * @returns {{
11
  *     type: SET_CONNECTION_STATE,
21
  *     type: SET_CONNECTION_STATE,
12
  *     connectionState: string
22
  *     connectionState: string

Loading…
Annulla
Salva