@twilio/conversations 2.1.0 → 3.0.0-rc.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -0
- package/builds/browser.js +1193 -690
- package/builds/browser.js.map +1 -1
- package/builds/lib.d.ts +248 -130
- package/builds/lib.js +1193 -690
- package/builds/lib.js.map +1 -1
- package/builds/twilio-conversations.js +1903 -1215
- package/builds/twilio-conversations.min.js +2 -2
- package/dist/client.js +403 -279
- package/dist/client.js.map +1 -1
- package/dist/command-executor.js.map +1 -1
- package/dist/configuration.js +2 -2
- package/dist/configuration.js.map +1 -1
- package/dist/data/messages.js +39 -19
- package/dist/data/messages.js.map +1 -1
- package/dist/media.js +36 -25
- package/dist/media.js.map +1 -1
- package/dist/message-builder.js +24 -18
- package/dist/message-builder.js.map +1 -1
- package/dist/message.js +46 -19
- package/dist/message.js.map +1 -1
- package/dist/packages/conversations/package.json.js +1 -1
- package/dist/unsent-message.js +13 -3
- package/dist/unsent-message.js.map +1 -1
- package/docs/assets/js/search.js +1 -1
- package/docs/classes/Client.html +205 -33
- package/docs/classes/Media.html +2 -28
- package/docs/classes/Message.html +94 -39
- package/docs/classes/MessageBuilder.html +31 -8
- package/docs/classes/UnsentMessage.html +2 -2
- package/docs/index.html +4 -2
- package/docs/interfaces/ConversationLimits.html +12 -12
- package/docs/modules.html +4 -2
- package/package.json +4 -3
package/docs/classes/Client.html
CHANGED
@@ -2777,6 +2777,9 @@ img {
|
|
2777
2777
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
2778
2778
|
<a href="Client.html#connectionState" class="tsd-kind-icon">connection<wbr>State</a>
|
2779
2779
|
</li>
|
2780
|
+
<li class=" tsd-kind-property tsd-parent-kind-class">
|
2781
|
+
<a href="Client.html#parsePushNotification" class="tsd-kind-icon">parse<wbr>Push<wbr>Notification</a>
|
2782
|
+
</li>
|
2780
2783
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
2781
2784
|
<a href="Client.html#version" class="tsd-kind-icon">version</a>
|
2782
2785
|
</li>
|
@@ -2804,6 +2807,12 @@ img {
|
|
2804
2807
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
2805
2808
|
<a href="Client.html#getSubscribedUsers" class="tsd-kind-icon">get<wbr>Subscribed<wbr>Users</a>
|
2806
2809
|
</li>
|
2810
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
2811
|
+
<a href="Client.html#getTemporaryContentUrlsForMedia" class="tsd-kind-icon">get<wbr>Temporary<wbr>Content<wbr>Urls<wbr>For<wbr>Media</a>
|
2812
|
+
</li>
|
2813
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
2814
|
+
<a href="Client.html#getTemporaryContentUrlsForMediaSids" class="tsd-kind-icon">get<wbr>Temporary<wbr>Content<wbr>Urls<wbr>For<wbr>Media<wbr>Sids</a>
|
2815
|
+
</li>
|
2807
2816
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
2808
2817
|
<a href="Client.html#getUser" class="tsd-kind-icon">get<wbr>User</a>
|
2809
2818
|
</li>
|
@@ -2826,7 +2835,10 @@ img {
|
|
2826
2835
|
<a href="Client.html#updateToken" class="tsd-kind-icon">update<wbr>Token</a>
|
2827
2836
|
</li>
|
2828
2837
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
2829
|
-
<a href="Client.html#parsePushNotification" class="tsd-kind-icon">parse<wbr>Push<wbr>Notification</a>
|
2838
|
+
<a href="Client.html#parsePushNotification-1" class="tsd-kind-icon">parse<wbr>Push<wbr>Notification</a>
|
2839
|
+
</li>
|
2840
|
+
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
2841
|
+
<a href="Client.html#populateInitRegistrations" class="tsd-kind-icon">populate<wbr>Init<wbr>Registrations</a>
|
2830
2842
|
</li>
|
2831
2843
|
</ul>
|
2832
2844
|
</li>
|
@@ -2895,6 +2907,7 @@ img {
|
|
2895
2907
|
<h3>Properties</h3>
|
2896
2908
|
<ul class="tsd-index-list">
|
2897
2909
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="Client.html#connectionState" class="tsd-kind-icon">connection<wbr>State</a></li>
|
2910
|
+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="Client.html#parsePushNotification" class="tsd-kind-icon">parse<wbr>Push<wbr>Notification</a></li>
|
2898
2911
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="Client.html#version" class="tsd-kind-icon">version</a></li>
|
2899
2912
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="Client.html#version-1" class="tsd-kind-icon">version</a></li>
|
2900
2913
|
</ul>
|
@@ -2914,6 +2927,8 @@ img {
|
|
2914
2927
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Client.html#getConversationByUniqueName" class="tsd-kind-icon">get<wbr>Conversation<wbr>ByUnique<wbr>Name</a></li>
|
2915
2928
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Client.html#getSubscribedConversations" class="tsd-kind-icon">get<wbr>Subscribed<wbr>Conversations</a></li>
|
2916
2929
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Client.html#getSubscribedUsers" class="tsd-kind-icon">get<wbr>Subscribed<wbr>Users</a></li>
|
2930
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Client.html#getTemporaryContentUrlsForMedia" class="tsd-kind-icon">get<wbr>Temporary<wbr>Content<wbr>Urls<wbr>For<wbr>Media</a></li>
|
2931
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Client.html#getTemporaryContentUrlsForMediaSids" class="tsd-kind-icon">get<wbr>Temporary<wbr>Content<wbr>Urls<wbr>For<wbr>Media<wbr>Sids</a></li>
|
2917
2932
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Client.html#getUser" class="tsd-kind-icon">get<wbr>User</a></li>
|
2918
2933
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Client.html#handlePushNotification" class="tsd-kind-icon">handle<wbr>Push<wbr>Notification</a></li>
|
2919
2934
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Client.html#removePushRegistrations" class="tsd-kind-icon">remove<wbr>Push<wbr>Registrations</a></li>
|
@@ -2921,7 +2936,8 @@ img {
|
|
2921
2936
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Client.html#shutdown" class="tsd-kind-icon">shutdown</a></li>
|
2922
2937
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Client.html#unsetPushRegistrationId" class="tsd-kind-icon">unset<wbr>Push<wbr>Registration<wbr>Id</a></li>
|
2923
2938
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Client.html#updateToken" class="tsd-kind-icon">update<wbr>Token</a></li>
|
2924
|
-
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Client.html#parsePushNotification" class="tsd-kind-icon">parse<wbr>Push<wbr>Notification</a></li>
|
2939
|
+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Client.html#parsePushNotification-1" class="tsd-kind-icon">parse<wbr>Push<wbr>Notification</a></li>
|
2940
|
+
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Client.html#populateInitRegistrations" class="tsd-kind-icon">populate<wbr>Init<wbr>Registrations</a></li>
|
2925
2941
|
</ul>
|
2926
2942
|
</section>
|
2927
2943
|
</div>
|
@@ -2942,9 +2958,11 @@ img {
|
|
2942
2958
|
</aside>
|
2943
2959
|
<div class="tsd-comment tsd-typography">
|
2944
2960
|
<div class="lead">
|
2945
|
-
<p>Returned Conversations instance is not yet fully initialized. Calling any
|
2946
|
-
Use connection events to monitor when
|
2947
|
-
|
2961
|
+
<p>Returned Conversations instance is not yet fully initialized. Calling any
|
2962
|
+
operations will block until it is. Use connection events to monitor when
|
2963
|
+
client becomes fully available (connectionStateChanged with state
|
2964
|
+
'connected') or not available (connectionStateChange with state 'denied',
|
2965
|
+
event tokenExpired, event connectionError).</p>
|
2948
2966
|
</div>
|
2949
2967
|
</div>
|
2950
2968
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
@@ -2986,7 +3004,8 @@ img {
|
|
2986
3004
|
</div>
|
2987
3005
|
<p>Parameters:</p>
|
2988
3006
|
<ol>
|
2989
|
-
<li>object <code>data</code> - info object provided with the event. It has the
|
3007
|
+
<li>object <code>data</code> - info object provided with the event. It has the
|
3008
|
+
following properties:<ul>
|
2990
3009
|
<li>boolean <code>terminal</code> - Twilsock will stop connection attempts if true</li>
|
2991
3010
|
<li>string <code>message</code> - the error message of the root cause</li>
|
2992
3011
|
<li>number? <code>httpStatusCode</code> - http status code if available</li>
|
@@ -3006,7 +3025,7 @@ img {
|
|
3006
3025
|
<div class="lead">
|
3007
3026
|
<p>Fired when the connection state of the client has been changed.</p>
|
3008
3027
|
</div>
|
3009
|
-
<p>
|
3028
|
+
<p>Parameters:</p>
|
3010
3029
|
<ol>
|
3011
3030
|
<li><a href="../modules.html#ConnectionState">ConnectionState</a> <code>state</code> - the new connection state</li>
|
3012
3031
|
</ol>
|
@@ -3020,8 +3039,9 @@ img {
|
|
3020
3039
|
</aside>
|
3021
3040
|
<div class="tsd-comment tsd-typography">
|
3022
3041
|
<div class="lead">
|
3023
|
-
<p>Fired when a conversation becomes visible to the client. The event is also
|
3024
|
-
|
3042
|
+
<p>Fired when a conversation becomes visible to the client. The event is also
|
3043
|
+
triggered when the client creates a new conversation.
|
3044
|
+
Fired for all conversations that the client has joined.</p>
|
3025
3045
|
</div>
|
3026
3046
|
<p>Parameters:</p>
|
3027
3047
|
<ol>
|
@@ -3085,15 +3105,18 @@ img {
|
|
3085
3105
|
</aside>
|
3086
3106
|
<div class="tsd-comment tsd-typography">
|
3087
3107
|
<div class="lead">
|
3088
|
-
<p>Fired when the attributes or the metadata of a conversation have been
|
3089
|
-
During conversation's creation and initialization, this event
|
3090
|
-
|
3108
|
+
<p>Fired when the attributes or the metadata of a conversation have been
|
3109
|
+
updated. During conversation's creation and initialization, this event
|
3110
|
+
might be fired multiple times for same joined or created conversation as
|
3111
|
+
new data is arriving from different sources.</p>
|
3091
3112
|
</div>
|
3092
3113
|
<p>Parameters:</p>
|
3093
3114
|
<ol>
|
3094
|
-
<li>object <code>data</code> - info object provided with the event. It has the
|
3115
|
+
<li>object <code>data</code> - info object provided with the event. It has the
|
3116
|
+
following properties:<ul>
|
3095
3117
|
<li><a href="Conversation.html">Conversation</a> <code>conversation</code> - the conversation in question</li>
|
3096
|
-
<li><a href="../modules.html#ConversationUpdateReason">ConversationUpdateReason</a>[] <code>updateReasons</code> - array of reasons
|
3118
|
+
<li><a href="../modules.html#ConversationUpdateReason">ConversationUpdateReason</a>[] <code>updateReasons</code> - array of reasons
|
3119
|
+
for the update</li>
|
3097
3120
|
</ul>
|
3098
3121
|
</li>
|
3099
3122
|
</ol>
|
@@ -3143,9 +3166,11 @@ img {
|
|
3143
3166
|
</div>
|
3144
3167
|
<p>Parameters:</p>
|
3145
3168
|
<ol>
|
3146
|
-
<li>object <code>data</code> - info object provided with the event. It has the
|
3169
|
+
<li>object <code>data</code> - info object provided with the event. It has the
|
3170
|
+
following properties:<ul>
|
3147
3171
|
<li><a href="Message.html">Message</a> <code>message</code> - the message in question</li>
|
3148
|
-
<li><a href="../modules.html#MessageUpdateReason">MessageUpdateReason</a>[] <code>updateReasons</code> - array of reasons for
|
3172
|
+
<li><a href="../modules.html#MessageUpdateReason">MessageUpdateReason</a>[] <code>updateReasons</code> - array of reasons for
|
3173
|
+
the update</li>
|
3149
3174
|
</ul>
|
3150
3175
|
</li>
|
3151
3176
|
</ol>
|
@@ -3195,9 +3220,11 @@ img {
|
|
3195
3220
|
</div>
|
3196
3221
|
<p>Parameters:</p>
|
3197
3222
|
<ol>
|
3198
|
-
<li>object <code>data</code> - info object provided with the event. It has the
|
3223
|
+
<li>object <code>data</code> - info object provided with the event. It has the
|
3224
|
+
following properties:<ul>
|
3199
3225
|
<li><a href="Participant.html">Participant</a> <code>participant</code> - the participant in question</li>
|
3200
|
-
<li><a href="../modules.html#ParticipantUpdateReason">ParticipantUpdateReason</a>[] <code>updateReasons</code> - array of reasons
|
3226
|
+
<li><a href="../modules.html#ParticipantUpdateReason">ParticipantUpdateReason</a>[] <code>updateReasons</code> - array of reasons
|
3227
|
+
for the update</li>
|
3201
3228
|
</ul>
|
3202
3229
|
</li>
|
3203
3230
|
</ol>
|
@@ -3211,11 +3238,13 @@ img {
|
|
3211
3238
|
</aside>
|
3212
3239
|
<div class="tsd-comment tsd-typography">
|
3213
3240
|
<div class="lead">
|
3214
|
-
<p>Fired when the client has received (and parsed) a push notification via one
|
3241
|
+
<p>Fired when the client has received (and parsed) a push notification via one
|
3242
|
+
of the push channels (apn or fcm).</p>
|
3215
3243
|
</div>
|
3216
3244
|
<p>Parameters:</p>
|
3217
3245
|
<ol>
|
3218
|
-
<li><a href="PushNotification.html">PushNotification</a> <code>pushNotification</code> - the push notification in
|
3246
|
+
<li><a href="PushNotification.html">PushNotification</a> <code>pushNotification</code> - the push notification in
|
3247
|
+
question</li>
|
3219
3248
|
</ol>
|
3220
3249
|
</div>
|
3221
3250
|
</section>
|
@@ -3231,7 +3260,12 @@ img {
|
|
3231
3260
|
</div>
|
3232
3261
|
<p>Parameters:</p>
|
3233
3262
|
<ol>
|
3234
|
-
<li
|
3263
|
+
<li>object <code>data</code> - info object provided with the event. It has the
|
3264
|
+
following properties:<ul>
|
3265
|
+
<li><a href="../modules.html#State">State</a> <code>state</code> - the new client state</li>
|
3266
|
+
<li>Error? <code>error</code> - the initialization error if present</li>
|
3267
|
+
</ul>
|
3268
|
+
</li>
|
3235
3269
|
</ol>
|
3236
3270
|
</div>
|
3237
3271
|
</section>
|
@@ -3337,13 +3371,16 @@ img {
|
|
3337
3371
|
</aside>
|
3338
3372
|
<div class="tsd-comment tsd-typography">
|
3339
3373
|
<div class="lead">
|
3340
|
-
<p>Fired when the properties or the reachability status of a user have been
|
3374
|
+
<p>Fired when the properties or the reachability status of a user have been
|
3375
|
+
updated.</p>
|
3341
3376
|
</div>
|
3342
3377
|
<p>Parameters:</p>
|
3343
3378
|
<ol>
|
3344
|
-
<li>object <code>data</code> - info object provided with the event. It has the
|
3379
|
+
<li>object <code>data</code> - info object provided with the event. It has the
|
3380
|
+
following properties:<ul>
|
3345
3381
|
<li><a href="User.html">User</a> <code>user</code> - the user in question</li>
|
3346
|
-
<li><a href="../modules.html#UserUpdateReason">UserUpdateReason</a>[] <code>updateReasons</code> - array of reasons for the
|
3382
|
+
<li><a href="../modules.html#UserUpdateReason">UserUpdateReason</a>[] <code>updateReasons</code> - array of reasons for the
|
3383
|
+
update</li>
|
3347
3384
|
</ul>
|
3348
3385
|
</li>
|
3349
3386
|
</ol>
|
@@ -3364,6 +3401,48 @@ img {
|
|
3364
3401
|
</div>
|
3365
3402
|
</div>
|
3366
3403
|
</section>
|
3404
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
3405
|
+
<a name="parsePushNotification" class="tsd-anchor"></a>
|
3406
|
+
<h3>parse<wbr>Push<wbr>Notification</h3>
|
3407
|
+
<div class="tsd-signature tsd-kind-icon">parse<wbr>Push<wbr>Notification<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>notificationPayload<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><a href="PushNotification.html" class="tsd-signature-type" data-tsd-kind="Class">PushNotification</a><span class="tsd-signature-symbol"> = ...</span></div>
|
3408
|
+
<aside class="tsd-sources">
|
3409
|
+
</aside>
|
3410
|
+
<div class="tsd-comment tsd-typography">
|
3411
|
+
<div class="lead">
|
3412
|
+
<p>Current version of the Conversations client.</p>
|
3413
|
+
</div>
|
3414
|
+
</div>
|
3415
|
+
<div class="tsd-type-declaration">
|
3416
|
+
<h4>Type declaration</h4>
|
3417
|
+
<ul class="tsd-parameters">
|
3418
|
+
<li class="tsd-parameter-signature">
|
3419
|
+
<ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
|
3420
|
+
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>notificationPayload<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="PushNotification.html" class="tsd-signature-type" data-tsd-kind="Class">PushNotification</a></li>
|
3421
|
+
</ul>
|
3422
|
+
<ul class="tsd-descriptions">
|
3423
|
+
<li class="tsd-description">
|
3424
|
+
<div class="tsd-comment tsd-typography">
|
3425
|
+
<div class="lead">
|
3426
|
+
<p>Static method for push notification payload parsing. Returns parsed push as
|
3427
|
+
a <a href="PushNotification.html">PushNotification</a> object.</p>
|
3428
|
+
</div>
|
3429
|
+
</div>
|
3430
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
3431
|
+
<ul class="tsd-parameters">
|
3432
|
+
<li>
|
3433
|
+
<h5>notificationPayload: <span class="tsd-signature-type">any</span></h5>
|
3434
|
+
<div class="tsd-comment tsd-typography">
|
3435
|
+
<p>Push notification payload.</p>
|
3436
|
+
</div>
|
3437
|
+
</li>
|
3438
|
+
</ul>
|
3439
|
+
<h4 class="tsd-returns-title">Returns <a href="PushNotification.html" class="tsd-signature-type" data-tsd-kind="Class">PushNotification</a></h4>
|
3440
|
+
</li>
|
3441
|
+
</ul>
|
3442
|
+
</li>
|
3443
|
+
</ul>
|
3444
|
+
</div>
|
3445
|
+
</section>
|
3367
3446
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
3368
3447
|
<a name="version" class="tsd-anchor"></a>
|
3369
3448
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> version</h3>
|
@@ -3403,7 +3482,7 @@ img {
|
|
3403
3482
|
</aside>
|
3404
3483
|
<div class="tsd-comment tsd-typography">
|
3405
3484
|
<div class="lead">
|
3406
|
-
<p>Client reachability state. Throws if accessed before the client
|
3485
|
+
<p>Client reachability state. Throws an error if accessed before the client
|
3407
3486
|
initialization was completed.</p>
|
3408
3487
|
</div>
|
3409
3488
|
</div>
|
@@ -3558,6 +3637,64 @@ img {
|
|
3558
3637
|
</li>
|
3559
3638
|
</ul>
|
3560
3639
|
</section>
|
3640
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
3641
|
+
<a name="getTemporaryContentUrlsForMedia" class="tsd-anchor"></a>
|
3642
|
+
<h3>get<wbr>Temporary<wbr>Content<wbr>Urls<wbr>For<wbr>Media</h3>
|
3643
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
3644
|
+
<li class="tsd-signature tsd-kind-icon">get<wbr>Temporary<wbr>Content<wbr>Urls<wbr>For<wbr>Media<span class="tsd-signature-symbol">(</span>contentSet<span class="tsd-signature-symbol">: </span><a href="Media.html" class="tsd-signature-type" data-tsd-kind="Class">Media</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CancellablePromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
3645
|
+
</ul>
|
3646
|
+
<ul class="tsd-descriptions">
|
3647
|
+
<li class="tsd-description">
|
3648
|
+
<aside class="tsd-sources">
|
3649
|
+
</aside>
|
3650
|
+
<div class="tsd-comment tsd-typography">
|
3651
|
+
<div class="lead">
|
3652
|
+
<p>Get content URLs for all media attachments in the given set using a single
|
3653
|
+
operation.</p>
|
3654
|
+
</div>
|
3655
|
+
</div>
|
3656
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
3657
|
+
<ul class="tsd-parameters">
|
3658
|
+
<li>
|
3659
|
+
<h5>contentSet: <a href="Media.html" class="tsd-signature-type" data-tsd-kind="Class">Media</a><span class="tsd-signature-symbol">[]</span></h5>
|
3660
|
+
<div class="tsd-comment tsd-typography">
|
3661
|
+
<p>Set of media attachments to query content URLs.</p>
|
3662
|
+
</div>
|
3663
|
+
</li>
|
3664
|
+
</ul>
|
3665
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">CancellablePromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
3666
|
+
</li>
|
3667
|
+
</ul>
|
3668
|
+
</section>
|
3669
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
3670
|
+
<a name="getTemporaryContentUrlsForMediaSids" class="tsd-anchor"></a>
|
3671
|
+
<h3>get<wbr>Temporary<wbr>Content<wbr>Urls<wbr>For<wbr>Media<wbr>Sids</h3>
|
3672
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
3673
|
+
<li class="tsd-signature tsd-kind-icon">get<wbr>Temporary<wbr>Content<wbr>Urls<wbr>For<wbr>Media<wbr>Sids<span class="tsd-signature-symbol">(</span>mediaSids<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CancellablePromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
|
3674
|
+
</ul>
|
3675
|
+
<ul class="tsd-descriptions">
|
3676
|
+
<li class="tsd-description">
|
3677
|
+
<aside class="tsd-sources">
|
3678
|
+
</aside>
|
3679
|
+
<div class="tsd-comment tsd-typography">
|
3680
|
+
<div class="lead">
|
3681
|
+
<p>Get content URLs for all media attachments in the given set of media sids
|
3682
|
+
using a single operation.</p>
|
3683
|
+
</div>
|
3684
|
+
</div>
|
3685
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
3686
|
+
<ul class="tsd-parameters">
|
3687
|
+
<li>
|
3688
|
+
<h5>mediaSids: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
3689
|
+
<div class="tsd-comment tsd-typography">
|
3690
|
+
<p>Set of media sids to query for the content URL.</p>
|
3691
|
+
</div>
|
3692
|
+
</li>
|
3693
|
+
</ul>
|
3694
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">CancellablePromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
|
3695
|
+
</li>
|
3696
|
+
</ul>
|
3697
|
+
</section>
|
3561
3698
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
3562
3699
|
<a name="getUser" class="tsd-anchor"></a>
|
3563
3700
|
<h3>get<wbr>User</h3>
|
@@ -3570,7 +3707,8 @@ img {
|
|
3570
3707
|
</aside>
|
3571
3708
|
<div class="tsd-comment tsd-typography">
|
3572
3709
|
<div class="lead">
|
3573
|
-
<p>Gets a user with the given identity. If it's in the subscribed list, then
|
3710
|
+
<p>Gets a user with the given identity. If it's in the subscribed list, then
|
3711
|
+
return the user object from it;
|
3574
3712
|
if not, then subscribe and add user to the subscribed list.</p>
|
3575
3713
|
</div>
|
3576
3714
|
</div>
|
@@ -3600,7 +3738,8 @@ img {
|
|
3600
3738
|
</aside>
|
3601
3739
|
<div class="tsd-comment tsd-typography">
|
3602
3740
|
<div class="lead">
|
3603
|
-
<p>Handle push notification payload parsing and emit the
|
3741
|
+
<p>Handle push notification payload parsing and emit the
|
3742
|
+
<a href="Client.html#pushNotification">Client.pushNotification</a> event on this <a href="Client.html">Client</a> instance.</p>
|
3604
3743
|
</div>
|
3605
3744
|
</div>
|
3606
3745
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
@@ -3631,8 +3770,10 @@ img {
|
|
3631
3770
|
<p>Clear existing registrations directly using provided device token.
|
3632
3771
|
This is useful to ensure stopped subscriptions without resubscribing.</p>
|
3633
3772
|
</div>
|
3634
|
-
<p>This function goes completely beside the state machine and removes all
|
3635
|
-
|
3773
|
+
<p>This function goes completely beside the state machine and removes all
|
3774
|
+
registrations.
|
3775
|
+
Use with caution: if it races with current state machine operations,
|
3776
|
+
madness will ensue.</p>
|
3636
3777
|
</div>
|
3637
3778
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
3638
3779
|
<ul class="tsd-parameters">
|
@@ -3645,7 +3786,8 @@ img {
|
|
3645
3786
|
<li>
|
3646
3787
|
<h5>registrationId: <span class="tsd-signature-type">string</span></h5>
|
3647
3788
|
<div class="tsd-comment tsd-typography">
|
3648
|
-
<p>Push notification ID provided by the FCM/APNS service
|
3789
|
+
<p>Push notification ID provided by the FCM/APNS service
|
3790
|
+
on the platform.</p>
|
3649
3791
|
</div>
|
3650
3792
|
</li>
|
3651
3793
|
</ul>
|
@@ -3679,7 +3821,8 @@ img {
|
|
3679
3821
|
<li>
|
3680
3822
|
<h5>registrationId: <span class="tsd-signature-type">string</span></h5>
|
3681
3823
|
<div class="tsd-comment tsd-typography">
|
3682
|
-
<p>Push notification ID provided by the FCM/APNS service
|
3824
|
+
<p>Push notification ID provided by the FCM/APNS service
|
3825
|
+
on the platform.</p>
|
3683
3826
|
</div>
|
3684
3827
|
</li>
|
3685
3828
|
</ul>
|
@@ -3768,7 +3911,7 @@ img {
|
|
3768
3911
|
</ul>
|
3769
3912
|
</section>
|
3770
3913
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
3771
|
-
<a name="parsePushNotification" class="tsd-anchor"></a>
|
3914
|
+
<a name="parsePushNotification-1" class="tsd-anchor"></a>
|
3772
3915
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> parse<wbr>Push<wbr>Notification</h3>
|
3773
3916
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
3774
3917
|
<li class="tsd-signature tsd-kind-icon">parse<wbr>Push<wbr>Notification<span class="tsd-signature-symbol">(</span>notificationPayload<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="PushNotification.html" class="tsd-signature-type" data-tsd-kind="Class">PushNotification</a></li>
|
@@ -3779,7 +3922,8 @@ img {
|
|
3779
3922
|
</aside>
|
3780
3923
|
<div class="tsd-comment tsd-typography">
|
3781
3924
|
<div class="lead">
|
3782
|
-
<p>Static method for push notification payload parsing. Returns parsed push as
|
3925
|
+
<p>Static method for push notification payload parsing. Returns parsed push as
|
3926
|
+
a <a href="PushNotification.html">PushNotification</a> object.</p>
|
3783
3927
|
</div>
|
3784
3928
|
</div>
|
3785
3929
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
@@ -3795,6 +3939,34 @@ img {
|
|
3795
3939
|
</li>
|
3796
3940
|
</ul>
|
3797
3941
|
</section>
|
3942
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
3943
|
+
<a name="populateInitRegistrations" class="tsd-anchor"></a>
|
3944
|
+
<h3><span class="tsd-flag ts-flagStatic">Static</span> populate<wbr>Init<wbr>Registrations</h3>
|
3945
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
3946
|
+
<li class="tsd-signature tsd-kind-icon">populate<wbr>Init<wbr>Registrations<span class="tsd-signature-symbol">(</span>reg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">InitRegistration</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
3947
|
+
</ul>
|
3948
|
+
<ul class="tsd-descriptions">
|
3949
|
+
<li class="tsd-description">
|
3950
|
+
<aside class="tsd-sources">
|
3951
|
+
</aside>
|
3952
|
+
<div class="tsd-comment tsd-typography">
|
3953
|
+
<div class="lead">
|
3954
|
+
<p>Populate the client with init registrations.</p>
|
3955
|
+
</div>
|
3956
|
+
</div>
|
3957
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
3958
|
+
<ul class="tsd-parameters">
|
3959
|
+
<li>
|
3960
|
+
<h5>reg: <span class="tsd-signature-type">InitRegistration</span></h5>
|
3961
|
+
<div class="tsd-comment tsd-typography">
|
3962
|
+
<p>The init registration to populate.</p>
|
3963
|
+
</div>
|
3964
|
+
</li>
|
3965
|
+
</ul>
|
3966
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
3967
|
+
</li>
|
3968
|
+
</ul>
|
3969
|
+
</section>
|
3798
3970
|
</section>
|
3799
3971
|
<footer>
|
3800
3972
|
<div class="container">
|
package/docs/classes/Media.html
CHANGED
@@ -2720,9 +2720,6 @@ img {
|
|
2720
2720
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
2721
2721
|
<a href="Media.html#size" class="tsd-kind-icon">size</a>
|
2722
2722
|
</li>
|
2723
|
-
<li class=" tsd-kind-method tsd-parent-kind-class">
|
2724
|
-
<a href="Media.html#getCachedTemporaryUrl" class="tsd-kind-icon">get<wbr>Cached<wbr>Temporary<wbr>Url</a>
|
2725
|
-
</li>
|
2726
2723
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
2727
2724
|
<a href="Media.html#getContentTemporaryUrl" class="tsd-kind-icon">get<wbr>Content<wbr>Temporary<wbr>Url</a>
|
2728
2725
|
</li>
|
@@ -2764,7 +2761,6 @@ img {
|
|
2764
2761
|
<section class="tsd-index-section ">
|
2765
2762
|
<h3>Methods</h3>
|
2766
2763
|
<ul class="tsd-index-list">
|
2767
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Media.html#getCachedTemporaryUrl" class="tsd-kind-icon">get<wbr>Cached<wbr>Temporary<wbr>Url</a></li>
|
2768
2764
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Media.html#getContentTemporaryUrl" class="tsd-kind-icon">get<wbr>Content<wbr>Temporary<wbr>Url</a></li>
|
2769
2765
|
</ul>
|
2770
2766
|
</section>
|
@@ -2871,33 +2867,11 @@ img {
|
|
2871
2867
|
</section>
|
2872
2868
|
<section class="tsd-panel-group tsd-member-group ">
|
2873
2869
|
<h2>Methods</h2>
|
2874
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
2875
|
-
<a name="getCachedTemporaryUrl" class="tsd-anchor"></a>
|
2876
|
-
<h3>get<wbr>Cached<wbr>Temporary<wbr>Url</h3>
|
2877
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
2878
|
-
<li class="tsd-signature tsd-kind-icon">get<wbr>Cached<wbr>Temporary<wbr>Url<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li>
|
2879
|
-
</ul>
|
2880
|
-
<ul class="tsd-descriptions">
|
2881
|
-
<li class="tsd-description">
|
2882
|
-
<aside class="tsd-sources">
|
2883
|
-
</aside>
|
2884
|
-
<div class="tsd-comment tsd-typography">
|
2885
|
-
<div class="lead">
|
2886
|
-
<p>Returns cached direct content URL for the media.</p>
|
2887
|
-
</div>
|
2888
|
-
<p>This URL will expire in several minutes. This function does not refresh the URL and can be used to query it several times
|
2889
|
-
without causing network traffic.
|
2890
|
-
If the URL becomes expired, you need to request a new one using getContentTemporaryUrl().</p>
|
2891
|
-
</div>
|
2892
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4>
|
2893
|
-
</li>
|
2894
|
-
</ul>
|
2895
|
-
</section>
|
2896
2870
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
2897
2871
|
<a name="getContentTemporaryUrl" class="tsd-anchor"></a>
|
2898
2872
|
<h3>get<wbr>Content<wbr>Temporary<wbr>Url</h3>
|
2899
2873
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
2900
|
-
<li class="tsd-signature tsd-kind-icon">get<wbr>Content<wbr>Temporary<wbr>Url<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">
|
2874
|
+
<li class="tsd-signature tsd-kind-icon">get<wbr>Content<wbr>Temporary<wbr>Url<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CancellablePromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li>
|
2901
2875
|
</ul>
|
2902
2876
|
<ul class="tsd-descriptions">
|
2903
2877
|
<li class="tsd-description">
|
@@ -2911,7 +2885,7 @@ img {
|
|
2911
2885
|
If the URL becomes expired, you need to request a new one.
|
2912
2886
|
Each call to this function produces a new temporary URL.</p>
|
2913
2887
|
</div>
|
2914
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">
|
2888
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">CancellablePromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4>
|
2915
2889
|
</li>
|
2916
2890
|
</ul>
|
2917
2891
|
</section>
|