@zoom/cobrowsesdk 2.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,1029 @@
1
+ /// <reference types="react" />
2
+
3
+ /**
4
+ * @description ZoomCobrowseAgentSDK global variable.
5
+ * @exports Package exposed namespace in IIFE format (Immediately Invoked Function Expression).
6
+ */
7
+ declare const ZoomCobrowseAgentSDK$1: {
8
+ /**
9
+ * @description Init Cobrowse SDK. Some settings will be configured in this step.
10
+ * @example
11
+ * ```
12
+ * ZoomCobrowseAgentSDK.init(settings, function({ success, session, error }) {
13
+ * if (success) {
14
+ * session.createAgentViewerEndpoint({
15
+ * pinCode:'{PIN_CODE}',
16
+ * sdkToken:'{SDK_TOKEN}'
17
+ * }, function({ success, agentViewerUrl, error }){
18
+ * if(success){
19
+ * console.log(agentViewerUrl)
20
+ * }else {
21
+ * console.log(error)
22
+ * }
23
+ * })
24
+ * } else {
25
+ * console.log(error);
26
+ * }
27
+ * });
28
+ * ```
29
+ */
30
+ init: (option: Settings, callback: SDKReadyCallback) => void;
31
+ };
32
+ declare enum AgentCustomizeOverridesFeatureKey {
33
+ /**
34
+ * @group ToolbarCommon
35
+ * @description The container for the agent toolbar when displayed vertically. Supports `stylingOverrides`.
36
+ */
37
+ AgentToolbarVerticalWrapper = "agentToolbarVerticalWrapper",
38
+ /**
39
+ * @group ToolbarCommon
40
+ * @description The container for the agent toolbar when displayed horizontally. Supports `stylingOverrides`.
41
+ */
42
+ AgentToolbarHorizontalWrapper = "agentToolbarHorizontalWrapper",
43
+ /**
44
+ * @group ToolbarCommon
45
+ * @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`.
46
+ */
47
+ AgentToolbarAllowRotation = "agentToolbarAllowRotation",
48
+ /**
49
+ * @group ToolbarCommon
50
+ * @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`.
51
+ */
52
+ AgentToolbarDefaultVertical = "agentToolbarDefaultVertical",
53
+ /**
54
+ * @group ToolbarCommon
55
+ * @description The container for all toolbar buttons except the "End Session" button when the agent toolbar is displayed vertically. Supports `stylingOverrides`.
56
+ */
57
+ AgentToolbarVerticalNormalBtnsWrapper = "agentToolbarVerticalNormalBtnsWrapper",
58
+ /**
59
+ * @group ToolbarCommon
60
+ * @description The container for all toolbar buttons except the "End Session" button when the agent toolbar is displayed horizontally. Supports `stylingOverrides`.
61
+ */
62
+ AgentToolbarHorizontalNormalBtnsWrapper = "agentToolbarHorizontalNormalBtnsWrapper",
63
+ /**
64
+ * @group ToolbarCommon
65
+ * @description Common styling for all agent toolbar buttons except the "End Session" button. Lower priority than individual button settings. Supports `stylingOverrides`.
66
+ */
67
+ AgentToolbarButtonCommon = "agentToolbarButtonCommon",
68
+ /**
69
+ * @group ToolbarCommon
70
+ * @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`.
71
+ */
72
+ AgentToolbarButtonActiveCommon = "agentToolbarButtonActiveCommon",
73
+ /**
74
+ * @group ToolbarCommon
75
+ * @description Common styling for tooltips of agent toolbar buttons. Supports `stylingOverrides`.
76
+ */
77
+ AgentToolbarTooltipCommon = "agentToolbarTooltipCommon",
78
+ /**
79
+ * @group ToolbarCommon
80
+ * @description Agent's main toolbar vertical divider. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`.
81
+ */
82
+ AgentToolbarVerticalDivider = "agentToolbarVerticalDivider",
83
+ /**
84
+ * @group ToolbarCommon
85
+ * @description Agent's main toolbar horizontal divider. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`.
86
+ */
87
+ AgentToolbarHorizontalDivider = "agentToolbarHorizontalDivider",
88
+ /**
89
+ * @group AgentToolbarFirstLevelButtons
90
+ * @description The "Zoom In" button in the agent's main toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`.
91
+ */
92
+ AgentToolbarZoomInButton = "agentToolbarZoomInButton",
93
+ /**
94
+ * @group AgentToolbarFirstLevelButtons
95
+ * @description The icon inside the "Zoom In" button in the agent's main toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`.
96
+ */
97
+ AgentToolbarZoomInIcon = "agentToolbarZoomInIcon",
98
+ /**
99
+ * @group AgentToolbarFirstLevelButtons
100
+ * @description The "Zoom Out" button in the agent's main toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`.
101
+ */
102
+ AgentToolbarZoomOutButton = "agentToolbarZoomOutButton",
103
+ /**
104
+ * @group AgentToolbarFirstLevelButtons
105
+ * @description The icon inside the "Zoom Out" button in the agent's main toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`.
106
+ */
107
+ AgentToolbarZoomOutIcon = "agentToolbarZoomOutIcon",
108
+ /**
109
+ * @group AgentToolbarFirstLevelButtons
110
+ * @description The "Zoom Menu" button in the agent's main toolbar. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`.
111
+ */
112
+ AgentToolbarZoomMenuButton = "agentToolbarZoomMenuButton",
113
+ /**
114
+ * @group AgentToolbarFirstLevelButtons
115
+ * @description The icon inside the "Zoom Menu" button in the agent's main toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`.
116
+ */
117
+ AgentToolbarZoomMenuIcon = "agentToolbarZoomMenuIcon",
118
+ /**
119
+ * @group AgentToolbarFirstLevelButtons
120
+ * @description The "Fullscreen" button in the agent's main toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`.
121
+ */
122
+ AgentToolbarFullScreenButton = "agentToolbarFullScreenButton",
123
+ /**
124
+ * @group AgentToolbarFirstLevelButtons
125
+ * @description The icon inside the "Fullscreen" button in the agent's main toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`.
126
+ */
127
+ AgentToolbarFullScreenIcon = "agentToolbarFullScreenIcon",
128
+ /**
129
+ * @group AgentToolbarFirstLevelButtons
130
+ * @description The "Exit Fullscreen" button in the agent's main toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`.
131
+ */
132
+ AgentToolbarExitFullScreenButton = "agentToolbarExitFullScreenButton",
133
+ /**
134
+ * @group AgentToolbarFirstLevelButtons
135
+ * @description The icon inside the "Exit Fullscreen" button in the agent's main toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`.
136
+ */
137
+ AgentToolbarExitFullScreenIcon = "agentToolbarExitFullScreenIcon",
138
+ /**
139
+ * @group AgentToolbarFirstLevelButtons
140
+ * @description The "Vanishing Pen" button in the agent's main toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`.
141
+ */
142
+ AgentToolbarVanishingPenButton = "agentToolbarVanishingPenButton",
143
+ /**
144
+ * @group AgentToolbarFirstLevelButtons
145
+ * @description The icon inside the "Vanishing Pen" button in the agent's main toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`.
146
+ */
147
+ AgentToolbarVanishingPenIcon = "agentToolbarVanishingPenIcon",
148
+ /**
149
+ * @group AgentToolbarFirstLevelButtons
150
+ * @description The "Pen" button in the agent's main toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`.
151
+ */
152
+ AgentToolbarPenButton = "agentToolbarPenButton",
153
+ /**
154
+ * @group AgentToolbarFirstLevelButtons
155
+ * @description The icon inside the "Pen" button in the agent's main toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`.
156
+ */
157
+ AgentToolbarPenIcon = "agentToolbarPenIcon",
158
+ /**
159
+ * @group AgentToolbarFirstLevelButtons
160
+ * @description The "Leave Cobrowse" button in the agent's main toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`.
161
+ */
162
+ AgentToolbarEndSessionButton = "agentToolbarEndSessionButton",
163
+ /**
164
+ * @group AgentToolbarFirstLevelButtons
165
+ * @description The icon inside the "Leave Cobrowse" button in the agent's main toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`.
166
+ */
167
+ AgentToolbarEndSessionIcon = "agentToolbarEndSessionIcon",
168
+ /**
169
+ * @group ToolbarVanishingPenSubMenuCommon
170
+ * @description The container for the Vanishing Pen sub-toolbar when the agent toolbar is displayed vertically. Supports `stylingOverrides`.
171
+ */
172
+ AgentVanishingPenSubMenuVerticalWrapper = "agentVanishingPenSubMenuVerticalWrapper",
173
+ /**
174
+ * @group ToolbarVanishingPenSubMenuCommon
175
+ * @description The container for the Vanishing Pen sub-toolbar when the agent toolbar is displayed horizontally. Supports `stylingOverrides`.
176
+ */
177
+ AgentVanishingPenSubMenuHorizontalWrapper = "agentVanishingPenSubMenuHorizontalWrapper",
178
+ /**
179
+ * @group ToolbarVanishingPenSubMenuCommon
180
+ * @description Common styling for all buttons in the Vanishing Pen sub-toolbar. Lower priority than individual button settings. Supports `stylingOverrides`.
181
+ */
182
+ AgentVanishingPenSubMenuButtonCommon = "agentVanishingPenSubMenuButtonCommon",
183
+ /**
184
+ * @group ToolbarVanishingPenSubMenuCommon
185
+ * @description Common styling when buttons in the Vanishing Pen sub-toolbar are in an active state. Lower priority than individual button settings. Supports `stylingOverrides`.
186
+ */
187
+ AgentVanishingPenMenuButtonActiveCommon = "agentVanishingPenSubMenuButtonActiveCommon",
188
+ /**
189
+ * @group ToolbarVanishingPenSubMenuButtons
190
+ * @description The "Mouse" button in the Vanishing Pen secondary toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`.
191
+ */
192
+ AgentVanishingPenSubMenuMouseButton = "agentVanishingPenSubMenuMouseButton",
193
+ /**
194
+ * @group ToolbarVanishingPenSubMenuButtons
195
+ * @description The icon inside the "Mouse" button in the Vanishing Pen secondary toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`.
196
+ */
197
+ AgentVanishingPenSubMenuMouseIcon = "agentVanishingPenSubMenuMouseIcon",
198
+ /**
199
+ * @group ToolbarVanishingPenSubMenuButtons
200
+ * @description The "Vanishing Pen" button in the Vanishing Pen secondary toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`.
201
+ */
202
+ AgentVanishingPenSubMenuVanishingPenButton = "agentVanishingPenSubMenuVanishingPenButton",
203
+ /**
204
+ * @group ToolbarVanishingPenSubMenuButtons
205
+ * @description The icon inside the "Vanishing Pen" button in the Vanishing Pen secondary toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`.
206
+ */
207
+ AgentVanishingPenSubMenuVanishingPenIcon = "agentVanishingPenSubMenuVanishingPenIcon",
208
+ /**
209
+ * @group ToolbarVanishingPenSubMenuButtons
210
+ * @description The "Vanishing Rectangle" button in the Vanishing Pen secondary toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`.
211
+ */
212
+ AgentVanishingPenSubMenuVanishingRectangleButton = "agentVanishingPenSubMenuVanishingRectangleButton",
213
+ /**
214
+ * @group ToolbarVanishingPenSubMenuButtons
215
+ * @description The icon inside the "Vanishing Rectangle" button in the Vanishing Pen secondary toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`.
216
+ */
217
+ AgentVanishingPenSubMenuVanishingRectangleIcon = "agentVanishingPenSubMenuVanishingRectangleIcon",
218
+ /**
219
+ * @group ToolbarVanishingPenSubMenuButtons
220
+ * @description The "Color" button in the Vanishing Pen secondary toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`.
221
+ */
222
+ AgentVanishingPenSubMenuVanishingColorButton = "agentVanishingPenSubMenuVanishingColorButton",
223
+ /**
224
+ * @group ToolbarVanishingPenSubMenuButtons
225
+ * @description The color preview section inside the "Color" button in the Vanishing Pen secondary toolbar. Supports `stylingOverrides`.
226
+ */
227
+ AgentVanishingPenSubMenuVanishingColorIcon = "agentVanishingPenSubMenuVanishingColorIcon",
228
+ /**
229
+ * @group ToolbarPenAnnotationSubMenuCommon
230
+ * @description The container for the Pen sub-toolbar when the agent toolbar is displayed vertically. Supports `stylingOverrides`.
231
+ */
232
+ AgentPenAnnotationSubMenuVerticalWrapper = "agentPenAnnotationSubMenuVerticalWrapper",
233
+ /**
234
+ * @group ToolbarPenAnnotationSubMenuCommon
235
+ * @description The container for the Pen sub-toolbar when the agent toolbar is displayed horizontally. Supports `stylingOverrides`.
236
+ */
237
+ AgentPenAnnotationSubMenuHorizontalWrapper = "agentPenAnnotationSubMenuHorizontalWrapper",
238
+ /**
239
+ * @group ToolbarPenAnnotationSubMenuCommon
240
+ * @description Common styling for all buttons in the Pen sub-toolbar. Lower priority than individual button settings. Supports `stylingOverrides`.
241
+ */
242
+ AgentPenAnnotationSubMenuButtonCommon = "agentPenAnnotationSubMenuButtonCommon",
243
+ /**
244
+ * @group ToolbarPenAnnotationSubMenuCommon
245
+ * @description Common styling when buttons in the Pen sub-toolbar are in an active state. Lower priority than individual button settings. Supports `stylingOverrides`.
246
+ */
247
+ AgentPenAnnotationSubMenuButtonActiveCommon = "agentPenAnnotationSubMenuButtonActiveCommon",
248
+ /**
249
+ * @group ToolbarPenAnnotationSubMenuButtons
250
+ * @description The "Mouse" button in the Pen secondary toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`.
251
+ */
252
+ AgentPenAnnotationSubMenuMouseButton = "agentPenAnnotationSubMenuMouseButton",
253
+ /**
254
+ * @group ToolbarPenAnnotationSubMenuButtons
255
+ * @description The icon inside the "Mouse" button in the Pen secondary toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`.
256
+ */
257
+ AgentPenAnnotationSubMenuMouseIcon = "agentPenAnnotationSubMenuMouseIcon",
258
+ /**
259
+ * @group ToolbarPenAnnotationSubMenuButtons
260
+ * @description The "Pen" button in the Pen secondary toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`.
261
+ */
262
+ AgentPenAnnotationSubMenuPenButton = "agentPenAnnotationSubMenuPenButton",
263
+ /**
264
+ * @group ToolbarPenAnnotationSubMenuButtons
265
+ * @description The icon inside the "Pen" button in the Pen secondary toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`.
266
+ */
267
+ AgentPenAnnotationSubMenuPenIcon = "agentPenAnnotationSubMenuPenIcon",
268
+ /**
269
+ * @group ToolbarPenAnnotationSubMenuButtons
270
+ * @description The "Rectangle" button in the Pen secondary toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`.
271
+ */
272
+ AgentPenAnnotationSubMenuRectangleButton = "agentPenAnnotationSubMenuRectangleButton",
273
+ /**
274
+ * @group ToolbarPenAnnotationSubMenuButtons
275
+ * @description The icon inside the "Rectangle" button in the Pen secondary toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`.
276
+ */
277
+ AgentPenAnnotationSubMenuRectangleIcon = "agentPenAnnotationSubMenuRectangleIcon",
278
+ /**
279
+ * @group ToolbarPenAnnotationSubMenuButtons
280
+ * @description The "Eraser" button in the Pen secondary toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`.
281
+ */
282
+ AgentPenAnnotationSubMenuEraserButton = "agentPenAnnotationSubMenuEraserButton",
283
+ /**
284
+ * @group ToolbarPenAnnotationSubMenuButtons
285
+ * @description The icon inside the "Eraser" button in the Pen secondary toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`.
286
+ */
287
+ AgentPenAnnotationSubMenuEraserIcon = "agentPenAnnotationSubMenuEraserIcon",
288
+ /**
289
+ * @group ToolbarPenAnnotationSubMenuButtons
290
+ * @description The "Color" button in the Pen secondary toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`.
291
+ */
292
+ AgentPenAnnotationSubMenuColorButton = "agentPenAnnotationSubMenuColorButton",
293
+ /**
294
+ * @group ToolbarPenAnnotationSubMenuButtons
295
+ * @description The color preview section inside the "Color" button in the Pen secondary toolbar. Supports `stylingOverrides`.
296
+ */
297
+ AgentPenAnnotationSubMenuColorIcon = "agentPenAnnotationSubMenuColorIcon",
298
+ /**
299
+ * @group ToolbarPenAnnotationSubMenuButtons
300
+ * @description The "Undo" button in the Pen secondary toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`.
301
+ */
302
+ AgentPenAnnotationSubMenuUndoButton = "agentPenAnnotationSubMenuUndoButton",
303
+ /**
304
+ * @group ToolbarPenAnnotationSubMenuButtons
305
+ * @description The icon inside the "Undo" button in the Pen secondary toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`.
306
+ */
307
+ AgentPenAnnotationSubMenuUndoIcon = "agentPenAnnotationSubMenuUndoIcon",
308
+ /**
309
+ * @group ToolbarPenAnnotationSubMenuButtons
310
+ * @description The "Redo" button in the Pen secondary toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`.
311
+ */
312
+ AgentPenAnnotationSubMenuRedoButton = "agentPenAnnotationSubMenuRedoButton",
313
+ /**
314
+ * @group ToolbarPenAnnotationSubMenuButtons
315
+ * @description The icon inside the "Redo" button in the Pen secondary toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`.
316
+ */
317
+ AgentPenAnnotationSubMenuRedoIcon = "agentPenAnnotationSubMenuRedoIcon",
318
+ /**
319
+ * @group ToolbarPenAnnotationSubMenuButtons
320
+ * @description The "Clear" button in the Pen secondary toolbar. Use `textOverride` to customize the tooltip text. Supports `stylingOverrides`, `textOverride`, and `disabledComponentOverride`.
321
+ */
322
+ AgentPenAnnotationSubMenuClearButton = "agentPenAnnotationSubMenuClearButton",
323
+ /**
324
+ * @group ToolbarPenAnnotationSubMenuButtons
325
+ * @description The icon inside the "Clear" button in the Pen secondary toolbar. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`.
326
+ */
327
+ AgentPenAnnotationSubMenuClearIcon = "agentPenAnnotationSubMenuClearIcon",
328
+ // pen submenu
329
+ /**
330
+ * @group ToolbarPenSubMenu
331
+ * @description The container for the PenWidth sub-menu in the agent's toolbar when displayed vertically, supports configuration of `stylingOverrides`.
332
+ */
333
+ AgentPenSubMenuVerticalWrapper = "agentPenSubMenuVerticalWrapper",
334
+ /**
335
+ * @group ToolbarPenSubMenu
336
+ * @description The container for the PenWidth sub-menu in the agent's toolbar when displayed horizontally, supports configuration of `stylingOverrides`.
337
+ */
338
+ AgentPenSubMenuHorizontalWrapper = "agentPenSubMenuHorizontalWrapper",
339
+ /**
340
+ * @group ToolbarPenSubMenu
341
+ * @description The common style for all buttons in the PenWidth sub-menu of the agent's toolbar, supports configuration of `stylingOverrides`.
342
+ */
343
+ AgentPenSubMenuButtonCommon = "agentPenSubMenuButtonCommon",
344
+ /**
345
+ * @group ToolbarPenSubMenu
346
+ * @description The common style for all buttons in the PenWidth sub-menu when selected (priority lower than individual button settings), supports configuration of `stylingOverrides`.
347
+ */
348
+ AgentPenSubMenuButtonActiveCommon = "agentPenSubMenuButtonActiveCommon",
349
+ /**
350
+ * @group ToolbarPenSubMenu
351
+ * @description The text for the "Draw" section in the PenWidth sub-menu of the agent's toolbar, supports configuration of `stylingOverrides`, `textOverride`.
352
+ */
353
+ AgentPenSubMenuDrawText = "agentPenSubMenuDrawText",
354
+ /**
355
+ * @group ToolbarPenSubMenu
356
+ * @description The text for the "Line Width" section in the PenWidth sub-menu of the agent's toolbar, supports configuration of `stylingOverrides`, `textOverride`.
357
+ */
358
+ AgentPenSubMenuLineWidthText = "agentPenSubMenuLineWidthText",
359
+ // color submenu
360
+ /**
361
+ * @group ToolbarColorSubMenu
362
+ * @description The container for the Color sub-menu in the agent's toolbar when displayed vertically, supports configuration of `stylingOverrides`.
363
+ */
364
+ AgentColorSubMenuVerticalWrapper = "agentColorSubMenuVerticalWrapper",
365
+ /**
366
+ * @group ToolbarColorSubMenu
367
+ * @description The container for the Color sub-menu in the agent's toolbar when displayed horizontally, supports configuration of `stylingOverrides`.
368
+ */
369
+ AgentColorSubMenuHorizontalWrapper = "agentColorSubMenuHorizontalWrapper",
370
+ /**
371
+ * @group ToolbarColorSubMenu
372
+ * @description The common style for all buttons in the Color sub-menu of the agent's toolbar, supports configuration of `stylingOverrides`.
373
+ */
374
+ AgentColorSubMenuButtonCommon = "agentColorSubMenuButtonCommon",
375
+ /**
376
+ * @group ToolbarColorSubMenu
377
+ * @description The common style for all buttons in the Color sub-menu when selected, supports configuration of `stylingOverrides`.
378
+ */
379
+ AgentColorSubMenuActiveButtonCommon = "agentColorSubMenuActiveButtonCommon",
380
+ // zoom in/out menu
381
+ /**
382
+ * @group ToolbarZoomInOutMenu
383
+ * @description The container for the "Zoom Menu" sub-menu in the agent's toolbar when displayed vertically, supports configuration of `stylingOverrides`.
384
+ */
385
+ AgentZoomInOutMenuVerticalWrapper = "agentZoomInOutMenuVerticalWrapper",
386
+ /**
387
+ * @group ToolbarZoomInOutMenu
388
+ * @description The container for the "Zoom Menu" sub-menu in the agent's toolbar when displayed horizontally, supports configuration of `stylingOverrides`.
389
+ */
390
+ AgentZoomInOutMenuHorizontalWrapper = "agentZoomInOutMenuHorizontalWrapper",
391
+ /**
392
+ * @group ToolbarZoomInOutMenu
393
+ * @description The root element for the "Zoom Menu" sub-menu in the agent's toolbar when displayed horizontally, supports configuration of `stylingOverrides`.
394
+ */
395
+ AgentZoomInOutMenuRoot = "agentZoomInOutMenuRoot",
396
+ /**
397
+ * @group ToolbarZoomInOutMenu
398
+ * @description The menu item in the "Zoom Menu" sub-menu of the agent's toolbar when displayed horizontally, supports configuration of `stylingOverrides`.
399
+ */
400
+ AgentZoomInOutMenuItem = "agentZoomInOutMenuItem",
401
+ /**
402
+ * @group ToolbarZoomInOutMenu
403
+ * @description The "FitToWindow" menu item in the "Zoom Menu" sub-menu of the agent's toolbar when displayed horizontally, supports configuration of `stylingOverrides`.
404
+ */
405
+ AgentZoomInOutMenuItemFitToWindow = "agentZoomInOutMenuItemFitToWindow",
406
+ /**
407
+ * @group ToolbarZoomInOutMenu
408
+ * @description The "ActualSize" menu item in the "Zoom Menu" sub-menu of the agent's toolbar when displayed horizontally, supports configuration of `stylingOverrides`.
409
+ */
410
+ AgentZoomInOutMenuItemActualSize = "agentZoomInOutMenuItemActualSize",
411
+ // leave session dialog (single agent)
412
+ /**
413
+ * @group SingleAgentEndSessionDialog
414
+ * @description The container for the End Session dialog when there is only one agent in the session, supports configuration of `stylingOverrides`.
415
+ */
416
+ AgentSingleAgentEndSessionDialogOverall = "agentSingleAgentEndSessionDialogOverall",
417
+ /**
418
+ * @group SingleAgentEndSessionDialog
419
+ * @description The title section container for the End Session dialog when there is only one agent in the session, supports configuration of `stylingOverrides`.
420
+ */
421
+ AgentSingleAgentEndSessionDialogTitleContainer = "agentSingleAgentEndSessionDialogTitleContainer",
422
+ /**
423
+ * @group SingleAgentEndSessionDialog
424
+ * @description The content section container for the End Session dialog when there is only one agent in the session, supports configuration of `stylingOverrides`.
425
+ */
426
+ AgentSingleAgentEndSessionDialogContentContainer = "agentSingleAgentEndSessionDialogContentContainer",
427
+ /**
428
+ * @group SingleAgentEndSessionDialog
429
+ * @description The footer section container for the End Session dialog when there is only one agent in the session, supports configuration of `stylingOverrides`.
430
+ */
431
+ AgentSingleAgentEndSessionDialogFooterContainer = "agentSingleAgentEndSessionDialogFooterContainer",
432
+ /**
433
+ * @group SingleAgentEndSessionDialog
434
+ * @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`.
435
+ */
436
+ AgentSingleAgentEndSessionDialogTitleIcon = "agentSingleAgentEndSessionDialogTitleIcon",
437
+ /**
438
+ * @group SingleAgentEndSessionDialog
439
+ * @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`.
440
+ */
441
+ AgentSingleAgentEndSessionDialogTitleContent = "agentSingleAgentEndSessionDialogTitleContent",
442
+ /**
443
+ * @group SingleAgentEndSessionDialog
444
+ * @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`.
445
+ */
446
+ AgentSingleAgentEndSessionDialogTextContent = "agentSingleAgentEndSessionDialogTextContent",
447
+ /**
448
+ * @group SingleAgentEndSessionDialog
449
+ * @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`.
450
+ */
451
+ AgentSingleAgentEndSessionDialogTopRightCloseButton = "agentSingleAgentEndSessionDialogTopRightCloseButton",
452
+ /**
453
+ * @group SingleAgentEndSessionDialog
454
+ * @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`.
455
+ */
456
+ AgentSingleAgentEndSessionDialogCancelButton = "agentSingleAgentEndSessionDialogCancelButton",
457
+ /**
458
+ * @group SingleAgentEndSessionDialog
459
+ * @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`.
460
+ */
461
+ AgentSingleAgentEndSessionDialogEndSessionButton = "agentSingleAgentEndSessionDialogEndSessionButton",
462
+ // end session dialog (multi agents)
463
+ /**
464
+ * @group MultiAgentsEndSessionDialog
465
+ * @description The container for the End Session dialog when there are multiple agents in the session, supports configuration of `stylingOverrides`.
466
+ */
467
+ AgentMultiAgentsEndSessionDialogOverall = "agentMultiAgentsEndSessionDialogOverall",
468
+ /**
469
+ * @group MultiAgentsEndSessionDialog
470
+ * @description The title section container for the End Session dialog when there are multiple agents in the session, supports configuration of `stylingOverrides`.
471
+ */
472
+ AgentMultiAgentsEndSessionDialogTitleContainer = "agentMultiAgentsEndSessionDialogTitleContainer",
473
+ /**
474
+ * @group MultiAgentsEndSessionDialog
475
+ * @description The content section container for the End Session dialog when there are multiple agents in the session, supports configuration of `stylingOverrides`.
476
+ */
477
+ AgentMultiAgentsEndSessionDialogContentContainer = "agentMultiAgentsEndSessionDialogContentContainer",
478
+ /**
479
+ * @group MultiAgentsEndSessionDialog
480
+ * @description The footer section container for the End Session dialog when there are multiple agents in the session, supports configuration of `stylingOverrides`.
481
+ */
482
+ AgentMultiAgentsEndSessionDialogFooterContainer = "agentMultiAgentsEndSessionDialogFooterContainer",
483
+ /**
484
+ * @group MultiAgentsEndSessionDialog
485
+ * @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`.
486
+ */
487
+ AgentMultiAgentsEndSessionDialogTitleIcon = "agentMultiAgentsEndSessionDialogTitleIcon",
488
+ /**
489
+ * @group MultiAgentsEndSessionDialog
490
+ * @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`.
491
+ */
492
+ AgentMultiAgentsEndSessionDialogTitleContent = "agentMultiAgentsEndSessionDialogTitleContent",
493
+ /**
494
+ * @group MultiAgentsEndSessionDialog
495
+ * @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`.
496
+ */
497
+ AgentMultiAgentsEndSessionDialogTextContent = "agentMultiAgentsEndSessionDialogTextContent",
498
+ /**
499
+ * @group MultiAgentsEndSessionDialog
500
+ * @description The top-right close button for the End Session dialog when there are multiple agents in the session, supports configuration of `stylingOverrides`, `disabledComponentOverride`.
501
+ */
502
+ AgentMultiAgentsEndSessionDialogTopRightCloseButton = "agentMultiAgentsEndSessionDialogTopRightCloseButton",
503
+ /**
504
+ * @group MultiAgentsEndSessionDialog
505
+ * @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`.
506
+ */
507
+ AgentMultiAgentsEndSessionDialogCancelButton = "agentMultiAgentsEndSessionDialogCancelButton",
508
+ /**
509
+ * @group MultiAgentsEndSessionDialog
510
+ * @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`.
511
+ */
512
+ AgentMultiAgentsEndSessionDialogLeaveSessionButton = "agentMultiAgentsEndSessionDialogLeaveSessionButton",
513
+ /**
514
+ * @group MultiAgentsEndSessionDialog
515
+ * @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`.
516
+ */
517
+ AgentMultiAgentsEndSessionDialogEndSessionButton = "agentMultiAgentsEndSessionDialogEndSessionButton",
518
+ // agent join failed dialog
519
+ /**
520
+ * @group JoinFailedDialog
521
+ * @description The container for the Join Failed dialog in the agent's toolbar, supports configuration of `stylingOverrides`.
522
+ */
523
+ AgentJoinFailedDialogOverall = "agentJoinFailedDialogOverall",
524
+ /**
525
+ * @group JoinFailedDialog
526
+ * @description The title section container for the Join Failed dialog, supports configuration of `stylingOverrides`.
527
+ */
528
+ AgentJoinFailedDialogTitleContainer = "agentJoinFailedDialogTitleContainer",
529
+ /**
530
+ * @group JoinFailedDialog
531
+ * @description The content section container for the Join Failed dialog, supports configuration of `stylingOverrides`.
532
+ */
533
+ AgentJoinFailedDialogContentContainer = "agentJoinFailedDialogContentContainer",
534
+ /**
535
+ * @group JoinFailedDialog
536
+ * @description The footer section container for the Join Failed dialog, supports configuration of `stylingOverrides`.
537
+ */
538
+ AgentJoinFailedDialogFooterContainer = "agentJoinFailedDialogFooterContainer",
539
+ /**
540
+ * @group JoinFailedDialog
541
+ * @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`.
542
+ */
543
+ AgentJoinFailedDialogTitleIcon = "agentJoinFailedDialogTitleIcon",
544
+ /**
545
+ * @group JoinFailedDialog
546
+ * @description The title text for the Join Failed dialog (e.g., "Agent number limit reached"), supports configuration of `stylingOverrides`.
547
+ */
548
+ AgentJoinFailedDialogTitleContent = "agentJoinFailedDialogTitleContent",
549
+ /**
550
+ * @group JoinFailedDialog
551
+ * @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`.
552
+ */
553
+ AgentJoinFailedDialogTextContent = "agentJoinFailedDialogTextContent",
554
+ /**
555
+ * @group JoinFailedDialog
556
+ * @description The top-right close button for the Join Failed dialog, supports configuration of `stylingOverrides`, `disabledComponentOverride`.
557
+ */
558
+ AgentJoinFailedDialogTopRightCloseButton = "agentJoinFailedDialogTopRightCloseButton",
559
+ /**
560
+ * @group JoinFailedDialog
561
+ * @description The "OK" button in the footer section of the Join Failed dialog, supports configuration of `stylingOverrides`, `textOverride`.
562
+ */
563
+ AgentJoinFailedDialogOkButton = "agentJoinFailedDialogOkButton",
564
+ /**
565
+ * @group FloatingPinToolbar
566
+ * @description The container for the floating Pin toolbar in the agent's interface, supports configuration of `stylingOverrides`, `disabledComponentOverride`.
567
+ */
568
+ AgentFloatingPinToolbarWrapper = "agentFloatingPinToolbarWrapper",
569
+ /**
570
+ * @group FloatingPinToolbar
571
+ * @description The prefix icon in the floating Pin toolbar of the agent's interface, supports configuration of `stylingOverrides`, `iconOverride`, `disabledComponentOverride`.
572
+ */
573
+ AgentFloatingPinToolbarPrefixIcon = "agentFloatingPinToolbarPrefixIcon",
574
+ /**
575
+ * @group FloatingPinToolbar
576
+ * @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`.
577
+ */
578
+ AgentFloatingPinToolbarContentText = "agentFloatingPinToolbarContentText",
579
+ /**
580
+ * @group FloatingPinToolbar
581
+ * @description The copy icon in the floating Pin toolbar of the agent's interface, supports configuration of `stylingOverrides`, `iconOverride`, `disabledComponentOverride`.
582
+ */
583
+ AgentFloatingPinToolbarCopyIcon = "agentFloatingPinToolbarCopyIcon",
584
+ /**
585
+ * @group ToastSuccess
586
+ * @description The container for the success toast in the agent's interface, supports configuration of `stylingOverrides`.
587
+ */
588
+ AgentToastSuccessPrefixIcon = "agentToastSuccessPrefixIcon",
589
+ /**
590
+ * @group ToastSuccess
591
+ * @description The prefix icon in the success toast in the agent's interface, supports configuration of `stylingOverrides`, `iconOverride`, `disabledComponentOverride`.
592
+ */
593
+ AgentToastSuccessWrapper = "agentToastSuccessWrapper",
594
+ /**
595
+ * @group ToastError
596
+ * @description The container for the error toast in the agent's interface, supports configuration of `stylingOverrides`.
597
+ */
598
+ AgentToastErrorPrefixIcon = "agentToastErrorPrefixIcon",
599
+ /**
600
+ * @group ToastError
601
+ * @description The prefix icon in the error toast in the agent's interface, supports configuration of `stylingOverrides`, `iconOverride`, `disabledComponentOverride`.
602
+ */
603
+ AgentToastErrorWrapper = "agentToastErrorWrapper",
604
+ /**
605
+ * @group ToastWarning
606
+ * @description The container for the warning toast in the agent's interface, supports configuration of `stylingOverrides`.
607
+ */
608
+ AgentToastWarningPrefixIcon = "agentToastWarningPrefixIcon",
609
+ /**
610
+ * @group ToastWarning
611
+ * @description The prefix icon in the warning toast in the agent's interface, supports configuration of `stylingOverrides`, `iconOverride`, `disabledComponentOverride`.
612
+ */
613
+ AgentToastWarningWrapper = "agentToastWarningWrapper",
614
+ /**
615
+ * @group ToastInfo
616
+ * @description The container for the info toast in the agent's interface, supports configuration of `stylingOverrides`.
617
+ */
618
+ AgentToastInfoPrefixIcon = "agentToastInfoPrefixIcon",
619
+ /**
620
+ * @group ToastInfo
621
+ * @description The prefix icon in the info toast in the agent's interface, supports configuration of `stylingOverrides`, `iconOverride`, `disabledComponentOverride`.
622
+ */
623
+ AgentToastInfoWrapper = "agentToastInfoWrapper"
624
+ }
625
+ declare enum EndReason {
626
+ /**
627
+ * @description The session was explicitly ended.
628
+ */
629
+ END_SESSION = "end_session",
630
+ /**
631
+ * @description The session was automatically deactivated.
632
+ */
633
+ DEACTIVE_SESSION = "deactive_session",
634
+ /**
635
+ * @description The session was cancelled.
636
+ */
637
+ CANCEL_SESSION = "cancel_session"
638
+ }
639
+ declare enum InitError {
640
+ UNKNOWN = "unknown",
641
+ NO_ROOT_DOM = "no_root_dom"
642
+ }
643
+ declare enum LeaveReason {
644
+ /**
645
+ * @description The user left the session.
646
+ */
647
+ LEAVE_SESSION = "leave_session",
648
+ /**
649
+ * @description The user was disconnected.
650
+ */
651
+ DISCONNECT_SESSION = "disconnect_session"
652
+ }
653
+ declare enum SessionErrorCode {
654
+ /**
655
+ * @description Join session failed due to pincode not found.
656
+ */
657
+ SESSION_JOIN_PIN_NOT_FOUND = 1006,
658
+ /**
659
+ * @description Join session failed due to invalid pincode.
660
+ */
661
+ SESSION_PIN_INVALID_FORMAT = 1008,
662
+ /**
663
+ * @description Join session failed due to empty pincode.
664
+ */
665
+ SESSION_START_PIN_REQUIRED = 1009,
666
+ /**
667
+ * @description Join session failed.
668
+ */
669
+ SESSION_JOIN_FAILED = 1011,
670
+ /**
671
+ * @description Join session failed due to count limit.
672
+ */
673
+ SESSION_AGENT_COUNT_LIMIT = 1013,
674
+ /**
675
+ * @description Join session failed due to duplicate user.
676
+ */
677
+ SESSION_DUPLICATE_USER = 1015,
678
+ /**
679
+ * @description Start or join session failed due to network error.
680
+ */
681
+ NETWORK_ERROR = 1016,
682
+ /**
683
+ * @description Join session failed due to invalid token.
684
+ */
685
+ TOKEN_INVALID = 2001,
686
+ /**
687
+ * @description Unknown error.
688
+ */
689
+ UNDEFINED = 9999
690
+ }
691
+ declare enum SessionStatus {
692
+ /**
693
+ * @description Session has previous record.
694
+ */
695
+ RECOVERABLE = "session_recoverable"
696
+ }
697
+ declare function customer_focus_lost(payload: {
698
+ /**
699
+ * customer is lost
700
+ */
701
+ isLost: boolean;
702
+ /**
703
+ * sessionId
704
+ */
705
+ sessionId: string;
706
+ /**
707
+ * User info
708
+ */
709
+ user: {
710
+ id: string;
711
+ name: string;
712
+ };
713
+ /**
714
+ * SDK version
715
+ */
716
+ version: string;
717
+ }): void;
718
+ declare function customer_transferred(payload: {
719
+ /**
720
+ * sessionId
721
+ */
722
+ sessionId: string;
723
+ /**
724
+ * User info
725
+ */
726
+ user: {
727
+ id: string;
728
+ name: string;
729
+ };
730
+ /**
731
+ * SDK version
732
+ */
733
+ version: string;
734
+ }): void;
735
+ declare function session_ended(payload: {
736
+ /**
737
+ * reason
738
+ */
739
+ reason: EndReason;
740
+ /**
741
+ * sessionId
742
+ */
743
+ sessionId: string;
744
+ /**
745
+ * SDK version
746
+ */
747
+ version: string;
748
+ }): void;
749
+ declare function session_error(payload: {
750
+ /**
751
+ * error code
752
+ */
753
+ code: SessionErrorCode;
754
+ /**
755
+ * error message
756
+ */
757
+ errorMsg: string;
758
+ /**
759
+ * SDK version
760
+ */
761
+ version: string;
762
+ }): void;
763
+ declare function session_joined(payload: {
764
+ /**
765
+ * Whether to reconnect the session.
766
+ */
767
+ isReconnect: boolean;
768
+ /**
769
+ * sessionId
770
+ */
771
+ sessionId: string;
772
+ /**
773
+ * SDK version
774
+ */
775
+ version: string;
776
+ }): void;
777
+ declare function session_left(payload: {
778
+ /**
779
+ * reason
780
+ */
781
+ reason: LeaveReason;
782
+ /**
783
+ * sessionId
784
+ */
785
+ sessionId: string;
786
+ /**
787
+ * SDK version
788
+ */
789
+ version: string;
790
+ }): void;
791
+ declare global {
792
+ interface Window {
793
+ ZoomCobrowseAgentSDK: typeof ZoomCobrowseAgentSDK$1;
794
+ }
795
+ const ZoomCobrowseAgentSDK: typeof ZoomCobrowseAgentSDK$1;
796
+ }
797
+ declare namespace Session {
798
+ /**
799
+ * @description Verify the PIN and get the agent page URL.
800
+ * @example
801
+ * ```
802
+ * session.createAgentViewerEndpoint({
803
+ * pinCode:'{PIN_CODE}',
804
+ * sdkToken:'{SDK_TOKEN}'
805
+ * }, function({ success, agentViewerUrl, error }){
806
+ * if(success){
807
+ * console.log(agentViewerUrl)
808
+ * }else {
809
+ * console.log(error)
810
+ * }
811
+ * })
812
+ * ```
813
+ */
814
+ function createAgentViewerEndpoint(option: CreateAgentViewerEndpointOptions, callback: CreateAgentViewerEndpointCallback): void;
815
+ /**
816
+ * @description Verify the PIN and get the agent page URL.
817
+ * @example
818
+ * ```
819
+ * session.join({
820
+ * pinCode:'{PIN_CODE}',
821
+ * sdkToken:'{SDK_TOKEN}'
822
+ * }, function({ success, session, error }){
823
+ * session.on('session_joined',payload => {
824
+ * console.log('session_joined', payload);
825
+ * })
826
+ * })
827
+ * ```
828
+ */
829
+ function join(option: CreateAgentViewerEndpointOptions): void;
830
+ /**
831
+ * @description Get session information.
832
+ * @example
833
+ * ```
834
+ * session.getSessionInfo();
835
+ * ```
836
+ */
837
+ function getSessionInfo(): SessionInfo | null;
838
+ /**
839
+ * @param event Session ended.
840
+ * @param listener Details in {@link session_ended}.
841
+ */
842
+ function on(event: "session_ended", listener: typeof session_ended): void;
843
+ /**
844
+ * @param event Error occurred.
845
+ * @param listener Details in {@link session_error}.
846
+ */
847
+ function on(event: "session_error", listener: typeof session_error): void;
848
+ /**
849
+ * @param event User joined session.
850
+ * @param listener Details in {@link session_joined}.
851
+ */
852
+ function on(event: "session_joined", listener: typeof session_joined): void;
853
+ /**
854
+ * @param event User left session.
855
+ * @param listener Details in {@link session_left}.
856
+ */
857
+ function on(event: "session_left", listener: typeof session_left): void;
858
+ /**
859
+ * @param event Customer focus lost.
860
+ * @param listener Details in {@link customer_focus_lost}.
861
+ */
862
+ function on(event: "customer_focus_lost", listener: typeof customer_focus_lost): void;
863
+ /**
864
+ * @param event Customer transferred.
865
+ * @param listener Details in {@link customer_transferred}.
866
+ */
867
+ function on(event: "customer_transferred", listener: typeof customer_transferred): void;
868
+ }
869
+ /**
870
+ * @description ZoomAgentCobrowseSDK createAgentViewerEndpoint Callback.
871
+ */
872
+ export type CreateAgentViewerEndpointCallback = ({ success, error, agentViewerUrl, }: {
873
+ success: boolean;
874
+ error?: CreateAgentViewerEndpointError;
875
+ agentViewerUrl?: string;
876
+ }) => void;
877
+ /**
878
+ * @description CreateAgentViewerEndpointCallback fetch error.
879
+ */
880
+ export type CreateAgentViewerEndpointError = {
881
+ msg: string;
882
+ code: number;
883
+ statusCode: number;
884
+ };
885
+ /**
886
+ * @description ZoomAgentCobrowseSDK request agent endpoint options.
887
+ */
888
+ export type CreateAgentViewerEndpointOptions = {
889
+ /**
890
+ * @description Use your Cobrowse SDK Key and Secret to generate the Cobrowse SDK JWT.
891
+ * Detail: https://developers.zoom.us/docs/cobrowse-sdk/get-started/#generate-tokens
892
+ */
893
+ sdkToken: string;
894
+ /**
895
+ * @description The pin code is generated by the session creator and notified to the session joiner.
896
+ */
897
+ pinCode: string;
898
+ };
899
+ /**
900
+ * @description
901
+ * Defines the configuration used to override the default appearance and behavior of Zoom Cobrowse UI components
902
+ * on the customer side. This object supports custom styling, icon replacement, text content changes,
903
+ * visibility control, and initial positioning.
904
+ *
905
+ * This enables you to flexibly adapt the UI to meet your branding or interaction needs
906
+ * without modifying the underlying SDK codebase. Each field is optional and can be applied selectively
907
+ * to specific UI components as exposed through the feature keys.
908
+ */
909
+ export type CustomizeOverride = {
910
+ /**
911
+ * @description Custom styling settings written in CSS-in-JS style.
912
+ * For components such as buttons that have multiple states, the following selectors are supported:
913
+ * - `&:hover`: Styles applied when the mouse hovers over the component.
914
+ * - `&:active`: Styles applied when the component is in an active (pressed) state.
915
+ * - `&:disabled`: Styles applied when the component is disabled.
916
+ * ```
917
+ * stylingOverrides: {
918
+ * backgroundColor: 'rgba(0,0,0,0)',
919
+ * border: '1px solid #fff',
920
+ * '&:hover': {
921
+ * backgroundColor: 'rgba(255,255,255,0.2)',
922
+ * },
923
+ * '&:active': {
924
+ * backgroundColor: 'rgba(255,255,255,0.5)',
925
+ * },
926
+ * }
927
+ * ```
928
+ */
929
+ stylingOverrides?: React.CSSProperties;
930
+ /**
931
+ * @description Icon resource to override the default, supporting both URL and base64 formats.
932
+ */
933
+ iconOverride?: string;
934
+ /**
935
+ * @description Custom text content to override the default label.
936
+ */
937
+ textOverride?: string;
938
+ /**
939
+ * @description Controls whether the corresponding UI component is displayed.
940
+ */
941
+ disabledComponentOverride?: boolean;
942
+ /**
943
+ * @description Initial position of the component within its container.
944
+ *
945
+ * - `top`: Distance from the top edge. Conflicts with `bottom`. If neither is set, vertical centering is applied.
946
+ * - `bottom`: Distance from the bottom edge. Conflicts with `top`. If neither is set, vertical centering is applied.
947
+ * - `left`: Distance from the left edge. Conflicts with `right`. If neither is set, horizontal centering is applied.
948
+ * - `right`: Distance from the right edge. Conflicts with `left`. If neither is set, horizontal centering is applied.
949
+ * @example
950
+ * ```
951
+ * initPositionOverride: {
952
+ * top: '20px',
953
+ * }
954
+ * ```
955
+ */
956
+ initPositionOverride?: {
957
+ top?: string;
958
+ bottom?: string;
959
+ left?: string;
960
+ right?: string;
961
+ };
962
+ };
963
+ /**
964
+ * @description ZoomAgentCobrowseSDK init Ready Callback.
965
+ */
966
+ export type SDKReadyCallback = ({ success, sdkInfo, session, error, }: {
967
+ success: boolean;
968
+ sdkInfo: SdkInfo;
969
+ session?: typeof Session;
970
+ error?: InitError;
971
+ }) => void;
972
+ /**
973
+ * @description SDK information.
974
+ */
975
+ export type SdkInfo = {
976
+ /**
977
+ * @description SDK version.
978
+ */
979
+ version: string;
980
+ };
981
+ /**
982
+ * @description Current session information.
983
+ */
984
+ export type SessionInfo = {
985
+ /**
986
+ * @description Current session ID.
987
+ */
988
+ sessionId: string;
989
+ /**
990
+ * @description Current session pincode.
991
+ */
992
+ pinCode?: string;
993
+ /**
994
+ * @description Current session status.
995
+ * @enum
996
+ */
997
+ sessionStatus?: SessionStatus;
998
+ };
999
+ /**
1000
+ * @description ZoomAgentCobrowseSDK init settings.
1001
+ * @interface Settings
1002
+ */
1003
+ export type Settings = {
1004
+ /**
1005
+ * @description Whether to use the built-in UI to display pincode, the default is true.
1006
+ */
1007
+ customizeOverrides?: {
1008
+ [key in AgentCustomizeOverridesFeatureKey]?: CustomizeOverride;
1009
+ };
1010
+ /**
1011
+ * @description In npm mode, a root dom selector or HTMLElement is required to insert an agent portal iframe into your page.
1012
+ */
1013
+ zoomAppRoot?: string | HTMLElement;
1014
+ /**
1015
+ * @description In npm mode, appKey is required for init Cobrowse.
1016
+ */
1017
+ appKey?: string;
1018
+ /**
1019
+ * @description In npm mode, zoomHostName is required for init Cobrowse.
1020
+ * @default us01-zcb.zoom.us
1021
+ */
1022
+ zoomHostName?: string;
1023
+ };
1024
+
1025
+ export {
1026
+ ZoomCobrowseAgentSDK$1 as default,
1027
+ };
1028
+
1029
+ export {};