UNPKG

@zoom/cobrowsesdk

Version:
1,130 lines (1,126 loc) 47.6 kB
/// <reference types="react" /> /** * @description ZoomCobrowseAgentSDK global variable. * @exports Package exposed namespace in IIFE format (Immediately Invoked Function Expression). */ declare const ZoomCobrowseAgentSDK$1: { /** * @description Init Cobrowse SDK. Some settings will be configured in this step. * @example * ``` * ZoomCobrowseAgentSDK.init(settings, function({ success, session, error }) { * if (success) { * session.createAgentViewerEndpoint({ * pinCode:'{PIN_CODE}', * sdkToken:'{SDK_TOKEN}' * }, function({ success, agentViewerUrl, error }){ * if(success){ * console.log(agentViewerUrl) * }else { * console.log(error) * } * }) * } else { * console.log(error); * } * }); * ``` */ init: (option: Settings, callback: SDKReadyCallback) => void; }; declare enum AgentCustomizeOverridesFeatureKey { /** * @group ToolbarCommon * @description The container for the agent toolbar when displayed vertically. Supports `stylingOverrides`. */ AgentToolbarVerticalWrapper = "agentToolbarVerticalWrapper", /** * @group ToolbarCommon * @description The container for the agent toolbar when displayed horizontally. Supports `stylingOverrides`. */ AgentToolbarHorizontalWrapper = "agentToolbarHorizontalWrapper", /** * @group ToolbarCommon * @description Controls whether the agent-side toolbar is allowed to rotate when touching the edge of the screen and meeting the rotation criteria. Supports `disabledComponentOverride`. */ AgentToolbarAllowRotation = "agentToolbarAllowRotation", /** * @group ToolbarCommon * @description Controls whether the toolbar is displayed vertically by default. When set to "true", the toolbar defaults to vertical orientation; when set to "false", it defaults to horizontal orientation. Supports `disabledComponentOverride`. */ AgentToolbarDefaultVertical = "agentToolbarDefaultVertical", /** * @group ToolbarCommon * @description The container for all toolbar buttons except the "End Session" button when the agent toolbar is displayed vertically. Supports `stylingOverrides`. */ AgentToolbarVerticalNormalBtnsWrapper = "agentToolbarVerticalNormalBtnsWrapper", /** * @group ToolbarCommon * @description The container for all toolbar buttons except the "End Session" button when the agent toolbar is displayed horizontally. Supports `stylingOverrides`. */ AgentToolbarHorizontalNormalBtnsWrapper = "agentToolbarHorizontalNormalBtnsWrapper", /** * @group ToolbarCommon * @description Common styling for all agent toolbar buttons except the "End Session" button. Lower priority than individual button settings. Supports `stylingOverrides`. */ AgentToolbarButtonCommon = "agentToolbarButtonCommon", /** * @group ToolbarCommon * @description Common styling when agent toolbar buttons (excluding the "End Session" button) are in an active state. Lower priority than individual button settings. Supports `stylingOverrides`. */ AgentToolbarButtonActiveCommon = "agentToolbarButtonActiveCommon", /** * @group ToolbarCommon * @description Common styling for tooltips of agent toolbar buttons. Supports `stylingOverrides`. */ AgentToolbarTooltipCommon = "agentToolbarTooltipCommon", /** * @group ToolbarCommon * @description Agent's main toolbar vertical divider. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`. */ AgentToolbarVerticalDivider = "agentToolbarVerticalDivider", /** * @group ToolbarCommon * @description Agent's main toolbar horizontal divider. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`. */ AgentToolbarHorizontalDivider = "agentToolbarHorizontalDivider", /** * @group AgentToolbarFirstLevelButtons * @description The "Zoom In" button in the agent's main toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`. */ AgentToolbarZoomInButton = "agentToolbarZoomInButton", /** * @group AgentToolbarFirstLevelButtons * @description The icon inside the "Zoom In" button in the agent's main toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`. */ AgentToolbarZoomInIcon = "agentToolbarZoomInIcon", /** * @group AgentToolbarFirstLevelButtons * @description The "Zoom Out" button in the agent's main toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`. */ AgentToolbarZoomOutButton = "agentToolbarZoomOutButton", /** * @group AgentToolbarFirstLevelButtons * @description The icon inside the "Zoom Out" button in the agent's main toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`. */ AgentToolbarZoomOutIcon = "agentToolbarZoomOutIcon", /** * @group AgentToolbarFirstLevelButtons * @description The "Zoom Menu" button in the agent's main toolbar. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`. */ AgentToolbarZoomMenuButton = "agentToolbarZoomMenuButton", /** * @group AgentToolbarFirstLevelButtons * @description The icon inside the "Zoom Menu" button in the agent's main toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`. */ AgentToolbarZoomMenuIcon = "agentToolbarZoomMenuIcon", /** * @group AgentToolbarFirstLevelButtons * @description The "Fullscreen" button in the agent's main toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`. */ AgentToolbarFullScreenButton = "agentToolbarFullScreenButton", /** * @group AgentToolbarFirstLevelButtons * @description The icon inside the "Fullscreen" button in the agent's main toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`. */ AgentToolbarFullScreenIcon = "agentToolbarFullScreenIcon", /** * @group AgentToolbarFirstLevelButtons * @description The "Exit Fullscreen" button in the agent's main toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`. */ AgentToolbarExitFullScreenButton = "agentToolbarExitFullScreenButton", /** * @group AgentToolbarFirstLevelButtons * @description The icon inside the "Exit Fullscreen" button in the agent's main toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`. */ AgentToolbarExitFullScreenIcon = "agentToolbarExitFullScreenIcon", /** * @group AgentToolbarFirstLevelButtons * @description The "Vanishing Pen" button in the agent's main toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`. */ AgentToolbarVanishingPenButton = "agentToolbarVanishingPenButton", /** * @group AgentToolbarFirstLevelButtons * @description The icon inside the "Vanishing Pen" button in the agent's main toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`. */ AgentToolbarVanishingPenIcon = "agentToolbarVanishingPenIcon", /** * @group AgentToolbarFirstLevelButtons * @description The "Pen" button in the agent's main toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`. */ AgentToolbarPenButton = "agentToolbarPenButton", /** * @group AgentToolbarFirstLevelButtons * @description The icon inside the "Pen" button in the agent's main toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`. */ AgentToolbarPenIcon = "agentToolbarPenIcon", /** * @group AgentToolbarFirstLevelButtons * @description The "Leave Cobrowse" button in the agent's main toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`. */ AgentToolbarEndSessionButton = "agentToolbarEndSessionButton", /** * @group AgentToolbarFirstLevelButtons * @description The icon inside the "Leave Cobrowse" button in the agent's main toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`. */ AgentToolbarEndSessionIcon = "agentToolbarEndSessionIcon", /** * @group ToolbarVanishingPenSubMenuCommon * @description The container for the Vanishing Pen sub-toolbar when the agent toolbar is displayed vertically. Supports `stylingOverrides`. */ AgentVanishingPenSubMenuVerticalWrapper = "agentVanishingPenSubMenuVerticalWrapper", /** * @group ToolbarVanishingPenSubMenuCommon * @description The container for the Vanishing Pen sub-toolbar when the agent toolbar is displayed horizontally. Supports `stylingOverrides`. */ AgentVanishingPenSubMenuHorizontalWrapper = "agentVanishingPenSubMenuHorizontalWrapper", /** * @group ToolbarVanishingPenSubMenuCommon * @description Common styling for all buttons in the Vanishing Pen sub-toolbar. Lower priority than individual button settings. Supports `stylingOverrides`. */ AgentVanishingPenSubMenuButtonCommon = "agentVanishingPenSubMenuButtonCommon", /** * @group ToolbarVanishingPenSubMenuCommon * @description Common styling when buttons in the Vanishing Pen sub-toolbar are in an active state. Lower priority than individual button settings. Supports `stylingOverrides`. */ AgentVanishingPenMenuButtonActiveCommon = "agentVanishingPenSubMenuButtonActiveCommon", /** * @group ToolbarVanishingPenSubMenuButtons * @description The "Mouse" button in the Vanishing Pen secondary toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`. */ AgentVanishingPenSubMenuMouseButton = "agentVanishingPenSubMenuMouseButton", /** * @group ToolbarVanishingPenSubMenuButtons * @description The icon inside the "Mouse" button in the Vanishing Pen secondary toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`. */ AgentVanishingPenSubMenuMouseIcon = "agentVanishingPenSubMenuMouseIcon", /** * @group ToolbarVanishingPenSubMenuButtons * @description The "Vanishing Pen" button in the Vanishing Pen secondary toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`. */ AgentVanishingPenSubMenuVanishingPenButton = "agentVanishingPenSubMenuVanishingPenButton", /** * @group ToolbarVanishingPenSubMenuButtons * @description The icon inside the "Vanishing Pen" button in the Vanishing Pen secondary toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`. */ AgentVanishingPenSubMenuVanishingPenIcon = "agentVanishingPenSubMenuVanishingPenIcon", /** * @group ToolbarVanishingPenSubMenuButtons * @description The "Vanishing Rectangle" button in the Vanishing Pen secondary toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`. */ AgentVanishingPenSubMenuVanishingRectangleButton = "agentVanishingPenSubMenuVanishingRectangleButton", /** * @group ToolbarVanishingPenSubMenuButtons * @description The icon inside the "Vanishing Rectangle" button in the Vanishing Pen secondary toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`. */ AgentVanishingPenSubMenuVanishingRectangleIcon = "agentVanishingPenSubMenuVanishingRectangleIcon", /** * @group ToolbarVanishingPenSubMenuButtons * @description The "Color" button in the Vanishing Pen secondary toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`. */ AgentVanishingPenSubMenuVanishingColorButton = "agentVanishingPenSubMenuVanishingColorButton", /** * @group ToolbarVanishingPenSubMenuButtons * @description The color preview section inside the "Color" button in the Vanishing Pen secondary toolbar. Supports `stylingOverrides`. */ AgentVanishingPenSubMenuVanishingColorIcon = "agentVanishingPenSubMenuVanishingColorIcon", /** * @group ToolbarPenAnnotationSubMenuCommon * @description The container for the Pen sub-toolbar when the agent toolbar is displayed vertically. Supports `stylingOverrides`. */ AgentPenAnnotationSubMenuVerticalWrapper = "agentPenAnnotationSubMenuVerticalWrapper", /** * @group ToolbarPenAnnotationSubMenuCommon * @description The container for the Pen sub-toolbar when the agent toolbar is displayed horizontally. Supports `stylingOverrides`. */ AgentPenAnnotationSubMenuHorizontalWrapper = "agentPenAnnotationSubMenuHorizontalWrapper", /** * @group ToolbarPenAnnotationSubMenuCommon * @description Common styling for all buttons in the Pen sub-toolbar. Lower priority than individual button settings. Supports `stylingOverrides`. */ AgentPenAnnotationSubMenuButtonCommon = "agentPenAnnotationSubMenuButtonCommon", /** * @group ToolbarPenAnnotationSubMenuCommon * @description Common styling when buttons in the Pen sub-toolbar are in an active state. Lower priority than individual button settings. Supports `stylingOverrides`. */ AgentPenAnnotationSubMenuButtonActiveCommon = "agentPenAnnotationSubMenuButtonActiveCommon", /** * @group ToolbarPenAnnotationSubMenuButtons * @description The "Mouse" button in the Pen secondary toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`. */ AgentPenAnnotationSubMenuMouseButton = "agentPenAnnotationSubMenuMouseButton", /** * @group ToolbarPenAnnotationSubMenuButtons * @description The icon inside the "Mouse" button in the Pen secondary toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`. */ AgentPenAnnotationSubMenuMouseIcon = "agentPenAnnotationSubMenuMouseIcon", /** * @group ToolbarPenAnnotationSubMenuButtons * @description The "Pen" button in the Pen secondary toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`. */ AgentPenAnnotationSubMenuPenButton = "agentPenAnnotationSubMenuPenButton", /** * @group ToolbarPenAnnotationSubMenuButtons * @description The icon inside the "Pen" button in the Pen secondary toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`. */ AgentPenAnnotationSubMenuPenIcon = "agentPenAnnotationSubMenuPenIcon", /** * @group ToolbarPenAnnotationSubMenuButtons * @description The "Rectangle" button in the Pen secondary toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`. */ AgentPenAnnotationSubMenuRectangleButton = "agentPenAnnotationSubMenuRectangleButton", /** * @group ToolbarPenAnnotationSubMenuButtons * @description The icon inside the "Rectangle" button in the Pen secondary toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`. */ AgentPenAnnotationSubMenuRectangleIcon = "agentPenAnnotationSubMenuRectangleIcon", /** * @group ToolbarPenAnnotationSubMenuButtons * @description The "Eraser" button in the Pen secondary toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`. */ AgentPenAnnotationSubMenuEraserButton = "agentPenAnnotationSubMenuEraserButton", /** * @group ToolbarPenAnnotationSubMenuButtons * @description The icon inside the "Eraser" button in the Pen secondary toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`. */ AgentPenAnnotationSubMenuEraserIcon = "agentPenAnnotationSubMenuEraserIcon", /** * @group ToolbarPenAnnotationSubMenuButtons * @description The "Color" button in the Pen secondary toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`. */ AgentPenAnnotationSubMenuColorButton = "agentPenAnnotationSubMenuColorButton", /** * @group ToolbarPenAnnotationSubMenuButtons * @description The color preview section inside the "Color" button in the Pen secondary toolbar. Supports `stylingOverrides`. */ AgentPenAnnotationSubMenuColorIcon = "agentPenAnnotationSubMenuColorIcon", /** * @group ToolbarPenAnnotationSubMenuButtons * @description The "Undo" button in the Pen secondary toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`. */ AgentPenAnnotationSubMenuUndoButton = "agentPenAnnotationSubMenuUndoButton", /** * @group ToolbarPenAnnotationSubMenuButtons * @description The icon inside the "Undo" button in the Pen secondary toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`. */ AgentPenAnnotationSubMenuUndoIcon = "agentPenAnnotationSubMenuUndoIcon", /** * @group ToolbarPenAnnotationSubMenuButtons * @description The "Redo" button in the Pen secondary toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`. */ AgentPenAnnotationSubMenuRedoButton = "agentPenAnnotationSubMenuRedoButton", /** * @group ToolbarPenAnnotationSubMenuButtons * @description The icon inside the "Redo" button in the Pen secondary toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`. */ AgentPenAnnotationSubMenuRedoIcon = "agentPenAnnotationSubMenuRedoIcon", /** * @group ToolbarPenAnnotationSubMenuButtons * @description The "Clear" button in the Pen secondary toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`. */ AgentPenAnnotationSubMenuClearButton = "agentPenAnnotationSubMenuClearButton", /** * @group ToolbarPenAnnotationSubMenuButtons * @description The icon inside the "Clear" button in the Pen secondary toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`. */ AgentPenAnnotationSubMenuClearIcon = "agentPenAnnotationSubMenuClearIcon", // pen submenu /** * @group ToolbarPenSubMenu * @description The container for the PenWidth sub-menu in the agent's toolbar when displayed vertically, supports configuration of `stylingOverrides`. */ AgentPenSubMenuVerticalWrapper = "agentPenSubMenuVerticalWrapper", /** * @group ToolbarPenSubMenu * @description The container for the PenWidth sub-menu in the agent's toolbar when displayed horizontally, supports configuration of `stylingOverrides`. */ AgentPenSubMenuHorizontalWrapper = "agentPenSubMenuHorizontalWrapper", /** * @group ToolbarPenSubMenu * @description The common style for all buttons in the PenWidth sub-menu of the agent's toolbar, supports configuration of `stylingOverrides`. */ AgentPenSubMenuButtonCommon = "agentPenSubMenuButtonCommon", /** * @group ToolbarPenSubMenu * @description The common style for all buttons in the PenWidth sub-menu when selected (priority lower than individual button settings), supports configuration of `stylingOverrides`. */ AgentPenSubMenuButtonActiveCommon = "agentPenSubMenuButtonActiveCommon", /** * @group ToolbarPenSubMenu * @description The text for the "Draw" section in the PenWidth sub-menu of the agent's toolbar, supports configuration of `stylingOverrides`, `textOverride`. */ AgentPenSubMenuDrawText = "agentPenSubMenuDrawText", /** * @group ToolbarPenSubMenu * @description The text for the "Line Width" section in the PenWidth sub-menu of the agent's toolbar, supports configuration of `stylingOverrides`, `textOverride`. */ AgentPenSubMenuLineWidthText = "agentPenSubMenuLineWidthText", // color submenu /** * @group ToolbarColorSubMenu * @description The container for the Color sub-menu in the agent's toolbar when displayed vertically, supports configuration of `stylingOverrides`. */ AgentColorSubMenuVerticalWrapper = "agentColorSubMenuVerticalWrapper", /** * @group ToolbarColorSubMenu * @description The container for the Color sub-menu in the agent's toolbar when displayed horizontally, supports configuration of `stylingOverrides`. */ AgentColorSubMenuHorizontalWrapper = "agentColorSubMenuHorizontalWrapper", /** * @group ToolbarColorSubMenu * @description The common style for all buttons in the Color sub-menu of the agent's toolbar, supports configuration of `stylingOverrides`. */ AgentColorSubMenuButtonCommon = "agentColorSubMenuButtonCommon", /** * @group ToolbarColorSubMenu * @description The common style for all buttons in the Color sub-menu when selected, supports configuration of `stylingOverrides`. */ AgentColorSubMenuActiveButtonCommon = "agentColorSubMenuActiveButtonCommon", // zoom in/out menu /** * @group ToolbarZoomInOutMenu * @description The container for the "Zoom Menu" sub-menu in the agent's toolbar when displayed vertically, supports configuration of `stylingOverrides`. */ AgentZoomInOutMenuVerticalWrapper = "agentZoomInOutMenuVerticalWrapper", /** * @group ToolbarZoomInOutMenu * @description The container for the "Zoom Menu" sub-menu in the agent's toolbar when displayed horizontally, supports configuration of `stylingOverrides`. */ AgentZoomInOutMenuHorizontalWrapper = "agentZoomInOutMenuHorizontalWrapper", /** * @group ToolbarZoomInOutMenu * @description The root element for the "Zoom Menu" sub-menu in the agent's toolbar when displayed horizontally, supports configuration of `stylingOverrides`. */ AgentZoomInOutMenuRoot = "agentZoomInOutMenuRoot", /** * @group ToolbarZoomInOutMenu * @description The menu item in the "Zoom Menu" sub-menu of the agent's toolbar when displayed horizontally, supports configuration of `stylingOverrides`. */ AgentZoomInOutMenuItem = "agentZoomInOutMenuItem", /** * @group ToolbarZoomInOutMenu * @description The "FitToWindow" menu item in the "Zoom Menu" sub-menu of the agent's toolbar when displayed horizontally, supports configuration of `stylingOverrides`. */ AgentZoomInOutMenuItemFitToWindow = "agentZoomInOutMenuItemFitToWindow", /** * @group ToolbarZoomInOutMenu * @description The "ActualSize" menu item in the "Zoom Menu" sub-menu of the agent's toolbar when displayed horizontally, supports configuration of `stylingOverrides`. */ AgentZoomInOutMenuItemActualSize = "agentZoomInOutMenuItemActualSize", // leave session dialog (single agent) /** * @group SingleAgentEndSessionDialog * @description The container for the End Session dialog when there is only one agent in the session, supports configuration of `stylingOverrides`. */ AgentSingleAgentEndSessionDialogOverall = "agentSingleAgentEndSessionDialogOverall", /** * @group SingleAgentEndSessionDialog * @description The title section container for the End Session dialog when there is only one agent in the session, supports configuration of `stylingOverrides`. */ AgentSingleAgentEndSessionDialogTitleContainer = "agentSingleAgentEndSessionDialogTitleContainer", /** * @group SingleAgentEndSessionDialog * @description The content section container for the End Session dialog when there is only one agent in the session, supports configuration of `stylingOverrides`. */ AgentSingleAgentEndSessionDialogContentContainer = "agentSingleAgentEndSessionDialogContentContainer", /** * @group SingleAgentEndSessionDialog * @description The footer section container for the End Session dialog when there is only one agent in the session, supports configuration of `stylingOverrides`. */ AgentSingleAgentEndSessionDialogFooterContainer = "agentSingleAgentEndSessionDialogFooterContainer", /** * @group SingleAgentEndSessionDialog * @description The title icon for the End Session dialog when there is only one agent in the session (default is a red circular icon with a white exclamation mark), supports configuration of `stylingOverrides`, `iconOverride`, `disabledComponentOverride`. */ AgentSingleAgentEndSessionDialogTitleIcon = "agentSingleAgentEndSessionDialogTitleIcon", /** * @group SingleAgentEndSessionDialog * @description The title text for the End Session dialog when there is only one agent in the session (default text is "End the session"), supports configuration of `stylingOverrides`, `textOverride`. */ AgentSingleAgentEndSessionDialogTitleContent = "agentSingleAgentEndSessionDialogTitleContent", /** * @group SingleAgentEndSessionDialog * @description The content text for the End Session dialog when there is only one agent in the session (default text is "Are you sure you want to end the Cobrowse session?"), supports configuration of `stylingOverrides`, `textOverride`. */ AgentSingleAgentEndSessionDialogTextContent = "agentSingleAgentEndSessionDialogTextContent", /** * @group SingleAgentEndSessionDialog * @description The top-right close button for the End Session dialog when there is only one agent in the session, supports configuration of `stylingOverrides`, `disabledComponentOverride`. */ AgentSingleAgentEndSessionDialogTopRightCloseButton = "agentSingleAgentEndSessionDialogTopRightCloseButton", /** * @group SingleAgentEndSessionDialog * @description The "Cancel" button in the footer section of the End Session dialog when there is only one agent in the session, supports configuration of `stylingOverrides`, `textOverride`. */ AgentSingleAgentEndSessionDialogCancelButton = "agentSingleAgentEndSessionDialogCancelButton", /** * @group SingleAgentEndSessionDialog * @description The "End" button in the footer section of the End Session dialog when there is only one agent in the session, supports configuration of `stylingOverrides`, `textOverride`. */ AgentSingleAgentEndSessionDialogEndSessionButton = "agentSingleAgentEndSessionDialogEndSessionButton", // end session dialog (multi agents) /** * @group MultiAgentsEndSessionDialog * @description The container for the End Session dialog when there are multiple agents in the session, supports configuration of `stylingOverrides`. */ AgentMultiAgentsEndSessionDialogOverall = "agentMultiAgentsEndSessionDialogOverall", /** * @group MultiAgentsEndSessionDialog * @description The title section container for the End Session dialog when there are multiple agents in the session, supports configuration of `stylingOverrides`. */ AgentMultiAgentsEndSessionDialogTitleContainer = "agentMultiAgentsEndSessionDialogTitleContainer", /** * @group MultiAgentsEndSessionDialog * @description The content section container for the End Session dialog when there are multiple agents in the session, supports configuration of `stylingOverrides`. */ AgentMultiAgentsEndSessionDialogContentContainer = "agentMultiAgentsEndSessionDialogContentContainer", /** * @group MultiAgentsEndSessionDialog * @description The footer section container for the End Session dialog when there are multiple agents in the session, supports configuration of `stylingOverrides`. */ AgentMultiAgentsEndSessionDialogFooterContainer = "agentMultiAgentsEndSessionDialogFooterContainer", /** * @group MultiAgentsEndSessionDialog * @description The title icon for the End Session dialog when there are multiple agents in the session (default is a red circular icon with a white exclamation mark), supports configuration of `stylingOverrides`, `iconOverride`, `disabledComponentOverride`. */ AgentMultiAgentsEndSessionDialogTitleIcon = "agentMultiAgentsEndSessionDialogTitleIcon", /** * @group MultiAgentsEndSessionDialog * @description The title text for the End Session dialog when there are multiple agents in the session (default text is "Leave the session"), supports configuration of `stylingOverrides`, `textOverride`. */ AgentMultiAgentsEndSessionDialogTitleContent = "agentMultiAgentsEndSessionDialogTitleContent", /** * @group MultiAgentsEndSessionDialog * @description The content text for the End Session dialog when there are multiple agents in the session (default text is "Are you sure you want to leave the Cobrowse session?"), supports configuration of `stylingOverrides`, `textOverride`. */ AgentMultiAgentsEndSessionDialogTextContent = "agentMultiAgentsEndSessionDialogTextContent", /** * @group MultiAgentsEndSessionDialog * @description The top-right close button for the End Session dialog when there are multiple agents in the session, supports configuration of `stylingOverrides`, `disabledComponentOverride`. */ AgentMultiAgentsEndSessionDialogTopRightCloseButton = "agentMultiAgentsEndSessionDialogTopRightCloseButton", /** * @group MultiAgentsEndSessionDialog * @description The "Cancel" button in the footer section of the End Session dialog when there are multiple agents in the session, supports configuration of `stylingOverrides`, `textOverride`. */ AgentMultiAgentsEndSessionDialogCancelButton = "agentMultiAgentsEndSessionDialogCancelButton", /** * @group MultiAgentsEndSessionDialog * @description The "Leave" button in the footer section of the End Session dialog when there are multiple agents in the session, supports configuration of `stylingOverrides`, `textOverride`. */ AgentMultiAgentsEndSessionDialogLeaveSessionButton = "agentMultiAgentsEndSessionDialogLeaveSessionButton", /** * @group MultiAgentsEndSessionDialog * @description The "End for All" button in the footer section of the End Session dialog when there are multiple agents in the session, supports configuration of `stylingOverrides`, `textOverride`. */ AgentMultiAgentsEndSessionDialogEndSessionButton = "agentMultiAgentsEndSessionDialogEndSessionButton", // agent join failed dialog /** * @group JoinFailedDialog * @description The container for the Join Failed dialog in the agent's toolbar, supports configuration of `stylingOverrides`. */ AgentJoinFailedDialogOverall = "agentJoinFailedDialogOverall", /** * @group JoinFailedDialog * @description The title section container for the Join Failed dialog, supports configuration of `stylingOverrides`. */ AgentJoinFailedDialogTitleContainer = "agentJoinFailedDialogTitleContainer", /** * @group JoinFailedDialog * @description The content section container for the Join Failed dialog, supports configuration of `stylingOverrides`. */ AgentJoinFailedDialogContentContainer = "agentJoinFailedDialogContentContainer", /** * @group JoinFailedDialog * @description The footer section container for the Join Failed dialog, supports configuration of `stylingOverrides`. */ AgentJoinFailedDialogFooterContainer = "agentJoinFailedDialogFooterContainer", /** * @group JoinFailedDialog * @description The title icon for the Join Failed dialog (default is a red circular icon with a white exclamation mark), supports configuration of `stylingOverrides`, `iconOverride`, `disabledComponentOverride`. */ AgentJoinFailedDialogTitleIcon = "agentJoinFailedDialogTitleIcon", /** * @group JoinFailedDialog * @description The title text for the Join Failed dialog (e.g., "Agent number limit reached"), supports configuration of `stylingOverrides`. */ AgentJoinFailedDialogTitleContent = "agentJoinFailedDialogTitleContent", /** * @group JoinFailedDialog * @description The content text for the Join Failed dialog (e.g., "The number of logged-in Agents has reached the upper limit"), supports configuration of `stylingOverrides`. */ AgentJoinFailedDialogTextContent = "agentJoinFailedDialogTextContent", /** * @group JoinFailedDialog * @description The top-right close button for the Join Failed dialog, supports configuration of `stylingOverrides`, `disabledComponentOverride`. */ AgentJoinFailedDialogTopRightCloseButton = "agentJoinFailedDialogTopRightCloseButton", /** * @group JoinFailedDialog * @description The "OK" button in the footer section of the Join Failed dialog, supports configuration of `stylingOverrides`, `textOverride`. */ AgentJoinFailedDialogOkButton = "agentJoinFailedDialogOkButton", /** * @group FloatingPinToolbar * @description The container for the floating Pin toolbar in the agent's interface, supports configuration of `stylingOverrides`, `disabledComponentOverride`. */ AgentFloatingPinToolbarWrapper = "agentFloatingPinToolbarWrapper", /** * @group FloatingPinToolbar * @description The prefix icon in the floating Pin toolbar of the agent's interface, supports configuration of `stylingOverrides`, `iconOverride`, `disabledComponentOverride`. */ AgentFloatingPinToolbarPrefixIcon = "agentFloatingPinToolbarPrefixIcon", /** * @group FloatingPinToolbar * @description The pincode display section in the floating Pin toolbar of the agent's interface (use `textOverride` to modify the "Code:" text), supports configuration of `stylingOverrides`, `textOverride`. */ AgentFloatingPinToolbarContentText = "agentFloatingPinToolbarContentText", /** * @group FloatingPinToolbar * @description The copy icon in the floating Pin toolbar of the agent's interface, supports configuration of `stylingOverrides`, `iconOverride`, `disabledComponentOverride`. */ AgentFloatingPinToolbarCopyIcon = "agentFloatingPinToolbarCopyIcon", /** * @group ToastSuccess * @description The container for the success toast in the agent's interface, supports configuration of `stylingOverrides`. */ AgentToastSuccessPrefixIcon = "agentToastSuccessPrefixIcon", /** * @group ToastSuccess * @description The prefix icon in the success toast in the agent's interface, supports configuration of `stylingOverrides`, `iconOverride`, `disabledComponentOverride`. */ AgentToastSuccessWrapper = "agentToastSuccessWrapper", /** * @group ToastError * @description The container for the error toast in the agent's interface, supports configuration of `stylingOverrides`. */ AgentToastErrorPrefixIcon = "agentToastErrorPrefixIcon", /** * @group ToastError * @description The prefix icon in the error toast in the agent's interface, supports configuration of `stylingOverrides`, `iconOverride`, `disabledComponentOverride`. */ AgentToastErrorWrapper = "agentToastErrorWrapper", /** * @group ToastWarning * @description The container for the warning toast in the agent's interface, supports configuration of `stylingOverrides`. */ AgentToastWarningPrefixIcon = "agentToastWarningPrefixIcon", /** * @group ToastWarning * @description The prefix icon in the warning toast in the agent's interface, supports configuration of `stylingOverrides`, `iconOverride`, `disabledComponentOverride`. */ AgentToastWarningWrapper = "agentToastWarningWrapper", /** * @group ToastInfo * @description The container for the info toast in the agent's interface, supports configuration of `stylingOverrides`. */ AgentToastInfoPrefixIcon = "agentToastInfoPrefixIcon", /** * @group ToastInfo * @description The prefix icon in the info toast in the agent's interface, supports configuration of `stylingOverrides`, `iconOverride`, `disabledComponentOverride`. */ AgentToastInfoWrapper = "agentToastInfoWrapper" } declare enum EndReason { /** * @description The session was explicitly ended. */ END_SESSION = "end_session", /** * @description The session was automatically deactivated. */ DEACTIVE_SESSION = "deactive_session", /** * @description The session was cancelled. */ CANCEL_SESSION = "cancel_session" } declare enum InitError { UNKNOWN = "unknown", NO_ROOT_DOM = "no_root_dom" } declare enum LeaveReason { /** * @description The user left the session. */ LEAVE_SESSION = "leave_session", /** * @description The user was disconnected. */ DISCONNECT_SESSION = "disconnect_session" } declare enum SessionErrorCode { /** * @description Join session failed due to pincode not found. */ SESSION_JOIN_PIN_NOT_FOUND = 1006, /** * @description Join session failed due to invalid pincode. */ SESSION_PIN_INVALID_FORMAT = 1008, /** * @description Join session failed due to empty pincode. */ SESSION_START_PIN_REQUIRED = 1009, /** * @description Join session failed. */ SESSION_JOIN_FAILED = 1011, /** * @description Join session failed due to count limit. */ SESSION_AGENT_COUNT_LIMIT = 1013, /** * @description Join session failed due to duplicate user. */ SESSION_DUPLICATE_USER = 1015, /** * @description Start or join session failed due to network error. */ NETWORK_ERROR = 1016, /** * @description Join session failed due to invalid token. */ TOKEN_INVALID = 2001, /** * @description Unknown error. */ UNDEFINED = 9999 } declare enum SessionStatus { /** * @description Session has previous record. */ RECOVERABLE = "session_recoverable" } declare function customer_focus_lost(payload: { /** * customer is lost */ isLost: boolean; /** * sessionId */ sessionId: string; /** * User info */ user: { id: string; name: string; }; /** * SDK version */ version: string; }): void; declare function customer_transferred(payload: { /** * sessionId */ sessionId: string; /** * User info */ user: { id: string; name: string; }; /** * SDK version */ version: string; }): void; declare function remote_assist_accepted(payload: { /** * Assistance type array. Only supports ['scroll_page']. */ assistType: [ "scroll_page" ]; /** * Session ID. */ sessionId: string; /** * SDK version. */ version: string; }): void; declare function remote_assist_rejected(payload: { /** * Assistance type array. Only supports ['scroll_page']. */ assistType: [ "scroll_page" ]; /** * Session ID. */ sessionId: string; /** * SDK version. */ version: string; }): void; declare function remote_assist_started(payload: { /** * Assistance type array. Only supports ['scroll_page']. */ assistType: [ "scroll_page" ]; /** * Session ID. */ sessionId: string; /** * SDK version. */ version: string; }): void; declare function remote_assist_stopped(payload: { /** * Assistance type array. Only supports ['scroll_page']. */ assistType: [ "scroll_page" ]; /** * Session ID. */ sessionId: string; /** * SDK version. */ version: string; }): void; declare function session_ended(payload: { /** * reason */ reason: EndReason; /** * sessionId */ sessionId: string; /** * SDK version */ version: string; }): void; declare function session_error(payload: { /** * error code */ code: SessionErrorCode; /** * error message */ errorMsg: string; /** * SDK version */ version: string; }): void; declare function session_joined(payload: { /** * Whether to reconnect the session. */ isReconnect: boolean; /** * sessionId */ sessionId: string; /** * SDK version */ version: string; }): void; declare function session_left(payload: { /** * reason */ reason: LeaveReason; /** * sessionId */ sessionId: string; /** * SDK version */ version: string; }): void; declare global { interface Window { ZoomCobrowseAgentSDK: typeof ZoomCobrowseAgentSDK$1; } const ZoomCobrowseAgentSDK: typeof ZoomCobrowseAgentSDK$1; } declare namespace Session { /** * @description Verify the PIN and get the agent page URL. * @example * ``` * session.createAgentViewerEndpoint({ * pinCode:'{PIN_CODE}', * sdkToken:'{SDK_TOKEN}' * }, function({ success, agentViewerUrl, error }){ * if(success){ * console.log(agentViewerUrl) * }else { * console.log(error) * } * }) * ``` */ function createAgentViewerEndpoint(option: CreateAgentViewerEndpointOptions, callback: CreateAgentViewerEndpointCallback): void; /** * @description Verify the PIN and get the agent page URL. * @example * ``` * session.join({ * pinCode:'{PIN_CODE}', * sdkToken:'{SDK_TOKEN}' * }, function({ success, session, error }){ * session.on('session_joined',payload => { * console.log('session_joined', payload); * }) * }) * ``` */ function join(option: CreateAgentViewerEndpointOptions): void; /** * @description Get session information. * @example * ``` * session.getSessionInfo(); * ``` */ function getSessionInfo(): SessionInfo | null; /** * @description Start remote assistance. * @example * ``` * session.startRemoteAssist(); * ``` */ function startRemoteAssist(): void; /** * @description Stop remote assistance * @example * ``` * session.stopRemoteAssist(); * ``` */ function stopRemoteAssist(): void; /** * @param event Session ended. * @param listener Details in {@link session_ended}. */ function on(event: "session_ended", listener: typeof session_ended): void; /** * @param event Error occurred. * @param listener Details in {@link session_error}. */ function on(event: "session_error", listener: typeof session_error): void; /** * @param event User joined session. * @param listener Details in {@link session_joined}. */ function on(event: "session_joined", listener: typeof session_joined): void; /** * @param event User left session. * @param listener Details in {@link session_left}. */ function on(event: "session_left", listener: typeof session_left): void; /** * @param event Customer focus lost. * @param listener Details in {@link customer_focus_lost}. */ function on(event: "customer_focus_lost", listener: typeof customer_focus_lost): void; /** * @param event Customer transferred. * @param listener Details in {@link customer_transferred}. */ function on(event: "customer_transferred", listener: typeof customer_transferred): void; /** * @param event Remote assist accepted. * @param listener Details in {@link remote_assist_accepted}. */ function on(event: "remote_assist_accepted", listener: typeof remote_assist_accepted): void; /** * @param event Remote assist rejected. * @param listener Details in {@link remote_assist_rejected}. */ function on(event: "remote_assist_rejected", listener: typeof remote_assist_rejected): void; /** * @param event Remote assist started. * @param listener Details in {@link remote_assist_started}. */ function on(event: "remote_assist_started", listener: typeof remote_assist_started): void; /** * @param event Remote assist stopped. * @param listener Details in {@link remote_assist_stopped}. */ function on(event: "remote_assist_stopped", listener: typeof remote_assist_stopped): void; } /** * @description ZoomAgentCobrowseSDK createAgentViewerEndpoint Callback. */ export type CreateAgentViewerEndpointCallback = ({ success, error, agentViewerUrl, }: { success: boolean; error?: CreateAgentViewerEndpointError; agentViewerUrl?: string; }) => void; /** * @description CreateAgentViewerEndpointCallback fetch error. */ export type CreateAgentViewerEndpointError = { msg: string; code: number; statusCode: number; }; /** * @description ZoomAgentCobrowseSDK request agent endpoint options. */ export type CreateAgentViewerEndpointOptions = { /** * @description Use your Cobrowse SDK Key and Secret to generate the Cobrowse SDK JWT. * Detail: https://developers.zoom.us/docs/cobrowse-sdk/get-started/#generate-tokens */ sdkToken: string; /** * @description The pin code is generated by the session creator and notified to the session joiner. */ pinCode: string; }; /** * @description * Defines the configuration used to override the default appearance and behavior of Zoom Cobrowse UI components * on the customer side. This object supports custom styling, icon replacement, text content changes, * visibility control, and initial positioning. * * This enables you to flexibly adapt the UI to meet your branding or interaction needs * without modifying the underlying SDK codebase. Each field is optional and can be applied selectively * to specific UI components as exposed through the feature keys. */ export type CustomizeOverride = { /** * @description Custom styling settings written in CSS-in-JS style. * For components such as buttons that have multiple states, the following selectors are supported: * - `&:hover`: Styles applied when the mouse hovers over the component. * - `&:active`: Styles applied when the component is in an active (pressed) state. * - `&:disabled`: Styles applied when the component is disabled. * ``` * stylingOverrides: { * backgroundColor: 'rgba(0,0,0,0)', * border: '1px solid #fff', * '&:hover': { * backgroundColor: 'rgba(255,255,255,0.2)', * }, * '&:active': { * backgroundColor: 'rgba(255,255,255,0.5)', * }, * } * ``` */ stylingOverrides?: React.CSSProperties; /** * @description Icon resource to override the default, supporting both URL and base64 formats. */ iconOverride?: string; /** * @description Custom text content to override the default label. */ textOverride?: string; /** * @description Controls whether the corresponding UI component is displayed. */ disabledComponentOverride?: boolean; /** * @description Initial position of the component within its container. * * - `top`: Distance from the top edge. Conflicts with `bottom`. If neither is set, vertical centering is applied. * - `bottom`: Distance from the bottom edge. Conflicts with `top`. If neither is set, vertical centering is applied. * - `left`: Distance from the left edge. Conflicts with `right`. If neither is set, horizontal centering is applied. * - `right`: Distance from the right edge. Conflicts with `left`. If neither is set, horizontal centering is applied. * @example * ``` * initPositionOverride: { * top: '20px', * } * ``` */ initPositionOverride?: { top?: string; bottom?: string; left?: string; right?: string; }; }; /** * @description ZoomAgentCobrowseSDK init Ready Callback. */ export type SDKReadyCallback = ({ success, sdkInfo, session, error, }: { success: boolean; sdkInfo: SdkInfo; session?: typeof Session; error?: InitError; }) => void; /** * @description SDK information. */ export type SdkInfo = { /** * @description SDK version. */ version: string; }; /** * @description Current session information. */ export type SessionInfo = { /** * @description Current session ID. */ sessionId: string; /** * @description Current session pincode. */ pinCode?: string; /** * @description Current session status. * @enum */ sessionStatus?: SessionStatus; }; /** * @description ZoomAgentCobrowseSDK init settings. * @interface Settings */ export type Settings = { /** * @description Whether to use the built-in UI to display pincode, the default is true. */ customizeOverrides?: { [key in AgentCustomizeOverridesFeatureKey]?: CustomizeOverride; }; /** * @description In npm mode, a root dom selector or HTMLElement is required to insert an agent portal iframe into your page. */ zoomAppRoot?: string | HTMLElement; /** * @description In npm mode, appKey is required for init Cobrowse. */ appKey?: string; /** * @description In npm mode, zoomHostName is required for init Cobrowse. * @default us01-zcb.zoom.us */ zoomHostName?: string; }; export { ZoomCobrowseAgentSDK$1 as default, }; export {};