@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.
- package/CHANGELOG.md +1 -0
- package/LICENSE.md +1 -0
- package/README.md +143 -0
- package/esm/agent.js +1 -0
- package/esm/base.js +1 -0
- package/esm/customer.js +1 -0
- package/esm/sdk-channel.js +1 -0
- package/esm/sdk-client-agent.js +1 -0
- package/esm/sdk-client.js +1 -0
- package/esm/sdk-controller.js +1 -0
- package/esm/sdk-core-css.js +1 -0
- package/esm/sdk-core.js +1 -0
- package/esm/sdk-portal-agent-css.js +1 -0
- package/esm/sdk-portal-agent.js +1 -0
- package/esm/sdk-portal-customer-css.js +1 -0
- package/esm/sdk-portal-customer.js +1 -0
- package/oss_attribution.txt +5929 -0
- package/package.json +45 -0
- package/types/agent-umd.d.ts +1029 -0
- package/types/agent.d.ts +1023 -0
- package/types/customer-umd.d.ts +1031 -0
- package/types/customer.d.ts +1025 -0
- package/umd/agent.js +1 -0
- package/umd/customer.js +1 -0
|
@@ -0,0 +1,1025 @@
|
|
|
1
|
+
import { CSSProperties } from 'react';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* @description ZoomCobrowseSDK global variable.
|
|
5
|
+
* @exports Package exposed namespace in IIFE format (Immediately Invoked Function Expression).
|
|
6
|
+
*/
|
|
7
|
+
declare const ZoomCobrowseSDK$1: {
|
|
8
|
+
/**
|
|
9
|
+
* @description Init Cobrowse SDK. Some settings will be configured in this step.
|
|
10
|
+
* @example
|
|
11
|
+
* ```
|
|
12
|
+
* ZoomCobrowseSDK.init(settings, function({success, session, error}) {
|
|
13
|
+
* if (success) {
|
|
14
|
+
* session.start({ sdkToken: 'xxx' });
|
|
15
|
+
* session.on('agent_joined', () => {});
|
|
16
|
+
* } else {
|
|
17
|
+
* console.log(error);
|
|
18
|
+
* }
|
|
19
|
+
* });
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
22
|
+
init: (option: Settings, callback: SDKReadyCallback) => void;
|
|
23
|
+
};
|
|
24
|
+
declare enum CustomerCustomizeOverridesFeatureKey {
|
|
25
|
+
/**
|
|
26
|
+
* @group FloatingToolbar
|
|
27
|
+
* @description The persistent toolbar container on the customer side. Supports `stylingOverrides` and `initPositionOverride`.
|
|
28
|
+
*/
|
|
29
|
+
CustomerFloatingToolbar = "customerFloatingToolbar",
|
|
30
|
+
/**
|
|
31
|
+
* @group FloatingToolbar
|
|
32
|
+
* @description The left icon in the persistent toolbar on the customer side (default is a green shield). Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`.
|
|
33
|
+
*/
|
|
34
|
+
CustomerFloatingToolbarIcon = "customerFloatingToolbarIcon",
|
|
35
|
+
/**
|
|
36
|
+
* @group FloatingToolbar
|
|
37
|
+
* @description The main text content of the persistent toolbar on the customer side (default: "You are in a secure Cobrowse session."). Supports `stylingOverrides` and `textOverride`.
|
|
38
|
+
*/
|
|
39
|
+
CustomerFloatingToolbarText = "customerFloatingToolbarText",
|
|
40
|
+
/**
|
|
41
|
+
* @group FloatingToolbar
|
|
42
|
+
* @description The red button on the right side of the persistent toolbar on the customer side (text: "End Session"). Supports `stylingOverrides` and `textOverride`.
|
|
43
|
+
*/
|
|
44
|
+
CustomerFloatingToolbarButton = "customerFloatingToolbarButton",
|
|
45
|
+
/**
|
|
46
|
+
* @group FloatingToolbar
|
|
47
|
+
* @description The prefix icon of the red button on the persistent toolbar on the customer side. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`.
|
|
48
|
+
*/
|
|
49
|
+
CustomerFloatingToolbarButtonPrefixIcon = "customerFloatingToolbarButtonPrefixIcon",
|
|
50
|
+
/**
|
|
51
|
+
* @group ScreenBorder
|
|
52
|
+
* @description The border around the customer container after session is connected (default: green). Supports `stylingOverrides`.
|
|
53
|
+
*/
|
|
54
|
+
CustomerScreenBorder = "customerScreenBorder",
|
|
55
|
+
// /**
|
|
56
|
+
// * @group AnnotationToolbar
|
|
57
|
+
// */
|
|
58
|
+
// CustomerAnnotationToolbarMouseButton = 'customerAnnotationToolbarMouseButton',
|
|
59
|
+
// /**
|
|
60
|
+
// * @group AnnotationToolbar
|
|
61
|
+
// */
|
|
62
|
+
// CustomerAnnotationToolbarVanishingPenButton = 'customerAnnotationToolbarVanishingPenButton',
|
|
63
|
+
// /**
|
|
64
|
+
// * @group AnnotationToolbar
|
|
65
|
+
// */
|
|
66
|
+
// CustomerAnnotationToolbarPenButton = 'customerAnnotationToolbarPenButton',
|
|
67
|
+
// /**
|
|
68
|
+
// * @group AnnotationToolbar
|
|
69
|
+
// */
|
|
70
|
+
// CustomerAnnotationToolbarVanishingRectangleButton = 'customerAnnotationToolbarVanishingRectangleButton',
|
|
71
|
+
// /**
|
|
72
|
+
// * @group AnnotationToolbar
|
|
73
|
+
// */
|
|
74
|
+
// CustomerAnnotationToolbarRectangleButton = 'customerAnnotationToolbarRectangleButton',
|
|
75
|
+
// /**
|
|
76
|
+
// * @group AnnotationToolbar
|
|
77
|
+
// */
|
|
78
|
+
// CustomerAnnotationToolbarEraserButton = 'customerAnnotationToolbarEraserButton',
|
|
79
|
+
// /**
|
|
80
|
+
// * @group AnnotationToolbar
|
|
81
|
+
// */
|
|
82
|
+
// CustomerAnnotationToolbarColorButton = 'customerAnnotationToolbarColorButton',
|
|
83
|
+
// /**
|
|
84
|
+
// * @group AnnotationToolbar
|
|
85
|
+
// */
|
|
86
|
+
// CustomerAnnotationToolbarClearButton = 'customerAnnotationToolbarClearButton',
|
|
87
|
+
// /**
|
|
88
|
+
// * @group AnnotationToolbar
|
|
89
|
+
// */
|
|
90
|
+
// CustomerAnnotationToolbarCloseButton = 'customerAnnotationToolbarCloseButton',
|
|
91
|
+
// /**
|
|
92
|
+
// * @group AnnotationToolbar
|
|
93
|
+
// */
|
|
94
|
+
// CustomerAnnotationToolbarOpenButton = 'customerAnnotationToolbarOpenButton',
|
|
95
|
+
// /**
|
|
96
|
+
// * @group JoinSessionDialog
|
|
97
|
+
// */
|
|
98
|
+
// // customer Join Session Dialog
|
|
99
|
+
// CustomerJoinSessionDialogOverall = 'customerJoinSessionDialogOverall',
|
|
100
|
+
// /**
|
|
101
|
+
// * @group JoinSessionDialog
|
|
102
|
+
// */
|
|
103
|
+
// CustomerJoinSessionDialogTitle = 'customerJoinSessionDialogTitle',
|
|
104
|
+
// /**
|
|
105
|
+
// * @group JoinSessionDialog
|
|
106
|
+
// */
|
|
107
|
+
// CustomerJoinSessionDialogTitleContent = 'customerJoinSessionDialogTitleContent',
|
|
108
|
+
// /**
|
|
109
|
+
// * @group JoinSessionDialog
|
|
110
|
+
// */
|
|
111
|
+
// CustomerJoinSessionDialogTitleIcon = 'customerJoinSessionDialogTitleIcon',
|
|
112
|
+
// /**
|
|
113
|
+
// * @group JoinSessionDialog
|
|
114
|
+
// */
|
|
115
|
+
// CustomerJoinSessionDialogTopRightCloseButton = 'customerJoinSessionDialogTopRightCloseButton',
|
|
116
|
+
// /**
|
|
117
|
+
// * @group JoinSessionDialog
|
|
118
|
+
// */
|
|
119
|
+
// CustomerJoinSessionDialogLoadingPinCodeIcon = 'customerJoinSessionDialogLoadingPinCodeIcon',
|
|
120
|
+
// /**
|
|
121
|
+
// * @group JoinSessionDialog
|
|
122
|
+
// */
|
|
123
|
+
// CustomerJoinSessionDialogPinCodeTipText = 'customerJoinSessionDialogPinCodeTipText',
|
|
124
|
+
// /**
|
|
125
|
+
// * @group JoinSessionDialog
|
|
126
|
+
// */
|
|
127
|
+
// CustomerJoinSessionDialogPinCodeContent = 'customerJoinSessionDialogPinCodeContent',
|
|
128
|
+
// /**
|
|
129
|
+
// * @group JoinSessionDialog
|
|
130
|
+
// */
|
|
131
|
+
// CustomerJoinSessionDialogFooterContainer = 'customerJoinSessionDialogFooterContainer',
|
|
132
|
+
// /**
|
|
133
|
+
// * @group JoinSessionDialog
|
|
134
|
+
// */
|
|
135
|
+
// CustomerJoinSessionDialogCancelButton = 'customerJoinSessionDialogCancelButton',
|
|
136
|
+
// customer End Session Dialog
|
|
137
|
+
/**
|
|
138
|
+
* @group EndSessionDialog
|
|
139
|
+
* @description The dialog container shown to confirm ending the session on the customer side. Supports `stylingOverrides`.
|
|
140
|
+
*/
|
|
141
|
+
CustomerEndSessionDialogOverall = "customerEndSessionDialogOverall",
|
|
142
|
+
/**
|
|
143
|
+
* @group EndSessionDialog
|
|
144
|
+
* @description The title section container of the session end confirmation dialog on the customer side. Supports `stylingOverrides`.
|
|
145
|
+
*/
|
|
146
|
+
CustomerEndSessionDialogTitleContainer = "customerEndSessionDialogTitleContainer",
|
|
147
|
+
/**
|
|
148
|
+
* @group EndSessionDialog
|
|
149
|
+
* @description The content section container of the session end confirmation dialog on the customer side. Supports `stylingOverrides`.
|
|
150
|
+
*/
|
|
151
|
+
CustomerEndSessionDialogContentContainer = "customerEndSessionDialogContentContainer",
|
|
152
|
+
/**
|
|
153
|
+
* @group EndSessionDialog
|
|
154
|
+
* @description The footer section container of the session end confirmation dialog on the customer side. Supports `stylingOverrides`.
|
|
155
|
+
*/
|
|
156
|
+
CustomerEndSessionDialogFooterContainer = "customerEndSessionDialogFooterContainer",
|
|
157
|
+
/**
|
|
158
|
+
* @group EndSessionDialog
|
|
159
|
+
* @description The title text of the session end confirmation dialog on the customer side (default: "End the session"). Supports `stylingOverrides` and `textOverride`.
|
|
160
|
+
*/
|
|
161
|
+
CustomerEndSessionDialogTitleContent = "customerEndSessionDialogTitleContent",
|
|
162
|
+
/**
|
|
163
|
+
* @group EndSessionDialog
|
|
164
|
+
* @description The icon in the title section of the session end confirmation dialog on the customer side (default: red circular background with white exclamation mark). Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`.
|
|
165
|
+
*/
|
|
166
|
+
CustomerEndSessionDialogTitleIcon = "customerEndSessionDialogTitleIcon",
|
|
167
|
+
/**
|
|
168
|
+
* @group EndSessionDialog
|
|
169
|
+
* @description The content text of the session end confirmation dialog on the customer side (default: "Are you sure you want to end the Cobrowse session?"). Supports `stylingOverrides` and `textOverride`.
|
|
170
|
+
*/
|
|
171
|
+
CustomerEndSessionDialogTextContent = "customerEndSessionDialogTextContent",
|
|
172
|
+
/**
|
|
173
|
+
* @group EndSessionDialog
|
|
174
|
+
* @description The close button in the top-right corner of the title section of the session end confirmation dialog on the customer side. Supports `stylingOverrides`.
|
|
175
|
+
*/
|
|
176
|
+
CustomerEndSessionDialogTopRightCloseButton = "customerEndSessionDialogTopRightCloseButton",
|
|
177
|
+
/**
|
|
178
|
+
* @group EndSessionDialog
|
|
179
|
+
* @description The cancel button in the footer of the session end confirmation dialog on the customer side (text: "Cancel"). Supports `stylingOverrides` and `textOverride`.
|
|
180
|
+
*/
|
|
181
|
+
CustomerEndSessionDialogCancelButton = "customerEndSessionDialogCancelButton",
|
|
182
|
+
/**
|
|
183
|
+
* @group EndSessionDialog
|
|
184
|
+
* @description The end button in the footer of the session end confirmation dialog on the customer side (text: "End"). Supports `stylingOverrides` and `textOverride`.
|
|
185
|
+
*/
|
|
186
|
+
CustomerEndSessionDialogEndSessionButton = "customerEndSessionDialogEndSessionButton",
|
|
187
|
+
/**
|
|
188
|
+
* @group ReconnectDialog
|
|
189
|
+
* @description The dialog container shown when the customer is disconnected and waiting to reconnect. Supports `stylingOverrides`.
|
|
190
|
+
*/
|
|
191
|
+
CustomerReconnectDialogOverall = "customerReconnectDialogOverall",
|
|
192
|
+
/**
|
|
193
|
+
* @group ReconnectDialog
|
|
194
|
+
* @description The content section container of the reconnecting dialog when the customer is disconnected. Supports `stylingOverrides`.
|
|
195
|
+
*/
|
|
196
|
+
CustomerReconnectDialogContentContainer = "customerReconnectDialogContentContainer",
|
|
197
|
+
/**
|
|
198
|
+
* @group ReconnectDialog
|
|
199
|
+
* @description The footer section container of the reconnecting dialog when the customer is disconnected. Supports `stylingOverrides`.
|
|
200
|
+
*/
|
|
201
|
+
CustomerReconnectDialogFooterContainer = "customerReconnectDialogFooterContainer",
|
|
202
|
+
/**
|
|
203
|
+
* @group ReconnectDialog
|
|
204
|
+
* @description The loading icon shown in the content section of the reconnecting dialog when the customer is disconnected. Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`.
|
|
205
|
+
*/
|
|
206
|
+
CustomerReconnectDialogLoadingIcon = "customerReconnectDialogLoadingIcon",
|
|
207
|
+
/**
|
|
208
|
+
* @group ReconnectDialog
|
|
209
|
+
* @description The content text of the reconnecting dialog when the customer is disconnected (default: "Reconnecting Cobrowse session. Please wait...."). Supports `stylingOverrides` and `textOverride`.
|
|
210
|
+
*/
|
|
211
|
+
CustomerReconnectDialogTextContent = "customerReconnectDialogTextContent",
|
|
212
|
+
/**
|
|
213
|
+
* @group ReconnectDialog
|
|
214
|
+
* @description The close button in the footer of the reconnecting dialog when the customer is disconnected (red background, text: "Cancel"). Supports `stylingOverrides` and `textOverride`.
|
|
215
|
+
*/
|
|
216
|
+
CustomerReconnectDialogCloseButton = "customerReconnectDialogCloseButton",
|
|
217
|
+
/**
|
|
218
|
+
* @group ReconnectDialog
|
|
219
|
+
* @description The prefix icon of the close button in the footer of the reconnecting dialog when the customer is disconnected (red background, text: "Cancel"). Supports `stylingOverrides`, `iconOverride`, and `disabledComponentOverride`.
|
|
220
|
+
*/
|
|
221
|
+
CustomerReconnectDialogCloseButtonPrefixIcon = "customerReconnectDialogCloseButtonPrefixIcon",
|
|
222
|
+
// // customer Connect Dialog
|
|
223
|
+
// /**
|
|
224
|
+
// * @group ConnectDialog
|
|
225
|
+
// */
|
|
226
|
+
// CustomerConnectDialogOverall = 'customerConnectDialogOverall',
|
|
227
|
+
// /**
|
|
228
|
+
// * @group ConnectDialog
|
|
229
|
+
// */
|
|
230
|
+
// CustomerConnectDialogContentContainer = 'customerConnectDialogContentContainer',
|
|
231
|
+
// /**
|
|
232
|
+
// * @group ConnectDialog
|
|
233
|
+
// */
|
|
234
|
+
// CustomerConnectDialogFooterContainer = 'customerConnectDialogFooterContainer',
|
|
235
|
+
// /**
|
|
236
|
+
// * @group ConnectDialog
|
|
237
|
+
// */
|
|
238
|
+
// CustomerConnectDialogLoadingIcon = 'customerConnectDialogLoadingIcon',
|
|
239
|
+
// /**
|
|
240
|
+
// * @group ConnectDialog
|
|
241
|
+
// */
|
|
242
|
+
// CustomerConnectDialogTextContent = 'customerConnectDialogTextContent',
|
|
243
|
+
// /**
|
|
244
|
+
// * @group ConnectDialog
|
|
245
|
+
// */
|
|
246
|
+
// CustomerConnectDialogCloseButton = 'customerConnectDialogCloseButton',
|
|
247
|
+
// /**
|
|
248
|
+
// * @group ConnectDialog
|
|
249
|
+
// */
|
|
250
|
+
// CustomerConnectDialogCloseButtonPrefixIcon = 'customerConnectDialogCloseButtonPrefixIcon',
|
|
251
|
+
// customer Join Failed Dialog
|
|
252
|
+
/**
|
|
253
|
+
* @group JoinFailedDialog
|
|
254
|
+
* @description Dialog container displayed when the customer fails to join the session. Supports `stylingOverrides`.
|
|
255
|
+
*/
|
|
256
|
+
CustomerJoinFailedDialogOverall = "customerJoinFailedDialogOverall",
|
|
257
|
+
/**
|
|
258
|
+
* @group JoinFailedDialog
|
|
259
|
+
* @description Title container of the join failure dialog. Supports `stylingOverrides`.
|
|
260
|
+
*/
|
|
261
|
+
CustomerJoinFailedDialogTitleContainer = "customerJoinFailedDialogTitleContainer",
|
|
262
|
+
/**
|
|
263
|
+
* @group JoinFailedDialog
|
|
264
|
+
* @description Content container of the join failure dialog. Supports `stylingOverrides`.
|
|
265
|
+
*/
|
|
266
|
+
CustomerJoinFailedDialogContentContainer = "customerJoinFailedDialogContentContainer",
|
|
267
|
+
/**
|
|
268
|
+
* @group JoinFailedDialog
|
|
269
|
+
* @description Footer container of the join failure dialog. Supports `stylingOverrides`.
|
|
270
|
+
*/
|
|
271
|
+
CustomerJoinFailedDialogFooterContainer = "customerJoinFailedDialogFooterContainer",
|
|
272
|
+
/**
|
|
273
|
+
* @group JoinFailedDialog
|
|
274
|
+
* @description Title content of the join failure dialog (default: End the session). Supports `stylingOverrides`, `textOverride`.
|
|
275
|
+
*/
|
|
276
|
+
CustomerJoinFailedDialogTitleContent = "customerJoinFailedDialogTitleContent",
|
|
277
|
+
/**
|
|
278
|
+
* @group JoinFailedDialog
|
|
279
|
+
* @description Title icon of the join failure dialog (default: red circular background with white exclamation mark). Supports `stylingOverrides`, `iconOverride`, `disabledComponentOverride`.
|
|
280
|
+
*/
|
|
281
|
+
CustomerJoinFailedDialogTitleIcon = "customerJoinFailedDialogTitleIcon",
|
|
282
|
+
/**
|
|
283
|
+
* @group JoinFailedDialog
|
|
284
|
+
* @description Error message in the content section of the join failure dialog (e.g. Unknown Service Exception.). Supports `stylingOverrides`.
|
|
285
|
+
*/
|
|
286
|
+
CustomerJoinFailedDialogTextContent = "customerJoinFailedDialogTextContent",
|
|
287
|
+
/**
|
|
288
|
+
* @group JoinFailedDialog
|
|
289
|
+
* @description Error code in the content section of the join failure dialog (e.g. Error code: 9999). Supports `stylingOverrides`.
|
|
290
|
+
*/
|
|
291
|
+
CustomerJoinFailedDialogTextSecondaryContent = "customerJoinFailedDialogTextSecondaryContent",
|
|
292
|
+
/**
|
|
293
|
+
* @group JoinFailedDialog
|
|
294
|
+
* @description OK button in the footer of the join failure dialog (label: OK). Supports `stylingOverrides`, `textOverride`.
|
|
295
|
+
*/
|
|
296
|
+
CustomerJoinFailedDialogOkButton = "customerJoinFailedDialogOkButton",
|
|
297
|
+
/**
|
|
298
|
+
* @group ReconnectFailedDialog
|
|
299
|
+
* @description Dialog container displayed when the customer fails to reconnect. Supports `stylingOverrides`.
|
|
300
|
+
*/
|
|
301
|
+
CustomerReconnectFailedDialogOverall = "customerReconnectFailedDialogOverall",
|
|
302
|
+
/**
|
|
303
|
+
* @group ReconnectFailedDialog
|
|
304
|
+
* @description Title container of the reconnect failure dialog. Supports `stylingOverrides`.
|
|
305
|
+
*/
|
|
306
|
+
CustomerReconnectFailedDialogTitleContainer = "customerReconnectFailedDialogTitleContainer",
|
|
307
|
+
/**
|
|
308
|
+
* @group ReconnectFailedDialog
|
|
309
|
+
* @description Content container of the reconnect failure dialog. Supports `stylingOverrides`.
|
|
310
|
+
*/
|
|
311
|
+
CustomerReconnectFailedDialogContentContainer = "customerReconnectFailedDialogContentContainer",
|
|
312
|
+
/**
|
|
313
|
+
* @group ReconnectFailedDialog
|
|
314
|
+
* @description Footer container of the reconnect failure dialog. Supports `stylingOverrides`.
|
|
315
|
+
*/
|
|
316
|
+
CustomerReconnectFailedDialogFooterContainer = "customerReconnectFailedDialogFooterContainer",
|
|
317
|
+
/**
|
|
318
|
+
* @group ReconnectFailedDialog
|
|
319
|
+
* @description Title content of the reconnect failure dialog (default: Failed to reconnect to the Cobrowse session). Supports `stylingOverrides`, `textOverride`.
|
|
320
|
+
*/
|
|
321
|
+
CustomerReconnectFailedDialogTitleContent = "customerReconnectFailedDialogTitleContent",
|
|
322
|
+
/**
|
|
323
|
+
* @group ReconnectFailedDialog
|
|
324
|
+
* @description Title icon of the reconnect failure dialog (default: red circular background with white exclamation mark). Supports `stylingOverrides`, `iconOverride`, `disabledComponentOverride`.
|
|
325
|
+
*/
|
|
326
|
+
CustomerReconnectFailedDialogTitleIcon = "customerReconnectFailedDialogTitleIcon",
|
|
327
|
+
/**
|
|
328
|
+
* @group ReconnectFailedDialog
|
|
329
|
+
* @description Error message in the content section of the reconnect failure dialog (e.g. The Cobrowse session has ended automatically due to failed reconnection. Please check your network connection and restart the session.). Supports `stylingOverrides`, `textOverride`.
|
|
330
|
+
*/
|
|
331
|
+
CustomerReconnectFailedDialogTextContent = "customerReconnectFailedDialogTextContent",
|
|
332
|
+
/**
|
|
333
|
+
* @group ReconnectFailedDialog
|
|
334
|
+
* @description Error code in the content section of the reconnect failure dialog (e.g. Error code: 9999). Supports `stylingOverrides`.
|
|
335
|
+
*/
|
|
336
|
+
CustomerReconnectFailedDialogTextSecondaryContent = "customerReconnectFailedDialogTextSecondaryContent",
|
|
337
|
+
/**
|
|
338
|
+
* @group ReconnectFailedDialog
|
|
339
|
+
* @description OK button in the footer of the reconnect failure dialog (label: OK). Supports `stylingOverrides`, `textOverride`.
|
|
340
|
+
*/
|
|
341
|
+
CustomerReconnectFailedDialogOkButton = "customerReconnectFailedDialogOkButton",
|
|
342
|
+
/**
|
|
343
|
+
* @group ReconnectTimeoutDialog
|
|
344
|
+
* @description Dialog container displayed when the remote agent fails to reconnect due to timeout. Supports `stylingOverrides`.
|
|
345
|
+
*/
|
|
346
|
+
CustomerReconnectTimeoutDialogOverall = "customerReconnectTimeoutDialogOverall",
|
|
347
|
+
/**
|
|
348
|
+
* @group ReconnectTimeoutDialog
|
|
349
|
+
* @description Title container of the timeout reconnect failure dialog. Supports `stylingOverrides`.
|
|
350
|
+
*/
|
|
351
|
+
CustomerReconnectTimeoutDialogTitleContainer = "customerReconnectTimeoutDialogTitleContainer",
|
|
352
|
+
/**
|
|
353
|
+
* @group ReconnectTimeoutDialog
|
|
354
|
+
* @description Content container of the timeout reconnect failure dialog. Supports `stylingOverrides`.
|
|
355
|
+
*/
|
|
356
|
+
CustomerReconnectTimeoutDialogContentContainer = "customerReconnectTimeoutDialogContentContainer",
|
|
357
|
+
/**
|
|
358
|
+
* @group ReconnectTimeoutDialog
|
|
359
|
+
* @description Footer container of the timeout reconnect failure dialog. Supports `stylingOverrides`.
|
|
360
|
+
*/
|
|
361
|
+
CustomerReconnectTimeoutDialogFooterContainer = "customerReconnectTimeoutDialogFooterContainer",
|
|
362
|
+
/**
|
|
363
|
+
* @group ReconnectTimeoutDialog
|
|
364
|
+
* @description Title content of the timeout reconnect failure dialog (default: Failed to reconnect to the Cobrowse session). Supports `stylingOverrides`, `textOverride`.
|
|
365
|
+
*/
|
|
366
|
+
CustomerReconnectTimeoutDialogTitleContent = "customerReconnectTimeoutDialogTitleContent",
|
|
367
|
+
/**
|
|
368
|
+
* @group ReconnectTimeoutDialog
|
|
369
|
+
* @description Title icon of the timeout reconnect failure dialog (default: red circular background with white exclamation mark). Supports `stylingOverrides`, `iconOverride`, `disabledComponentOverride`.
|
|
370
|
+
*/
|
|
371
|
+
CustomerReconnectTimeoutDialogTitleIcon = "customerReconnectTimeoutDialogTitleIcon",
|
|
372
|
+
/**
|
|
373
|
+
* @group ReconnectTimeoutDialog
|
|
374
|
+
* @description Error message in the content section of the timeout reconnect failure dialog (e.g. The Cobrowse session has ended automatically due to failed reconnection from {{name}}). Supports `stylingOverrides`, `textOverride`.
|
|
375
|
+
*/
|
|
376
|
+
CustomerReconnectTimeoutDialogTextContent = "customerReconnectTimeoutDialogTextContent",
|
|
377
|
+
/**
|
|
378
|
+
* @group ReconnectTimeoutDialog
|
|
379
|
+
* @description Error code in the content section of the timeout reconnect failure dialog (e.g. Error code: 40001). Supports `stylingOverrides`.
|
|
380
|
+
*/
|
|
381
|
+
CustomerReconnectTimeoutDialogTextSecondaryContent = "customerReconnectTimeoutDialogTextSecondaryContent",
|
|
382
|
+
/**
|
|
383
|
+
* @group ReconnectTimeoutDialog
|
|
384
|
+
* @description OK button in the footer of the timeout reconnect failure dialog (label: OK). Supports `stylingOverrides`, `textOverride`.
|
|
385
|
+
*/
|
|
386
|
+
CustomerReconnectTimeoutDialogOkButton = "customerReconnectTimeoutDialogOkButton",
|
|
387
|
+
/**
|
|
388
|
+
* @group ReconnectTimeoutDialog
|
|
389
|
+
* @description Top-right close button of the timeout reconnect failure dialog. Supports `stylingOverrides`.
|
|
390
|
+
*/
|
|
391
|
+
CustomerReconnectTimeoutDialogTopRightCloseButton = "customerReconnectTimeoutDialogTopRightCloseButton",
|
|
392
|
+
// customer (Agent) Disconnect Dialog
|
|
393
|
+
/**
|
|
394
|
+
* @group DisconnectDialog
|
|
395
|
+
* @description Dialog container displayed when the agent disconnects and is attempting to reconnect. Supports `stylingOverrides`.
|
|
396
|
+
*/
|
|
397
|
+
CustomerDisconnectDialogOverall = "customerDisconnectDialogOverall",
|
|
398
|
+
/**
|
|
399
|
+
* @group DisconnectDialog
|
|
400
|
+
* @description Content container of the disconnect reconnecting dialog. Supports `stylingOverrides`.
|
|
401
|
+
*/
|
|
402
|
+
CustomerDisconnectDialogContentContainer = "customerDisconnectDialogContentContainer",
|
|
403
|
+
/**
|
|
404
|
+
* @group DisconnectDialog
|
|
405
|
+
* @description Footer container of the disconnect reconnecting dialog. Supports `stylingOverrides`.
|
|
406
|
+
*/
|
|
407
|
+
CustomerDisconnectDialogFooterContainer = "customerDisconnectDialogFooterContainer",
|
|
408
|
+
/**
|
|
409
|
+
* @group DisconnectDialog
|
|
410
|
+
* @description Loading icon in the content section of the disconnect reconnecting dialog. Supports `stylingOverrides`, `iconOverride`, `disabledComponentOverride`.
|
|
411
|
+
*/
|
|
412
|
+
CustomerDisconnectDialogLoadingIcon = "customerDisconnectDialogLoadingIcon",
|
|
413
|
+
/**
|
|
414
|
+
* @group DisconnectDialog
|
|
415
|
+
* @description First line of text in the content section indicating reconnection (e.g. {{name}} is reconnecting to the Cobrowse session. Please wait...). Supports `stylingOverrides`.
|
|
416
|
+
*/
|
|
417
|
+
CustomerDisconnectDialogFirstLineTextContent = "customerDisconnectDialogFirstLineTextContent",
|
|
418
|
+
/**
|
|
419
|
+
* @group DisconnectDialog
|
|
420
|
+
* @description Second line of text in the content section (e.g. Give the pin code to your agent to join:). Supports `stylingOverrides`, `textOverride`.
|
|
421
|
+
*/
|
|
422
|
+
CustomerDisconnectDialogSecondLineTextContent = "customerDisconnectDialogSecondLineTextContent",
|
|
423
|
+
/**
|
|
424
|
+
* @group DisconnectDialog
|
|
425
|
+
* @description Pin code displayed in the content section of the disconnect reconnecting dialog. Supports `stylingOverrides`.
|
|
426
|
+
*/
|
|
427
|
+
CustomerDisconnectDialogPinCode = "customerDisconnectDialogPinCode",
|
|
428
|
+
/**
|
|
429
|
+
* @group DisconnectDialog
|
|
430
|
+
* @description Red button in the footer section of the disconnect reconnecting dialog (label: End Session). Supports `stylingOverrides`, `textOverride`.
|
|
431
|
+
*/
|
|
432
|
+
CustomerDisconnectDialogEndButton = "customerDisconnectDialogCloseButton",
|
|
433
|
+
/**
|
|
434
|
+
* @group DisconnectDialog
|
|
435
|
+
* @description Prefix icon of the red button (label: End Session) in the disconnect reconnecting dialog. Supports `stylingOverrides`, `iconOverride`, `disabledComponentOverride`.
|
|
436
|
+
*/
|
|
437
|
+
CustomerDisconnectDialogEndButtonPrefixIcon = "customerDisconnectDialogCloseButtonPrefixIcon",
|
|
438
|
+
/**
|
|
439
|
+
* @group ToastSuccess
|
|
440
|
+
* @description Container for customer-side success toast. Supports `stylingOverrides`.
|
|
441
|
+
*/
|
|
442
|
+
CustomerToastSuccessPrefixIcon = "customerToastSuccessPrefixIcon",
|
|
443
|
+
/**
|
|
444
|
+
* @group ToastSuccess
|
|
445
|
+
* @description Prefix icon for the customer-side success toast. Supports `stylingOverrides`, `iconOverride`, `disabledComponentOverride`.
|
|
446
|
+
*/
|
|
447
|
+
CustomerToastSuccessWrapper = "customerToastSuccessWrapper",
|
|
448
|
+
/**
|
|
449
|
+
* @group ToastError
|
|
450
|
+
* @description Container for customer-side error toast. Supports `stylingOverrides`.
|
|
451
|
+
*/
|
|
452
|
+
CustomerToastErrorPrefixIcon = "customerToastErrorPrefixIcon",
|
|
453
|
+
/**
|
|
454
|
+
* @group ToastError
|
|
455
|
+
* @description Prefix icon for the customer-side error toast. Supports `stylingOverrides`, `iconOverride`, `disabledComponentOverride`.
|
|
456
|
+
*/
|
|
457
|
+
CustomerToastErrorWrapper = "customerToastErrorWrapper",
|
|
458
|
+
/**
|
|
459
|
+
* @group ToastWarning
|
|
460
|
+
* @description Container for customer-side warning toast. Supports `stylingOverrides`.
|
|
461
|
+
*/
|
|
462
|
+
CustomerToastWarningPrefixIcon = "customerToastWarningPrefixIcon",
|
|
463
|
+
/**
|
|
464
|
+
* @group ToastWarning
|
|
465
|
+
* @description Prefix icon for the customer-side warning toast. Supports `stylingOverrides`, `iconOverride`, `disabledComponentOverride`.
|
|
466
|
+
*/
|
|
467
|
+
CustomerToastWarningWrapper = "customerToastWarningWrapper",
|
|
468
|
+
/**
|
|
469
|
+
* @group ToastInfo
|
|
470
|
+
* @description Container for customer-side info toast. Supports `stylingOverrides`.
|
|
471
|
+
*/
|
|
472
|
+
CustomerToastInfoPrefixIcon = "customerToastInfoPrefixIcon",
|
|
473
|
+
/**
|
|
474
|
+
* @group ToastInfo
|
|
475
|
+
* @description Prefix icon for the customer-side info toast. Supports `stylingOverrides`, `iconOverride`, `disabledComponentOverride`.
|
|
476
|
+
*/
|
|
477
|
+
CustomerToastInfoWrapper = "customerToastInfoWrapper"
|
|
478
|
+
}
|
|
479
|
+
declare enum EndReason {
|
|
480
|
+
/**
|
|
481
|
+
* @description The session was explicitly ended.
|
|
482
|
+
*/
|
|
483
|
+
END_SESSION = "end_session",
|
|
484
|
+
/**
|
|
485
|
+
* @description The session was automatically deactivated.
|
|
486
|
+
*/
|
|
487
|
+
DEACTIVE_SESSION = "deactive_session",
|
|
488
|
+
/**
|
|
489
|
+
* @description The session was cancelled.
|
|
490
|
+
*/
|
|
491
|
+
CANCEL_SESSION = "cancel_session"
|
|
492
|
+
}
|
|
493
|
+
declare enum InitError {
|
|
494
|
+
UNKNOWN = "unknown"
|
|
495
|
+
}
|
|
496
|
+
declare enum SessionErrorCode {
|
|
497
|
+
/**
|
|
498
|
+
* @description Start session failed.
|
|
499
|
+
*/
|
|
500
|
+
SESSION_START_FAILED = 1001,
|
|
501
|
+
/**
|
|
502
|
+
* @description There is already a session in progress.
|
|
503
|
+
*/
|
|
504
|
+
SESSION_CONNECTING_IN_PROGRESS = 1002,
|
|
505
|
+
/**
|
|
506
|
+
* @description Join session failed due to count limit.
|
|
507
|
+
*/
|
|
508
|
+
SESSION_COUNT_LIMIT = 1004,
|
|
509
|
+
/**
|
|
510
|
+
* @description Join session failed due to an invalid pincode.
|
|
511
|
+
*/
|
|
512
|
+
SESSION_PIN_INVALID_FORMAT = 1008,
|
|
513
|
+
/**
|
|
514
|
+
* @description Start session failed due to pincode already in use.
|
|
515
|
+
*/
|
|
516
|
+
SESSION_START_PIN_CONFLICT = 1010,
|
|
517
|
+
/**
|
|
518
|
+
* @description Join session failed.
|
|
519
|
+
*/
|
|
520
|
+
SESSION_JOIN_FAILED = 1011,
|
|
521
|
+
/**
|
|
522
|
+
* @description Join session failed due to count limit.
|
|
523
|
+
*/
|
|
524
|
+
SESSION_CUSTOMER_COUNT_LIMIT = 1012,
|
|
525
|
+
/**
|
|
526
|
+
* @description Start or join session failed due to network error.
|
|
527
|
+
*/
|
|
528
|
+
NETWORK_ERROR = 1016,
|
|
529
|
+
/**
|
|
530
|
+
* @description There is already a session in progress.
|
|
531
|
+
*/
|
|
532
|
+
SESSION_CANCELING_IN_PROGRESS = 1017,
|
|
533
|
+
/**
|
|
534
|
+
* @description Failed to transfer to new tab.
|
|
535
|
+
*/
|
|
536
|
+
FAILED_TO_TRANSFER_TO_NEW_TAB = 1018,
|
|
537
|
+
/**
|
|
538
|
+
* @description Join session failed due to invalid token.
|
|
539
|
+
*/
|
|
540
|
+
TOKEN_INVALID = 2001,
|
|
541
|
+
/**
|
|
542
|
+
* @description Unknown error.
|
|
543
|
+
*/
|
|
544
|
+
UNDEFINED = 9999
|
|
545
|
+
}
|
|
546
|
+
declare enum SessionStatus {
|
|
547
|
+
/**
|
|
548
|
+
* @description Session has not been created.
|
|
549
|
+
*/
|
|
550
|
+
NOT_CREATED = "session_not_created",
|
|
551
|
+
/**
|
|
552
|
+
* @description Session has previous record.
|
|
553
|
+
*/
|
|
554
|
+
RECOVERABLE = "session_recoverable",
|
|
555
|
+
/**
|
|
556
|
+
* @description Session has been started.
|
|
557
|
+
*/
|
|
558
|
+
STARTED = "session_started",
|
|
559
|
+
/**
|
|
560
|
+
* @description Connection failed.
|
|
561
|
+
*/
|
|
562
|
+
CONNECT_FAILED = "connect_failed",
|
|
563
|
+
/**
|
|
564
|
+
* @description Session connecting.
|
|
565
|
+
*/
|
|
566
|
+
CONNECTING = "session_connecting",
|
|
567
|
+
/**
|
|
568
|
+
* @description Session canceling.
|
|
569
|
+
*/
|
|
570
|
+
CANCELING = "session_canceling",
|
|
571
|
+
/**
|
|
572
|
+
* @description Session reconnecting.
|
|
573
|
+
*/
|
|
574
|
+
RECONNECTING = "session_reconnecting"
|
|
575
|
+
}
|
|
576
|
+
declare function agent_disconnected(payload: {
|
|
577
|
+
/**
|
|
578
|
+
* Session ID.
|
|
579
|
+
*/
|
|
580
|
+
sessionId: string;
|
|
581
|
+
/**
|
|
582
|
+
* User info.
|
|
583
|
+
*/
|
|
584
|
+
user: {
|
|
585
|
+
id: string;
|
|
586
|
+
name: string;
|
|
587
|
+
};
|
|
588
|
+
/**
|
|
589
|
+
* SDK version.
|
|
590
|
+
*/
|
|
591
|
+
version: string;
|
|
592
|
+
}): void;
|
|
593
|
+
declare function agent_joined(payload: {
|
|
594
|
+
/**
|
|
595
|
+
* Session ID.
|
|
596
|
+
*/
|
|
597
|
+
sessionId: string;
|
|
598
|
+
/**
|
|
599
|
+
* User info.
|
|
600
|
+
*/
|
|
601
|
+
user: {
|
|
602
|
+
id: string;
|
|
603
|
+
name: string;
|
|
604
|
+
};
|
|
605
|
+
/**
|
|
606
|
+
* SDK version.
|
|
607
|
+
*/
|
|
608
|
+
version: string;
|
|
609
|
+
}): void;
|
|
610
|
+
declare function agent_left(payload: {
|
|
611
|
+
/**
|
|
612
|
+
* Session ID.
|
|
613
|
+
*/
|
|
614
|
+
sessionId: string;
|
|
615
|
+
/**
|
|
616
|
+
* User info.
|
|
617
|
+
*/
|
|
618
|
+
user: {
|
|
619
|
+
id: string;
|
|
620
|
+
name: string;
|
|
621
|
+
};
|
|
622
|
+
/**
|
|
623
|
+
* SDK version.
|
|
624
|
+
*/
|
|
625
|
+
version: string;
|
|
626
|
+
}): void;
|
|
627
|
+
declare function current_user_transfer(payload: {
|
|
628
|
+
/**
|
|
629
|
+
* Session ID.
|
|
630
|
+
*/
|
|
631
|
+
sessionId: string;
|
|
632
|
+
/**
|
|
633
|
+
* User info.
|
|
634
|
+
*/
|
|
635
|
+
user: {
|
|
636
|
+
id: string;
|
|
637
|
+
name: string;
|
|
638
|
+
};
|
|
639
|
+
/**
|
|
640
|
+
* SDK version.
|
|
641
|
+
*/
|
|
642
|
+
version: string;
|
|
643
|
+
/**
|
|
644
|
+
* Transfer state.
|
|
645
|
+
*/
|
|
646
|
+
state: TransferState;
|
|
647
|
+
}): void;
|
|
648
|
+
declare function pincode_updated(payload: {
|
|
649
|
+
/**
|
|
650
|
+
* Pin code.
|
|
651
|
+
*/
|
|
652
|
+
pinCode: string;
|
|
653
|
+
/**
|
|
654
|
+
* Session ID.
|
|
655
|
+
*/
|
|
656
|
+
sessionId: string;
|
|
657
|
+
/**
|
|
658
|
+
* SDK version.
|
|
659
|
+
*/
|
|
660
|
+
version: string;
|
|
661
|
+
}): void;
|
|
662
|
+
declare function session_ended(payload: {
|
|
663
|
+
/**
|
|
664
|
+
* Reason.
|
|
665
|
+
*/
|
|
666
|
+
reason: EndReason;
|
|
667
|
+
/**
|
|
668
|
+
* Session ID.
|
|
669
|
+
*/
|
|
670
|
+
sessionId: string;
|
|
671
|
+
/**
|
|
672
|
+
* SDK version.
|
|
673
|
+
*/
|
|
674
|
+
version: string;
|
|
675
|
+
}): void;
|
|
676
|
+
declare function session_error(payload: {
|
|
677
|
+
/**
|
|
678
|
+
* Error code.
|
|
679
|
+
*/
|
|
680
|
+
code: SessionErrorCode;
|
|
681
|
+
/**
|
|
682
|
+
* Error message.
|
|
683
|
+
*/
|
|
684
|
+
errorMsg: string;
|
|
685
|
+
/**
|
|
686
|
+
* SDK version.
|
|
687
|
+
*/
|
|
688
|
+
version: string;
|
|
689
|
+
}): void;
|
|
690
|
+
declare function session_reconnecting(payload: {
|
|
691
|
+
/**
|
|
692
|
+
* Session ID.
|
|
693
|
+
*/
|
|
694
|
+
sessionId: string;
|
|
695
|
+
/**
|
|
696
|
+
* SDK version.
|
|
697
|
+
*/
|
|
698
|
+
version: string;
|
|
699
|
+
}): void;
|
|
700
|
+
declare function session_started(payload: {
|
|
701
|
+
/**
|
|
702
|
+
* Whether to reconnect the session.
|
|
703
|
+
*/
|
|
704
|
+
isReconnect: boolean;
|
|
705
|
+
/**
|
|
706
|
+
* Session ID.
|
|
707
|
+
*/
|
|
708
|
+
sessionId: string;
|
|
709
|
+
/**
|
|
710
|
+
* SDK version.
|
|
711
|
+
*/
|
|
712
|
+
version: string;
|
|
713
|
+
}): void;
|
|
714
|
+
declare namespace Session {
|
|
715
|
+
/**
|
|
716
|
+
* @description Start a Cobrowse session.
|
|
717
|
+
* @example
|
|
718
|
+
* ```
|
|
719
|
+
* session.start({ sdkToken });
|
|
720
|
+
* ```
|
|
721
|
+
*/
|
|
722
|
+
function start(options: StartSessionOptions): void;
|
|
723
|
+
/**
|
|
724
|
+
* @description Use for autojoin session.
|
|
725
|
+
* @example
|
|
726
|
+
* ```
|
|
727
|
+
* session.join();
|
|
728
|
+
* ```
|
|
729
|
+
*/
|
|
730
|
+
function join(): void;
|
|
731
|
+
/**
|
|
732
|
+
* @description End the Cobrowse session.
|
|
733
|
+
*/
|
|
734
|
+
function end(): void;
|
|
735
|
+
/**
|
|
736
|
+
* @description Get session information.
|
|
737
|
+
* @example
|
|
738
|
+
* ```
|
|
739
|
+
* session.getSessionInfo();
|
|
740
|
+
* ```
|
|
741
|
+
*/
|
|
742
|
+
function getSessionInfo(): SessionInfo | null;
|
|
743
|
+
/**
|
|
744
|
+
* @param event Session started
|
|
745
|
+
* @param listener Details in {@link session_started}.
|
|
746
|
+
*/
|
|
747
|
+
function on(event: "session_started", listener: typeof session_started): void;
|
|
748
|
+
/**
|
|
749
|
+
* @param event Session ended
|
|
750
|
+
* @param listener Details in {@link session_ended}.
|
|
751
|
+
*/
|
|
752
|
+
function on(event: "session_ended", listener: typeof session_ended): void;
|
|
753
|
+
/**
|
|
754
|
+
* @param event Session is reconnecting
|
|
755
|
+
* @param listener Details in {@link session_reconnecting}.
|
|
756
|
+
*/
|
|
757
|
+
function on(event: "session_reconnecting", listener: typeof session_reconnecting): void;
|
|
758
|
+
/**
|
|
759
|
+
* @param event Agent joined
|
|
760
|
+
* @param listener Details in {@link agent_joined}.
|
|
761
|
+
*/
|
|
762
|
+
function on(event: "agent_joined", listener: typeof agent_joined): void;
|
|
763
|
+
/**
|
|
764
|
+
* @param event Agent left
|
|
765
|
+
* @param listener Details in {@link agent_left}.
|
|
766
|
+
*/
|
|
767
|
+
function on(event: "agent_left", listener: typeof agent_left): void;
|
|
768
|
+
/**
|
|
769
|
+
* @param event Agent disconnected
|
|
770
|
+
* @param listener Details in {@link agent_disconnected}.
|
|
771
|
+
*/
|
|
772
|
+
function on(event: "agent_disconnected", listener: typeof agent_disconnected): void;
|
|
773
|
+
/**
|
|
774
|
+
* @param event Pincode updated
|
|
775
|
+
* @param listener Details in {@link pincode_updated}.
|
|
776
|
+
*/
|
|
777
|
+
function on(event: "pincode_updated", listener: typeof pincode_updated): void;
|
|
778
|
+
/**
|
|
779
|
+
* @param event Error occurred.
|
|
780
|
+
* @param listener Details in {@link session_error}.
|
|
781
|
+
*/
|
|
782
|
+
function on(event: "session_error", listener: typeof session_error): void;
|
|
783
|
+
/**
|
|
784
|
+
* @param event Customer focus is transferring.
|
|
785
|
+
* @param listener Details in {@link current_user_transfer}.
|
|
786
|
+
*/
|
|
787
|
+
function on(event: "current_user_transfer", listener: typeof current_user_transfer): void;
|
|
788
|
+
}
|
|
789
|
+
/**
|
|
790
|
+
* @description
|
|
791
|
+
* Defines the configuration used to override the default appearance and behavior of Zoom Cobrowse UI components
|
|
792
|
+
* on the customer side. This object supports custom styling, icon replacement, text content changes,
|
|
793
|
+
* visibility control, and initial positioning.
|
|
794
|
+
*
|
|
795
|
+
* This enables you to flexibly adapt the UI to meet your branding or interaction needs
|
|
796
|
+
* without modifying the underlying SDK codebase. Each field is optional and can be applied selectively
|
|
797
|
+
* to specific UI components as exposed through the feature keys.
|
|
798
|
+
*/
|
|
799
|
+
export type CustomizeOverride = {
|
|
800
|
+
/**
|
|
801
|
+
* @description Custom styling settings written in CSS-in-JS style.
|
|
802
|
+
* For components such as buttons that have multiple states, the following selectors are supported:
|
|
803
|
+
* - `&:hover`: Styles applied when the mouse hovers over the component.
|
|
804
|
+
* - `&:active`: Styles applied when the component is in an active (pressed) state.
|
|
805
|
+
* - `&:disabled`: Styles applied when the component is disabled.
|
|
806
|
+
* ```
|
|
807
|
+
* stylingOverrides: {
|
|
808
|
+
* backgroundColor: 'rgba(0,0,0,0)',
|
|
809
|
+
* border: '1px solid #fff',
|
|
810
|
+
* '&:hover': {
|
|
811
|
+
* backgroundColor: 'rgba(255,255,255,0.2)',
|
|
812
|
+
* },
|
|
813
|
+
* '&:active': {
|
|
814
|
+
* backgroundColor: 'rgba(255,255,255,0.5)',
|
|
815
|
+
* },
|
|
816
|
+
* }
|
|
817
|
+
* ```
|
|
818
|
+
*/
|
|
819
|
+
stylingOverrides?: CSSProperties;
|
|
820
|
+
/**
|
|
821
|
+
* @description Icon resource to override the default, supporting both URL and base64 formats.
|
|
822
|
+
*/
|
|
823
|
+
iconOverride?: string;
|
|
824
|
+
/**
|
|
825
|
+
* @description Custom text content to override the default label.
|
|
826
|
+
*/
|
|
827
|
+
textOverride?: string;
|
|
828
|
+
/**
|
|
829
|
+
* @description Controls whether the corresponding UI component is displayed.
|
|
830
|
+
*/
|
|
831
|
+
disabledComponentOverride?: boolean;
|
|
832
|
+
/**
|
|
833
|
+
* @description Initial position of the component within its container.
|
|
834
|
+
*
|
|
835
|
+
* - `top`: Distance from the top edge. Conflicts with `bottom`. If neither is set, vertical centering is applied.
|
|
836
|
+
* - `bottom`: Distance from the bottom edge. Conflicts with `top`. If neither is set, vertical centering is applied.
|
|
837
|
+
* - `left`: Distance from the left edge. Conflicts with `right`. If neither is set, horizontal centering is applied.
|
|
838
|
+
* - `right`: Distance from the right edge. Conflicts with `left`. If neither is set, horizontal centering is applied.
|
|
839
|
+
* @example
|
|
840
|
+
* ```
|
|
841
|
+
* initPositionOverride: {
|
|
842
|
+
* top: '20px',
|
|
843
|
+
* }
|
|
844
|
+
* ```
|
|
845
|
+
*/
|
|
846
|
+
initPositionOverride?: {
|
|
847
|
+
top?: string;
|
|
848
|
+
bottom?: string;
|
|
849
|
+
left?: string;
|
|
850
|
+
right?: string;
|
|
851
|
+
};
|
|
852
|
+
};
|
|
853
|
+
/**
|
|
854
|
+
* @description ZoomCobrowseSDK init Ready Callback.
|
|
855
|
+
*/
|
|
856
|
+
export type SDKReadyCallback = ({ success, sdkInfo, session, error, }: {
|
|
857
|
+
success: boolean;
|
|
858
|
+
sdkInfo: SdkInfo;
|
|
859
|
+
session?: typeof Session;
|
|
860
|
+
error?: InitError;
|
|
861
|
+
}) => void;
|
|
862
|
+
/**
|
|
863
|
+
* @description SDK information.
|
|
864
|
+
*/
|
|
865
|
+
export type SdkInfo = {
|
|
866
|
+
/**
|
|
867
|
+
* @description SDK version.
|
|
868
|
+
*/
|
|
869
|
+
version: string;
|
|
870
|
+
};
|
|
871
|
+
/**
|
|
872
|
+
* @description Current session information.
|
|
873
|
+
*/
|
|
874
|
+
export type SessionInfo = {
|
|
875
|
+
/**
|
|
876
|
+
* @description Current session ID.
|
|
877
|
+
*/
|
|
878
|
+
sessionId: string;
|
|
879
|
+
/**
|
|
880
|
+
* @description Current session pincode.
|
|
881
|
+
*/
|
|
882
|
+
pinCode?: string;
|
|
883
|
+
/**
|
|
884
|
+
* @description Current session status.
|
|
885
|
+
* @enum
|
|
886
|
+
*/
|
|
887
|
+
sessionStatus: SessionStatus;
|
|
888
|
+
};
|
|
889
|
+
/**
|
|
890
|
+
* @description ZoomCobrowseSDK init settings.
|
|
891
|
+
* @interface Settings
|
|
892
|
+
*/
|
|
893
|
+
export type Settings = {
|
|
894
|
+
/**
|
|
895
|
+
* @description Whether to enable annotation on the customer side, the default is false.
|
|
896
|
+
*/
|
|
897
|
+
allowCustomerAnnotation?: boolean;
|
|
898
|
+
/**
|
|
899
|
+
* @description Whether to enable agent on the customer side, the default is true.
|
|
900
|
+
*/
|
|
901
|
+
allowAgentAnnotation?: boolean;
|
|
902
|
+
/**
|
|
903
|
+
* @description PII mask config.
|
|
904
|
+
*/
|
|
905
|
+
piiMask?: {
|
|
906
|
+
//enable?: boolean;
|
|
907
|
+
/**
|
|
908
|
+
* @description PII mask config.
|
|
909
|
+
* 'custom_input': Customize the input to be masked based on 'mask_css_selectors' and 'mask_html_attribute'
|
|
910
|
+
* 'all_input': Mask all inputs, ignore 'mask_css_selectors' and 'mask_html_attribute'
|
|
911
|
+
* the default is 'custom_input'
|
|
912
|
+
*/
|
|
913
|
+
maskType?: "custom_input" | "all_input";
|
|
914
|
+
/**
|
|
915
|
+
* @description Mask part of the input by customizing the CSS selector, which only takes effect when the maskType is 'custom_input', the default is empty string.
|
|
916
|
+
*/
|
|
917
|
+
maskCssSelectors?: string;
|
|
918
|
+
/**
|
|
919
|
+
* @description Mask part of the input by customizing the HTML attributes, which only takes effect when the maskType is 'custom_input', the default is empty string.
|
|
920
|
+
*/
|
|
921
|
+
maskHTMLAttributes?: string;
|
|
922
|
+
};
|
|
923
|
+
/*recording?: {
|
|
924
|
+
enable?: boolean;
|
|
925
|
+
};*/
|
|
926
|
+
/**
|
|
927
|
+
* @description ignored elements and not record by CSS selector.
|
|
928
|
+
*/
|
|
929
|
+
ignoredElements?: string[];
|
|
930
|
+
/**
|
|
931
|
+
* @description Whether to use the built-in UI to display pincode, the default is true.
|
|
932
|
+
*/
|
|
933
|
+
usePinCodeUI?: boolean;
|
|
934
|
+
/**
|
|
935
|
+
* @description Configuration used to customize and override the Zoom Cobrowse UI.
|
|
936
|
+
*/
|
|
937
|
+
customizeOverrides?: {
|
|
938
|
+
[key in CustomerCustomizeOverridesFeatureKey]?: CustomizeOverride;
|
|
939
|
+
};
|
|
940
|
+
/**
|
|
941
|
+
* @description Remote assist config.
|
|
942
|
+
*/
|
|
943
|
+
remoteAssist?: {
|
|
944
|
+
/**
|
|
945
|
+
* @description Whether to enable remote assist, the default is false.
|
|
946
|
+
*/
|
|
947
|
+
enable?: boolean;
|
|
948
|
+
/**
|
|
949
|
+
* @description Whether to enable customer consent, the default is true.
|
|
950
|
+
*/
|
|
951
|
+
enableCustomerConsent?: boolean;
|
|
952
|
+
/**
|
|
953
|
+
* @description Remote assist type, currently only support 'scroll_page', the default is 'scroll_page'.
|
|
954
|
+
*/
|
|
955
|
+
remoteAssistTypes?: "scroll_page"[];
|
|
956
|
+
};
|
|
957
|
+
/**
|
|
958
|
+
* @description Session continuation config.
|
|
959
|
+
*/
|
|
960
|
+
allowSessionContinuation?: {
|
|
961
|
+
/**
|
|
962
|
+
* @description Whether to enable session continuation, the default is false.
|
|
963
|
+
*/
|
|
964
|
+
enable: boolean;
|
|
965
|
+
/**
|
|
966
|
+
* @description The cookie key for session continuation, the default is '$$_ZCB_SESSION_$$'(base64 encoded).
|
|
967
|
+
*/
|
|
968
|
+
stateCookieKey?: string;
|
|
969
|
+
};
|
|
970
|
+
/**
|
|
971
|
+
* @description In npm mode, appKey is required for init Cobrowse.
|
|
972
|
+
*/
|
|
973
|
+
appKey?: string;
|
|
974
|
+
/**
|
|
975
|
+
* @description In npm mode, zoomHostName is required for init Cobrowse. The default is 'us01-zcb.zoom.us'.
|
|
976
|
+
*/
|
|
977
|
+
zoomHostName?: string;
|
|
978
|
+
};
|
|
979
|
+
/**
|
|
980
|
+
* @description ZoomCobrowseSDK join session options.
|
|
981
|
+
*/
|
|
982
|
+
//export type JoinSessionOptions = {
|
|
983
|
+
/**
|
|
984
|
+
* @description Use your Cobrowse SDK Key and Secret to generate the Cobrowse SDK JWT.
|
|
985
|
+
* See for details: https://developers.zoom.us/docs/cobrowse-sdk/get-started/
|
|
986
|
+
*/
|
|
987
|
+
// sdkToken: string;
|
|
988
|
+
/**
|
|
989
|
+
* @description The pin code is generated by the session creator and notified to the session joiner.
|
|
990
|
+
*/
|
|
991
|
+
// pinCode: string;
|
|
992
|
+
//};
|
|
993
|
+
/**
|
|
994
|
+
* @description ZoomCobrowseSDK start session options.
|
|
995
|
+
*/
|
|
996
|
+
export type StartSessionOptions = {
|
|
997
|
+
/**
|
|
998
|
+
* @description Use your Cobrowse SDK Key and Secret to generate the Cobrowse SDK JWT.
|
|
999
|
+
* Detail: https://developers.zoom.us/docs/cobrowse-sdk/get-started/#generate-tokens
|
|
1000
|
+
*/
|
|
1001
|
+
sdkToken: string;
|
|
1002
|
+
/**
|
|
1003
|
+
* @description (BYOP mode)Use a custom PIN. This property takes effect after the JWT token configuration turns on BYOP mode.
|
|
1004
|
+
* Only numbers and letters, or a combination of both. Letters can be in any case, but will be converted to uppercase.
|
|
1005
|
+
* The number of digits is limited to no more than 10 characters.
|
|
1006
|
+
*/
|
|
1007
|
+
customPinCode?: string;
|
|
1008
|
+
};
|
|
1009
|
+
/**
|
|
1010
|
+
* @description Transfer state for user focus/control transfer operations.
|
|
1011
|
+
* Represents the current state of transferring user focus or control between different contexts.
|
|
1012
|
+
*
|
|
1013
|
+
* - 'transferring_in': User is transferring to the current page
|
|
1014
|
+
* - 'transfer_in_success': User transferred into the current page successfully
|
|
1015
|
+
* - 'transfer_in_failed': User transferred into the current page failed
|
|
1016
|
+
* - 'transfer_in_cancelled': User transferred into the current page cancelled
|
|
1017
|
+
* - 'transfer_out_success': User has been successfully transferred out of the current page
|
|
1018
|
+
*/
|
|
1019
|
+
export type TransferState = "transferring_in" | "transfer_in_success" | "transfer_in_failed" | "transfer_in_cancelled" | "transfer_out_success";
|
|
1020
|
+
|
|
1021
|
+
export {
|
|
1022
|
+
ZoomCobrowseSDK$1 as ZoomCobrowseSDK,
|
|
1023
|
+
};
|
|
1024
|
+
|
|
1025
|
+
export {};
|