@resconet/qp-bridge 1.2.1-alpha.44 → 1.3.1
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/README.md +297 -243
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -80,25 +80,26 @@ await setAnswer("numericQuestion", 42);
|
|
|
80
80
|
|
|
81
81
|
Creates a MediaItem from the provided parameters and content.
|
|
82
82
|
|
|
83
|
-
| Function
|
|
84
|
-
|
|
|
83
|
+
| Function | Type |
|
|
84
|
+
| ---------- | ---------- |
|
|
85
85
|
| `createMediaItem` | `{ (name: string, mimeType: string, content: File): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: Blob): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: string): { ...; }; (name: string, mimeType:...` |
|
|
86
86
|
|
|
87
87
|
Parameters:
|
|
88
88
|
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
89
|
+
* `name`: - Name of the media item.
|
|
90
|
+
* `mimeType`: - MIME type of the media item.
|
|
91
|
+
* `content`: - Content as File, Blob, base64 string, or ArrayBuffer.
|
|
92
|
+
* `id`: - Optional id for the media item. If not provided, a UUID will be generated.
|
|
93
|
+
* `name`: - Name of the media item.
|
|
94
|
+
* `mimeType`: - MIME type of the media item.
|
|
95
|
+
* `content`: - Content as Blob.
|
|
96
|
+
* `name`: - Name of the media item.
|
|
97
|
+
* `mimeType`: - MIME type of the media item.
|
|
98
|
+
* `content`: - Content as base64 string or binary string.
|
|
99
|
+
* `name`: - Name of the media item.
|
|
100
|
+
* `mimeType`: - MIME type of the media item.
|
|
101
|
+
* `content`: - Content as ArrayBuffer.
|
|
102
|
+
|
|
102
103
|
|
|
103
104
|
Returns:
|
|
104
105
|
|
|
@@ -108,25 +109,26 @@ MediaItem object with blobUrl generated from the content.
|
|
|
108
109
|
|
|
109
110
|
Creates a MediaItem from the provided parameters and content.
|
|
110
111
|
|
|
111
|
-
| Function
|
|
112
|
-
|
|
|
112
|
+
| Function | Type |
|
|
113
|
+
| ---------- | ---------- |
|
|
113
114
|
| `createMediaItem` | `{ (name: string, mimeType: string, content: File): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: Blob): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: string): { ...; }; (name: string, mimeType:...` |
|
|
114
115
|
|
|
115
116
|
Parameters:
|
|
116
117
|
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
118
|
+
* `name`: - Name of the media item.
|
|
119
|
+
* `mimeType`: - MIME type of the media item.
|
|
120
|
+
* `content`: - Content as File, Blob, base64 string, or ArrayBuffer.
|
|
121
|
+
* `id`: - Optional id for the media item. If not provided, a UUID will be generated.
|
|
122
|
+
* `name`: - Name of the media item.
|
|
123
|
+
* `mimeType`: - MIME type of the media item.
|
|
124
|
+
* `content`: - Content as Blob.
|
|
125
|
+
* `name`: - Name of the media item.
|
|
126
|
+
* `mimeType`: - MIME type of the media item.
|
|
127
|
+
* `content`: - Content as base64 string or binary string.
|
|
128
|
+
* `name`: - Name of the media item.
|
|
129
|
+
* `mimeType`: - MIME type of the media item.
|
|
130
|
+
* `content`: - Content as ArrayBuffer.
|
|
131
|
+
|
|
130
132
|
|
|
131
133
|
Returns:
|
|
132
134
|
|
|
@@ -136,25 +138,26 @@ MediaItem object with blobUrl generated from the content.
|
|
|
136
138
|
|
|
137
139
|
Creates a MediaItem from the provided parameters and content.
|
|
138
140
|
|
|
139
|
-
| Function
|
|
140
|
-
|
|
|
141
|
+
| Function | Type |
|
|
142
|
+
| ---------- | ---------- |
|
|
141
143
|
| `createMediaItem` | `{ (name: string, mimeType: string, content: File): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: Blob): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: string): { ...; }; (name: string, mimeType:...` |
|
|
142
144
|
|
|
143
145
|
Parameters:
|
|
144
146
|
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
147
|
+
* `name`: - Name of the media item.
|
|
148
|
+
* `mimeType`: - MIME type of the media item.
|
|
149
|
+
* `content`: - Content as File, Blob, base64 string, or ArrayBuffer.
|
|
150
|
+
* `id`: - Optional id for the media item. If not provided, a UUID will be generated.
|
|
151
|
+
* `name`: - Name of the media item.
|
|
152
|
+
* `mimeType`: - MIME type of the media item.
|
|
153
|
+
* `content`: - Content as Blob.
|
|
154
|
+
* `name`: - Name of the media item.
|
|
155
|
+
* `mimeType`: - MIME type of the media item.
|
|
156
|
+
* `content`: - Content as base64 string or binary string.
|
|
157
|
+
* `name`: - Name of the media item.
|
|
158
|
+
* `mimeType`: - MIME type of the media item.
|
|
159
|
+
* `content`: - Content as ArrayBuffer.
|
|
160
|
+
|
|
158
161
|
|
|
159
162
|
Returns:
|
|
160
163
|
|
|
@@ -164,25 +167,26 @@ MediaItem object with blobUrl generated from the content.
|
|
|
164
167
|
|
|
165
168
|
Creates a MediaItem from the provided parameters and content.
|
|
166
169
|
|
|
167
|
-
| Function
|
|
168
|
-
|
|
|
170
|
+
| Function | Type |
|
|
171
|
+
| ---------- | ---------- |
|
|
169
172
|
| `createMediaItem` | `{ (name: string, mimeType: string, content: File): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: Blob): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: string): { ...; }; (name: string, mimeType:...` |
|
|
170
173
|
|
|
171
174
|
Parameters:
|
|
172
175
|
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
176
|
+
* `name`: - Name of the media item.
|
|
177
|
+
* `mimeType`: - MIME type of the media item.
|
|
178
|
+
* `content`: - Content as File, Blob, base64 string, or ArrayBuffer.
|
|
179
|
+
* `id`: - Optional id for the media item. If not provided, a UUID will be generated.
|
|
180
|
+
* `name`: - Name of the media item.
|
|
181
|
+
* `mimeType`: - MIME type of the media item.
|
|
182
|
+
* `content`: - Content as Blob.
|
|
183
|
+
* `name`: - Name of the media item.
|
|
184
|
+
* `mimeType`: - MIME type of the media item.
|
|
185
|
+
* `content`: - Content as base64 string or binary string.
|
|
186
|
+
* `name`: - Name of the media item.
|
|
187
|
+
* `mimeType`: - MIME type of the media item.
|
|
188
|
+
* `content`: - Content as ArrayBuffer.
|
|
189
|
+
|
|
186
190
|
|
|
187
191
|
Returns:
|
|
188
192
|
|
|
@@ -192,25 +196,26 @@ MediaItem object with blobUrl generated from the content.
|
|
|
192
196
|
|
|
193
197
|
Creates a MediaItem from the provided parameters and content.
|
|
194
198
|
|
|
195
|
-
| Function
|
|
196
|
-
|
|
|
199
|
+
| Function | Type |
|
|
200
|
+
| ---------- | ---------- |
|
|
197
201
|
| `createMediaItem` | `{ (name: string, mimeType: string, content: File): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: Blob): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: string): { ...; }; (name: string, mimeType:...` |
|
|
198
202
|
|
|
199
203
|
Parameters:
|
|
200
204
|
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
205
|
+
* `name`: - Name of the media item.
|
|
206
|
+
* `mimeType`: - MIME type of the media item.
|
|
207
|
+
* `content`: - Content as File, Blob, base64 string, or ArrayBuffer.
|
|
208
|
+
* `id`: - Optional id for the media item. If not provided, a UUID will be generated.
|
|
209
|
+
* `name`: - Name of the media item.
|
|
210
|
+
* `mimeType`: - MIME type of the media item.
|
|
211
|
+
* `content`: - Content as Blob.
|
|
212
|
+
* `name`: - Name of the media item.
|
|
213
|
+
* `mimeType`: - MIME type of the media item.
|
|
214
|
+
* `content`: - Content as base64 string or binary string.
|
|
215
|
+
* `name`: - Name of the media item.
|
|
216
|
+
* `mimeType`: - MIME type of the media item.
|
|
217
|
+
* `content`: - Content as ArrayBuffer.
|
|
218
|
+
|
|
214
219
|
|
|
215
220
|
Returns:
|
|
216
221
|
|
|
@@ -220,25 +225,26 @@ MediaItem object with blobUrl generated from the content.
|
|
|
220
225
|
|
|
221
226
|
Creates a MediaItem from the provided parameters and content.
|
|
222
227
|
|
|
223
|
-
| Function
|
|
224
|
-
|
|
|
228
|
+
| Function | Type |
|
|
229
|
+
| ---------- | ---------- |
|
|
225
230
|
| `createMediaItem` | `{ (name: string, mimeType: string, content: File): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: Blob): { id: string; name: string; mimeType: string; blobUrl: string; }; (name: string, mimeType: string, content: string): { ...; }; (name: string, mimeType:...` |
|
|
226
231
|
|
|
227
232
|
Parameters:
|
|
228
233
|
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
234
|
+
* `name`: - Name of the media item.
|
|
235
|
+
* `mimeType`: - MIME type of the media item.
|
|
236
|
+
* `content`: - Content as File, Blob, base64 string, or ArrayBuffer.
|
|
237
|
+
* `id`: - Optional id for the media item. If not provided, a UUID will be generated.
|
|
238
|
+
* `name`: - Name of the media item.
|
|
239
|
+
* `mimeType`: - MIME type of the media item.
|
|
240
|
+
* `content`: - Content as Blob.
|
|
241
|
+
* `name`: - Name of the media item.
|
|
242
|
+
* `mimeType`: - MIME type of the media item.
|
|
243
|
+
* `content`: - Content as base64 string or binary string.
|
|
244
|
+
* `name`: - Name of the media item.
|
|
245
|
+
* `mimeType`: - MIME type of the media item.
|
|
246
|
+
* `content`: - Content as ArrayBuffer.
|
|
247
|
+
|
|
242
248
|
|
|
243
249
|
Returns:
|
|
244
250
|
|
|
@@ -248,20 +254,21 @@ MediaItem object with blobUrl generated from the content.
|
|
|
248
254
|
|
|
249
255
|
Updates a MediaItem with the provided changes.
|
|
250
256
|
|
|
251
|
-
| Function
|
|
252
|
-
|
|
|
257
|
+
| Function | Type |
|
|
258
|
+
| ---------- | ---------- |
|
|
253
259
|
| `updateMediaItem` | `{ (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { content: File; }): { id: string; name: string; mimeType: string; blobUrl: string; }; (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { ...; }): { ...; }; (mediaItem: { ...; }, updates: { ...` |
|
|
254
260
|
|
|
255
261
|
Parameters:
|
|
256
262
|
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
263
|
+
* `mediaItem`: - The original MediaItem to update.
|
|
264
|
+
* `updates`: - Object containing properties to update (name, mimeType, content).
|
|
265
|
+
* `mediaItem`: - The original MediaItem to update.
|
|
266
|
+
* `updates`: - Object containing content as Blob.
|
|
267
|
+
* `mediaItem`: - The original MediaItem to update.
|
|
268
|
+
* `updates`: - Object containing content as base64 string or binary string.
|
|
269
|
+
* `mediaItem`: - The original MediaItem to update.
|
|
270
|
+
* `updates`: - Object containing content as ArrayBuffer.
|
|
271
|
+
|
|
265
272
|
|
|
266
273
|
Returns:
|
|
267
274
|
|
|
@@ -271,20 +278,21 @@ Updated MediaItem object.
|
|
|
271
278
|
|
|
272
279
|
Updates a MediaItem with the provided changes.
|
|
273
280
|
|
|
274
|
-
| Function
|
|
275
|
-
|
|
|
281
|
+
| Function | Type |
|
|
282
|
+
| ---------- | ---------- |
|
|
276
283
|
| `updateMediaItem` | `{ (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { content: File; }): { id: string; name: string; mimeType: string; blobUrl: string; }; (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { ...; }): { ...; }; (mediaItem: { ...; }, updates: { ...` |
|
|
277
284
|
|
|
278
285
|
Parameters:
|
|
279
286
|
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
287
|
+
* `mediaItem`: - The original MediaItem to update.
|
|
288
|
+
* `updates`: - Object containing properties to update (name, mimeType, content).
|
|
289
|
+
* `mediaItem`: - The original MediaItem to update.
|
|
290
|
+
* `updates`: - Object containing content as Blob.
|
|
291
|
+
* `mediaItem`: - The original MediaItem to update.
|
|
292
|
+
* `updates`: - Object containing content as base64 string or binary string.
|
|
293
|
+
* `mediaItem`: - The original MediaItem to update.
|
|
294
|
+
* `updates`: - Object containing content as ArrayBuffer.
|
|
295
|
+
|
|
288
296
|
|
|
289
297
|
Returns:
|
|
290
298
|
|
|
@@ -294,20 +302,21 @@ Updated MediaItem object.
|
|
|
294
302
|
|
|
295
303
|
Updates a MediaItem with the provided changes.
|
|
296
304
|
|
|
297
|
-
| Function
|
|
298
|
-
|
|
|
305
|
+
| Function | Type |
|
|
306
|
+
| ---------- | ---------- |
|
|
299
307
|
| `updateMediaItem` | `{ (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { content: File; }): { id: string; name: string; mimeType: string; blobUrl: string; }; (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { ...; }): { ...; }; (mediaItem: { ...; }, updates: { ...` |
|
|
300
308
|
|
|
301
309
|
Parameters:
|
|
302
310
|
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
+
* `mediaItem`: - The original MediaItem to update.
|
|
312
|
+
* `updates`: - Object containing properties to update (name, mimeType, content).
|
|
313
|
+
* `mediaItem`: - The original MediaItem to update.
|
|
314
|
+
* `updates`: - Object containing content as Blob.
|
|
315
|
+
* `mediaItem`: - The original MediaItem to update.
|
|
316
|
+
* `updates`: - Object containing content as base64 string or binary string.
|
|
317
|
+
* `mediaItem`: - The original MediaItem to update.
|
|
318
|
+
* `updates`: - Object containing content as ArrayBuffer.
|
|
319
|
+
|
|
311
320
|
|
|
312
321
|
Returns:
|
|
313
322
|
|
|
@@ -317,20 +326,21 @@ Updated MediaItem object.
|
|
|
317
326
|
|
|
318
327
|
Updates a MediaItem with the provided changes.
|
|
319
328
|
|
|
320
|
-
| Function
|
|
321
|
-
|
|
|
329
|
+
| Function | Type |
|
|
330
|
+
| ---------- | ---------- |
|
|
322
331
|
| `updateMediaItem` | `{ (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { content: File; }): { id: string; name: string; mimeType: string; blobUrl: string; }; (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { ...; }): { ...; }; (mediaItem: { ...; }, updates: { ...` |
|
|
323
332
|
|
|
324
333
|
Parameters:
|
|
325
334
|
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
335
|
+
* `mediaItem`: - The original MediaItem to update.
|
|
336
|
+
* `updates`: - Object containing properties to update (name, mimeType, content).
|
|
337
|
+
* `mediaItem`: - The original MediaItem to update.
|
|
338
|
+
* `updates`: - Object containing content as Blob.
|
|
339
|
+
* `mediaItem`: - The original MediaItem to update.
|
|
340
|
+
* `updates`: - Object containing content as base64 string or binary string.
|
|
341
|
+
* `mediaItem`: - The original MediaItem to update.
|
|
342
|
+
* `updates`: - Object containing content as ArrayBuffer.
|
|
343
|
+
|
|
334
344
|
|
|
335
345
|
Returns:
|
|
336
346
|
|
|
@@ -340,20 +350,21 @@ Updated MediaItem object.
|
|
|
340
350
|
|
|
341
351
|
Updates a MediaItem with the provided changes.
|
|
342
352
|
|
|
343
|
-
| Function
|
|
344
|
-
|
|
|
353
|
+
| Function | Type |
|
|
354
|
+
| ---------- | ---------- |
|
|
345
355
|
| `updateMediaItem` | `{ (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { content: File; }): { id: string; name: string; mimeType: string; blobUrl: string; }; (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { ...; }): { ...; }; (mediaItem: { ...; }, updates: { ...` |
|
|
346
356
|
|
|
347
357
|
Parameters:
|
|
348
358
|
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
359
|
+
* `mediaItem`: - The original MediaItem to update.
|
|
360
|
+
* `updates`: - Object containing properties to update (name, mimeType, content).
|
|
361
|
+
* `mediaItem`: - The original MediaItem to update.
|
|
362
|
+
* `updates`: - Object containing content as Blob.
|
|
363
|
+
* `mediaItem`: - The original MediaItem to update.
|
|
364
|
+
* `updates`: - Object containing content as base64 string or binary string.
|
|
365
|
+
* `mediaItem`: - The original MediaItem to update.
|
|
366
|
+
* `updates`: - Object containing content as ArrayBuffer.
|
|
367
|
+
|
|
357
368
|
|
|
358
369
|
Returns:
|
|
359
370
|
|
|
@@ -363,20 +374,21 @@ Updated MediaItem object.
|
|
|
363
374
|
|
|
364
375
|
Updates a MediaItem with the provided changes.
|
|
365
376
|
|
|
366
|
-
| Function
|
|
367
|
-
|
|
|
377
|
+
| Function | Type |
|
|
378
|
+
| ---------- | ---------- |
|
|
368
379
|
| `updateMediaItem` | `{ (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { content: File; }): { id: string; name: string; mimeType: string; blobUrl: string; }; (mediaItem: { id: string; name: string; mimeType: string; blobUrl: string; }, updates: { ...; }): { ...; }; (mediaItem: { ...; }, updates: { ...` |
|
|
369
380
|
|
|
370
381
|
Parameters:
|
|
371
382
|
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
383
|
+
* `mediaItem`: - The original MediaItem to update.
|
|
384
|
+
* `updates`: - Object containing properties to update (name, mimeType, content).
|
|
385
|
+
* `mediaItem`: - The original MediaItem to update.
|
|
386
|
+
* `updates`: - Object containing content as Blob.
|
|
387
|
+
* `mediaItem`: - The original MediaItem to update.
|
|
388
|
+
* `updates`: - Object containing content as base64 string or binary string.
|
|
389
|
+
* `mediaItem`: - The original MediaItem to update.
|
|
390
|
+
* `updates`: - Object containing content as ArrayBuffer.
|
|
391
|
+
|
|
380
392
|
|
|
381
393
|
Returns:
|
|
382
394
|
|
|
@@ -384,50 +396,58 @@ Updated MediaItem object.
|
|
|
384
396
|
|
|
385
397
|
### initOnSaveMessageHandler
|
|
386
398
|
|
|
387
|
-
| Function
|
|
388
|
-
|
|
|
399
|
+
| Function | Type |
|
|
400
|
+
| ---------- | ---------- |
|
|
389
401
|
| `initOnSaveMessageHandler` | `() => void` |
|
|
390
402
|
|
|
391
403
|
### removeOnSaveMessageHandler
|
|
392
404
|
|
|
393
|
-
| Function
|
|
394
|
-
|
|
|
405
|
+
| Function | Type |
|
|
406
|
+
| ---------- | ---------- |
|
|
395
407
|
| `removeOnSaveMessageHandler` | `() => void` |
|
|
396
408
|
|
|
397
409
|
### setAnswer
|
|
398
410
|
|
|
399
411
|
Sets the answer for a specific question in the questionnaire.
|
|
400
412
|
|
|
401
|
-
| Function
|
|
402
|
-
|
|
|
413
|
+
| Function | Type |
|
|
414
|
+
| ---------- | ---------- |
|
|
403
415
|
| `setAnswer` | `(questionName: string, answer: unknown) => Promise<void>` |
|
|
404
416
|
|
|
405
417
|
Parameters:
|
|
406
418
|
|
|
407
|
-
|
|
408
|
-
|
|
419
|
+
* `questionName`: - Name of the question for which the answer is being set.
|
|
420
|
+
* `answer`: - The answer to set for the question. Can be any type.
|
|
421
|
+
|
|
409
422
|
|
|
410
423
|
Returns:
|
|
411
424
|
|
|
412
425
|
A promise that resolves when the answer has been successfully set.
|
|
413
426
|
|
|
427
|
+
References:
|
|
428
|
+
|
|
429
|
+
* onAnswerChange
|
|
430
|
+
|
|
431
|
+
|
|
414
432
|
Examples:
|
|
415
433
|
|
|
416
434
|
```typescript
|
|
417
|
-
await setAnswer(
|
|
435
|
+
await setAnswer('favoriteColor', 'blue');
|
|
418
436
|
```
|
|
419
437
|
|
|
438
|
+
|
|
420
439
|
### getQuestion
|
|
421
440
|
|
|
422
441
|
Retrieves a question by its name from the questionnaire.
|
|
423
442
|
|
|
424
|
-
| Function
|
|
425
|
-
|
|
|
443
|
+
| Function | Type |
|
|
444
|
+
| ---------- | ---------- |
|
|
426
445
|
| `getQuestion` | `(name: string) => Promise<{ label: string; description: string; disabled: boolean; required: boolean; hidden: boolean; semanticColor?: string or undefined; errorMessage?: string or undefined; answer?: unknown; }>` |
|
|
427
446
|
|
|
428
447
|
Parameters:
|
|
429
448
|
|
|
430
|
-
|
|
449
|
+
* `name`: - The name of the question to retrieve.
|
|
450
|
+
|
|
431
451
|
|
|
432
452
|
Returns:
|
|
433
453
|
|
|
@@ -436,22 +456,24 @@ A promise that resolves to the question object.
|
|
|
436
456
|
Examples:
|
|
437
457
|
|
|
438
458
|
```typescript
|
|
439
|
-
const question = await getQuestion(
|
|
459
|
+
const question = await getQuestion('favoriteColor');
|
|
440
460
|
console.log(question.label); // Outputs the label of the question
|
|
441
461
|
```
|
|
442
462
|
|
|
463
|
+
|
|
443
464
|
### setQuestion
|
|
444
465
|
|
|
445
466
|
Updates a question in the questionnaire.
|
|
446
467
|
|
|
447
|
-
| Function
|
|
448
|
-
|
|
|
468
|
+
| Function | Type |
|
|
469
|
+
| ---------- | ---------- |
|
|
449
470
|
| `setQuestion` | `(name: string, questionData: { semanticColor?: string or undefined; label?: string or undefined; description?: string or undefined; disabled?: boolean or undefined; required?: boolean or undefined; hidden?: boolean or undefined; errorMessage?: string or undefined; answer?: unknown; }) => Promise<...>` |
|
|
450
471
|
|
|
451
472
|
Parameters:
|
|
452
473
|
|
|
453
|
-
|
|
454
|
-
|
|
474
|
+
* `name`: - The name of the question to update. This is a unique identifier and cannot be changed.
|
|
475
|
+
* `questionData`: - The updated question data excluding the name property.
|
|
476
|
+
|
|
455
477
|
|
|
456
478
|
Returns:
|
|
457
479
|
|
|
@@ -460,20 +482,22 @@ A promise that resolves when the question has been successfully updated.
|
|
|
460
482
|
Examples:
|
|
461
483
|
|
|
462
484
|
```typescript
|
|
463
|
-
await setQuestion(
|
|
485
|
+
await setQuestion('favoriteColor', { label: 'What is your favorite color?' });
|
|
464
486
|
```
|
|
465
487
|
|
|
488
|
+
|
|
466
489
|
### getGroup
|
|
467
490
|
|
|
468
491
|
Retrieves a group by its name from the questionnaire.
|
|
469
492
|
|
|
470
|
-
| Function
|
|
471
|
-
| ---------- |
|
|
493
|
+
| Function | Type |
|
|
494
|
+
| ---------- | ---------- |
|
|
472
495
|
| `getGroup` | `(name: string) => Promise<{ label: string; hidden: boolean; collapsed: boolean; }>` |
|
|
473
496
|
|
|
474
497
|
Parameters:
|
|
475
498
|
|
|
476
|
-
|
|
499
|
+
* `name`: - The name of the group to retrieve.
|
|
500
|
+
|
|
477
501
|
|
|
478
502
|
Returns:
|
|
479
503
|
|
|
@@ -482,24 +506,26 @@ A promise that resolves to the group object.
|
|
|
482
506
|
Examples:
|
|
483
507
|
|
|
484
508
|
```typescript
|
|
485
|
-
const group = await getGroup(
|
|
509
|
+
const group = await getGroup('personalInfo');
|
|
486
510
|
console.log(group.label); // Outputs the label of the group
|
|
487
511
|
console.log(group.hidden); // Outputs whether the group is hidden
|
|
488
512
|
console.log(group.collapsed); // Outputs whether the group is collapsed
|
|
489
513
|
```
|
|
490
514
|
|
|
515
|
+
|
|
491
516
|
### setGroup
|
|
492
517
|
|
|
493
518
|
Updates a group in the questionnaire.
|
|
494
519
|
|
|
495
|
-
| Function
|
|
496
|
-
| ---------- |
|
|
520
|
+
| Function | Type |
|
|
521
|
+
| ---------- | ---------- |
|
|
497
522
|
| `setGroup` | `(name: string, groupData: { label?: string or undefined; hidden?: boolean or undefined; collapsed?: boolean or undefined; }) => Promise<void>` |
|
|
498
523
|
|
|
499
524
|
Parameters:
|
|
500
525
|
|
|
501
|
-
|
|
502
|
-
|
|
526
|
+
* `name`: - The name of the group to update. This is a unique identifier and cannot be changed.
|
|
527
|
+
* `groupData`: - The updated group data excluding the name property.
|
|
528
|
+
|
|
503
529
|
|
|
504
530
|
Returns:
|
|
505
531
|
|
|
@@ -508,47 +534,51 @@ A promise that resolves when the group has been successfully updated.
|
|
|
508
534
|
Examples:
|
|
509
535
|
|
|
510
536
|
```typescript
|
|
511
|
-
await setGroup(
|
|
537
|
+
await setGroup('personalInfo', { label: 'Personal Information', hidden: false, collapsed: true });
|
|
512
538
|
```
|
|
513
539
|
|
|
540
|
+
|
|
514
541
|
### onAnswerChange
|
|
515
542
|
|
|
516
543
|
Subscribes to changes in answers for questions.
|
|
517
544
|
Calls the provided listener whenever an answer changes in the questionnaire.
|
|
518
545
|
|
|
519
|
-
| Function
|
|
520
|
-
|
|
|
546
|
+
| Function | Type |
|
|
547
|
+
| ---------- | ---------- |
|
|
521
548
|
| `onAnswerChange` | `(listener: (question: string, answer: unknown) => void) => { cancelSubscription: () => void; }` |
|
|
522
549
|
|
|
523
550
|
Parameters:
|
|
524
551
|
|
|
525
|
-
|
|
552
|
+
* `listener`: - A function that will be called with the question name and the new answer whenever an answer changes.
|
|
553
|
+
|
|
526
554
|
|
|
527
555
|
Examples:
|
|
528
556
|
|
|
529
557
|
```typescript
|
|
530
|
-
import { onAnswerChange } from
|
|
558
|
+
import { onAnswerChange } from 'qp-bridge';
|
|
531
559
|
const { cancelSubscription } = onAnswerChange((question, answer) => {
|
|
532
|
-
|
|
533
|
-
});
|
|
560
|
+
console.log(`Answer for ${question} changed to:`, answer);
|
|
561
|
+
});
|
|
534
562
|
|
|
535
563
|
// To stop listening for changes:
|
|
536
564
|
cancelSubscription();
|
|
537
565
|
```
|
|
538
566
|
|
|
567
|
+
|
|
539
568
|
### withBusyIndicator
|
|
540
569
|
|
|
541
570
|
Wraps an asynchronous action with a busy indicator in the host application.
|
|
542
571
|
Shows a loading indicator during the execution of the provided action,
|
|
543
572
|
ensuring the UI reflects the busy state appropriately.
|
|
544
573
|
|
|
545
|
-
| Function
|
|
546
|
-
|
|
|
574
|
+
| Function | Type |
|
|
575
|
+
| ---------- | ---------- |
|
|
547
576
|
| `withBusyIndicator` | `<T>(action: () => Promise<T>) => Promise<T>` |
|
|
548
577
|
|
|
549
578
|
Parameters:
|
|
550
579
|
|
|
551
|
-
|
|
580
|
+
* `action`: - A function returning a promise whose execution should be wrapped.
|
|
581
|
+
|
|
552
582
|
|
|
553
583
|
Returns:
|
|
554
584
|
|
|
@@ -558,19 +588,20 @@ Examples:
|
|
|
558
588
|
|
|
559
589
|
```typescript
|
|
560
590
|
const result = await withBusyIndicator(async () => {
|
|
561
|
-
await setAnswer(
|
|
562
|
-
return
|
|
591
|
+
await setAnswer('favoriteColor', 'blue');
|
|
592
|
+
return 'done';
|
|
563
593
|
});
|
|
564
594
|
console.log(result); // 'done'
|
|
565
595
|
```
|
|
566
596
|
|
|
597
|
+
|
|
567
598
|
### saveQuestionnaire
|
|
568
599
|
|
|
569
600
|
Saves the current questionnaire state.
|
|
570
601
|
Triggers a save operation for the questionnaire data.
|
|
571
602
|
|
|
572
|
-
| Function
|
|
573
|
-
|
|
|
603
|
+
| Function | Type |
|
|
604
|
+
| ---------- | ---------- |
|
|
574
605
|
| `saveQuestionnaire` | `() => Promise<void>` |
|
|
575
606
|
|
|
576
607
|
Returns:
|
|
@@ -581,16 +612,17 @@ Examples:
|
|
|
581
612
|
|
|
582
613
|
```typescript
|
|
583
614
|
await saveQuestionnaire();
|
|
584
|
-
console.log(
|
|
615
|
+
console.log('Questionnaire saved successfully');
|
|
585
616
|
```
|
|
586
617
|
|
|
618
|
+
|
|
587
619
|
### completeAndCloseQuestionnaire
|
|
588
620
|
|
|
589
621
|
Completes and closes the current questionnaire.
|
|
590
622
|
Triggers the complete and close operation for the questionnaire.
|
|
591
623
|
|
|
592
|
-
| Function
|
|
593
|
-
|
|
|
624
|
+
| Function | Type |
|
|
625
|
+
| ---------- | ---------- |
|
|
594
626
|
| `completeAndCloseQuestionnaire` | `() => Promise<void>` |
|
|
595
627
|
|
|
596
628
|
Returns:
|
|
@@ -601,21 +633,23 @@ Examples:
|
|
|
601
633
|
|
|
602
634
|
```typescript
|
|
603
635
|
await completeAndCloseQuestionnaire();
|
|
604
|
-
console.log(
|
|
636
|
+
console.log('Questionnaire completed and closed successfully');
|
|
605
637
|
```
|
|
606
638
|
|
|
639
|
+
|
|
607
640
|
### executeCustomCommand
|
|
608
641
|
|
|
609
642
|
Executes a custom command by its name.
|
|
610
643
|
Triggers the execution of any user-defined command in the questionnaire.
|
|
611
644
|
|
|
612
|
-
| Function
|
|
613
|
-
|
|
|
645
|
+
| Function | Type |
|
|
646
|
+
| ---------- | ---------- |
|
|
614
647
|
| `executeCustomCommand` | `(commandName: string) => Promise<void>` |
|
|
615
648
|
|
|
616
649
|
Parameters:
|
|
617
650
|
|
|
618
|
-
|
|
651
|
+
* `commandName`: - The name of the command to execute.
|
|
652
|
+
|
|
619
653
|
|
|
620
654
|
Returns:
|
|
621
655
|
|
|
@@ -624,22 +658,24 @@ A promise that resolves when the command has been successfully executed.
|
|
|
624
658
|
Examples:
|
|
625
659
|
|
|
626
660
|
```typescript
|
|
627
|
-
await executeCustomCommand(
|
|
628
|
-
console.log(
|
|
661
|
+
await executeCustomCommand('MyCustomCommand');
|
|
662
|
+
console.log('Custom command executed successfully');
|
|
629
663
|
```
|
|
630
664
|
|
|
665
|
+
|
|
631
666
|
### onQuestionnaireLoaded
|
|
632
667
|
|
|
633
668
|
Registers a handler function to be called when the questionnaire is fully loaded.
|
|
634
669
|
Useful for performing actions that depend on the questionnaire being ready.
|
|
635
670
|
|
|
636
|
-
| Function
|
|
637
|
-
|
|
|
671
|
+
| Function | Type |
|
|
672
|
+
| ---------- | ---------- |
|
|
638
673
|
| `onQuestionnaireLoaded` | `(handler: () => void) => { cancelSubscription: () => void; }` |
|
|
639
674
|
|
|
640
675
|
Parameters:
|
|
641
676
|
|
|
642
|
-
|
|
677
|
+
* `handler`: - A function to be called when the questionnaire is loaded.
|
|
678
|
+
|
|
643
679
|
|
|
644
680
|
Returns:
|
|
645
681
|
|
|
@@ -648,27 +684,29 @@ An object with a `cancelSubscription` method to unregister the handler.
|
|
|
648
684
|
Examples:
|
|
649
685
|
|
|
650
686
|
```typescript
|
|
651
|
-
import { onQuestionnaireLoaded } from
|
|
687
|
+
import { onQuestionnaireLoaded } from 'qp-bridge';
|
|
652
688
|
const { cancelSubscription } = onQuestionnaireLoaded(() => {
|
|
653
|
-
console.log(
|
|
689
|
+
console.log('Questionnaire is fully loaded');
|
|
654
690
|
});
|
|
655
691
|
|
|
656
692
|
// To stop listening for questionnaire load events:
|
|
657
693
|
cancelSubscription();
|
|
658
694
|
```
|
|
659
695
|
|
|
696
|
+
|
|
660
697
|
### onCommandExecuted
|
|
661
698
|
|
|
662
699
|
Registers a handler function to be called when a command is executed.
|
|
663
700
|
Useful for reacting to custom command executions within the questionnaire.
|
|
664
701
|
|
|
665
|
-
| Function
|
|
666
|
-
|
|
|
702
|
+
| Function | Type |
|
|
703
|
+
| ---------- | ---------- |
|
|
667
704
|
| `onCommandExecuted` | `(handler: (commandName: string) => void) => { cancelSubscription: () => void; }` |
|
|
668
705
|
|
|
669
706
|
Parameters:
|
|
670
707
|
|
|
671
|
-
|
|
708
|
+
* `handler`: - A function that receives the name of the executed command.
|
|
709
|
+
|
|
672
710
|
|
|
673
711
|
Returns:
|
|
674
712
|
|
|
@@ -677,8 +715,8 @@ An object with a `cancelSubscription` method to unregister the handler.
|
|
|
677
715
|
Examples:
|
|
678
716
|
|
|
679
717
|
```typescript
|
|
680
|
-
import { onCommandExecuted } from
|
|
681
|
-
const { cancelSubscription } = onCommandExecuted(commandName => {
|
|
718
|
+
import { onCommandExecuted } from 'qp-bridge';
|
|
719
|
+
const { cancelSubscription } = onCommandExecuted((commandName) => {
|
|
682
720
|
console.log(`Command executed: ${commandName}`);
|
|
683
721
|
});
|
|
684
722
|
|
|
@@ -686,18 +724,20 @@ const { cancelSubscription } = onCommandExecuted(commandName => {
|
|
|
686
724
|
cancelSubscription();
|
|
687
725
|
```
|
|
688
726
|
|
|
727
|
+
|
|
689
728
|
### onSave
|
|
690
729
|
|
|
691
730
|
Registers a validator function to be called when a save event occurs.
|
|
692
731
|
Useful for validating data before saving the questionnaire.
|
|
693
732
|
|
|
694
|
-
| Function | Type
|
|
695
|
-
|
|
|
733
|
+
| Function | Type |
|
|
734
|
+
| ---------- | ---------- |
|
|
696
735
|
| `onSave` | `(validator: Validator) => { cancelSubscription: () => void; }` |
|
|
697
736
|
|
|
698
737
|
Parameters:
|
|
699
738
|
|
|
700
|
-
|
|
739
|
+
* `validator`: - A function returning a Promise resolving to a boolean indicating if the save is valid.
|
|
740
|
+
|
|
701
741
|
|
|
702
742
|
Returns:
|
|
703
743
|
|
|
@@ -706,7 +746,7 @@ An object with a `cancelSubscription` method to unregister the validator.
|
|
|
706
746
|
Examples:
|
|
707
747
|
|
|
708
748
|
```typescript
|
|
709
|
-
import { onSave } from
|
|
749
|
+
import { onSave } from 'qp-bridge';
|
|
710
750
|
const { cancelSubscription } = onSave(async () => {
|
|
711
751
|
// perform validation logic
|
|
712
752
|
return true;
|
|
@@ -716,17 +756,19 @@ const { cancelSubscription } = onSave(async () => {
|
|
|
716
756
|
cancelSubscription();
|
|
717
757
|
```
|
|
718
758
|
|
|
759
|
+
|
|
719
760
|
### fetchEntities
|
|
720
761
|
|
|
721
762
|
Fetches entities from the CRM system using the provided FetchXML query.
|
|
722
763
|
|
|
723
|
-
| Function
|
|
724
|
-
|
|
|
764
|
+
| Function | Type |
|
|
765
|
+
| ---------- | ---------- |
|
|
725
766
|
| `fetchEntities` | `(fetchXml: string) => Promise<Record<string, unknown>[]>` |
|
|
726
767
|
|
|
727
768
|
Parameters:
|
|
728
769
|
|
|
729
|
-
|
|
770
|
+
* `fetchXml`: - The FetchXML query string to execute.
|
|
771
|
+
|
|
730
772
|
|
|
731
773
|
Returns:
|
|
732
774
|
|
|
@@ -745,18 +787,20 @@ const entities = await fetchEntities(fetchXml);
|
|
|
745
787
|
console.log(entities); // Array of contact entities
|
|
746
788
|
```
|
|
747
789
|
|
|
790
|
+
|
|
748
791
|
### getEntityById
|
|
749
792
|
|
|
750
793
|
Retrieves a single entity by its name and ID from the CRM system.
|
|
751
794
|
|
|
752
|
-
| Function
|
|
753
|
-
|
|
|
795
|
+
| Function | Type |
|
|
796
|
+
| ---------- | ---------- |
|
|
754
797
|
| `getEntityById` | `(entityName: string, id: string) => Promise<Record<string, unknown>>` |
|
|
755
798
|
|
|
756
799
|
Parameters:
|
|
757
800
|
|
|
758
|
-
|
|
759
|
-
|
|
801
|
+
* `entityName`: - The name of the entity to retrieve (e.g., "contact", "account").
|
|
802
|
+
* `id`: - The unique identifier of the entity.
|
|
803
|
+
|
|
760
804
|
|
|
761
805
|
Returns:
|
|
762
806
|
|
|
@@ -765,44 +809,47 @@ A promise that resolves to the entity object.
|
|
|
765
809
|
Examples:
|
|
766
810
|
|
|
767
811
|
```typescript
|
|
768
|
-
const contact = await getEntityById(
|
|
812
|
+
const contact = await getEntityById('contact', '12345678-1234-1234-1234-123456789abc');
|
|
769
813
|
console.log(contact.attributes.firstname); // Entity firstname attribute
|
|
770
814
|
```
|
|
771
815
|
|
|
816
|
+
|
|
772
817
|
### createNewEntity
|
|
773
818
|
|
|
774
819
|
Creates a new entity marker that can be enriched before saving.
|
|
775
820
|
The returned entity is flagged with `isNew` so the host can distinguish new records.
|
|
776
821
|
|
|
777
|
-
| Function
|
|
778
|
-
|
|
|
822
|
+
| Function | Type |
|
|
823
|
+
| ---------- | ---------- |
|
|
779
824
|
| `createNewEntity` | `() => Record<string, unknown>` |
|
|
780
825
|
|
|
781
826
|
### saveEntity
|
|
782
827
|
|
|
783
828
|
Persists an entity through the bridge. Supports both new and existing entities.
|
|
784
829
|
|
|
785
|
-
| Function
|
|
786
|
-
|
|
|
830
|
+
| Function | Type |
|
|
831
|
+
| ---------- | ---------- |
|
|
787
832
|
| `saveEntity` | `(entity: Record<string, unknown>) => Promise<void>` |
|
|
788
833
|
|
|
789
834
|
Parameters:
|
|
790
835
|
|
|
791
|
-
|
|
836
|
+
* `entity`: - Entity payload; include `isNew` for newly created entities.
|
|
837
|
+
|
|
792
838
|
|
|
793
839
|
### repeatGroup
|
|
794
840
|
|
|
795
841
|
Repeats a specific group within a repeatable group by creating a copy of the group at the specified index.
|
|
796
842
|
The parent group must be a repeatable group and the index must refer to an existing group instance.
|
|
797
843
|
|
|
798
|
-
| Function
|
|
799
|
-
|
|
|
844
|
+
| Function | Type |
|
|
845
|
+
| ---------- | ---------- |
|
|
800
846
|
| `repeatGroup` | `(repeatableGroupName: string, groupIndex: number) => Promise<void>` |
|
|
801
847
|
|
|
802
848
|
Parameters:
|
|
803
849
|
|
|
804
|
-
|
|
805
|
-
|
|
850
|
+
* `repeatableGroupName`: - The name of the parent repeatable group.
|
|
851
|
+
* `groupIndex`: - The index (0-based) of the group instance to repeat.
|
|
852
|
+
|
|
806
853
|
|
|
807
854
|
Returns:
|
|
808
855
|
|
|
@@ -811,22 +858,24 @@ A promise that resolves when the group has been successfully repeated.
|
|
|
811
858
|
Examples:
|
|
812
859
|
|
|
813
860
|
```typescript
|
|
814
|
-
await repeatGroup(
|
|
815
|
-
console.log(
|
|
861
|
+
await repeatGroup('personalInfoRepeatable', 1);
|
|
862
|
+
console.log('Group repeated successfully');
|
|
816
863
|
```
|
|
817
864
|
|
|
865
|
+
|
|
818
866
|
### addNewGroup
|
|
819
867
|
|
|
820
868
|
Adds a new group instance to a repeatable group.
|
|
821
869
|
The specified name must refer to a repeatable group.
|
|
822
870
|
|
|
823
|
-
| Function
|
|
824
|
-
|
|
|
871
|
+
| Function | Type |
|
|
872
|
+
| ---------- | ---------- |
|
|
825
873
|
| `addNewGroup` | `(repeatableGroupName: string) => Promise<void>` |
|
|
826
874
|
|
|
827
875
|
Parameters:
|
|
828
876
|
|
|
829
|
-
|
|
877
|
+
* `repeatableGroupName`: - The name of the repeatable group to add a new instance to.
|
|
878
|
+
|
|
830
879
|
|
|
831
880
|
Returns:
|
|
832
881
|
|
|
@@ -835,23 +884,25 @@ A promise that resolves when the new group has been successfully added.
|
|
|
835
884
|
Examples:
|
|
836
885
|
|
|
837
886
|
```typescript
|
|
838
|
-
await addNewGroup(
|
|
839
|
-
console.log(
|
|
887
|
+
await addNewGroup('personalInfoRepeatable');
|
|
888
|
+
console.log('New group added successfully');
|
|
840
889
|
```
|
|
841
890
|
|
|
891
|
+
|
|
842
892
|
### deleteGroup
|
|
843
893
|
|
|
844
894
|
Deletes a specific group instance from a repeatable group by index.
|
|
845
895
|
The parent group must be a repeatable group and the index must refer to an existing group instance.
|
|
846
896
|
|
|
847
|
-
| Function
|
|
848
|
-
|
|
|
897
|
+
| Function | Type |
|
|
898
|
+
| ---------- | ---------- |
|
|
849
899
|
| `deleteGroup` | `(repeatableGroupName: string, groupIndex: number) => Promise<void>` |
|
|
850
900
|
|
|
851
901
|
Parameters:
|
|
852
902
|
|
|
853
|
-
|
|
854
|
-
|
|
903
|
+
* `repeatableGroupName`: - The name of the parent repeatable group.
|
|
904
|
+
* `groupIndex`: - The index (0-based) of the group instance to delete.
|
|
905
|
+
|
|
855
906
|
|
|
856
907
|
Returns:
|
|
857
908
|
|
|
@@ -860,8 +911,11 @@ A promise that resolves when the group has been successfully deleted.
|
|
|
860
911
|
Examples:
|
|
861
912
|
|
|
862
913
|
```typescript
|
|
863
|
-
await deleteGroup(
|
|
864
|
-
console.log(
|
|
914
|
+
await deleteGroup('personalInfoRepeatable', 1);
|
|
915
|
+
console.log('Group deleted successfully');
|
|
865
916
|
```
|
|
866
917
|
|
|
918
|
+
|
|
919
|
+
|
|
920
|
+
|
|
867
921
|
<!-- TSDOC_END -->
|