Fix jsdocs
This commit is contained in:
parent
8882d9c3b6
commit
ec2e6525ac
|
@ -1263,10 +1263,8 @@ export default {
|
||||||
|
|
||||||
room.on(
|
room.on(
|
||||||
ConferenceEvents.AUTH_STATUS_CHANGED,
|
ConferenceEvents.AUTH_STATUS_CHANGED,
|
||||||
function (authEnabled, authLogin) {
|
(authEnabled, authLogin) =>
|
||||||
APP.UI.updateAuthInfo(authEnabled, authLogin);
|
APP.UI.updateAuthInfo(authEnabled, authLogin));
|
||||||
}
|
|
||||||
);
|
|
||||||
|
|
||||||
room.on(ConferenceEvents.PARTCIPANT_FEATURES_CHANGED,
|
room.on(ConferenceEvents.PARTCIPANT_FEATURES_CHANGED,
|
||||||
user => APP.UI.onUserFeaturesChanged(user));
|
user => APP.UI.onUserFeaturesChanged(user));
|
||||||
|
|
|
@ -295,7 +295,7 @@ UI.getSharedVideoManager = function () {
|
||||||
* Starts the UI module and initializes all related components.
|
* Starts the UI module and initializes all related components.
|
||||||
*
|
*
|
||||||
* @returns {boolean} true if the UI is ready and the conference should be
|
* @returns {boolean} true if the UI is ready and the conference should be
|
||||||
* esablished, false - otherwise (for example in the case of welcome page)
|
* established, false - otherwise (for example in the case of welcome page)
|
||||||
*/
|
*/
|
||||||
UI.start = function () {
|
UI.start = function () {
|
||||||
document.title = interfaceConfig.APP_NAME;
|
document.title = interfaceConfig.APP_NAME;
|
||||||
|
@ -367,7 +367,6 @@ UI.start = function () {
|
||||||
// this is the default toastr close button html, just adds tabIndex
|
// this is the default toastr close button html, just adds tabIndex
|
||||||
"closeHtml": '<button type="button" tabIndex="-1">×</button>'
|
"closeHtml": '<button type="button" tabIndex="-1">×</button>'
|
||||||
};
|
};
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
const { callee } = APP.store.getState()['features/jwt'];
|
const { callee } = APP.store.getState()['features/jwt'];
|
||||||
|
@ -1385,8 +1384,8 @@ UI.hideRingOverlay
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Indicates if any the "top" overlays are currently visible. The check includes
|
* Indicates if any the "top" overlays are currently visible. The check includes
|
||||||
* the call overlay, the suspended overlay, the GUM permissions overlay, and the
|
* the call/ring overlay, the suspended overlay, the GUM permissions overlay,
|
||||||
* page-reload overlay.
|
* and the page-reload overlay.
|
||||||
*
|
*
|
||||||
* @returns {*|boolean} {true} if an overlay is visible; {false}, otherwise
|
* @returns {*|boolean} {true} if an overlay is visible; {false}, otherwise
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -89,7 +89,7 @@ function _conferenceFailed(state, action) {
|
||||||
/**
|
/**
|
||||||
* The indicator of how the conference/room is locked. If falsy, the
|
* The indicator of how the conference/room is locked. If falsy, the
|
||||||
* conference/room is unlocked; otherwise, it's either
|
* conference/room is unlocked; otherwise, it's either
|
||||||
* {@code LOCKED_LOCALLY| or {@code LOCKED_REMOTELY}.
|
* {@code LOCKED_LOCALLY} or {@code LOCKED_REMOTELY}.
|
||||||
*
|
*
|
||||||
* @type {string}
|
* @type {string}
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -2,10 +2,10 @@
|
||||||
* Create an action for when dominant speaker changes.
|
* Create an action for when dominant speaker changes.
|
||||||
*
|
*
|
||||||
* {
|
* {
|
||||||
* type: DOMINANT_SPEAKER_CHANGED,
|
* type: DOMINANT_SPEAKER_CHANGED,
|
||||||
* participant: {
|
* participant: {
|
||||||
* id: string
|
* id: string
|
||||||
* }
|
* }
|
||||||
* }
|
* }
|
||||||
*/
|
*/
|
||||||
export const DOMINANT_SPEAKER_CHANGED = Symbol('DOMINANT_SPEAKER_CHANGED');
|
export const DOMINANT_SPEAKER_CHANGED = Symbol('DOMINANT_SPEAKER_CHANGED');
|
||||||
|
@ -15,9 +15,9 @@ export const DOMINANT_SPEAKER_CHANGED = Symbol('DOMINANT_SPEAKER_CHANGED');
|
||||||
* local participant joins a new conference or quits one.
|
* local participant joins a new conference or quits one.
|
||||||
*
|
*
|
||||||
* {
|
* {
|
||||||
* type: PARTICIPANT_ID_CHANGED,
|
* type: PARTICIPANT_ID_CHANGED,
|
||||||
* newValue: string,
|
* newValue: string,
|
||||||
* oldValue: string
|
* oldValue: string
|
||||||
* }
|
* }
|
||||||
*/
|
*/
|
||||||
export const PARTICIPANT_ID_CHANGED = Symbol('PARTICIPANT_ID_CHANGED');
|
export const PARTICIPANT_ID_CHANGED = Symbol('PARTICIPANT_ID_CHANGED');
|
||||||
|
@ -26,8 +26,8 @@ export const PARTICIPANT_ID_CHANGED = Symbol('PARTICIPANT_ID_CHANGED');
|
||||||
* Action to signal that a participant has joined.
|
* Action to signal that a participant has joined.
|
||||||
*
|
*
|
||||||
* {
|
* {
|
||||||
* type: PARTICIPANT_JOINED,
|
* type: PARTICIPANT_JOINED,
|
||||||
* participant: Participant
|
* participant: Participant
|
||||||
* }
|
* }
|
||||||
*/
|
*/
|
||||||
export const PARTICIPANT_JOINED = Symbol('PARTICIPANT_JOINED');
|
export const PARTICIPANT_JOINED = Symbol('PARTICIPANT_JOINED');
|
||||||
|
@ -36,10 +36,10 @@ export const PARTICIPANT_JOINED = Symbol('PARTICIPANT_JOINED');
|
||||||
* Action to handle case when participant lefts.
|
* Action to handle case when participant lefts.
|
||||||
*
|
*
|
||||||
* {
|
* {
|
||||||
* type: PARTICIPANT_LEFT,
|
* type: PARTICIPANT_LEFT,
|
||||||
* participant: {
|
* participant: {
|
||||||
* id: string
|
* id: string
|
||||||
* }
|
* }
|
||||||
* }
|
* }
|
||||||
*/
|
*/
|
||||||
export const PARTICIPANT_LEFT = Symbol('PARTICIPANT_LEFT');
|
export const PARTICIPANT_LEFT = Symbol('PARTICIPANT_LEFT');
|
||||||
|
@ -48,8 +48,8 @@ export const PARTICIPANT_LEFT = Symbol('PARTICIPANT_LEFT');
|
||||||
* Action to handle case when info about participant changes.
|
* Action to handle case when info about participant changes.
|
||||||
*
|
*
|
||||||
* {
|
* {
|
||||||
* type: PARTICIPANT_UPDATED,
|
* type: PARTICIPANT_UPDATED,
|
||||||
* participant: Participant
|
* participant: Participant
|
||||||
* }
|
* }
|
||||||
*/
|
*/
|
||||||
export const PARTICIPANT_UPDATED = Symbol('PARTICIPANT_UPDATED');
|
export const PARTICIPANT_UPDATED = Symbol('PARTICIPANT_UPDATED');
|
||||||
|
@ -58,10 +58,10 @@ export const PARTICIPANT_UPDATED = Symbol('PARTICIPANT_UPDATED');
|
||||||
* The type of the Redux action which pins a conference participant.
|
* The type of the Redux action which pins a conference participant.
|
||||||
*
|
*
|
||||||
* {
|
* {
|
||||||
* type: PIN_PARTICIPANT,
|
* type: PIN_PARTICIPANT,
|
||||||
* participant: {
|
* participant: {
|
||||||
* id: string
|
* id: string
|
||||||
* }
|
* }
|
||||||
* }
|
* }
|
||||||
*/
|
*/
|
||||||
export const PIN_PARTICIPANT = Symbol('PIN_PARTICIPANT');
|
export const PIN_PARTICIPANT = Symbol('PIN_PARTICIPANT');
|
||||||
|
|
Loading…
Reference in New Issue