twilio-taskrouter 0.8.2 → 0.8.4

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.
Files changed (21) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/dist/docs/Activity.html +525 -131
  3. package/dist/docs/Channel.html +900 -7
  4. package/dist/docs/IncomingTransfer.html +180 -14
  5. package/dist/docs/OutgoingTransfer.html +234 -17
  6. package/dist/docs/Reservation.html +901 -2351
  7. package/dist/docs/Supervisor.html +4385 -0
  8. package/dist/docs/Task.html +1738 -537
  9. package/dist/docs/TaskQueue.html +1021 -5
  10. package/dist/docs/Transfers.html +444 -4
  11. package/dist/docs/Worker.html +1555 -594
  12. package/dist/docs/Workspace.html +159 -913
  13. package/dist/docs/classes.list.html +1823 -14
  14. package/dist/docs/global.html +4755 -0
  15. package/dist/docs/index.html +11 -4
  16. package/dist/docs/quicksearch.html +1 -1
  17. package/dist/index.commonjs2.js +1 -1
  18. package/dist/index.commonjs2.js.LICENSE.txt +1 -1
  19. package/dist/index.window.js +2 -2
  20. package/dist/index.window.js.LICENSE.txt +1 -1
  21. package/package.json +9 -7
package/dist/docs/global.html ADDED
@@ -0,0 +1,4755 @@
1
+ <!DOCTYPE html><html lang="en"><head>
2
+ <meta charset="utf-8">
3
+ <meta name="viewport" content="width=device-width">
4
+ <title>Documentation Global</title>
5
+
6
+ <!--[if lt IE 9]>
7
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
8
+ <![endif]-->
9
+ <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
10
+
11
+ <link type="text/css" rel="stylesheet" href="styles/site.simplex.css">
12
+
13
+ </head>
14
+
15
+ <body>
16
+
17
+ <div class="navbar navbar-default navbar-fixed-top ">
18
+ <div class="container">
19
+ <div class="navbar-header">
20
+ <a class="navbar-brand" href="index.html">Documentation</a>
21
+ <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
22
+ <span class="icon-bar"></span>
23
+ <span class="icon-bar"></span>
24
+ <span class="icon-bar"></span>
25
+ </button>
26
+ </div>
27
+ <div class="navbar-collapse collapse" id="topNavigation">
28
+ <ul class="nav navbar-nav">
29
+
30
+ <li class="dropdown">
31
+ <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a>
32
+ <ul class="dropdown-menu ">
33
+ <li><a href="Activity.html">Activity</a></li><li><a href="Channel.html">Channel</a></li><li><a href="IncomingTransfer.html">IncomingTransfer</a></li><li><a href="OutgoingTransfer.html">OutgoingTransfer</a></li><li><a href="Reservation.html">Reservation</a></li><li><a href="Supervisor.html">Supervisor</a></li><li><a href="Task.html">Task</a></li><li><a href="TaskQueue.html">TaskQueue</a></li><li><a href="Transfers.html">Transfers</a></li><li><a href="Worker.html">Worker</a></li><li><a href="Workspace.html">Workspace</a></li>
34
+ </ul>
35
+ </li>
36
+
37
+ <li class="dropdown">
38
+ <a href="events.list.html" class="dropdown-toggle" data-toggle="dropdown">Events<b class="caret"></b></a>
39
+ <ul class="dropdown-menu ">
40
+ <li><a href="Channel.html#event:availabilityUpdated">Channel#event:availabilityUpdated</a></li><li><a href="Channel.html#event:capacityUpdated">Channel#event:capacityUpdated</a></li><li><a href="OutgoingTransfer.html#event:attemptFailed">OutgoingTransfer#event:attemptFailed</a></li><li><a href="OutgoingTransfer.html#event:canceled">OutgoingTransfer#event:canceled</a></li><li><a href="OutgoingTransfer.html#event:completed">OutgoingTransfer#event:completed</a></li><li><a href="OutgoingTransfer.html#event:failed">OutgoingTransfer#event:failed</a></li><li><a href="Reservation.html#event:accepted">Reservation#event:accepted</a></li><li><a href="Reservation.html#event:canceled">Reservation#event:canceled</a></li><li><a href="Reservation.html#event:completed">Reservation#event:completed</a></li><li><a href="Reservation.html#event:rejected">Reservation#event:rejected</a></li><li><a href="Reservation.html#event:rescinded">Reservation#event:rescinded</a></li><li><a href="Reservation.html#event:timeout">Reservation#event:timeout</a></li><li><a href="Reservation.html#event:wrapup">Reservation#event:wrapup</a></li><li><a href="Supervisor.html#event:activityUpdated">Supervisor#event:activityUpdated</a></li><li><a href="Supervisor.html#event:attributesUpdated">Supervisor#event:attributesUpdated</a></li><li><a href="Supervisor.html#event:disconnected">Supervisor#event:disconnected</a></li><li><a href="Supervisor.html#event:error">Supervisor#event:error</a></li><li><a href="Supervisor.html#event:monitor">Supervisor#event:monitor</a></li><li><a href="Supervisor.html#event:ready">Supervisor#event:ready</a></li><li><a href="Supervisor.html#event:reservationCreated">Supervisor#event:reservationCreated</a></li><li><a href="Supervisor.html#event:reservationFailed">Supervisor#event:reservationFailed</a></li><li><a href="Supervisor.html#event:tokenExpired">Supervisor#event:tokenExpired</a></li><li><a href="Supervisor.html#event:tokenUpdated">Supervisor#event:tokenUpdated</a></li><li><a href="Task.html#event:canceled">Task#event:canceled</a></li><li><a href="Task.html#event:completed">Task#event:completed</a></li><li><a href="Task.html#event:transferAttemptFailed">Task#event:transferAttemptFailed</a></li><li><a href="Task.html#event:transferCanceled">Task#event:transferCanceled</a></li><li><a href="Task.html#event:transferCompleted">Task#event:transferCompleted</a></li><li><a href="Task.html#event:transferFailed">Task#event:transferFailed</a></li><li><a href="Task.html#event:transferInitiated">Task#event:transferInitiated</a></li><li><a href="Task.html#event:updated">Task#event:updated</a></li><li><a href="Task.html#event:wrapup">Task#event:wrapup</a></li><li><a href="Worker.html#event:activityUpdated">Worker#event:activityUpdated</a></li><li><a href="Worker.html#event:attributesUpdated">Worker#event:attributesUpdated</a></li><li><a href="Worker.html#event:disconnected">Worker#event:disconnected</a></li><li><a href="Worker.html#event:error">Worker#event:error</a></li><li><a href="Worker.html#event:ready">Worker#event:ready</a></li><li><a href="Worker.html#event:reservationCreated">Worker#event:reservationCreated</a></li><li><a href="Worker.html#event:reservationFailed">Worker#event:reservationFailed</a></li><li><a href="Worker.html#event:tokenExpired">Worker#event:tokenExpired</a></li><li><a href="Worker.html#event:tokenUpdated">Worker#event:tokenUpdated</a></li>
41
+ </ul>
42
+ </li>
43
+
44
+ <li class="dropdown">
45
+ <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a>
46
+ <ul class="dropdown-menu ">
47
+ <li><a href="global.html">Global</a></li>
48
+ </ul>
49
+ </li>
50
+
51
+ </ul>
52
+
53
+ <div class="col-sm-3 col-md-3">
54
+ <form class="navbar-form" role="search">
55
+ <div class="input-group">
56
+ <input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
57
+ <div class="input-group-btn">
58
+ <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
59
+ </div>
60
+ </div>
61
+ </form>
62
+ </div>
63
+
64
+ </div>
65
+
66
+ </div>
67
+ </div>
68
+
69
+
70
+ <div class="container" id="toc-content">
71
+ <div class="row">
72
+
73
+
74
+ <div class="col-md-8">
75
+
76
+ <div id="main">
77
+
78
+
79
+ <h1 class="page-title">Global</h1>
80
+ <section>
81
+
82
+ <header>
83
+
84
+ <h2>
85
+
86
+ </h2>
87
+
88
+
89
+ </header>
90
+
91
+
92
+ <article>
93
+ <div class="container-overview">
94
+
95
+
96
+
97
+
98
+ <dl class="details">
99
+
100
+
101
+
102
+
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
+
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+ </dl>
135
+
136
+
137
+
138
+
139
+ </div>
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+ <h3 class="subsection-title">Type Definitions</h3>
157
+
158
+ <dl>
159
+
160
+ <hr>
161
+ <dt class="name" id="ActivityUpdateOptions">
162
+ <h4 id="ActivityUpdateOptions">ActivityUpdateOptions</h4>
163
+
164
+
165
+ </dt>
166
+ <dd>
167
+
168
+
169
+
170
+ <h5>Type:</h5>
171
+ <ul>
172
+ <li>
173
+
174
+ <span class="param-type">Object</span>
175
+
176
+
177
+
178
+ </li>
179
+ </ul>
180
+
181
+
182
+
183
+ <dl class="details">
184
+
185
+
186
+ <h5 class="subsection-title">Properties:</h5>
187
+
188
+ <dl>
189
+
190
+ <table class="props table table-striped">
191
+ <thead>
192
+ <tr>
193
+
194
+ <th>Name</th>
195
+
196
+
197
+ <th>Type</th>
198
+
199
+
200
+ <th>Argument</th>
201
+
202
+
203
+
204
+ <th>Default</th>
205
+
206
+
207
+ <th class="last">Description</th>
208
+ </tr>
209
+ </thead>
210
+
211
+ <tbody>
212
+
213
+
214
+ <tr>
215
+
216
+ <td class="name"><code>rejectPendingReservations</code></td>
217
+
218
+
219
+ <td class="type">
220
+
221
+
222
+ <span class="param-type">boolean</span>
223
+
224
+
225
+
226
+
227
+ </td>
228
+
229
+
230
+ <td class="attributes">
231
+
232
+ &lt;optional&gt;<br>
233
+
234
+
235
+
236
+ </td>
237
+
238
+
239
+
240
+ <td class="default">
241
+
242
+ false
243
+
244
+ </td>
245
+
246
+
247
+ <td class="description last"><p>Represents whether all pending reservations should be rejected with the update to an unavailable <a href="Activity.html">Activity</a>.</p></td>
248
+ </tr>
249
+
250
+
251
+ </tbody>
252
+ </table>
253
+ </dl>
254
+
255
+
256
+
257
+
258
+
259
+
260
+
261
+
262
+
263
+
264
+
265
+
266
+
267
+
268
+
269
+
270
+
271
+
272
+
273
+
274
+
275
+
276
+
277
+
278
+
279
+
280
+
281
+
282
+
283
+
284
+
285
+
286
+
287
+
288
+
289
+
290
+ </dl>
291
+
292
+
293
+
294
+ </dd>
295
+
296
+
297
+
298
+ <hr>
299
+ <dt class="name" id="CallOptions">
300
+ <h4 id="CallOptions">CallOptions</h4>
301
+
302
+
303
+ </dt>
304
+ <dd>
305
+
306
+
307
+
308
+ <h5>Type:</h5>
309
+ <ul>
310
+ <li>
311
+
312
+ <span class="param-type">Object</span>
313
+
314
+
315
+
316
+ </li>
317
+ </ul>
318
+
319
+
320
+
321
+ <dl class="details">
322
+
323
+
324
+ <h5 class="subsection-title">Properties:</h5>
325
+
326
+ <dl>
327
+
328
+ <table class="props table table-striped">
329
+ <thead>
330
+ <tr>
331
+
332
+ <th>Name</th>
333
+
334
+
335
+ <th>Type</th>
336
+
337
+
338
+ <th>Argument</th>
339
+
340
+
341
+
342
+ <th>Default</th>
343
+
344
+
345
+ <th class="last">Description</th>
346
+ </tr>
347
+ </thead>
348
+
349
+ <tbody>
350
+
351
+
352
+ <tr>
353
+
354
+ <td class="name"><code>accept</code></td>
355
+
356
+
357
+ <td class="type">
358
+
359
+
360
+ <span class="param-type">boolean</span>
361
+
362
+
363
+
364
+
365
+ </td>
366
+
367
+
368
+ <td class="attributes">
369
+
370
+ &lt;optional&gt;<br>
371
+
372
+
373
+
374
+ </td>
375
+
376
+
377
+
378
+ <td class="default">
379
+
380
+ false
381
+
382
+ </td>
383
+
384
+
385
+ <td class="description last"><p>Represents whether the <a href="Task.html">Task</a> should be
386
+ accepted before initiating the call</p></td>
387
+ </tr>
388
+
389
+
390
+
391
+ <tr>
392
+
393
+ <td class="name"><code>record</code></td>
394
+
395
+
396
+ <td class="type">
397
+
398
+
399
+ <span class="param-type">string</span>
400
+
401
+
402
+
403
+
404
+ </td>
405
+
406
+
407
+ <td class="attributes">
408
+
409
+ &lt;optional&gt;<br>
410
+
411
+
412
+
413
+ </td>
414
+
415
+
416
+
417
+ <td class="default">
418
+
419
+ 'do-not-record'
420
+
421
+ </td>
422
+
423
+
424
+ <td class="description last"><p>To record the call or not</p></td>
425
+ </tr>
426
+
427
+
428
+
429
+ <tr>
430
+
431
+ <td class="name"><code>statusCallbackUrl</code></td>
432
+
433
+
434
+ <td class="type">
435
+
436
+
437
+ <span class="param-type">string</span>
438
+
439
+
440
+
441
+
442
+ </td>
443
+
444
+
445
+ <td class="attributes">
446
+
447
+ &lt;optional&gt;<br>
448
+
449
+
450
+
451
+ </td>
452
+
453
+
454
+
455
+ <td class="default">
456
+
457
+ null
458
+
459
+ </td>
460
+
461
+
462
+ <td class="description last"><p>A valid status status callback url</p></td>
463
+ </tr>
464
+
465
+
466
+
467
+ <tr>
468
+
469
+ <td class="name"><code>to</code></td>
470
+
471
+
472
+ <td class="type">
473
+
474
+
475
+ <span class="param-type">string</span>
476
+
477
+
478
+
479
+
480
+ </td>
481
+
482
+
483
+ <td class="attributes">
484
+
485
+ &lt;optional&gt;<br>
486
+
487
+
488
+
489
+ </td>
490
+
491
+
492
+
493
+ <td class="default">
494
+
495
+ null
496
+
497
+ </td>
498
+
499
+
500
+ <td class="description last"><p>The number or endpoint that should be called.
501
+ If not provided, the contact_uri defined in the <a href="Worker.html">Worker</a> attributes will be used</p></td>
502
+ </tr>
503
+
504
+
505
+
506
+ <tr>
507
+
508
+ <td class="name"><code>timeout</code></td>
509
+
510
+
511
+ <td class="type">
512
+
513
+
514
+ <span class="param-type">number</span>
515
+
516
+
517
+
518
+
519
+ </td>
520
+
521
+
522
+ <td class="attributes">
523
+
524
+ &lt;optional&gt;<br>
525
+
526
+
527
+
528
+ </td>
529
+
530
+
531
+
532
+ <td class="default">
533
+
534
+ 60
535
+
536
+ </td>
537
+
538
+
539
+ <td class="description last"><p>The integer number of seconds Twilio should allow the phone associated to "contact_uri" to ring</p></td>
540
+ </tr>
541
+
542
+
543
+ </tbody>
544
+ </table>
545
+ </dl>
546
+
547
+
548
+
549
+
550
+
551
+
552
+
553
+
554
+
555
+
556
+
557
+
558
+
559
+
560
+
561
+
562
+
563
+
564
+
565
+
566
+
567
+
568
+
569
+
570
+
571
+
572
+
573
+
574
+
575
+
576
+
577
+
578
+
579
+
580
+
581
+
582
+ </dl>
583
+
584
+
585
+
586
+ </dd>
587
+
588
+
589
+
590
+ <hr>
591
+ <dt class="name" id="ConferenceOptions">
592
+ <h4 id="ConferenceOptions">ConferenceOptions</h4>
593
+
594
+
595
+ </dt>
596
+ <dd>
597
+
598
+
599
+
600
+ <h5>Type:</h5>
601
+ <ul>
602
+ <li>
603
+
604
+ <span class="param-type">Object</span>
605
+
606
+
607
+
608
+ </li>
609
+ </ul>
610
+
611
+
612
+
613
+ <dl class="details">
614
+
615
+
616
+ <h5 class="subsection-title">Properties:</h5>
617
+
618
+ <dl>
619
+
620
+ <table class="props table table-striped">
621
+ <thead>
622
+ <tr>
623
+
624
+ <th>Name</th>
625
+
626
+
627
+ <th>Type</th>
628
+
629
+
630
+ <th>Argument</th>
631
+
632
+
633
+
634
+ <th>Default</th>
635
+
636
+
637
+ <th class="last">Description</th>
638
+ </tr>
639
+ </thead>
640
+
641
+ <tbody>
642
+
643
+
644
+ <tr>
645
+
646
+ <td class="name"><code>to</code></td>
647
+
648
+
649
+ <td class="type">
650
+
651
+
652
+ <span class="param-type">string</span>
653
+
654
+
655
+
656
+
657
+ </td>
658
+
659
+
660
+ <td class="attributes">
661
+
662
+ &lt;optional&gt;<br>
663
+
664
+
665
+
666
+ </td>
667
+
668
+
669
+
670
+ <td class="default">
671
+
672
+ null
673
+
674
+ </td>
675
+
676
+
677
+ <td class="description last"><p>The contact uri of the <a href="Worker.html">Worker</a>; can be a phone
678
+ number or a client ID. Required, if no contact_uri on the <a href="Worker.html">Worker</a>'s attributes.</p></td>
679
+ </tr>
680
+
681
+
682
+
683
+ <tr>
684
+
685
+ <td class="name"><code>from</code></td>
686
+
687
+
688
+ <td class="type">
689
+
690
+
691
+ <span class="param-type">string</span>
692
+
693
+
694
+
695
+
696
+ </td>
697
+
698
+
699
+ <td class="attributes">
700
+
701
+ &lt;optional&gt;<br>
702
+
703
+
704
+
705
+ </td>
706
+
707
+
708
+
709
+ <td class="default">
710
+
711
+ null
712
+
713
+ </td>
714
+
715
+
716
+ <td class="description last"><p>The caller id for the call to the <a href="Worker.html">Worker</a>.
717
+ Must be a verified Twilio number.</p></td>
718
+ </tr>
719
+
720
+
721
+
722
+ <tr>
723
+
724
+ <td class="name"><code>timeout</code></td>
725
+
726
+
727
+ <td class="type">
728
+
729
+
730
+ <span class="param-type">number</span>
731
+
732
+
733
+
734
+
735
+ </td>
736
+
737
+
738
+ <td class="attributes">
739
+
740
+ &lt;optional&gt;<br>
741
+
742
+
743
+
744
+ </td>
745
+
746
+
747
+
748
+ <td class="default">
749
+
750
+ 60
751
+
752
+ </td>
753
+
754
+
755
+ <td class="description last"><p>The integer number of seconds that
756
+ Twilio should allow the call to ring before assuming there is no answer.</p></td>
757
+ </tr>
758
+
759
+
760
+
761
+ <tr>
762
+
763
+ <td class="name"><code>statusCallback</code></td>
764
+
765
+
766
+ <td class="type">
767
+
768
+
769
+ <span class="param-type">string</span>
770
+
771
+
772
+
773
+
774
+ </td>
775
+
776
+
777
+ <td class="attributes">
778
+
779
+ &lt;optional&gt;<br>
780
+
781
+
782
+
783
+ </td>
784
+
785
+
786
+
787
+ <td class="default">
788
+
789
+ null
790
+
791
+ </td>
792
+
793
+
794
+ <td class="description last"><p>The URL endpoint to receive call status events of the Worker leg.</p></td>
795
+ </tr>
796
+
797
+
798
+
799
+ <tr>
800
+
801
+ <td class="name"><code>statusCallbackMethod</code></td>
802
+
803
+
804
+ <td class="type">
805
+
806
+
807
+ <span class="param-type">string</span>
808
+
809
+
810
+
811
+
812
+ </td>
813
+
814
+
815
+ <td class="attributes">
816
+
817
+ &lt;optional&gt;<br>
818
+
819
+
820
+
821
+ </td>
822
+
823
+
824
+
825
+ <td class="default">
826
+
827
+ 'POST'
828
+
829
+ </td>
830
+
831
+
832
+ <td class="description last"><p>The HTTP method for the Status Callback URL.</p></td>
833
+ </tr>
834
+
835
+
836
+
837
+ <tr>
838
+
839
+ <td class="name"><code>statusCallbackEvent</code></td>
840
+
841
+
842
+ <td class="type">
843
+
844
+
845
+ <span class="param-type">string</span>
846
+
847
+
848
+
849
+
850
+ </td>
851
+
852
+
853
+ <td class="attributes">
854
+
855
+ &lt;optional&gt;<br>
856
+
857
+
858
+
859
+ </td>
860
+
861
+
862
+
863
+ <td class="default">
864
+
865
+ 'completed'
866
+
867
+ </td>
868
+
869
+
870
+ <td class="description last"><p>A comma separated list of events to subscribe to.
871
+ The possible list of events are: ['initiated', 'ringing', 'answered', 'completed'].</p></td>
872
+ </tr>
873
+
874
+
875
+
876
+ <tr>
877
+
878
+ <td class="name"><code>record</code></td>
879
+
880
+
881
+ <td class="type">
882
+
883
+
884
+ <span class="param-type">string</span>
885
+
886
+
887
+
888
+
889
+ </td>
890
+
891
+
892
+ <td class="attributes">
893
+
894
+ &lt;optional&gt;<br>
895
+
896
+
897
+
898
+ </td>
899
+
900
+
901
+
902
+ <td class="default">
903
+
904
+ 'do-not-record'
905
+
906
+ </td>
907
+
908
+
909
+ <td class="description last"><p>Whether to record the <a href="Worker.html">Worker</a> leg of the Conference.</p></td>
910
+ </tr>
911
+
912
+
913
+
914
+ <tr>
915
+
916
+ <td class="name"><code>muted</code></td>
917
+
918
+
919
+ <td class="type">
920
+
921
+
922
+ <span class="param-type">boolean</span>
923
+
924
+
925
+
926
+
927
+ </td>
928
+
929
+
930
+ <td class="attributes">
931
+
932
+ &lt;optional&gt;<br>
933
+
934
+
935
+
936
+ </td>
937
+
938
+
939
+
940
+ <td class="default">
941
+
942
+ false
943
+
944
+ </td>
945
+
946
+
947
+ <td class="description last"><p>Whether the <a href="Worker.html">Worker</a> leg of the Conference is muted.</p></td>
948
+ </tr>
949
+
950
+
951
+
952
+ <tr>
953
+
954
+ <td class="name"><code>beep</code></td>
955
+
956
+
957
+ <td class="type">
958
+
959
+
960
+ <span class="param-type">string</span>
961
+ |
962
+
963
+ <span class="param-type">boolean</span>
964
+
965
+
966
+
967
+
968
+ </td>
969
+
970
+
971
+ <td class="attributes">
972
+
973
+ &lt;optional&gt;<br>
974
+
975
+
976
+
977
+ </td>
978
+
979
+
980
+
981
+ <td class="default">
982
+
983
+ true
984
+
985
+ </td>
986
+
987
+
988
+ <td class="description last"><p>Whether the <a href="Worker.html">Worker</a> leg should be when entering the Conference.
989
+ The options for beep are: [true, false, 'onEnter', 'onExit'].</p></td>
990
+ </tr>
991
+
992
+
993
+
994
+ <tr>
995
+
996
+ <td class="name"><code>startConferenceOnEnter</code></td>
997
+
998
+
999
+ <td class="type">
1000
+
1001
+
1002
+ <span class="param-type">boolean</span>
1003
+
1004
+
1005
+
1006
+
1007
+ </td>
1008
+
1009
+
1010
+ <td class="attributes">
1011
+
1012
+ &lt;optional&gt;<br>
1013
+
1014
+
1015
+
1016
+ </td>
1017
+
1018
+
1019
+
1020
+ <td class="default">
1021
+
1022
+ true
1023
+
1024
+ </td>
1025
+
1026
+
1027
+ <td class="description last"><p>Whether the Conference should start when the <a href="Worker.html">Worker</a> leg enters.</p></td>
1028
+ </tr>
1029
+
1030
+
1031
+
1032
+ <tr>
1033
+
1034
+ <td class="name"><code>endConferenceOnExit</code></td>
1035
+
1036
+
1037
+ <td class="type">
1038
+
1039
+
1040
+ <span class="param-type">boolean</span>
1041
+
1042
+
1043
+
1044
+
1045
+ </td>
1046
+
1047
+
1048
+ <td class="attributes">
1049
+
1050
+ &lt;optional&gt;<br>
1051
+
1052
+
1053
+
1054
+ </td>
1055
+
1056
+
1057
+
1058
+ <td class="default">
1059
+
1060
+ false
1061
+
1062
+ </td>
1063
+
1064
+
1065
+ <td class="description last"><p>Whether the Conference should end when the <a href="Worker.html">Worker</a> leg exits.</p></td>
1066
+ </tr>
1067
+
1068
+
1069
+
1070
+ <tr>
1071
+
1072
+ <td class="name"><code>endConferenceOnCustomerExit</code></td>
1073
+
1074
+
1075
+ <td class="type">
1076
+
1077
+
1078
+ <span class="param-type">boolean</span>
1079
+
1080
+
1081
+
1082
+
1083
+ </td>
1084
+
1085
+
1086
+ <td class="attributes">
1087
+
1088
+ &lt;optional&gt;<br>
1089
+
1090
+
1091
+
1092
+ </td>
1093
+
1094
+
1095
+
1096
+ <td class="default">
1097
+
1098
+ false
1099
+
1100
+ </td>
1101
+
1102
+
1103
+ <td class="description last"><p>Whether the Conference should end when the customer leg exits.</p></td>
1104
+ </tr>
1105
+
1106
+
1107
+
1108
+ <tr>
1109
+
1110
+ <td class="name"><code>beepOnCustomerEntrance</code></td>
1111
+
1112
+
1113
+ <td class="type">
1114
+
1115
+
1116
+ <span class="param-type">boolean</span>
1117
+
1118
+
1119
+
1120
+
1121
+ </td>
1122
+
1123
+
1124
+ <td class="attributes">
1125
+
1126
+ &lt;optional&gt;<br>
1127
+
1128
+
1129
+
1130
+ </td>
1131
+
1132
+
1133
+
1134
+ <td class="default">
1135
+
1136
+ true
1137
+
1138
+ </td>
1139
+
1140
+
1141
+ <td class="description last"><p>Whether the Conference should beep when the customer leg enters.</p></td>
1142
+ </tr>
1143
+
1144
+
1145
+
1146
+ <tr>
1147
+
1148
+ <td class="name"><code>waitUrl</code></td>
1149
+
1150
+
1151
+ <td class="type">
1152
+
1153
+
1154
+ <span class="param-type">string</span>
1155
+
1156
+
1157
+
1158
+
1159
+ </td>
1160
+
1161
+
1162
+ <td class="attributes">
1163
+
1164
+ &lt;optional&gt;<br>
1165
+
1166
+
1167
+
1168
+ </td>
1169
+
1170
+
1171
+
1172
+ <td class="default">
1173
+
1174
+ default Twilio hold music
1175
+
1176
+ </td>
1177
+
1178
+
1179
+ <td class="description last"><p>The URL endpoint to play when waiting for the Conference to begin.</p></td>
1180
+ </tr>
1181
+
1182
+
1183
+
1184
+ <tr>
1185
+
1186
+ <td class="name"><code>waitMethod</code></td>
1187
+
1188
+
1189
+ <td class="type">
1190
+
1191
+
1192
+ <span class="param-type">string</span>
1193
+
1194
+
1195
+
1196
+
1197
+ </td>
1198
+
1199
+
1200
+ <td class="attributes">
1201
+
1202
+ &lt;optional&gt;<br>
1203
+
1204
+
1205
+
1206
+ </td>
1207
+
1208
+
1209
+
1210
+ <td class="default">
1211
+
1212
+ 'POST'
1213
+
1214
+ </td>
1215
+
1216
+
1217
+ <td class="description last"><p>The HTTP method for the Wait URL.</p></td>
1218
+ </tr>
1219
+
1220
+
1221
+
1222
+ <tr>
1223
+
1224
+ <td class="name"><code>earlyMedia</code></td>
1225
+
1226
+
1227
+ <td class="type">
1228
+
1229
+
1230
+ <span class="param-type">boolean</span>
1231
+
1232
+
1233
+
1234
+
1235
+ </td>
1236
+
1237
+
1238
+ <td class="attributes">
1239
+
1240
+ &lt;optional&gt;<br>
1241
+
1242
+
1243
+
1244
+ </td>
1245
+
1246
+
1247
+
1248
+ <td class="default">
1249
+
1250
+ true
1251
+
1252
+ </td>
1253
+
1254
+
1255
+ <td class="description last"><p>Whether Twilio should feed early media to be played directly into a Conference.</p></td>
1256
+ </tr>
1257
+
1258
+
1259
+
1260
+ <tr>
1261
+
1262
+ <td class="name"><code>maxParticipants</code></td>
1263
+
1264
+
1265
+ <td class="type">
1266
+
1267
+
1268
+ <span class="param-type">number</span>
1269
+
1270
+
1271
+
1272
+
1273
+ </td>
1274
+
1275
+
1276
+ <td class="attributes">
1277
+
1278
+ &lt;optional&gt;<br>
1279
+
1280
+
1281
+
1282
+ </td>
1283
+
1284
+
1285
+
1286
+ <td class="default">
1287
+
1288
+ 10
1289
+
1290
+ </td>
1291
+
1292
+
1293
+ <td class="description last"><p>The number of max participants allowed in a Conference.</p></td>
1294
+ </tr>
1295
+
1296
+
1297
+
1298
+ <tr>
1299
+
1300
+ <td class="name"><code>conferenceStatusCallback</code></td>
1301
+
1302
+
1303
+ <td class="type">
1304
+
1305
+
1306
+ <span class="param-type">string</span>
1307
+
1308
+
1309
+
1310
+
1311
+ </td>
1312
+
1313
+
1314
+ <td class="attributes">
1315
+
1316
+ &lt;optional&gt;<br>
1317
+
1318
+
1319
+
1320
+ </td>
1321
+
1322
+
1323
+
1324
+ <td class="default">
1325
+
1326
+ null
1327
+
1328
+ </td>
1329
+
1330
+
1331
+ <td class="description last"><p>The URL endpoint to receive Conference status events.</p></td>
1332
+ </tr>
1333
+
1334
+
1335
+
1336
+ <tr>
1337
+
1338
+ <td class="name"><code>conferenceStatusCallbackMethod</code></td>
1339
+
1340
+
1341
+ <td class="type">
1342
+
1343
+
1344
+ <span class="param-type">string</span>
1345
+
1346
+
1347
+
1348
+
1349
+ </td>
1350
+
1351
+
1352
+ <td class="attributes">
1353
+
1354
+ &lt;optional&gt;<br>
1355
+
1356
+
1357
+
1358
+ </td>
1359
+
1360
+
1361
+
1362
+ <td class="default">
1363
+
1364
+ 'POST'
1365
+
1366
+ </td>
1367
+
1368
+
1369
+ <td class="description last"><p>The HTTP method for the Conference Status Callback URL.</p></td>
1370
+ </tr>
1371
+
1372
+
1373
+
1374
+ <tr>
1375
+
1376
+ <td class="name"><code>conferenceStatusCallbackEvent</code></td>
1377
+
1378
+
1379
+ <td class="type">
1380
+
1381
+
1382
+ <span class="param-type">string</span>
1383
+
1384
+
1385
+
1386
+
1387
+ </td>
1388
+
1389
+
1390
+ <td class="attributes">
1391
+
1392
+ &lt;optional&gt;<br>
1393
+
1394
+
1395
+
1396
+ </td>
1397
+
1398
+
1399
+
1400
+ <td class="default">
1401
+
1402
+ 'start,end'
1403
+
1404
+ </td>
1405
+
1406
+
1407
+ <td class="description last"><p>A comma separated list of Conference events to subscribe to.
1408
+ The possible list of events are: ['start', 'end', 'join', 'leave', 'mute', 'hold', 'speaker'].</p></td>
1409
+ </tr>
1410
+
1411
+
1412
+
1413
+ <tr>
1414
+
1415
+ <td class="name"><code>conferenceRecord</code></td>
1416
+
1417
+
1418
+ <td class="type">
1419
+
1420
+
1421
+ <span class="param-type">string</span>
1422
+ |
1423
+
1424
+ <span class="param-type">boolean</span>
1425
+
1426
+
1427
+
1428
+
1429
+ </td>
1430
+
1431
+
1432
+ <td class="attributes">
1433
+
1434
+ &lt;optional&gt;<br>
1435
+
1436
+
1437
+
1438
+ </td>
1439
+
1440
+
1441
+
1442
+ <td class="default">
1443
+
1444
+ false
1445
+
1446
+ </td>
1447
+
1448
+
1449
+ <td class="description last"><p>Whether the entire Conference should be recorded.
1450
+ The possible options for conferenceRecord are: [true, false, 'record-from-start', 'do-not-record'].</p></td>
1451
+ </tr>
1452
+
1453
+
1454
+
1455
+ <tr>
1456
+
1457
+ <td class="name"><code>conferenceTrim</code></td>
1458
+
1459
+
1460
+ <td class="type">
1461
+
1462
+
1463
+ <span class="param-type">string</span>
1464
+
1465
+
1466
+
1467
+
1468
+ </td>
1469
+
1470
+
1471
+ <td class="attributes">
1472
+
1473
+ &lt;optional&gt;<br>
1474
+
1475
+
1476
+
1477
+ </td>
1478
+
1479
+
1480
+
1481
+ <td class="default">
1482
+
1483
+ 'trim-silence'
1484
+
1485
+ </td>
1486
+
1487
+
1488
+ <td class="description last"><p>Whether to trim the Conference recording.
1489
+ The options for conferenceTrim are: ['trim-silence', 'do-not-trim'].</p></td>
1490
+ </tr>
1491
+
1492
+
1493
+
1494
+ <tr>
1495
+
1496
+ <td class="name"><code>recordingChannels</code></td>
1497
+
1498
+
1499
+ <td class="type">
1500
+
1501
+
1502
+ <span class="param-type">string</span>
1503
+
1504
+
1505
+
1506
+
1507
+ </td>
1508
+
1509
+
1510
+ <td class="attributes">
1511
+
1512
+ &lt;optional&gt;<br>
1513
+
1514
+
1515
+
1516
+ </td>
1517
+
1518
+
1519
+
1520
+ <td class="default">
1521
+
1522
+ 'mono'
1523
+
1524
+ </td>
1525
+
1526
+
1527
+ <td class="description last"><p>Which channel of the Conference to record. The options are: ['mono', 'dual'].</p></td>
1528
+ </tr>
1529
+
1530
+
1531
+
1532
+ <tr>
1533
+
1534
+ <td class="name"><code>recordingStatusCallback</code></td>
1535
+
1536
+
1537
+ <td class="type">
1538
+
1539
+
1540
+ <span class="param-type">string</span>
1541
+
1542
+
1543
+
1544
+
1545
+ </td>
1546
+
1547
+
1548
+ <td class="attributes">
1549
+
1550
+ &lt;optional&gt;<br>
1551
+
1552
+
1553
+
1554
+ </td>
1555
+
1556
+
1557
+
1558
+ <td class="default">
1559
+
1560
+ null
1561
+
1562
+ </td>
1563
+
1564
+
1565
+ <td class="description last"><p>The URL endpoint to receive recording status events.</p></td>
1566
+ </tr>
1567
+
1568
+
1569
+
1570
+ <tr>
1571
+
1572
+ <td class="name"><code>recordingStatusCallbackMethod</code></td>
1573
+
1574
+
1575
+ <td class="type">
1576
+
1577
+
1578
+ <span class="param-type">string</span>
1579
+
1580
+
1581
+
1582
+
1583
+ </td>
1584
+
1585
+
1586
+ <td class="attributes">
1587
+
1588
+ &lt;optional&gt;<br>
1589
+
1590
+
1591
+
1592
+ </td>
1593
+
1594
+
1595
+
1596
+ <td class="default">
1597
+
1598
+ 'POST'
1599
+
1600
+ </td>
1601
+
1602
+
1603
+ <td class="description last"><p>The HTTP method for the Recording Status Callback URL.</p></td>
1604
+ </tr>
1605
+
1606
+
1607
+
1608
+ <tr>
1609
+
1610
+ <td class="name"><code>conferenceRecordingStatusCallback</code></td>
1611
+
1612
+
1613
+ <td class="type">
1614
+
1615
+
1616
+ <span class="param-type">string</span>
1617
+
1618
+
1619
+
1620
+
1621
+ </td>
1622
+
1623
+
1624
+ <td class="attributes">
1625
+
1626
+ &lt;optional&gt;<br>
1627
+
1628
+
1629
+
1630
+ </td>
1631
+
1632
+
1633
+
1634
+ <td class="default">
1635
+
1636
+ null
1637
+
1638
+ </td>
1639
+
1640
+
1641
+ <td class="description last"><p>The URl endpoint to receive Conference events.</p></td>
1642
+ </tr>
1643
+
1644
+
1645
+
1646
+ <tr>
1647
+
1648
+ <td class="name"><code>conferenceRecordingStatusCallbackMethod</code></td>
1649
+
1650
+
1651
+ <td class="type">
1652
+
1653
+
1654
+ <span class="param-type">string</span>
1655
+
1656
+
1657
+
1658
+
1659
+ </td>
1660
+
1661
+
1662
+ <td class="attributes">
1663
+
1664
+ &lt;optional&gt;<br>
1665
+
1666
+
1667
+
1668
+ </td>
1669
+
1670
+
1671
+
1672
+ <td class="default">
1673
+
1674
+ 'POST'
1675
+
1676
+ </td>
1677
+
1678
+
1679
+ <td class="description last"><p>The HTTP method of the Conference Recording Status Callback.</p></td>
1680
+ </tr>
1681
+
1682
+
1683
+
1684
+ <tr>
1685
+
1686
+ <td class="name"><code>region</code></td>
1687
+
1688
+
1689
+ <td class="type">
1690
+
1691
+
1692
+ <span class="param-type">string</span>
1693
+
1694
+
1695
+
1696
+
1697
+ </td>
1698
+
1699
+
1700
+ <td class="attributes">
1701
+
1702
+ &lt;optional&gt;<br>
1703
+
1704
+
1705
+
1706
+ </td>
1707
+
1708
+
1709
+
1710
+ <td class="default">
1711
+
1712
+ null
1713
+
1714
+ </td>
1715
+
1716
+
1717
+ <td class="description last"><p>The specific region. The options for region are: ['us1', 'ie1', 'sg1', 'br1', 'au1', 'jp1'].</p></td>
1718
+ </tr>
1719
+
1720
+
1721
+
1722
+ <tr>
1723
+
1724
+ <td class="name"><code>sipAuthUsername</code></td>
1725
+
1726
+
1727
+ <td class="type">
1728
+
1729
+
1730
+ <span class="param-type">string</span>
1731
+
1732
+
1733
+
1734
+
1735
+ </td>
1736
+
1737
+
1738
+ <td class="attributes">
1739
+
1740
+ &lt;optional&gt;<br>
1741
+
1742
+
1743
+
1744
+ </td>
1745
+
1746
+
1747
+
1748
+ <td class="default">
1749
+
1750
+ null
1751
+
1752
+ </td>
1753
+
1754
+
1755
+ <td class="description last"><p>The SIP auth username to use.</p></td>
1756
+ </tr>
1757
+
1758
+
1759
+
1760
+ <tr>
1761
+
1762
+ <td class="name"><code>sipAuthPassword</code></td>
1763
+
1764
+
1765
+ <td class="type">
1766
+
1767
+
1768
+ <span class="param-type">string</span>
1769
+
1770
+
1771
+
1772
+
1773
+ </td>
1774
+
1775
+
1776
+ <td class="attributes">
1777
+
1778
+ &lt;optional&gt;<br>
1779
+
1780
+
1781
+
1782
+ </td>
1783
+
1784
+
1785
+
1786
+ <td class="default">
1787
+
1788
+ null
1789
+
1790
+ </td>
1791
+
1792
+
1793
+ <td class="description last"><p>The SIP auth password to use.</p></td>
1794
+ </tr>
1795
+
1796
+
1797
+ </tbody>
1798
+ </table>
1799
+ </dl>
1800
+
1801
+
1802
+
1803
+
1804
+
1805
+
1806
+
1807
+
1808
+
1809
+
1810
+
1811
+
1812
+
1813
+
1814
+
1815
+
1816
+
1817
+
1818
+
1819
+
1820
+
1821
+
1822
+
1823
+
1824
+
1825
+
1826
+
1827
+
1828
+
1829
+
1830
+
1831
+
1832
+
1833
+
1834
+
1835
+
1836
+ </dl>
1837
+
1838
+
1839
+
1840
+ </dd>
1841
+
1842
+
1843
+
1844
+ <hr>
1845
+ <dt class="name" id="DequeueOptions">
1846
+ <h4 id="DequeueOptions">DequeueOptions</h4>
1847
+
1848
+
1849
+ </dt>
1850
+ <dd>
1851
+
1852
+
1853
+
1854
+ <h5>Type:</h5>
1855
+ <ul>
1856
+ <li>
1857
+
1858
+ <span class="param-type">Object</span>
1859
+
1860
+
1861
+
1862
+ </li>
1863
+ </ul>
1864
+
1865
+
1866
+
1867
+ <dl class="details">
1868
+
1869
+
1870
+ <h5 class="subsection-title">Properties:</h5>
1871
+
1872
+ <dl>
1873
+
1874
+ <table class="props table table-striped">
1875
+ <thead>
1876
+ <tr>
1877
+
1878
+ <th>Name</th>
1879
+
1880
+
1881
+ <th>Type</th>
1882
+
1883
+
1884
+ <th>Argument</th>
1885
+
1886
+
1887
+
1888
+ <th>Default</th>
1889
+
1890
+
1891
+ <th class="last">Description</th>
1892
+ </tr>
1893
+ </thead>
1894
+
1895
+ <tbody>
1896
+
1897
+
1898
+ <tr>
1899
+
1900
+ <td class="name"><code>from</code></td>
1901
+
1902
+
1903
+ <td class="type">
1904
+
1905
+
1906
+ <span class="param-type">string</span>
1907
+
1908
+
1909
+
1910
+
1911
+ </td>
1912
+
1913
+
1914
+ <td class="attributes">
1915
+
1916
+ &lt;optional&gt;<br>
1917
+
1918
+
1919
+
1920
+ </td>
1921
+
1922
+
1923
+
1924
+ <td class="default">
1925
+
1926
+ null
1927
+
1928
+ </td>
1929
+
1930
+
1931
+ <td class="description last"><p>The caller id for the call to the <a href="Worker.html">Worker</a>.
1932
+ Must be a verified Twilio number.</p></td>
1933
+ </tr>
1934
+
1935
+
1936
+
1937
+ <tr>
1938
+
1939
+ <td class="name"><code>to</code></td>
1940
+
1941
+
1942
+ <td class="type">
1943
+
1944
+
1945
+ <span class="param-type">string</span>
1946
+
1947
+
1948
+
1949
+
1950
+ </td>
1951
+
1952
+
1953
+ <td class="attributes">
1954
+
1955
+ &lt;optional&gt;<br>
1956
+
1957
+
1958
+
1959
+ </td>
1960
+
1961
+
1962
+
1963
+ <td class="default">
1964
+
1965
+ null
1966
+
1967
+ </td>
1968
+
1969
+
1970
+ <td class="description last"><p>The contact uri of the <a href="Worker.html">Worker</a>; can be a phone
1971
+ number or a client ID. Required, if no contact_uri on the <a href="Worker.html">Worker</a>'s attributes.</p></td>
1972
+ </tr>
1973
+
1974
+
1975
+
1976
+ <tr>
1977
+
1978
+ <td class="name"><code>postWorkActivitySid</code></td>
1979
+
1980
+
1981
+ <td class="type">
1982
+
1983
+
1984
+ <span class="param-type">string</span>
1985
+
1986
+
1987
+
1988
+
1989
+ </td>
1990
+
1991
+
1992
+ <td class="attributes">
1993
+
1994
+ &lt;optional&gt;<br>
1995
+
1996
+
1997
+
1998
+ </td>
1999
+
2000
+
2001
+
2002
+ <td class="default">
2003
+
2004
+ null
2005
+
2006
+ </td>
2007
+
2008
+
2009
+ <td class="description last"><p>The activitySid to update the
2010
+ <a href="Worker.html">Worker</a> to after dequeuing the <a href="Reservation.html">Reservation</a>.</p></td>
2011
+ </tr>
2012
+
2013
+
2014
+
2015
+ <tr>
2016
+
2017
+ <td class="name"><code>record</code></td>
2018
+
2019
+
2020
+ <td class="type">
2021
+
2022
+
2023
+ <span class="param-type">string</span>
2024
+
2025
+
2026
+
2027
+
2028
+ </td>
2029
+
2030
+
2031
+ <td class="attributes">
2032
+
2033
+ &lt;optional&gt;<br>
2034
+
2035
+
2036
+
2037
+ </td>
2038
+
2039
+
2040
+
2041
+ <td class="default">
2042
+
2043
+ 'do-not-record'
2044
+
2045
+ </td>
2046
+
2047
+
2048
+ <td class="description last"><p>Defines which legs of the call
2049
+ should be recorded.</p></td>
2050
+ </tr>
2051
+
2052
+
2053
+
2054
+ <tr>
2055
+
2056
+ <td class="name"><code>timeout</code></td>
2057
+
2058
+
2059
+ <td class="type">
2060
+
2061
+
2062
+ <span class="param-type">number</span>
2063
+
2064
+
2065
+
2066
+
2067
+ </td>
2068
+
2069
+
2070
+ <td class="attributes">
2071
+
2072
+ &lt;optional&gt;<br>
2073
+
2074
+
2075
+
2076
+ </td>
2077
+
2078
+
2079
+
2080
+ <td class="default">
2081
+
2082
+ 60
2083
+
2084
+ </td>
2085
+
2086
+
2087
+ <td class="description last"><p>The integer number of seconds that
2088
+ Twilio should allow the call to ring before assuming there is no answer.</p></td>
2089
+ </tr>
2090
+
2091
+
2092
+
2093
+ <tr>
2094
+
2095
+ <td class="name"><code>statusCallbackUrl</code></td>
2096
+
2097
+
2098
+ <td class="type">
2099
+
2100
+
2101
+ <span class="param-type">string</span>
2102
+
2103
+
2104
+
2105
+
2106
+ </td>
2107
+
2108
+
2109
+ <td class="attributes">
2110
+
2111
+ &lt;optional&gt;<br>
2112
+
2113
+
2114
+
2115
+ </td>
2116
+
2117
+
2118
+
2119
+ <td class="default">
2120
+
2121
+ null
2122
+
2123
+ </td>
2124
+
2125
+
2126
+ <td class="description last"><p>A URL that Twilio will send
2127
+ asynchronous webhook this._request. to on a completed call event.</p></td>
2128
+ </tr>
2129
+
2130
+
2131
+
2132
+ <tr>
2133
+
2134
+ <td class="name"><code>statusCallbackEvents</code></td>
2135
+
2136
+
2137
+ <td class="type">
2138
+
2139
+
2140
+ <span class="param-type">string</span>
2141
+
2142
+
2143
+
2144
+
2145
+ </td>
2146
+
2147
+
2148
+ <td class="attributes">
2149
+
2150
+ &lt;optional&gt;<br>
2151
+
2152
+
2153
+
2154
+ </td>
2155
+
2156
+
2157
+
2158
+ <td class="default">
2159
+
2160
+ null
2161
+
2162
+ </td>
2163
+
2164
+
2165
+ <td class="description last"><p>A comma separated string of the events to subscribe to</p></td>
2166
+ </tr>
2167
+
2168
+
2169
+ </tbody>
2170
+ </table>
2171
+ </dl>
2172
+
2173
+
2174
+
2175
+
2176
+
2177
+
2178
+
2179
+
2180
+
2181
+
2182
+
2183
+
2184
+
2185
+
2186
+
2187
+
2188
+
2189
+
2190
+
2191
+
2192
+
2193
+
2194
+
2195
+
2196
+
2197
+
2198
+
2199
+
2200
+
2201
+
2202
+
2203
+
2204
+
2205
+
2206
+
2207
+
2208
+ </dl>
2209
+
2210
+
2211
+
2212
+ </dd>
2213
+
2214
+
2215
+
2216
+ <hr>
2217
+ <dt class="name" id="FetchTaskQueuesParams">
2218
+ <h4 id="FetchTaskQueuesParams">FetchTaskQueuesParams</h4>
2219
+
2220
+
2221
+ </dt>
2222
+ <dd>
2223
+
2224
+
2225
+
2226
+ <h5>Type:</h5>
2227
+ <ul>
2228
+ <li>
2229
+
2230
+ <span class="param-type">Object</span>
2231
+
2232
+
2233
+
2234
+ </li>
2235
+ </ul>
2236
+
2237
+
2238
+
2239
+ <dl class="details">
2240
+
2241
+
2242
+ <h5 class="subsection-title">Properties:</h5>
2243
+
2244
+ <dl>
2245
+
2246
+ <table class="props table table-striped">
2247
+ <thead>
2248
+ <tr>
2249
+
2250
+ <th>Name</th>
2251
+
2252
+
2253
+ <th>Type</th>
2254
+
2255
+
2256
+ <th>Argument</th>
2257
+
2258
+
2259
+
2260
+
2261
+ <th class="last">Description</th>
2262
+ </tr>
2263
+ </thead>
2264
+
2265
+ <tbody>
2266
+
2267
+
2268
+ <tr>
2269
+
2270
+ <td class="name"><code>AfterSid</code></td>
2271
+
2272
+
2273
+ <td class="type">
2274
+
2275
+
2276
+ <span class="param-type">string</span>
2277
+
2278
+
2279
+
2280
+
2281
+ </td>
2282
+
2283
+
2284
+ <td class="attributes">
2285
+
2286
+ &lt;optional&gt;<br>
2287
+
2288
+
2289
+
2290
+ </td>
2291
+
2292
+
2293
+
2294
+
2295
+ <td class="description last"></td>
2296
+ </tr>
2297
+
2298
+
2299
+
2300
+ <tr>
2301
+
2302
+ <td class="name"><code>FriendlyName</code></td>
2303
+
2304
+
2305
+ <td class="type">
2306
+
2307
+
2308
+ <span class="param-type">string</span>
2309
+
2310
+
2311
+
2312
+
2313
+ </td>
2314
+
2315
+
2316
+ <td class="attributes">
2317
+
2318
+ &lt;optional&gt;<br>
2319
+
2320
+
2321
+
2322
+ </td>
2323
+
2324
+
2325
+
2326
+
2327
+ <td class="description last"></td>
2328
+ </tr>
2329
+
2330
+
2331
+
2332
+ <tr>
2333
+
2334
+ <td class="name"><code>Ordering</code></td>
2335
+
2336
+
2337
+ <td class="type">
2338
+
2339
+
2340
+ <span class="param-type">"DateUpdated:asc"</span>
2341
+ |
2342
+
2343
+ <span class="param-type">"DateUpdated:desc"</span>
2344
+
2345
+
2346
+
2347
+
2348
+ </td>
2349
+
2350
+
2351
+ <td class="attributes">
2352
+
2353
+ &lt;optional&gt;<br>
2354
+
2355
+
2356
+
2357
+ </td>
2358
+
2359
+
2360
+
2361
+
2362
+ <td class="description last"></td>
2363
+ </tr>
2364
+
2365
+
2366
+ </tbody>
2367
+ </table>
2368
+ </dl>
2369
+
2370
+
2371
+
2372
+
2373
+
2374
+
2375
+
2376
+
2377
+
2378
+
2379
+
2380
+
2381
+
2382
+
2383
+
2384
+
2385
+
2386
+
2387
+
2388
+
2389
+
2390
+
2391
+
2392
+
2393
+
2394
+
2395
+
2396
+
2397
+
2398
+
2399
+
2400
+
2401
+
2402
+
2403
+
2404
+
2405
+ </dl>
2406
+
2407
+
2408
+
2409
+ </dd>
2410
+
2411
+
2412
+
2413
+ <hr>
2414
+ <dt class="name" id="FetchWorkersParams">
2415
+ <h4 id="FetchWorkersParams">FetchWorkersParams</h4>
2416
+
2417
+
2418
+ </dt>
2419
+ <dd>
2420
+
2421
+
2422
+
2423
+ <h5>Type:</h5>
2424
+ <ul>
2425
+ <li>
2426
+
2427
+ <span class="param-type">Object</span>
2428
+
2429
+
2430
+
2431
+ </li>
2432
+ </ul>
2433
+
2434
+
2435
+
2436
+ <dl class="details">
2437
+
2438
+
2439
+ <h5 class="subsection-title">Properties:</h5>
2440
+
2441
+ <dl>
2442
+
2443
+ <table class="props table table-striped">
2444
+ <thead>
2445
+ <tr>
2446
+
2447
+ <th>Name</th>
2448
+
2449
+
2450
+ <th>Type</th>
2451
+
2452
+
2453
+ <th>Argument</th>
2454
+
2455
+
2456
+
2457
+
2458
+ <th class="last">Description</th>
2459
+ </tr>
2460
+ </thead>
2461
+
2462
+ <tbody>
2463
+
2464
+
2465
+ <tr>
2466
+
2467
+ <td class="name"><code>AfterSid</code></td>
2468
+
2469
+
2470
+ <td class="type">
2471
+
2472
+
2473
+ <span class="param-type">string</span>
2474
+
2475
+
2476
+
2477
+
2478
+ </td>
2479
+
2480
+
2481
+ <td class="attributes">
2482
+
2483
+ &lt;optional&gt;<br>
2484
+
2485
+
2486
+
2487
+ </td>
2488
+
2489
+
2490
+
2491
+
2492
+ <td class="description last"></td>
2493
+ </tr>
2494
+
2495
+
2496
+
2497
+ <tr>
2498
+
2499
+ <td class="name"><code>FriendlyName</code></td>
2500
+
2501
+
2502
+ <td class="type">
2503
+
2504
+
2505
+ <span class="param-type">string</span>
2506
+
2507
+
2508
+
2509
+
2510
+ </td>
2511
+
2512
+
2513
+ <td class="attributes">
2514
+
2515
+ &lt;optional&gt;<br>
2516
+
2517
+
2518
+
2519
+ </td>
2520
+
2521
+
2522
+
2523
+
2524
+ <td class="description last"></td>
2525
+ </tr>
2526
+
2527
+
2528
+
2529
+ <tr>
2530
+
2531
+ <td class="name"><code>ActivitySid</code></td>
2532
+
2533
+
2534
+ <td class="type">
2535
+
2536
+
2537
+ <span class="param-type">string</span>
2538
+
2539
+
2540
+
2541
+
2542
+ </td>
2543
+
2544
+
2545
+ <td class="attributes">
2546
+
2547
+ &lt;optional&gt;<br>
2548
+
2549
+
2550
+
2551
+ </td>
2552
+
2553
+
2554
+
2555
+
2556
+ <td class="description last"></td>
2557
+ </tr>
2558
+
2559
+
2560
+
2561
+ <tr>
2562
+
2563
+ <td class="name"><code>ActivityName</code></td>
2564
+
2565
+
2566
+ <td class="type">
2567
+
2568
+
2569
+ <span class="param-type">string</span>
2570
+
2571
+
2572
+
2573
+
2574
+ </td>
2575
+
2576
+
2577
+ <td class="attributes">
2578
+
2579
+ &lt;optional&gt;<br>
2580
+
2581
+
2582
+
2583
+ </td>
2584
+
2585
+
2586
+
2587
+
2588
+ <td class="description last"></td>
2589
+ </tr>
2590
+
2591
+
2592
+
2593
+ <tr>
2594
+
2595
+ <td class="name"><code>TargetWorkersExpression</code></td>
2596
+
2597
+
2598
+ <td class="type">
2599
+
2600
+
2601
+ <span class="param-type">string</span>
2602
+
2603
+
2604
+
2605
+
2606
+ </td>
2607
+
2608
+
2609
+ <td class="attributes">
2610
+
2611
+ &lt;optional&gt;<br>
2612
+
2613
+
2614
+
2615
+ </td>
2616
+
2617
+
2618
+
2619
+
2620
+ <td class="description last"></td>
2621
+ </tr>
2622
+
2623
+
2624
+
2625
+ <tr>
2626
+
2627
+ <td class="name"><code>Ordering</code></td>
2628
+
2629
+
2630
+ <td class="type">
2631
+
2632
+
2633
+ <span class="param-type">"DateStatusChanged:asc"</span>
2634
+ |
2635
+
2636
+ <span class="param-type">"DateStatusChanged:desc"</span>
2637
+
2638
+
2639
+
2640
+
2641
+ </td>
2642
+
2643
+
2644
+ <td class="attributes">
2645
+
2646
+ &lt;optional&gt;<br>
2647
+
2648
+
2649
+
2650
+ </td>
2651
+
2652
+
2653
+
2654
+
2655
+ <td class="description last"></td>
2656
+ </tr>
2657
+
2658
+
2659
+
2660
+ <tr>
2661
+
2662
+ <td class="name"><code>MaxWorkers</code></td>
2663
+
2664
+
2665
+ <td class="type">
2666
+
2667
+
2668
+ <span class="param-type">number</span>
2669
+
2670
+
2671
+
2672
+
2673
+ </td>
2674
+
2675
+
2676
+ <td class="attributes">
2677
+
2678
+ &lt;optional&gt;<br>
2679
+
2680
+
2681
+
2682
+ </td>
2683
+
2684
+
2685
+
2686
+
2687
+ <td class="description last"></td>
2688
+ </tr>
2689
+
2690
+
2691
+ </tbody>
2692
+ </table>
2693
+ </dl>
2694
+
2695
+
2696
+
2697
+
2698
+
2699
+
2700
+
2701
+
2702
+
2703
+
2704
+
2705
+
2706
+
2707
+
2708
+
2709
+
2710
+
2711
+
2712
+
2713
+
2714
+
2715
+
2716
+
2717
+
2718
+
2719
+
2720
+
2721
+
2722
+
2723
+
2724
+
2725
+
2726
+
2727
+
2728
+
2729
+
2730
+ </dl>
2731
+
2732
+
2733
+
2734
+ </dd>
2735
+
2736
+
2737
+
2738
+ <hr>
2739
+ <dt class="name" id="HoldOptions">
2740
+ <h4 id="HoldOptions">HoldOptions</h4>
2741
+
2742
+
2743
+ </dt>
2744
+ <dd>
2745
+
2746
+
2747
+
2748
+ <h5>Type:</h5>
2749
+ <ul>
2750
+ <li>
2751
+
2752
+ <span class="param-type">Object</span>
2753
+
2754
+
2755
+
2756
+ </li>
2757
+ </ul>
2758
+
2759
+
2760
+
2761
+ <dl class="details">
2762
+
2763
+
2764
+ <h5 class="subsection-title">Properties:</h5>
2765
+
2766
+ <dl>
2767
+
2768
+ <table class="props table table-striped">
2769
+ <thead>
2770
+ <tr>
2771
+
2772
+ <th>Name</th>
2773
+
2774
+
2775
+ <th>Type</th>
2776
+
2777
+
2778
+
2779
+
2780
+
2781
+ <th class="last">Description</th>
2782
+ </tr>
2783
+ </thead>
2784
+
2785
+ <tbody>
2786
+
2787
+
2788
+ <tr>
2789
+
2790
+ <td class="name"><code>holdUrl</code></td>
2791
+
2792
+
2793
+ <td class="type">
2794
+
2795
+
2796
+ <span class="param-type">string</span>
2797
+
2798
+
2799
+
2800
+
2801
+ </td>
2802
+
2803
+
2804
+
2805
+
2806
+
2807
+ <td class="description last"><p>The URL endpoint to play when participant is on hold.</p></td>
2808
+ </tr>
2809
+
2810
+
2811
+
2812
+ <tr>
2813
+
2814
+ <td class="name"><code>holdMethod</code></td>
2815
+
2816
+
2817
+ <td class="type">
2818
+
2819
+
2820
+ <span class="param-type">'GET'</span>
2821
+
2822
+
2823
+
2824
+
2825
+ </td>
2826
+
2827
+
2828
+
2829
+
2830
+
2831
+ <td class="description last"><p>The HTTP method for the hold URL.</p></td>
2832
+ </tr>
2833
+
2834
+
2835
+ </tbody>
2836
+ </table>
2837
+ </dl>
2838
+
2839
+
2840
+
2841
+
2842
+
2843
+
2844
+
2845
+
2846
+
2847
+
2848
+
2849
+
2850
+
2851
+
2852
+
2853
+
2854
+
2855
+
2856
+
2857
+
2858
+
2859
+
2860
+
2861
+
2862
+
2863
+
2864
+
2865
+
2866
+
2867
+
2868
+
2869
+
2870
+
2871
+
2872
+
2873
+
2874
+ </dl>
2875
+
2876
+
2877
+
2878
+ </dd>
2879
+
2880
+
2881
+
2882
+ <hr>
2883
+ <dt class="name" id="RedirectOptions">
2884
+ <h4 id="RedirectOptions">RedirectOptions</h4>
2885
+
2886
+
2887
+ </dt>
2888
+ <dd>
2889
+
2890
+
2891
+
2892
+ <h5>Type:</h5>
2893
+ <ul>
2894
+ <li>
2895
+
2896
+ <span class="param-type">Object</span>
2897
+
2898
+
2899
+
2900
+ </li>
2901
+ </ul>
2902
+
2903
+
2904
+
2905
+ <dl class="details">
2906
+
2907
+
2908
+ <h5 class="subsection-title">Properties:</h5>
2909
+
2910
+ <dl>
2911
+
2912
+ <table class="props table table-striped">
2913
+ <thead>
2914
+ <tr>
2915
+
2916
+ <th>Name</th>
2917
+
2918
+
2919
+ <th>Type</th>
2920
+
2921
+
2922
+ <th>Argument</th>
2923
+
2924
+
2925
+
2926
+ <th>Default</th>
2927
+
2928
+
2929
+ <th class="last">Description</th>
2930
+ </tr>
2931
+ </thead>
2932
+
2933
+ <tbody>
2934
+
2935
+
2936
+ <tr>
2937
+
2938
+ <td class="name"><code>accept</code></td>
2939
+
2940
+
2941
+ <td class="type">
2942
+
2943
+
2944
+ <span class="param-type">boolean</span>
2945
+
2946
+
2947
+
2948
+
2949
+ </td>
2950
+
2951
+
2952
+ <td class="attributes">
2953
+
2954
+ &lt;optional&gt;<br>
2955
+
2956
+
2957
+
2958
+ </td>
2959
+
2960
+
2961
+
2962
+ <td class="default">
2963
+
2964
+ false
2965
+
2966
+ </td>
2967
+
2968
+
2969
+ <td class="description last"><p>Represents whether the <a href="Task.html">Task</a> should be
2970
+ accepted before initiating the call</p></td>
2971
+ </tr>
2972
+
2973
+
2974
+ </tbody>
2975
+ </table>
2976
+ </dl>
2977
+
2978
+
2979
+
2980
+
2981
+
2982
+
2983
+
2984
+
2985
+
2986
+
2987
+
2988
+
2989
+
2990
+
2991
+
2992
+
2993
+
2994
+
2995
+
2996
+
2997
+
2998
+
2999
+
3000
+
3001
+
3002
+
3003
+
3004
+
3005
+
3006
+
3007
+
3008
+
3009
+
3010
+
3011
+
3012
+
3013
+ </dl>
3014
+
3015
+
3016
+
3017
+ </dd>
3018
+
3019
+
3020
+
3021
+ <hr>
3022
+ <dt class="name" id="RejectOptions">
3023
+ <h4 id="RejectOptions">RejectOptions</h4>
3024
+
3025
+
3026
+ </dt>
3027
+ <dd>
3028
+
3029
+
3030
+
3031
+ <h5>Type:</h5>
3032
+ <ul>
3033
+ <li>
3034
+
3035
+ <span class="param-type">Object</span>
3036
+
3037
+
3038
+
3039
+ </li>
3040
+ </ul>
3041
+
3042
+
3043
+
3044
+ <dl class="details">
3045
+
3046
+
3047
+ <h5 class="subsection-title">Properties:</h5>
3048
+
3049
+ <dl>
3050
+
3051
+ <table class="props table table-striped">
3052
+ <thead>
3053
+ <tr>
3054
+
3055
+ <th>Name</th>
3056
+
3057
+
3058
+ <th>Type</th>
3059
+
3060
+
3061
+
3062
+
3063
+
3064
+ <th class="last">Description</th>
3065
+ </tr>
3066
+ </thead>
3067
+
3068
+ <tbody>
3069
+
3070
+
3071
+ <tr>
3072
+
3073
+ <td class="name"><code>activitySid</code></td>
3074
+
3075
+
3076
+ <td class="type">
3077
+
3078
+
3079
+ <span class="param-type">string</span>
3080
+
3081
+
3082
+
3083
+
3084
+ </td>
3085
+
3086
+
3087
+
3088
+
3089
+
3090
+ <td class="description last"><p>The sid of the <a href="Activity.html">Activity</a> to update the worker to
3091
+ upon rejecting the <a href="Reservation.html">Reservation</a></p></td>
3092
+ </tr>
3093
+
3094
+
3095
+ </tbody>
3096
+ </table>
3097
+ </dl>
3098
+
3099
+
3100
+
3101
+
3102
+
3103
+
3104
+
3105
+
3106
+
3107
+
3108
+
3109
+
3110
+
3111
+
3112
+
3113
+
3114
+
3115
+
3116
+
3117
+
3118
+
3119
+
3120
+
3121
+
3122
+
3123
+
3124
+
3125
+
3126
+
3127
+
3128
+
3129
+
3130
+
3131
+
3132
+
3133
+
3134
+ </dl>
3135
+
3136
+
3137
+
3138
+ </dd>
3139
+
3140
+
3141
+
3142
+ <hr>
3143
+ <dt class="name" id="ReservationParticipantOptions">
3144
+ <h4 id="ReservationParticipantOptions">ReservationParticipantOptions</h4>
3145
+
3146
+
3147
+ </dt>
3148
+ <dd>
3149
+
3150
+
3151
+
3152
+ <h5>Type:</h5>
3153
+ <ul>
3154
+ <li>
3155
+
3156
+ <span class="param-type">Object</span>
3157
+
3158
+
3159
+
3160
+ </li>
3161
+ </ul>
3162
+
3163
+
3164
+
3165
+ <dl class="details">
3166
+
3167
+
3168
+ <h5 class="subsection-title">Properties:</h5>
3169
+
3170
+ <dl>
3171
+
3172
+ <table class="props table table-striped">
3173
+ <thead>
3174
+ <tr>
3175
+
3176
+ <th>Name</th>
3177
+
3178
+
3179
+ <th>Type</th>
3180
+
3181
+
3182
+
3183
+
3184
+
3185
+ <th class="last">Description</th>
3186
+ </tr>
3187
+ </thead>
3188
+
3189
+ <tbody>
3190
+
3191
+
3192
+ <tr>
3193
+
3194
+ <td class="name"><code>endConferenceOnExit</code></td>
3195
+
3196
+
3197
+ <td class="type">
3198
+
3199
+
3200
+ <span class="param-type">boolean</span>
3201
+
3202
+
3203
+
3204
+
3205
+ </td>
3206
+
3207
+
3208
+
3209
+
3210
+
3211
+ <td class="description last"><p>Whether the Conference should end when this <a href="Worker.html">Worker</a> participant leaves the Conference</p></td>
3212
+ </tr>
3213
+
3214
+
3215
+
3216
+ <tr>
3217
+
3218
+ <td class="name"><code>mute</code></td>
3219
+
3220
+
3221
+ <td class="type">
3222
+
3223
+
3224
+ <span class="param-type">boolean</span>
3225
+
3226
+
3227
+
3228
+
3229
+ </td>
3230
+
3231
+
3232
+
3233
+
3234
+
3235
+ <td class="description last"><p>Mute or unmute this <a href="Worker.html">Worker</a> participant</p></td>
3236
+ </tr>
3237
+
3238
+
3239
+
3240
+ <tr>
3241
+
3242
+ <td class="name"><code>beepOnExit</code></td>
3243
+
3244
+
3245
+ <td class="type">
3246
+
3247
+
3248
+ <span class="param-type">boolean</span>
3249
+
3250
+
3251
+
3252
+
3253
+ </td>
3254
+
3255
+
3256
+
3257
+
3258
+
3259
+ <td class="description last"><p>Whether there should be a beep sound when this <a href="Worker.html">Worker</a> participant leaves the Conference</p></td>
3260
+ </tr>
3261
+
3262
+
3263
+ </tbody>
3264
+ </table>
3265
+ </dl>
3266
+
3267
+
3268
+
3269
+
3270
+
3271
+
3272
+
3273
+
3274
+
3275
+
3276
+
3277
+
3278
+
3279
+
3280
+
3281
+
3282
+
3283
+
3284
+
3285
+
3286
+
3287
+
3288
+
3289
+
3290
+
3291
+
3292
+
3293
+
3294
+
3295
+
3296
+
3297
+
3298
+
3299
+
3300
+
3301
+
3302
+ </dl>
3303
+
3304
+
3305
+
3306
+ </dd>
3307
+
3308
+
3309
+
3310
+ <hr>
3311
+ <dt class="name" id="TaskParticipantOptions">
3312
+ <h4 id="TaskParticipantOptions">TaskParticipantOptions</h4>
3313
+
3314
+
3315
+ </dt>
3316
+ <dd>
3317
+
3318
+
3319
+
3320
+ <h5>Type:</h5>
3321
+ <ul>
3322
+ <li>
3323
+
3324
+ <span class="param-type">Object</span>
3325
+
3326
+
3327
+
3328
+ </li>
3329
+ </ul>
3330
+
3331
+
3332
+
3333
+ <dl class="details">
3334
+
3335
+
3336
+ <h5 class="subsection-title">Properties:</h5>
3337
+
3338
+ <dl>
3339
+
3340
+ <table class="props table table-striped">
3341
+ <thead>
3342
+ <tr>
3343
+
3344
+ <th>Name</th>
3345
+
3346
+
3347
+ <th>Type</th>
3348
+
3349
+
3350
+
3351
+
3352
+
3353
+ <th class="last">Description</th>
3354
+ </tr>
3355
+ </thead>
3356
+
3357
+ <tbody>
3358
+
3359
+
3360
+ <tr>
3361
+
3362
+ <td class="name"><code>hold</code></td>
3363
+
3364
+
3365
+ <td class="type">
3366
+
3367
+
3368
+ <span class="param-type">boolean</span>
3369
+
3370
+
3371
+
3372
+
3373
+ </td>
3374
+
3375
+
3376
+
3377
+
3378
+
3379
+ <td class="description last"><p>Whether to hold the customer leg of the Conference referenced by the <a href="Task.html">Task</a></p></td>
3380
+ </tr>
3381
+
3382
+
3383
+
3384
+ <tr>
3385
+
3386
+ <td class="name"><code>holdUrl</code></td>
3387
+
3388
+
3389
+ <td class="type">
3390
+
3391
+
3392
+ <span class="param-type">string</span>
3393
+
3394
+
3395
+
3396
+
3397
+ </td>
3398
+
3399
+
3400
+
3401
+
3402
+
3403
+ <td class="description last"><p>The URL endpoint to play when participant is on hold.</p></td>
3404
+ </tr>
3405
+
3406
+
3407
+
3408
+ <tr>
3409
+
3410
+ <td class="name"><code>holdMethod</code></td>
3411
+
3412
+
3413
+ <td class="type">
3414
+
3415
+
3416
+ <span class="param-type">'GET'</span>
3417
+
3418
+
3419
+
3420
+
3421
+ </td>
3422
+
3423
+
3424
+
3425
+
3426
+
3427
+ <td class="description last"><p>The HTTP method for the hold URL.</p></td>
3428
+ </tr>
3429
+
3430
+
3431
+ </tbody>
3432
+ </table>
3433
+ </dl>
3434
+
3435
+
3436
+
3437
+
3438
+
3439
+
3440
+
3441
+
3442
+
3443
+
3444
+
3445
+
3446
+
3447
+
3448
+
3449
+
3450
+
3451
+
3452
+
3453
+
3454
+
3455
+
3456
+
3457
+
3458
+
3459
+
3460
+
3461
+
3462
+
3463
+
3464
+
3465
+
3466
+
3467
+
3468
+
3469
+
3470
+ </dl>
3471
+
3472
+
3473
+
3474
+ </dd>
3475
+
3476
+
3477
+
3478
+ <hr>
3479
+ <dt class="name" id="TransferOptions">
3480
+ <h4 id="TransferOptions">TransferOptions</h4>
3481
+
3482
+
3483
+ </dt>
3484
+ <dd>
3485
+
3486
+
3487
+
3488
+ <h5>Type:</h5>
3489
+ <ul>
3490
+ <li>
3491
+
3492
+ <span class="param-type">Object</span>
3493
+
3494
+
3495
+
3496
+ </li>
3497
+ </ul>
3498
+
3499
+
3500
+
3501
+ <dl class="details">
3502
+
3503
+
3504
+ <h5 class="subsection-title">Properties:</h5>
3505
+
3506
+ <dl>
3507
+
3508
+ <table class="props table table-striped">
3509
+ <thead>
3510
+ <tr>
3511
+
3512
+ <th>Name</th>
3513
+
3514
+
3515
+ <th>Type</th>
3516
+
3517
+
3518
+
3519
+
3520
+ <th>Default</th>
3521
+
3522
+
3523
+ <th class="last">Description</th>
3524
+ </tr>
3525
+ </thead>
3526
+
3527
+ <tbody>
3528
+
3529
+
3530
+ <tr>
3531
+
3532
+ <td class="name"><code>attributes</code></td>
3533
+
3534
+
3535
+ <td class="type">
3536
+
3537
+
3538
+ <span class="param-type">Record.&lt;any, any&gt;</span>
3539
+
3540
+
3541
+
3542
+
3543
+ </td>
3544
+
3545
+
3546
+
3547
+
3548
+ <td class="default">
3549
+
3550
+ </td>
3551
+
3552
+
3553
+ <td class="description last"><p>Updated attributes for the task</p></td>
3554
+ </tr>
3555
+
3556
+
3557
+
3558
+ <tr>
3559
+
3560
+ <td class="name"><code>mode</code></td>
3561
+
3562
+
3563
+ <td class="type">
3564
+
3565
+
3566
+ <span class="param-type">'WARM'</span>
3567
+ |
3568
+
3569
+ <span class="param-type">'COLD'</span>
3570
+
3571
+
3572
+
3573
+
3574
+ </td>
3575
+
3576
+
3577
+
3578
+
3579
+ <td class="default">
3580
+
3581
+ 'WARM'
3582
+
3583
+ </td>
3584
+
3585
+
3586
+ <td class="description last"><p>'WARM' or 'COLD'</p></td>
3587
+ </tr>
3588
+
3589
+
3590
+
3591
+ <tr>
3592
+
3593
+ <td class="name"><code>priority</code></td>
3594
+
3595
+
3596
+ <td class="type">
3597
+
3598
+
3599
+ <span class="param-type">number</span>
3600
+
3601
+
3602
+
3603
+
3604
+ </td>
3605
+
3606
+
3607
+
3608
+
3609
+ <td class="default">
3610
+
3611
+ </td>
3612
+
3613
+
3614
+ <td class="description last"><p>Updated priority for the task</p></td>
3615
+ </tr>
3616
+
3617
+
3618
+ </tbody>
3619
+ </table>
3620
+ </dl>
3621
+
3622
+
3623
+
3624
+
3625
+
3626
+
3627
+
3628
+
3629
+
3630
+
3631
+
3632
+
3633
+
3634
+
3635
+
3636
+
3637
+
3638
+
3639
+
3640
+
3641
+
3642
+
3643
+
3644
+
3645
+
3646
+
3647
+
3648
+
3649
+
3650
+
3651
+
3652
+
3653
+
3654
+
3655
+
3656
+
3657
+ </dl>
3658
+
3659
+
3660
+
3661
+ </dd>
3662
+
3663
+
3664
+
3665
+ <hr>
3666
+ <dt class="name" id="WorkerDeps">
3667
+ <h4 id="WorkerDeps">WorkerDeps</h4>
3668
+
3669
+
3670
+ </dt>
3671
+ <dd>
3672
+
3673
+
3674
+
3675
+ <h5>Type:</h5>
3676
+ <ul>
3677
+ <li>
3678
+
3679
+ <span class="param-type">Object</span>
3680
+
3681
+
3682
+
3683
+ </li>
3684
+ </ul>
3685
+
3686
+
3687
+
3688
+ <dl class="details">
3689
+
3690
+
3691
+ <h5 class="subsection-title">Properties:</h5>
3692
+
3693
+ <dl>
3694
+
3695
+ <table class="props table table-striped">
3696
+ <thead>
3697
+ <tr>
3698
+
3699
+ <th>Name</th>
3700
+
3701
+
3702
+ <th>Type</th>
3703
+
3704
+
3705
+
3706
+
3707
+
3708
+ <th class="last">Description</th>
3709
+ </tr>
3710
+ </thead>
3711
+
3712
+ <tbody>
3713
+
3714
+
3715
+ <tr>
3716
+
3717
+ <td class="name"><code>Request</code></td>
3718
+
3719
+
3720
+ <td class="type">
3721
+
3722
+
3723
+ <span class="param-type">Request</span>
3724
+
3725
+
3726
+
3727
+
3728
+ </td>
3729
+
3730
+
3731
+
3732
+
3733
+
3734
+ <td class="description last"></td>
3735
+ </tr>
3736
+
3737
+
3738
+
3739
+ <tr>
3740
+
3741
+ <td class="name"><code>EventBridgeSignaling</code></td>
3742
+
3743
+
3744
+ <td class="type">
3745
+
3746
+
3747
+ <span class="param-type">EventBridgeSignaling</span>
3748
+
3749
+
3750
+
3751
+
3752
+ </td>
3753
+
3754
+
3755
+
3756
+
3757
+
3758
+ <td class="description last"></td>
3759
+ </tr>
3760
+
3761
+
3762
+ </tbody>
3763
+ </table>
3764
+ </dl>
3765
+
3766
+
3767
+
3768
+
3769
+
3770
+
3771
+
3772
+
3773
+
3774
+
3775
+
3776
+
3777
+
3778
+
3779
+
3780
+
3781
+
3782
+
3783
+
3784
+
3785
+
3786
+
3787
+
3788
+
3789
+
3790
+
3791
+
3792
+
3793
+
3794
+
3795
+
3796
+
3797
+
3798
+
3799
+
3800
+
3801
+ </dl>
3802
+
3803
+
3804
+
3805
+ </dd>
3806
+
3807
+
3808
+
3809
+ <hr>
3810
+ <dt class="name" id="WorkerOptions">
3811
+ <h4 id="WorkerOptions">WorkerOptions</h4>
3812
+
3813
+
3814
+ </dt>
3815
+ <dd>
3816
+
3817
+
3818
+
3819
+ <h5>Type:</h5>
3820
+ <ul>
3821
+ <li>
3822
+
3823
+ <span class="param-type">Object</span>
3824
+
3825
+
3826
+
3827
+ </li>
3828
+ </ul>
3829
+
3830
+
3831
+
3832
+ <dl class="details">
3833
+
3834
+
3835
+ <h5 class="subsection-title">Properties:</h5>
3836
+
3837
+ <dl>
3838
+
3839
+ <table class="props table table-striped">
3840
+ <thead>
3841
+ <tr>
3842
+
3843
+ <th>Name</th>
3844
+
3845
+
3846
+ <th>Type</th>
3847
+
3848
+
3849
+ <th>Argument</th>
3850
+
3851
+
3852
+
3853
+ <th>Default</th>
3854
+
3855
+
3856
+ <th class="last">Description</th>
3857
+ </tr>
3858
+ </thead>
3859
+
3860
+ <tbody>
3861
+
3862
+
3863
+ <tr>
3864
+
3865
+ <td class="name"><code>connectActivitySid</code></td>
3866
+
3867
+
3868
+ <td class="type">
3869
+
3870
+
3871
+ <span class="param-type">string</span>
3872
+
3873
+
3874
+
3875
+
3876
+ </td>
3877
+
3878
+
3879
+ <td class="attributes">
3880
+
3881
+ &lt;optional&gt;<br>
3882
+
3883
+
3884
+
3885
+ </td>
3886
+
3887
+
3888
+
3889
+ <td class="default">
3890
+
3891
+ ''
3892
+
3893
+ </td>
3894
+
3895
+
3896
+ <td class="description last"><p>The <a href="Activity.html">Activity</a> state of the Worker upon connect</p></td>
3897
+ </tr>
3898
+
3899
+
3900
+
3901
+ <tr>
3902
+
3903
+ <td class="name"><code>closeExistingSessions</code></td>
3904
+
3905
+
3906
+ <td class="type">
3907
+
3908
+
3909
+ <span class="param-type">boolean</span>
3910
+
3911
+
3912
+
3913
+
3914
+ </td>
3915
+
3916
+
3917
+ <td class="attributes">
3918
+
3919
+ &lt;optional&gt;<br>
3920
+
3921
+
3922
+
3923
+ </td>
3924
+
3925
+
3926
+
3927
+ <td class="default">
3928
+
3929
+ false
3930
+
3931
+ </td>
3932
+
3933
+
3934
+ <td class="description last"><ul>
3935
+ <li>Whether other open sessions of this <a href="Worker.html">Worker</a>
3936
+ should be terminated</li>
3937
+ </ul></td>
3938
+ </tr>
3939
+
3940
+
3941
+
3942
+ <tr>
3943
+
3944
+ <td class="name"><code>logLevel</code></td>
3945
+
3946
+
3947
+ <td class="type">
3948
+
3949
+
3950
+ <span class="param-type">string</span>
3951
+
3952
+
3953
+
3954
+
3955
+ </td>
3956
+
3957
+
3958
+ <td class="attributes">
3959
+
3960
+ &lt;optional&gt;<br>
3961
+
3962
+
3963
+
3964
+ </td>
3965
+
3966
+
3967
+
3968
+ <td class="default">
3969
+
3970
+ 'error'
3971
+
3972
+ </td>
3973
+
3974
+
3975
+ <td class="description last"><p>The level of logging to enable
3976
+ ['error', 'warn', 'info', 'debug', 'trace', 'silent']</p></td>
3977
+ </tr>
3978
+
3979
+
3980
+
3981
+ <tr>
3982
+
3983
+ <td class="name"><code>region</code></td>
3984
+
3985
+
3986
+ <td class="type">
3987
+
3988
+
3989
+ <span class="param-type">string</span>
3990
+
3991
+
3992
+
3993
+
3994
+ </td>
3995
+
3996
+
3997
+ <td class="attributes">
3998
+
3999
+ &lt;optional&gt;<br>
4000
+
4001
+
4002
+
4003
+ </td>
4004
+
4005
+
4006
+
4007
+ <td class="default">
4008
+
4009
+ </td>
4010
+
4011
+
4012
+ <td class="description last"><p>the realm for connections (ex. "stage-us1")</p></td>
4013
+ </tr>
4014
+
4015
+
4016
+ </tbody>
4017
+ </table>
4018
+ </dl>
4019
+
4020
+
4021
+
4022
+
4023
+
4024
+
4025
+
4026
+
4027
+
4028
+
4029
+
4030
+
4031
+
4032
+
4033
+
4034
+
4035
+
4036
+
4037
+
4038
+
4039
+
4040
+
4041
+
4042
+
4043
+
4044
+
4045
+
4046
+
4047
+
4048
+
4049
+
4050
+
4051
+
4052
+
4053
+
4054
+
4055
+ </dl>
4056
+
4057
+
4058
+
4059
+ </dd>
4060
+
4061
+
4062
+
4063
+ <hr>
4064
+ <dt class="name" id="WorkerTaskOptions">
4065
+ <h4 id="WorkerTaskOptions">WorkerTaskOptions</h4>
4066
+
4067
+
4068
+ </dt>
4069
+ <dd>
4070
+
4071
+
4072
+
4073
+ <h5>Type:</h5>
4074
+ <ul>
4075
+ <li>
4076
+
4077
+ <span class="param-type">Object</span>
4078
+
4079
+
4080
+
4081
+ </li>
4082
+ </ul>
4083
+
4084
+
4085
+
4086
+ <dl class="details">
4087
+
4088
+
4089
+ <h5 class="subsection-title">Properties:</h5>
4090
+
4091
+ <dl>
4092
+
4093
+ <table class="props table table-striped">
4094
+ <thead>
4095
+ <tr>
4096
+
4097
+ <th>Name</th>
4098
+
4099
+
4100
+ <th>Type</th>
4101
+
4102
+
4103
+ <th>Argument</th>
4104
+
4105
+
4106
+
4107
+ <th>Default</th>
4108
+
4109
+
4110
+ <th class="last">Description</th>
4111
+ </tr>
4112
+ </thead>
4113
+
4114
+ <tbody>
4115
+
4116
+
4117
+ <tr>
4118
+
4119
+ <td class="name"><code>attributes</code></td>
4120
+
4121
+
4122
+ <td class="type">
4123
+
4124
+
4125
+ <span class="param-type">Record.&lt;any, any&gt;</span>
4126
+
4127
+
4128
+
4129
+
4130
+ </td>
4131
+
4132
+
4133
+ <td class="attributes">
4134
+
4135
+ &lt;optional&gt;<br>
4136
+
4137
+
4138
+
4139
+ </td>
4140
+
4141
+
4142
+
4143
+ <td class="default">
4144
+
4145
+ null
4146
+
4147
+ </td>
4148
+
4149
+
4150
+ <td class="description last"><p>Additional attributes for the <a href="Task.html">Task</a></p></td>
4151
+ </tr>
4152
+
4153
+
4154
+
4155
+ <tr>
4156
+
4157
+ <td class="name"><code>taskChannelUniqueName</code></td>
4158
+
4159
+
4160
+ <td class="type">
4161
+
4162
+
4163
+ <span class="param-type">string</span>
4164
+
4165
+
4166
+
4167
+
4168
+ </td>
4169
+
4170
+
4171
+ <td class="attributes">
4172
+
4173
+ &lt;optional&gt;<br>
4174
+
4175
+
4176
+
4177
+ </td>
4178
+
4179
+
4180
+
4181
+ <td class="default">
4182
+
4183
+ null
4184
+
4185
+ </td>
4186
+
4187
+
4188
+ <td class="description last"><p>The friendly name of the <a href="Channel.html">Channel</a> this <a href="Task.html">Task</a>
4189
+ belongs to. If not provided, defaults to 'default' channel.</p></td>
4190
+ </tr>
4191
+
4192
+
4193
+
4194
+ <tr>
4195
+
4196
+ <td class="name"><code>taskChannelSid</code></td>
4197
+
4198
+
4199
+ <td class="type">
4200
+
4201
+
4202
+ <span class="param-type">string</span>
4203
+
4204
+
4205
+
4206
+
4207
+ </td>
4208
+
4209
+
4210
+ <td class="attributes">
4211
+
4212
+ &lt;optional&gt;<br>
4213
+
4214
+
4215
+
4216
+ </td>
4217
+
4218
+
4219
+
4220
+ <td class="default">
4221
+
4222
+ null
4223
+
4224
+ </td>
4225
+
4226
+
4227
+ <td class="description last"><p>The Sid of the <a href="Channel.html">Channel</a> this <a href="Task.html">Task</a> belongs to. If not
4228
+ provided, defaults to 'default' channel.</p></td>
4229
+ </tr>
4230
+
4231
+
4232
+ </tbody>
4233
+ </table>
4234
+ </dl>
4235
+
4236
+
4237
+
4238
+
4239
+
4240
+
4241
+
4242
+
4243
+
4244
+
4245
+
4246
+
4247
+
4248
+
4249
+
4250
+
4251
+
4252
+
4253
+
4254
+
4255
+
4256
+
4257
+
4258
+
4259
+
4260
+
4261
+
4262
+
4263
+
4264
+
4265
+
4266
+
4267
+
4268
+
4269
+
4270
+
4271
+ </dl>
4272
+
4273
+
4274
+
4275
+ </dd>
4276
+
4277
+
4278
+
4279
+ <hr>
4280
+ <dt class="name" id="WorkspaceOptions">
4281
+ <h4 id="WorkspaceOptions">WorkspaceOptions</h4>
4282
+
4283
+
4284
+ </dt>
4285
+ <dd>
4286
+
4287
+
4288
+
4289
+ <h5>Type:</h5>
4290
+ <ul>
4291
+ <li>
4292
+
4293
+ <span class="param-type">Object</span>
4294
+
4295
+
4296
+
4297
+ </li>
4298
+ </ul>
4299
+
4300
+
4301
+
4302
+ <dl class="details">
4303
+
4304
+
4305
+ <h5 class="subsection-title">Properties:</h5>
4306
+
4307
+ <dl>
4308
+
4309
+ <table class="props table table-striped">
4310
+ <thead>
4311
+ <tr>
4312
+
4313
+ <th>Name</th>
4314
+
4315
+
4316
+ <th>Type</th>
4317
+
4318
+
4319
+ <th>Argument</th>
4320
+
4321
+
4322
+
4323
+ <th>Default</th>
4324
+
4325
+
4326
+ <th class="last">Description</th>
4327
+ </tr>
4328
+ </thead>
4329
+
4330
+ <tbody>
4331
+
4332
+
4333
+ <tr>
4334
+
4335
+ <td class="name"><code>region</code></td>
4336
+
4337
+
4338
+ <td class="type">
4339
+
4340
+
4341
+ <span class="param-type">string</span>
4342
+
4343
+
4344
+
4345
+
4346
+ </td>
4347
+
4348
+
4349
+ <td class="attributes">
4350
+
4351
+ &lt;optional&gt;<br>
4352
+
4353
+
4354
+
4355
+ </td>
4356
+
4357
+
4358
+
4359
+ <td class="default">
4360
+
4361
+ </td>
4362
+
4363
+
4364
+ <td class="description last"><p>the realm for connections (ex. "stage-us1")</p></td>
4365
+ </tr>
4366
+
4367
+
4368
+
4369
+ <tr>
4370
+
4371
+ <td class="name"><code>pageSize</code></td>
4372
+
4373
+
4374
+ <td class="type">
4375
+
4376
+
4377
+ <span class="param-type">number</span>
4378
+
4379
+
4380
+
4381
+
4382
+ </td>
4383
+
4384
+
4385
+ <td class="attributes">
4386
+
4387
+ &lt;optional&gt;<br>
4388
+
4389
+
4390
+
4391
+ </td>
4392
+
4393
+
4394
+
4395
+ <td class="default">
4396
+
4397
+ </td>
4398
+
4399
+
4400
+ <td class="description last"><p>The number of items returned in each request</p></td>
4401
+ </tr>
4402
+
4403
+
4404
+
4405
+ <tr>
4406
+
4407
+ <td class="name"><code>logLevel</code></td>
4408
+
4409
+
4410
+ <td class="type">
4411
+
4412
+
4413
+ <span class="param-type">string</span>
4414
+
4415
+
4416
+
4417
+
4418
+ </td>
4419
+
4420
+
4421
+ <td class="attributes">
4422
+
4423
+ &lt;optional&gt;<br>
4424
+
4425
+
4426
+
4427
+ </td>
4428
+
4429
+
4430
+
4431
+ <td class="default">
4432
+
4433
+ 'error'
4434
+
4435
+ </td>
4436
+
4437
+
4438
+ <td class="description last"><p>The level of logging to enable
4439
+ ['error', 'warn', 'info', 'debug', 'trace', 'silent']</p></td>
4440
+ </tr>
4441
+
4442
+
4443
+ </tbody>
4444
+ </table>
4445
+ </dl>
4446
+
4447
+
4448
+
4449
+
4450
+
4451
+
4452
+
4453
+
4454
+
4455
+
4456
+
4457
+
4458
+
4459
+
4460
+
4461
+
4462
+
4463
+
4464
+
4465
+
4466
+
4467
+
4468
+
4469
+
4470
+
4471
+
4472
+
4473
+
4474
+
4475
+
4476
+
4477
+
4478
+
4479
+
4480
+
4481
+
4482
+ </dl>
4483
+
4484
+
4485
+
4486
+ </dd>
4487
+
4488
+
4489
+
4490
+ <hr>
4491
+ <dt class="name" id="WrappingOptions">
4492
+ <h4 id="WrappingOptions">WrappingOptions</h4>
4493
+
4494
+
4495
+ </dt>
4496
+ <dd>
4497
+
4498
+
4499
+
4500
+ <h5>Type:</h5>
4501
+ <ul>
4502
+ <li>
4503
+
4504
+ <span class="param-type">Object</span>
4505
+
4506
+
4507
+
4508
+ </li>
4509
+ </ul>
4510
+
4511
+
4512
+
4513
+ <dl class="details">
4514
+
4515
+
4516
+ <h5 class="subsection-title">Properties:</h5>
4517
+
4518
+ <dl>
4519
+
4520
+ <table class="props table table-striped">
4521
+ <thead>
4522
+ <tr>
4523
+
4524
+ <th>Name</th>
4525
+
4526
+
4527
+ <th>Type</th>
4528
+
4529
+
4530
+
4531
+
4532
+ <th>Default</th>
4533
+
4534
+
4535
+ <th class="last">Description</th>
4536
+ </tr>
4537
+ </thead>
4538
+
4539
+ <tbody>
4540
+
4541
+
4542
+ <tr>
4543
+
4544
+ <td class="name"><code>reason</code></td>
4545
+
4546
+
4547
+ <td class="type">
4548
+
4549
+
4550
+ <span class="param-type">string</span>
4551
+
4552
+
4553
+
4554
+
4555
+ </td>
4556
+
4557
+
4558
+
4559
+
4560
+ <td class="default">
4561
+
4562
+ null
4563
+
4564
+ </td>
4565
+
4566
+
4567
+ <td class="description last"><p>The reason for wrapping up the <a href="Task.html">Task</a></p></td>
4568
+ </tr>
4569
+
4570
+
4571
+ </tbody>
4572
+ </table>
4573
+ </dl>
4574
+
4575
+
4576
+
4577
+
4578
+
4579
+
4580
+
4581
+
4582
+
4583
+
4584
+
4585
+
4586
+
4587
+
4588
+
4589
+
4590
+
4591
+
4592
+
4593
+
4594
+
4595
+
4596
+
4597
+
4598
+
4599
+
4600
+
4601
+
4602
+
4603
+
4604
+
4605
+
4606
+
4607
+
4608
+
4609
+
4610
+ </dl>
4611
+
4612
+
4613
+
4614
+ </dd>
4615
+
4616
+ </dl>
4617
+
4618
+
4619
+
4620
+ </article>
4621
+
4622
+ </section>
4623
+
4624
+
4625
+
4626
+
4627
+ </div>
4628
+ </div>
4629
+
4630
+ <div class="clearfix"></div>
4631
+
4632
+
4633
+ <div class="col-md-3">
4634
+ <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
4635
+ </div>
4636
+
4637
+
4638
+ </div>
4639
+ </div>
4640
+
4641
+
4642
+ <div class="modal fade" id="searchResults">
4643
+ <div class="modal-dialog">
4644
+ <div class="modal-content">
4645
+ <div class="modal-header">
4646
+ <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button>
4647
+ <h4 class="modal-title">Search results</h4>
4648
+ </div>
4649
+ <div class="modal-body"></div>
4650
+ <div class="modal-footer">
4651
+ <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
4652
+ </div>
4653
+ </div><!-- /.modal-content -->
4654
+ </div><!-- /.modal-dialog -->
4655
+ </div>
4656
+
4657
+
4658
+ <footer>
4659
+
4660
+
4661
+ <span class="jsdoc-message">
4662
+ Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
4663
+
4664
+ on 2023-08-01T08:45:21+00:00
4665
+
4666
+ using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
4667
+ </span>
4668
+ </footer>
4669
+
4670
+ <script src="scripts/docstrap.lib.js"></script>
4671
+ <script src="scripts/toc.js"></script>
4672
+
4673
+ <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
4674
+
4675
+
4676
+ <script>
4677
+ $( function () {
4678
+ $( "[id*='$']" ).each( function () {
4679
+ var $this = $( this );
4680
+
4681
+ $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
4682
+ } );
4683
+
4684
+ $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
4685
+ var $this = $( this );
4686
+
4687
+ var example = $this.find( "code" );
4688
+ exampleText = example.html();
4689
+ var lang = /{@lang (.*?)}/.exec( exampleText );
4690
+ if ( lang && lang[1] ) {
4691
+ exampleText = exampleText.replace( lang[0], "" );
4692
+ example.html( exampleText );
4693
+ lang = lang[1];
4694
+ } else {
4695
+ var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
4696
+ lang = langClassMatch ? langClassMatch[1] : "javascript";
4697
+ }
4698
+
4699
+ if ( lang ) {
4700
+
4701
+ $this
4702
+ .addClass( "sunlight-highlight-" + lang )
4703
+ .addClass( "linenums" )
4704
+ .html( example.html() );
4705
+
4706
+ }
4707
+ } );
4708
+
4709
+ Sunlight.highlightAll( {
4710
+ lineNumbers : false,
4711
+ showMenu : true,
4712
+ enableDoclinks : true
4713
+ } );
4714
+
4715
+ $.catchAnchorLinks( {
4716
+ navbarOffset: 10
4717
+ } );
4718
+ $( "#toc" ).toc( {
4719
+ anchorName : function ( i, heading, prefix ) {
4720
+ return $( heading ).attr( "id" ) || ( prefix + i );
4721
+ },
4722
+ selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
4723
+ showAndHide : false,
4724
+ smoothScrolling: true
4725
+ } );
4726
+
4727
+ $( "#main span[id^='toc']" ).addClass( "toc-shim" );
4728
+ $( '.dropdown-toggle' ).dropdown();
4729
+
4730
+ $( "table" ).each( function () {
4731
+ var $this = $( this );
4732
+ $this.addClass('table');
4733
+ } );
4734
+
4735
+ } );
4736
+ </script>
4737
+
4738
+
4739
+
4740
+ <!--Navigation and Symbol Display-->
4741
+
4742
+
4743
+ <!--Google Analytics-->
4744
+
4745
+
4746
+
4747
+ <script type="text/javascript">
4748
+ $(document).ready(function() {
4749
+ SearcherDisplay.init();
4750
+ });
4751
+ </script>
4752
+
4753
+
4754
+
4755
+ </body></html>