twilio-taskrouter 2.0.13 → 2.0.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +0 -10
- package/dist/docs/Activity.html +1 -1
- package/dist/docs/Channel.html +1 -1
- package/dist/docs/IncomingTransfer.html +1 -1
- package/dist/docs/OutgoingTransfer.html +1 -1
- package/dist/docs/Reservation.html +1 -1
- package/dist/docs/Supervisor.html +1 -1
- package/dist/docs/Task.html +1 -1
- package/dist/docs/TaskQueue.html +1 -1
- package/dist/docs/Transfers.html +1 -1
- package/dist/docs/Worker.html +1 -1
- package/dist/docs/Workspace.html +1 -339
- package/dist/docs/classes.list.html +1 -1
- package/dist/docs/global.html +97 -737
- package/dist/docs/index.html +1 -1
- package/dist/docs/quicksearch.html +1 -1
- package/dist/index.commonjs2.js +1 -1
- package/dist/index.commonjs2.js.LICENSE.txt +1 -1
- package/dist/index.window.js +2 -2
- package/dist/index.window.js.LICENSE.txt +1 -1
- package/dist/types.d.ts +0 -26
- package/package.json +3 -5
package/dist/docs/global.html
CHANGED
|
@@ -2494,73 +2494,6 @@ asynchronous webhook this._request. to on a completed call event.</p></td>
|
|
|
2494
2494
|
|
|
2495
2495
|
|
|
2496
2496
|
|
|
2497
|
-
|
|
2498
|
-
|
|
2499
|
-
|
|
2500
|
-
|
|
2501
|
-
|
|
2502
|
-
|
|
2503
|
-
|
|
2504
|
-
|
|
2505
|
-
|
|
2506
|
-
|
|
2507
|
-
|
|
2508
|
-
|
|
2509
|
-
|
|
2510
|
-
|
|
2511
|
-
|
|
2512
|
-
|
|
2513
|
-
</dl>
|
|
2514
|
-
|
|
2515
|
-
|
|
2516
|
-
|
|
2517
|
-
</dd>
|
|
2518
|
-
|
|
2519
|
-
|
|
2520
|
-
|
|
2521
|
-
<hr>
|
|
2522
|
-
<dt class="name" id="FetchWorkerInfoParams">
|
|
2523
|
-
<h4 id="FetchWorkerInfoParams">FetchWorkerInfoParams</h4>
|
|
2524
|
-
|
|
2525
|
-
|
|
2526
|
-
</dt>
|
|
2527
|
-
<dd>
|
|
2528
|
-
|
|
2529
|
-
|
|
2530
|
-
|
|
2531
|
-
<h5>Type:</h5>
|
|
2532
|
-
<ul>
|
|
2533
|
-
<li>
|
|
2534
|
-
|
|
2535
|
-
<span class="param-type"><a href="global.html#FetchWorkersParams">FetchWorkersParams</a></span>
|
|
2536
|
-
|
|
2537
|
-
|
|
2538
|
-
|
|
2539
|
-
</li>
|
|
2540
|
-
</ul>
|
|
2541
|
-
|
|
2542
|
-
|
|
2543
|
-
|
|
2544
|
-
<dl class="details">
|
|
2545
|
-
|
|
2546
|
-
|
|
2547
|
-
|
|
2548
|
-
|
|
2549
|
-
|
|
2550
|
-
|
|
2551
|
-
|
|
2552
|
-
|
|
2553
|
-
|
|
2554
|
-
|
|
2555
|
-
|
|
2556
|
-
|
|
2557
|
-
|
|
2558
|
-
|
|
2559
|
-
|
|
2560
|
-
|
|
2561
|
-
|
|
2562
|
-
|
|
2563
|
-
|
|
2564
2497
|
|
|
2565
2498
|
|
|
2566
2499
|
|
|
@@ -2884,15 +2817,6 @@ asynchronous webhook this._request. to on a completed call event.</p></td>
|
|
|
2884
2817
|
|
|
2885
2818
|
|
|
2886
2819
|
|
|
2887
|
-
<dt class="important tag-deprecated method-doc-label method-doc-details-label">Deprecated:</dt>
|
|
2888
|
-
|
|
2889
|
-
<dd class="yes-def tag-deprecated">
|
|
2890
|
-
<ul class="dummy">
|
|
2891
|
-
<li>Yes</li>
|
|
2892
|
-
</ul>
|
|
2893
|
-
</dd>
|
|
2894
|
-
|
|
2895
|
-
|
|
2896
2820
|
|
|
2897
2821
|
|
|
2898
2822
|
|
|
@@ -3904,8 +3828,6 @@ upon rejecting the <a href="Reservation.html">Reservation</a></p></td>
|
|
|
3904
3828
|
<th>Type</th>
|
|
3905
3829
|
|
|
3906
3830
|
|
|
3907
|
-
<th>Argument</th>
|
|
3908
|
-
|
|
3909
3831
|
|
|
3910
3832
|
|
|
3911
3833
|
|
|
@@ -3932,12 +3854,6 @@ upon rejecting the <a href="Reservation.html">Reservation</a></p></td>
|
|
|
3932
3854
|
</td>
|
|
3933
3855
|
|
|
3934
3856
|
|
|
3935
|
-
<td class="attributes">
|
|
3936
|
-
|
|
3937
|
-
|
|
3938
|
-
|
|
3939
|
-
</td>
|
|
3940
|
-
|
|
3941
3857
|
|
|
3942
3858
|
|
|
3943
3859
|
|
|
@@ -3962,44 +3878,6 @@ upon rejecting the <a href="Reservation.html">Reservation</a></p></td>
|
|
|
3962
3878
|
</td>
|
|
3963
3879
|
|
|
3964
3880
|
|
|
3965
|
-
<td class="attributes">
|
|
3966
|
-
|
|
3967
|
-
|
|
3968
|
-
|
|
3969
|
-
</td>
|
|
3970
|
-
|
|
3971
|
-
|
|
3972
|
-
|
|
3973
|
-
|
|
3974
|
-
<td class="description last"></td>
|
|
3975
|
-
</tr>
|
|
3976
|
-
|
|
3977
|
-
|
|
3978
|
-
|
|
3979
|
-
<tr>
|
|
3980
|
-
|
|
3981
|
-
<td class="name"><code>GraphQLSignaling</code></td>
|
|
3982
|
-
|
|
3983
|
-
|
|
3984
|
-
<td class="type">
|
|
3985
|
-
|
|
3986
|
-
|
|
3987
|
-
<span class="param-type">GraphQLSignaling</span>
|
|
3988
|
-
|
|
3989
|
-
|
|
3990
|
-
|
|
3991
|
-
|
|
3992
|
-
</td>
|
|
3993
|
-
|
|
3994
|
-
|
|
3995
|
-
<td class="attributes">
|
|
3996
|
-
|
|
3997
|
-
<optional><br>
|
|
3998
|
-
|
|
3999
|
-
|
|
4000
|
-
|
|
4001
|
-
</td>
|
|
4002
|
-
|
|
4003
3881
|
|
|
4004
3882
|
|
|
4005
3883
|
|
|
@@ -4055,8 +3933,8 @@ upon rejecting the <a href="Reservation.html">Reservation</a></p></td>
|
|
|
4055
3933
|
|
|
4056
3934
|
|
|
4057
3935
|
<hr>
|
|
4058
|
-
<dt class="name" id="
|
|
4059
|
-
<h4 id="
|
|
3936
|
+
<dt class="name" id="WorkerOptions">
|
|
3937
|
+
<h4 id="WorkerOptions">WorkerOptions</h4>
|
|
4060
3938
|
|
|
4061
3939
|
|
|
4062
3940
|
</dt>
|
|
@@ -4094,8 +3972,12 @@ upon rejecting the <a href="Reservation.html">Reservation</a></p></td>
|
|
|
4094
3972
|
<th>Type</th>
|
|
4095
3973
|
|
|
4096
3974
|
|
|
3975
|
+
<th>Argument</th>
|
|
3976
|
+
|
|
4097
3977
|
|
|
4098
3978
|
|
|
3979
|
+
<th>Default</th>
|
|
3980
|
+
|
|
4099
3981
|
|
|
4100
3982
|
<th class="last">Description</th>
|
|
4101
3983
|
</tr>
|
|
@@ -4106,7 +3988,7 @@ upon rejecting the <a href="Reservation.html">Reservation</a></p></td>
|
|
|
4106
3988
|
|
|
4107
3989
|
<tr>
|
|
4108
3990
|
|
|
4109
|
-
<td class="name"><code>
|
|
3991
|
+
<td class="name"><code>connectActivitySid</code></td>
|
|
4110
3992
|
|
|
4111
3993
|
|
|
4112
3994
|
<td class="type">
|
|
@@ -4120,47 +4002,37 @@ upon rejecting the <a href="Reservation.html">Reservation</a></p></td>
|
|
|
4120
4002
|
</td>
|
|
4121
4003
|
|
|
4122
4004
|
|
|
4123
|
-
|
|
4124
|
-
|
|
4125
|
-
|
|
4126
|
-
<td class="description last"><p>The SID of the owning account of the Worker</p></td>
|
|
4127
|
-
</tr>
|
|
4128
|
-
|
|
4129
|
-
|
|
4130
|
-
|
|
4131
|
-
<tr>
|
|
4132
|
-
|
|
4133
|
-
<td class="name"><code>activityName</code></td>
|
|
4134
|
-
|
|
4135
|
-
|
|
4136
|
-
<td class="type">
|
|
4137
|
-
|
|
4005
|
+
<td class="attributes">
|
|
4006
|
+
|
|
4007
|
+
<optional><br>
|
|
4138
4008
|
|
|
4139
|
-
<span class="param-type">string</span>
|
|
4140
|
-
|
|
4141
|
-
|
|
4142
4009
|
|
|
4010
|
+
|
|
4011
|
+
</td>
|
|
4143
4012
|
|
|
4144
|
-
</td>
|
|
4145
4013
|
|
|
4146
4014
|
|
|
4147
|
-
|
|
4015
|
+
<td class="default">
|
|
4016
|
+
|
|
4017
|
+
''
|
|
4018
|
+
|
|
4019
|
+
</td>
|
|
4148
4020
|
|
|
4149
4021
|
|
|
4150
|
-
<td class="description last"><p>The
|
|
4022
|
+
<td class="description last"><p>The <a href="Activity.html">Activity</a> state of the Worker upon connect</p></td>
|
|
4151
4023
|
</tr>
|
|
4152
4024
|
|
|
4153
4025
|
|
|
4154
4026
|
|
|
4155
4027
|
<tr>
|
|
4156
4028
|
|
|
4157
|
-
<td class="name"><code>
|
|
4029
|
+
<td class="name"><code>closeExistingSessions</code></td>
|
|
4158
4030
|
|
|
4159
4031
|
|
|
4160
4032
|
<td class="type">
|
|
4161
4033
|
|
|
4162
4034
|
|
|
4163
|
-
<span class="param-type">
|
|
4035
|
+
<span class="param-type">boolean</span>
|
|
4164
4036
|
|
|
4165
4037
|
|
|
4166
4038
|
|
|
@@ -4168,41 +4040,34 @@ upon rejecting the <a href="Reservation.html">Reservation</a></p></td>
|
|
|
4168
4040
|
</td>
|
|
4169
4041
|
|
|
4170
4042
|
|
|
4171
|
-
|
|
4172
|
-
|
|
4173
|
-
|
|
4174
|
-
<td class="description last"><p>The SID of the current activity</p></td>
|
|
4175
|
-
</tr>
|
|
4176
|
-
|
|
4177
|
-
|
|
4178
|
-
|
|
4179
|
-
<tr>
|
|
4180
|
-
|
|
4181
|
-
<td class="name"><code>attributes</code></td>
|
|
4182
|
-
|
|
4183
|
-
|
|
4184
|
-
<td class="type">
|
|
4185
|
-
|
|
4043
|
+
<td class="attributes">
|
|
4044
|
+
|
|
4045
|
+
<optional><br>
|
|
4186
4046
|
|
|
4187
|
-
<span class="param-type">Object</span>
|
|
4188
|
-
|
|
4189
|
-
|
|
4190
4047
|
|
|
4048
|
+
|
|
4049
|
+
</td>
|
|
4191
4050
|
|
|
4192
|
-
</td>
|
|
4193
4051
|
|
|
4194
4052
|
|
|
4195
|
-
|
|
4053
|
+
<td class="default">
|
|
4054
|
+
|
|
4055
|
+
false
|
|
4056
|
+
|
|
4057
|
+
</td>
|
|
4196
4058
|
|
|
4197
4059
|
|
|
4198
|
-
<td class="description last"><
|
|
4060
|
+
<td class="description last"><ul>
|
|
4061
|
+
<li>Whether other open sessions of this <a href="Worker.html">Worker</a>
|
|
4062
|
+
should be terminated</li>
|
|
4063
|
+
</ul></td>
|
|
4199
4064
|
</tr>
|
|
4200
4065
|
|
|
4201
4066
|
|
|
4202
4067
|
|
|
4203
4068
|
<tr>
|
|
4204
4069
|
|
|
4205
|
-
<td class="name"><code>
|
|
4070
|
+
<td class="name"><code>setWorkerOfflineIfDisconnected</code></td>
|
|
4206
4071
|
|
|
4207
4072
|
|
|
4208
4073
|
<td class="type">
|
|
@@ -4216,23 +4081,37 @@ upon rejecting the <a href="Reservation.html">Reservation</a></p></td>
|
|
|
4216
4081
|
</td>
|
|
4217
4082
|
|
|
4218
4083
|
|
|
4084
|
+
<td class="attributes">
|
|
4085
|
+
|
|
4086
|
+
<optional><br>
|
|
4087
|
+
|
|
4088
|
+
|
|
4089
|
+
|
|
4090
|
+
</td>
|
|
4091
|
+
|
|
4219
4092
|
|
|
4220
4093
|
|
|
4094
|
+
<td class="default">
|
|
4095
|
+
|
|
4096
|
+
true
|
|
4097
|
+
|
|
4098
|
+
</td>
|
|
4099
|
+
|
|
4221
4100
|
|
|
4222
|
-
<td class="description last"><p>
|
|
4101
|
+
<td class="description last"><p>A boolean defining whether if <a href="Worker.html">Worker</a> availability set as Offline when the connection is terminated</p></td>
|
|
4223
4102
|
</tr>
|
|
4224
4103
|
|
|
4225
4104
|
|
|
4226
4105
|
|
|
4227
4106
|
<tr>
|
|
4228
4107
|
|
|
4229
|
-
<td class="name"><code>
|
|
4108
|
+
<td class="name"><code>logLevel</code></td>
|
|
4230
4109
|
|
|
4231
4110
|
|
|
4232
4111
|
<td class="type">
|
|
4233
4112
|
|
|
4234
4113
|
|
|
4235
|
-
<span class="param-type">
|
|
4114
|
+
<span class="param-type">string</span>
|
|
4236
4115
|
|
|
4237
4116
|
|
|
4238
4117
|
|
|
@@ -4240,23 +4119,38 @@ upon rejecting the <a href="Reservation.html">Reservation</a></p></td>
|
|
|
4240
4119
|
</td>
|
|
4241
4120
|
|
|
4242
4121
|
|
|
4122
|
+
<td class="attributes">
|
|
4123
|
+
|
|
4124
|
+
<optional><br>
|
|
4125
|
+
|
|
4126
|
+
|
|
4127
|
+
|
|
4128
|
+
</td>
|
|
4129
|
+
|
|
4243
4130
|
|
|
4244
4131
|
|
|
4132
|
+
<td class="default">
|
|
4133
|
+
|
|
4134
|
+
'error'
|
|
4135
|
+
|
|
4136
|
+
</td>
|
|
4137
|
+
|
|
4245
4138
|
|
|
4246
|
-
<td class="description last"><p>
|
|
4139
|
+
<td class="description last"><p>The level of logging to enable
|
|
4140
|
+
['error', 'warn', 'info', 'debug', 'trace', 'silent']</p></td>
|
|
4247
4141
|
</tr>
|
|
4248
4142
|
|
|
4249
4143
|
|
|
4250
4144
|
|
|
4251
4145
|
<tr>
|
|
4252
4146
|
|
|
4253
|
-
<td class="name"><code>
|
|
4147
|
+
<td class="name"><code>region</code></td>
|
|
4254
4148
|
|
|
4255
4149
|
|
|
4256
4150
|
<td class="type">
|
|
4257
4151
|
|
|
4258
4152
|
|
|
4259
|
-
<span class="param-type">
|
|
4153
|
+
<span class="param-type">string</span>
|
|
4260
4154
|
|
|
4261
4155
|
|
|
4262
4156
|
|
|
@@ -4264,23 +4158,35 @@ upon rejecting the <a href="Reservation.html">Reservation</a></p></td>
|
|
|
4264
4158
|
</td>
|
|
4265
4159
|
|
|
4266
4160
|
|
|
4161
|
+
<td class="attributes">
|
|
4162
|
+
|
|
4163
|
+
<optional><br>
|
|
4164
|
+
|
|
4165
|
+
|
|
4166
|
+
|
|
4167
|
+
</td>
|
|
4168
|
+
|
|
4267
4169
|
|
|
4268
4170
|
|
|
4171
|
+
<td class="default">
|
|
4172
|
+
|
|
4173
|
+
</td>
|
|
4174
|
+
|
|
4269
4175
|
|
|
4270
|
-
<td class="description last"><p>
|
|
4176
|
+
<td class="description last"><p>the realm for connections (ex. "stage-us1")</p></td>
|
|
4271
4177
|
</tr>
|
|
4272
4178
|
|
|
4273
4179
|
|
|
4274
4180
|
|
|
4275
4181
|
<tr>
|
|
4276
4182
|
|
|
4277
|
-
<td class="name"><code>
|
|
4183
|
+
<td class="name"><code>enableVersionCheck</code></td>
|
|
4278
4184
|
|
|
4279
4185
|
|
|
4280
4186
|
<td class="type">
|
|
4281
4187
|
|
|
4282
4188
|
|
|
4283
|
-
<span class="param-type">
|
|
4189
|
+
<span class="param-type">boolean</span>
|
|
4284
4190
|
|
|
4285
4191
|
|
|
4286
4192
|
|
|
@@ -4288,573 +4194,27 @@ upon rejecting the <a href="Reservation.html">Reservation</a></p></td>
|
|
|
4288
4194
|
</td>
|
|
4289
4195
|
|
|
4290
4196
|
|
|
4197
|
+
<td class="attributes">
|
|
4198
|
+
|
|
4199
|
+
<optional><br>
|
|
4200
|
+
|
|
4291
4201
|
|
|
4202
|
+
|
|
4203
|
+
</td>
|
|
4292
4204
|
|
|
4293
4205
|
|
|
4294
|
-
<td class="description last"><p>When the Worker was last updated</p></td>
|
|
4295
|
-
</tr>
|
|
4296
|
-
|
|
4297
|
-
|
|
4298
|
-
|
|
4299
|
-
<tr>
|
|
4300
4206
|
|
|
4301
|
-
<td class="
|
|
4302
|
-
|
|
4303
|
-
|
|
4304
|
-
|
|
4305
|
-
|
|
4306
|
-
|
|
4307
|
-
<span class="param-type">string</span>
|
|
4308
|
-
|
|
4309
|
-
|
|
4310
|
-
|
|
4311
|
-
|
|
4312
|
-
</td>
|
|
4313
|
-
|
|
4314
|
-
|
|
4315
|
-
|
|
4316
|
-
|
|
4317
|
-
|
|
4318
|
-
<td class="description last"><p>The friendly name of the Worker</p></td>
|
|
4319
|
-
</tr>
|
|
4320
|
-
|
|
4321
|
-
|
|
4322
|
-
|
|
4323
|
-
<tr>
|
|
4324
|
-
|
|
4325
|
-
<td class="name"><code>sid</code></td>
|
|
4326
|
-
|
|
4327
|
-
|
|
4328
|
-
<td class="type">
|
|
4329
|
-
|
|
4330
|
-
|
|
4331
|
-
<span class="param-type">string</span>
|
|
4332
|
-
|
|
4333
|
-
|
|
4334
|
-
|
|
4335
|
-
|
|
4336
|
-
</td>
|
|
4337
|
-
|
|
4338
|
-
|
|
4339
|
-
|
|
4340
|
-
|
|
4341
|
-
|
|
4342
|
-
<td class="description last"><p>The SID of the Worker</p></td>
|
|
4343
|
-
</tr>
|
|
4344
|
-
|
|
4345
|
-
|
|
4346
|
-
|
|
4347
|
-
<tr>
|
|
4348
|
-
|
|
4349
|
-
<td class="name"><code>workspaceSid</code></td>
|
|
4350
|
-
|
|
4351
|
-
|
|
4352
|
-
<td class="type">
|
|
4353
|
-
|
|
4354
|
-
|
|
4355
|
-
<span class="param-type">string</span>
|
|
4356
|
-
|
|
4357
|
-
|
|
4358
|
-
|
|
4359
|
-
|
|
4360
|
-
</td>
|
|
4361
|
-
|
|
4362
|
-
|
|
4363
|
-
|
|
4364
|
-
|
|
4365
|
-
|
|
4366
|
-
<td class="description last"><p>The SID of the Workspace the Worker belongs to</p></td>
|
|
4367
|
-
</tr>
|
|
4368
|
-
|
|
4369
|
-
|
|
4370
|
-
|
|
4371
|
-
<tr>
|
|
4372
|
-
|
|
4373
|
-
<td class="name"><code>version</code></td>
|
|
4374
|
-
|
|
4375
|
-
|
|
4376
|
-
<td class="type">
|
|
4377
|
-
|
|
4378
|
-
|
|
4379
|
-
<span class="param-type">string</span>
|
|
4380
|
-
|
|
4381
|
-
|
|
4382
|
-
|
|
4383
|
-
|
|
4384
|
-
</td>
|
|
4385
|
-
|
|
4386
|
-
|
|
4387
|
-
|
|
4388
|
-
|
|
4389
|
-
|
|
4390
|
-
<td class="description last"><p>The version of this Worker</p></td>
|
|
4391
|
-
</tr>
|
|
4392
|
-
|
|
4393
|
-
|
|
4394
|
-
|
|
4395
|
-
<tr>
|
|
4396
|
-
|
|
4397
|
-
<td class="name"><code>workerSid</code></td>
|
|
4398
|
-
|
|
4399
|
-
|
|
4400
|
-
<td class="type">
|
|
4401
|
-
|
|
4402
|
-
|
|
4403
|
-
<span class="param-type">string</span>
|
|
4404
|
-
|
|
4405
|
-
|
|
4406
|
-
|
|
4407
|
-
|
|
4408
|
-
</td>
|
|
4409
|
-
|
|
4410
|
-
|
|
4411
|
-
|
|
4412
|
-
|
|
4413
|
-
|
|
4414
|
-
<td class="description last"><p>[Duplicate] sid of the Worker</p></td>
|
|
4415
|
-
</tr>
|
|
4416
|
-
|
|
4417
|
-
|
|
4418
|
-
|
|
4419
|
-
<tr>
|
|
4420
|
-
|
|
4421
|
-
<td class="name"><code>workerActivitySid</code></td>
|
|
4422
|
-
|
|
4423
|
-
|
|
4424
|
-
<td class="type">
|
|
4425
|
-
|
|
4426
|
-
|
|
4427
|
-
<span class="param-type">string</span>
|
|
4428
|
-
|
|
4429
|
-
|
|
4430
|
-
|
|
4431
|
-
|
|
4432
|
-
</td>
|
|
4433
|
-
|
|
4434
|
-
|
|
4435
|
-
|
|
4436
|
-
|
|
4437
|
-
|
|
4438
|
-
<td class="description last"><p>[Duplicate] activitySid of the Worker</p></td>
|
|
4439
|
-
</tr>
|
|
4440
|
-
|
|
4441
|
-
|
|
4442
|
-
|
|
4443
|
-
<tr>
|
|
4444
|
-
|
|
4445
|
-
<td class="name"><code>dateActivityChanged</code></td>
|
|
4446
|
-
|
|
4447
|
-
|
|
4448
|
-
<td class="type">
|
|
4449
|
-
|
|
4450
|
-
|
|
4451
|
-
<span class="param-type">Date</span>
|
|
4452
|
-
|
|
4453
|
-
|
|
4454
|
-
|
|
4455
|
-
|
|
4456
|
-
</td>
|
|
4457
|
-
|
|
4458
|
-
|
|
4459
|
-
|
|
4460
|
-
|
|
4461
|
-
|
|
4462
|
-
<td class="description last"><p>[Duplicate] dateStatusChanged of the Worker</p></td>
|
|
4463
|
-
</tr>
|
|
4464
|
-
|
|
4465
|
-
|
|
4466
|
-
|
|
4467
|
-
<tr>
|
|
4468
|
-
|
|
4469
|
-
<td class="name"><code>friendlyName</code></td>
|
|
4470
|
-
|
|
4471
|
-
|
|
4472
|
-
<td class="type">
|
|
4473
|
-
|
|
4474
|
-
|
|
4475
|
-
<span class="param-type">string</span>
|
|
4476
|
-
|
|
4477
|
-
|
|
4478
|
-
|
|
4479
|
-
|
|
4480
|
-
</td>
|
|
4481
|
-
|
|
4482
|
-
|
|
4483
|
-
|
|
4484
|
-
|
|
4485
|
-
|
|
4486
|
-
<td class="description last"><p>[Duplicate] name of the Worker</p></td>
|
|
4487
|
-
</tr>
|
|
4488
|
-
|
|
4489
|
-
|
|
4490
|
-
</tbody>
|
|
4491
|
-
</table>
|
|
4492
|
-
</dl>
|
|
4493
|
-
|
|
4494
|
-
|
|
4495
|
-
|
|
4496
|
-
|
|
4497
|
-
|
|
4498
|
-
|
|
4499
|
-
|
|
4500
|
-
|
|
4501
|
-
|
|
4502
|
-
|
|
4503
|
-
|
|
4504
|
-
|
|
4505
|
-
|
|
4506
|
-
|
|
4507
|
-
|
|
4508
|
-
|
|
4509
|
-
|
|
4510
|
-
|
|
4511
|
-
|
|
4512
|
-
|
|
4513
|
-
|
|
4514
|
-
|
|
4515
|
-
|
|
4516
|
-
|
|
4517
|
-
|
|
4518
|
-
|
|
4519
|
-
|
|
4520
|
-
|
|
4521
|
-
|
|
4522
|
-
|
|
4523
|
-
|
|
4524
|
-
|
|
4525
|
-
|
|
4526
|
-
|
|
4527
|
-
|
|
4528
|
-
|
|
4529
|
-
</dl>
|
|
4530
|
-
|
|
4531
|
-
|
|
4532
|
-
|
|
4533
|
-
</dd>
|
|
4534
|
-
|
|
4535
|
-
|
|
4536
|
-
|
|
4537
|
-
<hr>
|
|
4538
|
-
<dt class="name" id="WorkerOptions">
|
|
4539
|
-
<h4 id="WorkerOptions">WorkerOptions</h4>
|
|
4540
|
-
|
|
4541
|
-
|
|
4542
|
-
</dt>
|
|
4543
|
-
<dd>
|
|
4544
|
-
|
|
4545
|
-
|
|
4546
|
-
|
|
4547
|
-
<h5>Type:</h5>
|
|
4548
|
-
<ul>
|
|
4549
|
-
<li>
|
|
4550
|
-
|
|
4551
|
-
<span class="param-type">Object</span>
|
|
4552
|
-
|
|
4553
|
-
|
|
4554
|
-
|
|
4555
|
-
</li>
|
|
4556
|
-
</ul>
|
|
4557
|
-
|
|
4558
|
-
|
|
4559
|
-
|
|
4560
|
-
<dl class="details">
|
|
4561
|
-
|
|
4562
|
-
|
|
4563
|
-
<h5 class="subsection-title">Properties:</h5>
|
|
4564
|
-
|
|
4565
|
-
<dl>
|
|
4566
|
-
|
|
4567
|
-
<table class="props table table-striped">
|
|
4568
|
-
<thead>
|
|
4569
|
-
<tr>
|
|
4570
|
-
|
|
4571
|
-
<th>Name</th>
|
|
4572
|
-
|
|
4573
|
-
|
|
4574
|
-
<th>Type</th>
|
|
4575
|
-
|
|
4576
|
-
|
|
4577
|
-
<th>Argument</th>
|
|
4578
|
-
|
|
4579
|
-
|
|
4580
|
-
|
|
4581
|
-
<th>Default</th>
|
|
4582
|
-
|
|
4583
|
-
|
|
4584
|
-
<th class="last">Description</th>
|
|
4585
|
-
</tr>
|
|
4586
|
-
</thead>
|
|
4587
|
-
|
|
4588
|
-
<tbody>
|
|
4589
|
-
|
|
4590
|
-
|
|
4591
|
-
<tr>
|
|
4592
|
-
|
|
4593
|
-
<td class="name"><code>connectActivitySid</code></td>
|
|
4594
|
-
|
|
4595
|
-
|
|
4596
|
-
<td class="type">
|
|
4597
|
-
|
|
4598
|
-
|
|
4599
|
-
<span class="param-type">string</span>
|
|
4600
|
-
|
|
4601
|
-
|
|
4602
|
-
|
|
4603
|
-
|
|
4604
|
-
</td>
|
|
4605
|
-
|
|
4606
|
-
|
|
4607
|
-
<td class="attributes">
|
|
4608
|
-
|
|
4609
|
-
<optional><br>
|
|
4610
|
-
|
|
4611
|
-
|
|
4612
|
-
|
|
4613
|
-
</td>
|
|
4614
|
-
|
|
4615
|
-
|
|
4616
|
-
|
|
4617
|
-
<td class="default">
|
|
4618
|
-
|
|
4619
|
-
''
|
|
4620
|
-
|
|
4621
|
-
</td>
|
|
4622
|
-
|
|
4623
|
-
|
|
4624
|
-
<td class="description last"><p>The <a href="Activity.html">Activity</a> state of the Worker upon connect</p></td>
|
|
4625
|
-
</tr>
|
|
4626
|
-
|
|
4627
|
-
|
|
4628
|
-
|
|
4629
|
-
<tr>
|
|
4630
|
-
|
|
4631
|
-
<td class="name"><code>closeExistingSessions</code></td>
|
|
4632
|
-
|
|
4633
|
-
|
|
4634
|
-
<td class="type">
|
|
4635
|
-
|
|
4636
|
-
|
|
4637
|
-
<span class="param-type">boolean</span>
|
|
4638
|
-
|
|
4639
|
-
|
|
4640
|
-
|
|
4641
|
-
|
|
4642
|
-
</td>
|
|
4643
|
-
|
|
4644
|
-
|
|
4645
|
-
<td class="attributes">
|
|
4646
|
-
|
|
4647
|
-
<optional><br>
|
|
4648
|
-
|
|
4649
|
-
|
|
4650
|
-
|
|
4651
|
-
</td>
|
|
4652
|
-
|
|
4653
|
-
|
|
4654
|
-
|
|
4655
|
-
<td class="default">
|
|
4656
|
-
|
|
4657
|
-
false
|
|
4658
|
-
|
|
4659
|
-
</td>
|
|
4660
|
-
|
|
4661
|
-
|
|
4662
|
-
<td class="description last"><ul>
|
|
4663
|
-
<li>Whether other open sessions of this <a href="Worker.html">Worker</a>
|
|
4664
|
-
should be terminated</li>
|
|
4665
|
-
</ul></td>
|
|
4666
|
-
</tr>
|
|
4667
|
-
|
|
4668
|
-
|
|
4669
|
-
|
|
4670
|
-
<tr>
|
|
4671
|
-
|
|
4672
|
-
<td class="name"><code>setWorkerOfflineIfDisconnected</code></td>
|
|
4673
|
-
|
|
4674
|
-
|
|
4675
|
-
<td class="type">
|
|
4676
|
-
|
|
4677
|
-
|
|
4678
|
-
<span class="param-type">boolean</span>
|
|
4679
|
-
|
|
4680
|
-
|
|
4681
|
-
|
|
4682
|
-
|
|
4683
|
-
</td>
|
|
4684
|
-
|
|
4685
|
-
|
|
4686
|
-
<td class="attributes">
|
|
4687
|
-
|
|
4688
|
-
<optional><br>
|
|
4689
|
-
|
|
4690
|
-
|
|
4691
|
-
|
|
4692
|
-
</td>
|
|
4693
|
-
|
|
4694
|
-
|
|
4695
|
-
|
|
4696
|
-
<td class="default">
|
|
4697
|
-
|
|
4698
|
-
true
|
|
4699
|
-
|
|
4700
|
-
</td>
|
|
4701
|
-
|
|
4702
|
-
|
|
4703
|
-
<td class="description last"><p>A boolean defining whether if <a href="Worker.html">Worker</a> availability set as Offline when the connection is terminated</p></td>
|
|
4704
|
-
</tr>
|
|
4705
|
-
|
|
4706
|
-
|
|
4707
|
-
|
|
4708
|
-
<tr>
|
|
4709
|
-
|
|
4710
|
-
<td class="name"><code>logLevel</code></td>
|
|
4711
|
-
|
|
4712
|
-
|
|
4713
|
-
<td class="type">
|
|
4714
|
-
|
|
4715
|
-
|
|
4716
|
-
<span class="param-type">string</span>
|
|
4717
|
-
|
|
4718
|
-
|
|
4719
|
-
|
|
4720
|
-
|
|
4721
|
-
</td>
|
|
4722
|
-
|
|
4723
|
-
|
|
4724
|
-
<td class="attributes">
|
|
4725
|
-
|
|
4726
|
-
<optional><br>
|
|
4727
|
-
|
|
4728
|
-
|
|
4729
|
-
|
|
4730
|
-
</td>
|
|
4731
|
-
|
|
4732
|
-
|
|
4733
|
-
|
|
4734
|
-
<td class="default">
|
|
4735
|
-
|
|
4736
|
-
'error'
|
|
4737
|
-
|
|
4738
|
-
</td>
|
|
4739
|
-
|
|
4740
|
-
|
|
4741
|
-
<td class="description last"><p>The level of logging to enable
|
|
4742
|
-
['error', 'warn', 'info', 'debug', 'trace', 'silent']</p></td>
|
|
4743
|
-
</tr>
|
|
4744
|
-
|
|
4745
|
-
|
|
4746
|
-
|
|
4747
|
-
<tr>
|
|
4748
|
-
|
|
4749
|
-
<td class="name"><code>region</code></td>
|
|
4750
|
-
|
|
4751
|
-
|
|
4752
|
-
<td class="type">
|
|
4753
|
-
|
|
4754
|
-
|
|
4755
|
-
<span class="param-type">string</span>
|
|
4756
|
-
|
|
4757
|
-
|
|
4758
|
-
|
|
4759
|
-
|
|
4760
|
-
</td>
|
|
4761
|
-
|
|
4762
|
-
|
|
4763
|
-
<td class="attributes">
|
|
4764
|
-
|
|
4765
|
-
<optional><br>
|
|
4766
|
-
|
|
4767
|
-
|
|
4768
|
-
|
|
4769
|
-
</td>
|
|
4770
|
-
|
|
4771
|
-
|
|
4772
|
-
|
|
4773
|
-
<td class="default">
|
|
4774
|
-
|
|
4775
|
-
</td>
|
|
4776
|
-
|
|
4777
|
-
|
|
4778
|
-
<td class="description last"><p>the realm for connections (ex. "stage-us1")</p></td>
|
|
4779
|
-
</tr>
|
|
4780
|
-
|
|
4781
|
-
|
|
4782
|
-
|
|
4783
|
-
<tr>
|
|
4784
|
-
|
|
4785
|
-
<td class="name"><code>enableVersionCheck</code></td>
|
|
4786
|
-
|
|
4787
|
-
|
|
4788
|
-
<td class="type">
|
|
4789
|
-
|
|
4790
|
-
|
|
4791
|
-
<span class="param-type">boolean</span>
|
|
4792
|
-
|
|
4793
|
-
|
|
4794
|
-
|
|
4795
|
-
|
|
4796
|
-
</td>
|
|
4797
|
-
|
|
4798
|
-
|
|
4799
|
-
<td class="attributes">
|
|
4800
|
-
|
|
4801
|
-
<optional><br>
|
|
4802
|
-
|
|
4803
|
-
|
|
4804
|
-
|
|
4805
|
-
</td>
|
|
4806
|
-
|
|
4807
|
-
|
|
4808
|
-
|
|
4809
|
-
<td class="default">
|
|
4810
|
-
|
|
4811
|
-
false
|
|
4812
|
-
|
|
4813
|
-
</td>
|
|
4207
|
+
<td class="default">
|
|
4208
|
+
|
|
4209
|
+
false
|
|
4210
|
+
|
|
4211
|
+
</td>
|
|
4814
4212
|
|
|
4815
4213
|
|
|
4816
4214
|
<td class="description last"><p>To avoid accidentally overwriting objects with outdated data</p></td>
|
|
4817
4215
|
</tr>
|
|
4818
4216
|
|
|
4819
4217
|
|
|
4820
|
-
|
|
4821
|
-
<tr>
|
|
4822
|
-
|
|
4823
|
-
<td class="name"><code>useGraphQL</code></td>
|
|
4824
|
-
|
|
4825
|
-
|
|
4826
|
-
<td class="type">
|
|
4827
|
-
|
|
4828
|
-
|
|
4829
|
-
<span class="param-type">boolean</span>
|
|
4830
|
-
|
|
4831
|
-
|
|
4832
|
-
|
|
4833
|
-
|
|
4834
|
-
</td>
|
|
4835
|
-
|
|
4836
|
-
|
|
4837
|
-
<td class="attributes">
|
|
4838
|
-
|
|
4839
|
-
<optional><br>
|
|
4840
|
-
|
|
4841
|
-
|
|
4842
|
-
|
|
4843
|
-
</td>
|
|
4844
|
-
|
|
4845
|
-
|
|
4846
|
-
|
|
4847
|
-
<td class="default">
|
|
4848
|
-
|
|
4849
|
-
false
|
|
4850
|
-
|
|
4851
|
-
</td>
|
|
4852
|
-
|
|
4853
|
-
|
|
4854
|
-
<td class="description last"><p>Subscribe to worker events using GraphQL subscriptions</p></td>
|
|
4855
|
-
</tr>
|
|
4856
|
-
|
|
4857
|
-
|
|
4858
4218
|
</tbody>
|
|
4859
4219
|
</table>
|
|
4860
4220
|
</dl>
|
|
@@ -5543,7 +4903,7 @@ provided, defaults to dateCreated.</p></td>
|
|
|
5543
4903
|
<span class="jsdoc-message">
|
|
5544
4904
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a>
|
|
5545
4905
|
|
|
5546
|
-
on 2025-05-
|
|
4906
|
+
on 2025-05-08T08:31:45+00:00
|
|
5547
4907
|
|
|
5548
4908
|
using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
|
|
5549
4909
|
</span>
|