haskal
/
jiti-meet
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

This commit is contained in:
paweldomas 2018-04-12 09:23:15 -05:00 committed by Любомир Маринов
parent 5cf16a20d3
commit 8f142d5ec4
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
react/features/testing/actions.js
View File

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