jiti-meet/react/features/overlay/actions.ts

63 lines
1.7 KiB
TypeScript
Raw Normal View History

import {
2017-02-19 00:42:11 +00:00
MEDIA_PERMISSION_PROMPT_VISIBILITY_CHANGED,
SET_FATAL_ERROR,
SET_PAGE_RELOAD_OVERLAY_CANCELED
} from './actionTypes';
/**
2017-02-19 00:42:11 +00:00
* Signals that the prompt for media permission is visible or not.
*
2017-02-19 00:42:11 +00:00
* @param {boolean} isVisible - If the value is true - the prompt for media
* permission is visible otherwise the value is false/undefined.
* @param {string} browser - The name of the current browser.
2017-05-31 05:24:34 +00:00
* @public
* @returns {{
2017-02-19 00:42:11 +00:00
* type: MEDIA_PERMISSION_PROMPT_VISIBILITY_CHANGED,
* browser: {string},
* isVisible: {boolean}
* }}
*/
2019-04-09 11:05:20 +00:00
export function mediaPermissionPromptVisibilityChanged(isVisible: boolean, browser: string) {
return {
2017-02-19 00:42:11 +00:00
type: MEDIA_PERMISSION_PROMPT_VISIBILITY_CHANGED,
browser,
isVisible
};
}
/**
* The action indicates that an unrecoverable error has occurred and the reload
* screen will be displayed or hidden.
*
* @param {Object} fatalError - A critical error which was not claimed by any
* feature for error recovery (the recoverable flag was not set). If
* {@code undefined} then any fatal error currently stored will be discarded.
* @returns {{
* type: SET_FATAL_ERROR,
* fatalError: ?Error
* }}
*/
export function setFatalError(fatalError?: Object) {
return {
type: SET_FATAL_ERROR,
fatalError
};
}
/**
* The action indicates that the overlay was canceled.
*
* @param {Object} error - The error that caused the display of the overlay.
*
* @returns {{
* type: SET_PAGE_RELOAD_OVERLAY_CANCELED,
* error: ?Error
* }}
*/
export function setPageReloadOverlayCanceled(error: Object) {
return {
type: SET_PAGE_RELOAD_OVERLAY_CANCELED,
error
};
}