From 8f142d5ec47deda689ef3168c99e0bb710ab6aba Mon Sep 17 00:00:00 2001 From: paweldomas Date: Thu, 12 Apr 2018 09:23:15 -0500 Subject: [PATCH] doc(testing/actions): fill missing in 'setConnectionState' --- react/features/testing/actions.js | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/react/features/testing/actions.js b/react/features/testing/actions.js index b65c73268..8a7e8f18b 100644 --- a/react/features/testing/actions.js +++ b/react/features/testing/actions.js @@ -2,11 +2,21 @@ import { SET_CONNECTION_STATE } from './actionTypes'; +// eslint-disable-next-line jsdoc/require-description-complete-sentence /** * Sets the conference connection state of the testing feature. * * @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): + *
  • {@link JitsiConferenceEvents.CONNECTION_ESTABLISHED} + * - ("conference.connectionEstablished"
  • + *
  • {@link JitsiConferenceEvents.CONNECTION_INTERRUPTED} + * - ("conference.connectionInterrupted")
  • + *
  • {@link JitsiConferenceEvents.CONNECTION_RESTORED} + * - ("conference.connectionRestored")
  • + * In the reducer the value will be an empty string until first event is + * received. + * * @returns {{ * type: SET_CONNECTION_STATE, * connectionState: string