@twilio/conversations 2.1.0-rc.8 → 3.0.0-canary.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -4
- package/builds/browser.js +2730 -1984
- package/builds/browser.js.map +1 -1
- package/builds/lib.d.ts +516 -307
- package/builds/lib.js +2730 -1984
- package/builds/lib.js.map +1 -1
- package/builds/twilio-conversations.js +5347 -4949
- package/builds/twilio-conversations.min.js +1 -16
- package/dist/aggregated-delivery-receipt.js.map +1 -1
- package/dist/client.js +429 -284
- 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/conversation.js +405 -369
- package/dist/conversation.js.map +1 -1
- package/dist/data/conversations.js +10 -11
- package/dist/data/conversations.js.map +1 -1
- package/dist/data/messages.js +46 -26
- package/dist/data/messages.js.map +1 -1
- package/dist/data/participants.js +19 -10
- package/dist/data/participants.js.map +1 -1
- package/dist/data/users.js +2 -2
- package/dist/data/users.js.map +1 -1
- package/dist/detailed-delivery-receipt.js.map +1 -1
- package/dist/index.js +6 -4
- package/dist/index.js.map +1 -1
- package/dist/interfaces/attributes.js.map +1 -1
- package/dist/interfaces/notification-types.js.map +1 -1
- package/dist/logger.js +2 -4
- package/dist/logger.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 +60 -29
- package/dist/message.js.map +1 -1
- package/dist/node_modules/tslib/tslib.es6.js +1 -1
- package/dist/node_modules/tslib/tslib.es6.js.map +1 -1
- package/dist/packages/conversations/package.json.js +1 -1
- package/dist/participant.js +2 -2
- package/dist/participant.js.map +1 -1
- package/dist/push-notification.js.map +1 -1
- package/dist/rest-paginator.js.map +1 -1
- package/dist/services/network.js.map +1 -1
- package/dist/services/typing-indicator.js +1 -1
- package/dist/services/typing-indicator.js.map +1 -1
- package/dist/unsent-message.js +13 -3
- package/dist/unsent-message.js.map +1 -1
- package/dist/user.js +1 -1
- package/dist/user.js.map +1 -1
- package/dist/util/deferred.js.map +1 -1
- package/dist/util/index.js.map +1 -1
- package/docs/assets/js/search.js +1 -1
- package/docs/classes/Client.html +205 -39
- package/docs/classes/Conversation.html +103 -51
- package/docs/classes/Media.html +2 -28
- package/docs/classes/Message.html +94 -39
- package/docs/classes/MessageBuilder.html +31 -8
- package/docs/classes/PushNotification.html +1 -1
- package/docs/classes/UnsentMessage.html +2 -2
- package/docs/index.html +20 -27
- package/docs/interfaces/ConversationLimits.html +12 -12
- package/docs/interfaces/ConversationState.html +2 -2
- package/docs/interfaces/ConversationUpdatedEventArgs.html +3001 -0
- package/docs/interfaces/PushNotificationData.html +48 -0
- package/docs/modules.html +19 -26
- package/package.json +24 -20
- package/CHANGELOG.md +0 -404
@@ -2759,6 +2759,9 @@ img {
|
|
2759
2759
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
2760
2760
|
<a href="Conversation.html#lastReadMessageIndex" class="tsd-kind-icon">last<wbr>Read<wbr>Message<wbr>Index</a>
|
2761
2761
|
</li>
|
2762
|
+
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
2763
|
+
<a href="Conversation.html#limits" class="tsd-kind-icon">limits</a>
|
2764
|
+
</li>
|
2762
2765
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
2763
2766
|
<a href="Conversation.html#notificationLevel" class="tsd-kind-icon">notification<wbr>Level</a>
|
2764
2767
|
</li>
|
@@ -2855,7 +2858,8 @@ img {
|
|
2855
2858
|
<section class="tsd-panel tsd-comment">
|
2856
2859
|
<div class="tsd-comment tsd-typography">
|
2857
2860
|
<div class="lead">
|
2858
|
-
<p>A conversation represents communication between multiple Conversations
|
2861
|
+
<p>A conversation represents communication between multiple Conversations
|
2862
|
+
clients.</p>
|
2859
2863
|
</div>
|
2860
2864
|
</div>
|
2861
2865
|
</section>
|
@@ -2907,6 +2911,7 @@ img {
|
|
2907
2911
|
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Conversation.html#friendlyName" class="tsd-kind-icon">friendly<wbr>Name</a></li>
|
2908
2912
|
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Conversation.html#lastMessage" class="tsd-kind-icon">last<wbr>Message</a></li>
|
2909
2913
|
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Conversation.html#lastReadMessageIndex" class="tsd-kind-icon">last<wbr>Read<wbr>Message<wbr>Index</a></li>
|
2914
|
+
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Conversation.html#limits" class="tsd-kind-icon">limits</a></li>
|
2910
2915
|
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Conversation.html#notificationLevel" class="tsd-kind-icon">notification<wbr>Level</a></li>
|
2911
2916
|
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Conversation.html#state" class="tsd-kind-icon">state</a></li>
|
2912
2917
|
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Conversation.html#status" class="tsd-kind-icon">status</a></li>
|
@@ -2992,9 +2997,11 @@ img {
|
|
2992
2997
|
</div>
|
2993
2998
|
<p>Parameters:</p>
|
2994
2999
|
<ol>
|
2995
|
-
<li>object <code>data</code> - info object provided with the event. It has the
|
3000
|
+
<li>object <code>data</code> - info object provided with the event. It has the
|
3001
|
+
following properties:<ul>
|
2996
3002
|
<li><a href="Message.html">Message</a> <code>message</code> - message that has received the update</li>
|
2997
|
-
<li><a href="../modules.html#MessageUpdateReason">MessageUpdateReason</a>[] <code>updateReasons</code> - array of reasons for
|
3003
|
+
<li><a href="../modules.html#MessageUpdateReason">MessageUpdateReason</a>[] <code>updateReasons</code> - array of reasons for
|
3004
|
+
the update</li>
|
2998
3005
|
</ul>
|
2999
3006
|
</li>
|
3000
3007
|
</ol>
|
@@ -3012,7 +3019,8 @@ img {
|
|
3012
3019
|
</div>
|
3013
3020
|
<p>Parameters:</p>
|
3014
3021
|
<ol>
|
3015
|
-
<li><a href="Participant.html">Participant</a> <code>participant</code> - participant that joined the
|
3022
|
+
<li><a href="Participant.html">Participant</a> <code>participant</code> - participant that joined the
|
3023
|
+
conversation</li>
|
3016
3024
|
</ol>
|
3017
3025
|
</div>
|
3018
3026
|
</section>
|
@@ -3028,7 +3036,8 @@ img {
|
|
3028
3036
|
</div>
|
3029
3037
|
<p>Parameters:</p>
|
3030
3038
|
<ol>
|
3031
|
-
<li><a href="Participant.html">Participant</a> <code>participant</code> - participant that left the
|
3039
|
+
<li><a href="Participant.html">Participant</a> <code>participant</code> - participant that left the
|
3040
|
+
conversation</li>
|
3032
3041
|
</ol>
|
3033
3042
|
</div>
|
3034
3043
|
</section>
|
@@ -3044,9 +3053,12 @@ img {
|
|
3044
3053
|
</div>
|
3045
3054
|
<p>Parameters:</p>
|
3046
3055
|
<ol>
|
3047
|
-
<li>object <code>data</code> - info object provided with the event. It has the
|
3048
|
-
|
3049
|
-
<li><a href="
|
3056
|
+
<li>object <code>data</code> - info object provided with the event. It has the
|
3057
|
+
following properties:<ul>
|
3058
|
+
<li><a href="Participant.html">Participant</a> <code>participant</code> - participant that has received the
|
3059
|
+
update</li>
|
3060
|
+
<li><a href="../modules.html#ParticipantUpdateReason">ParticipantUpdateReason</a>[] <code>updateReasons</code> - array of reasons
|
3061
|
+
for the update</li>
|
3050
3062
|
</ul>
|
3051
3063
|
</li>
|
3052
3064
|
</ol>
|
@@ -3060,7 +3072,8 @@ img {
|
|
3060
3072
|
</aside>
|
3061
3073
|
<div class="tsd-comment tsd-typography">
|
3062
3074
|
<div class="lead">
|
3063
|
-
<p>Fired when the conversation was destroyed or the currently-logged-in user
|
3075
|
+
<p>Fired when the conversation was destroyed or the currently-logged-in user
|
3076
|
+
has left private conversation.</p>
|
3064
3077
|
</div>
|
3065
3078
|
<p>Parameters:</p>
|
3066
3079
|
<ol>
|
@@ -3080,7 +3093,8 @@ img {
|
|
3080
3093
|
</div>
|
3081
3094
|
<p>Parameters:</p>
|
3082
3095
|
<ol>
|
3083
|
-
<li><a href="Participant.html">Participant</a> <code>participant</code> - the participant that has stopped
|
3096
|
+
<li><a href="Participant.html">Participant</a> <code>participant</code> - the participant that has stopped
|
3097
|
+
typing</li>
|
3084
3098
|
</ol>
|
3085
3099
|
</div>
|
3086
3100
|
</section>
|
@@ -3096,7 +3110,8 @@ img {
|
|
3096
3110
|
</div>
|
3097
3111
|
<p>Parameters:</p>
|
3098
3112
|
<ol>
|
3099
|
-
<li><a href="Participant.html">Participant</a> <code>participant</code> - the participant that has started
|
3113
|
+
<li><a href="Participant.html">Participant</a> <code>participant</code> - the participant that has started
|
3114
|
+
typing</li>
|
3100
3115
|
</ol>
|
3101
3116
|
</div>
|
3102
3117
|
</section>
|
@@ -3112,9 +3127,12 @@ img {
|
|
3112
3127
|
</div>
|
3113
3128
|
<p>Parameters:</p>
|
3114
3129
|
<ol>
|
3115
|
-
<li>object <code>data</code> - info object provided with the event. It has the
|
3116
|
-
|
3117
|
-
<li><a href="
|
3130
|
+
<li>object <code>data</code> - info object provided with the event. It has the
|
3131
|
+
following properties:<ul>
|
3132
|
+
<li><a href="Conversation.html">Conversation</a> <code>conversation</code> - conversation that has received
|
3133
|
+
the update</li>
|
3134
|
+
<li><a href="../modules.html#ConversationUpdateReason">ConversationUpdateReason</a>[] <code>updateReasons</code> - array of reasons
|
3135
|
+
for the update</li>
|
3118
3136
|
</ul>
|
3119
3137
|
</li>
|
3120
3138
|
</ol>
|
@@ -3271,6 +3289,25 @@ img {
|
|
3271
3289
|
</li>
|
3272
3290
|
</ul>
|
3273
3291
|
</section>
|
3292
|
+
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
3293
|
+
<a name="limits" class="tsd-anchor"></a>
|
3294
|
+
<h3>limits</h3>
|
3295
|
+
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
|
3296
|
+
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> limits<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ConversationLimits.html" class="tsd-signature-type" data-tsd-kind="Interface">ConversationLimits</a></li>
|
3297
|
+
</ul>
|
3298
|
+
<ul class="tsd-descriptions">
|
3299
|
+
<li class="tsd-description">
|
3300
|
+
<aside class="tsd-sources">
|
3301
|
+
</aside>
|
3302
|
+
<div class="tsd-comment tsd-typography">
|
3303
|
+
<div class="lead">
|
3304
|
+
<p>Current conversation limits.</p>
|
3305
|
+
</div>
|
3306
|
+
</div>
|
3307
|
+
<h4 class="tsd-returns-title">Returns <a href="../interfaces/ConversationLimits.html" class="tsd-signature-type" data-tsd-kind="Interface">ConversationLimits</a></h4>
|
3308
|
+
</li>
|
3309
|
+
</ul>
|
3310
|
+
</section>
|
3274
3311
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
3275
3312
|
<a name="notificationLevel" class="tsd-anchor"></a>
|
3276
3313
|
<h3>notification<wbr>Level</h3>
|
@@ -3354,7 +3391,7 @@ img {
|
|
3354
3391
|
<a name="add" class="tsd-anchor"></a>
|
3355
3392
|
<h3>add</h3>
|
3356
3393
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
3357
|
-
<li class="tsd-signature tsd-kind-icon">add<span class="tsd-signature-symbol">(</span>identity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, attributes<span class="tsd-signature-symbol">?: </span><a href="../modules.html#JSONValue" class="tsd-signature-type" data-tsd-kind="Type alias">JSONValue</a><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><
|
3394
|
+
<li class="tsd-signature tsd-kind-icon">add<span class="tsd-signature-symbol">(</span>identity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, attributes<span class="tsd-signature-symbol">?: </span><a href="../modules.html#JSONValue" class="tsd-signature-type" data-tsd-kind="Type alias">JSONValue</a><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><a href="Participant.html" class="tsd-signature-type" data-tsd-kind="Class">Participant</a><span class="tsd-signature-symbol">></span></li>
|
3358
3395
|
</ul>
|
3359
3396
|
<ul class="tsd-descriptions">
|
3360
3397
|
<li class="tsd-description">
|
@@ -3380,7 +3417,8 @@ img {
|
|
3380
3417
|
</div>
|
3381
3418
|
</li>
|
3382
3419
|
</ul>
|
3383
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><
|
3420
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Participant.html" class="tsd-signature-type" data-tsd-kind="Class">Participant</a><span class="tsd-signature-symbol">></span></h4>
|
3421
|
+
<p>The added participant.</p>
|
3384
3422
|
</li>
|
3385
3423
|
</ul>
|
3386
3424
|
</section>
|
@@ -3388,7 +3426,7 @@ img {
|
|
3388
3426
|
<a name="addNonChatParticipant" class="tsd-anchor"></a>
|
3389
3427
|
<h3>add<wbr>Non<wbr>Chat<wbr>Participant</h3>
|
3390
3428
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
3391
|
-
<li class="tsd-signature tsd-kind-icon">add<wbr>Non<wbr>Chat<wbr>Participant<span class="tsd-signature-symbol">(</span>proxyAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, attributes<span class="tsd-signature-symbol">?: </span><a href="../modules.html#JSONValue" class="tsd-signature-type" data-tsd-kind="Type alias">JSONValue</a>, bindingOptions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ParticipantBindingOptions</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><
|
3429
|
+
<li class="tsd-signature tsd-kind-icon">add<wbr>Non<wbr>Chat<wbr>Participant<span class="tsd-signature-symbol">(</span>proxyAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, attributes<span class="tsd-signature-symbol">?: </span><a href="../modules.html#JSONValue" class="tsd-signature-type" data-tsd-kind="Type alias">JSONValue</a>, bindingOptions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ParticipantBindingOptions</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><a href="Participant.html" class="tsd-signature-type" data-tsd-kind="Class">Participant</a><span class="tsd-signature-symbol">></span></li>
|
3392
3430
|
</ul>
|
3393
3431
|
<ul class="tsd-descriptions">
|
3394
3432
|
<li class="tsd-description">
|
@@ -3422,11 +3460,13 @@ img {
|
|
3422
3460
|
<li>
|
3423
3461
|
<h5>bindingOptions: <span class="tsd-signature-type">ParticipantBindingOptions</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
3424
3462
|
<div class="tsd-comment tsd-typography">
|
3425
|
-
<p>Options for adding email participants - name and
|
3463
|
+
<p>Options for adding email participants - name and
|
3464
|
+
CC/To level.</p>
|
3426
3465
|
</div>
|
3427
3466
|
</li>
|
3428
3467
|
</ul>
|
3429
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><
|
3468
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Participant.html" class="tsd-signature-type" data-tsd-kind="Class">Participant</a><span class="tsd-signature-symbol">></span></h4>
|
3469
|
+
<p>The added participant.</p>
|
3430
3470
|
</li>
|
3431
3471
|
</ul>
|
3432
3472
|
</section>
|
@@ -3442,9 +3482,10 @@ img {
|
|
3442
3482
|
</aside>
|
3443
3483
|
<div class="tsd-comment tsd-typography">
|
3444
3484
|
<div class="lead">
|
3445
|
-
<p>Advance the conversation's last read message index to the current read
|
3446
|
-
Rejects if the user is not a participant of the conversation.
|
3447
|
-
|
3485
|
+
<p>Advance the conversation's last read message index to the current read
|
3486
|
+
horizon. Rejects if the user is not a participant of the conversation. Last
|
3487
|
+
read message index is updated only if the new index value is higher than
|
3488
|
+
the previous.</p>
|
3448
3489
|
</div>
|
3449
3490
|
</div>
|
3450
3491
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
@@ -3519,20 +3560,23 @@ img {
|
|
3519
3560
|
<li>
|
3520
3561
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> pageSize: <span class="tsd-signature-type">number</span></h5>
|
3521
3562
|
<div class="tsd-comment tsd-typography">
|
3522
|
-
<p>Number of messages to return in a single chunk. Default is
|
3563
|
+
<p>Number of messages to return in a single chunk. Default is
|
3564
|
+
30.</p>
|
3523
3565
|
</div>
|
3524
3566
|
</li>
|
3525
3567
|
<li>
|
3526
3568
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> anchor: <span class="tsd-signature-type">number</span></h5>
|
3527
3569
|
<div class="tsd-comment tsd-typography">
|
3528
|
-
<p>Index of the newest message to fetch. Default is from the
|
3570
|
+
<p>Index of the newest message to fetch. Default is from the
|
3571
|
+
end.</p>
|
3529
3572
|
</div>
|
3530
3573
|
</li>
|
3531
3574
|
<li>
|
3532
3575
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> direction: <span class="tsd-signature-type">"backwards"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"forward"</span></h5>
|
3533
3576
|
<div class="tsd-comment tsd-typography">
|
3534
|
-
<p>Query direction. By default it queries backwards
|
3535
|
-
|
3577
|
+
<p>Query direction. By default, it queries backwards
|
3578
|
+
from newer to older. The <code>"forward"</code> value will query in the opposite
|
3579
|
+
direction.</p>
|
3536
3580
|
</div>
|
3537
3581
|
</li>
|
3538
3582
|
</ul>
|
@@ -3555,11 +3599,12 @@ img {
|
|
3555
3599
|
<div class="lead">
|
3556
3600
|
<p>Get the total message count in the conversation.</p>
|
3557
3601
|
</div>
|
3558
|
-
<p>This method is semi-realtime. This means that this data will be eventually
|
3559
|
-
but will also be possibly incorrect for a few seconds. The
|
3560
|
-
|
3561
|
-
|
3562
|
-
|
3602
|
+
<p>This method is semi-realtime. This means that this data will be eventually
|
3603
|
+
correct, but will also be possibly incorrect for a few seconds. The
|
3604
|
+
Conversations system does not provide real time events for counter values
|
3605
|
+
changes.</p>
|
3606
|
+
<p>This is useful for any UI badges, but it is not recommended to build any
|
3607
|
+
core application logic based on these counters being accurate in real time.</p>
|
3563
3608
|
</div>
|
3564
3609
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4>
|
3565
3610
|
</li>
|
@@ -3654,11 +3699,12 @@ img {
|
|
3654
3699
|
<div class="lead">
|
3655
3700
|
<p>Get conversation participants count.</p>
|
3656
3701
|
</div>
|
3657
|
-
<p>This method is semi-realtime. This means that this data will be eventually
|
3658
|
-
but will also be possibly incorrect for a few seconds. The
|
3659
|
-
|
3660
|
-
|
3661
|
-
|
3702
|
+
<p>This method is semi-realtime. This means that this data will be eventually
|
3703
|
+
correct, but will also be possibly incorrect for a few seconds. The
|
3704
|
+
Conversations system does not provide real time events for counter values
|
3705
|
+
changes.</p>
|
3706
|
+
<p>This is useful for any UI badges, but it is not recommended to build any
|
3707
|
+
core application logic based on these counters being accurate in real time.</p>
|
3662
3708
|
</div>
|
3663
3709
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4>
|
3664
3710
|
</li>
|
@@ -3676,17 +3722,18 @@ img {
|
|
3676
3722
|
</aside>
|
3677
3723
|
<div class="tsd-comment tsd-typography">
|
3678
3724
|
<div class="lead">
|
3679
|
-
<p>Get unread messages count for the user if they are a participant of this
|
3680
|
-
Rejects if the user is not a participant of the conversation.</p>
|
3725
|
+
<p>Get unread messages count for the user if they are a participant of this
|
3726
|
+
conversation. Rejects if the user is not a participant of the conversation.</p>
|
3681
3727
|
</div>
|
3682
3728
|
<p>Use this method to obtain the number of unread messages together with
|
3683
3729
|
<a href="Conversation.html#updateLastReadMessageIndex">Conversation.updateLastReadMessageIndex</a> instead of relying on the
|
3684
3730
|
message indices which may have gaps. See <a href="Message.html#index">Message.index</a> for details.</p>
|
3685
|
-
<p>This method is semi-realtime. This means that this data will be eventually
|
3686
|
-
but will also be possibly incorrect for a few seconds. The
|
3687
|
-
|
3688
|
-
|
3689
|
-
|
3731
|
+
<p>This method is semi-realtime. This means that this data will be eventually
|
3732
|
+
correct, but will also be possibly incorrect for a few seconds. The
|
3733
|
+
Conversations system does not provide real time events for counter values
|
3734
|
+
changes.</p>
|
3735
|
+
<p>This is useful for any UI badges, but it is not recommended to build any
|
3736
|
+
core application logic based on these counters being accurate in real time.</p>
|
3690
3737
|
</div>
|
3691
3738
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4>
|
3692
3739
|
</li>
|
@@ -3743,7 +3790,7 @@ img {
|
|
3743
3790
|
<div class="tsd-comment tsd-typography">
|
3744
3791
|
<div class="lead">
|
3745
3792
|
<p>New interface to prepare for sending a message.
|
3746
|
-
Use instead of
|
3793
|
+
Use this instead of {@link Message.sendMessage}.</p>
|
3747
3794
|
</div>
|
3748
3795
|
</div>
|
3749
3796
|
<h4 class="tsd-returns-title">Returns <a href="MessageBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">MessageBuilder</a></h4>
|
@@ -3801,7 +3848,8 @@ img {
|
|
3801
3848
|
<h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">FormData</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/SendMediaOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SendMediaOptions</a></h5>
|
3802
3849
|
<div class="tsd-comment tsd-typography">
|
3803
3850
|
<p>Message body for the text message,
|
3804
|
-
|
3851
|
+
<code>FormData</code> or <a href="../interfaces/SendMediaOptions.html">SendMediaOptions</a> for media content. Sending FormData
|
3852
|
+
is supported only with the browser engine.</p>
|
3805
3853
|
</div>
|
3806
3854
|
</li>
|
3807
3855
|
<li>
|
@@ -3834,7 +3882,8 @@ img {
|
|
3834
3882
|
</aside>
|
3835
3883
|
<div class="tsd-comment tsd-typography">
|
3836
3884
|
<div class="lead">
|
3837
|
-
<p>Set last read message index of the conversation to the index of the last
|
3885
|
+
<p>Set last read message index of the conversation to the index of the last
|
3886
|
+
known message.</p>
|
3838
3887
|
</div>
|
3839
3888
|
</div>
|
3840
3889
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4>
|
@@ -3902,8 +3951,10 @@ img {
|
|
3902
3951
|
</aside>
|
3903
3952
|
<div class="tsd-comment tsd-typography">
|
3904
3953
|
<div class="lead">
|
3905
|
-
<p>Send a notification to the server indicating that this client is currently
|
3906
|
-
|
3954
|
+
<p>Send a notification to the server indicating that this client is currently
|
3955
|
+
typing in this conversation. Typing ended notification is sent after a
|
3956
|
+
while automatically, but by calling this method again you ensure that
|
3957
|
+
typing ended is not received.</p>
|
3907
3958
|
</div>
|
3908
3959
|
</div>
|
3909
3960
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
@@ -3986,8 +4037,8 @@ img {
|
|
3986
4037
|
<li>
|
3987
4038
|
<h5>index: <span class="tsd-signature-type">number</span></h5>
|
3988
4039
|
<div class="tsd-comment tsd-typography">
|
3989
|
-
<p>Message index to set as last read.
|
3990
|
-
|
4040
|
+
<p>Message index to set as last read. If null is provided, then
|
4041
|
+
the behavior is identical to <a href="Conversation.html#setAllMessagesUnread">Conversation.setAllMessagesUnread</a>.</p>
|
3991
4042
|
</div>
|
3992
4043
|
</li>
|
3993
4044
|
</ul>
|
@@ -4016,7 +4067,8 @@ img {
|
|
4016
4067
|
<li>
|
4017
4068
|
<h5>uniqueName: <span class="tsd-signature-type">string</span></h5>
|
4018
4069
|
<div class="tsd-comment tsd-typography">
|
4019
|
-
<p>New unique name for the conversation. Setting unique name
|
4070
|
+
<p>New unique name for the conversation. Setting unique name
|
4071
|
+
to null removes it.</p>
|
4020
4072
|
</div>
|
4021
4073
|
</li>
|
4022
4074
|
</ul>
|
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>
|