@twilio/conversations 2.1.0 → 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 +2726 -1984
- package/builds/browser.js.map +1 -1
- package/builds/lib.d.ts +514 -308
- package/builds/lib.js +2726 -1984
- package/builds/lib.js.map +1 -1
- package/builds/twilio-conversations.js +5414 -5035
- 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 +403 -370
- 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 +80 -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 -420
@@ -2858,7 +2858,8 @@ img {
|
|
2858
2858
|
<section class="tsd-panel tsd-comment">
|
2859
2859
|
<div class="tsd-comment tsd-typography">
|
2860
2860
|
<div class="lead">
|
2861
|
-
<p>A conversation represents communication between multiple Conversations
|
2861
|
+
<p>A conversation represents communication between multiple Conversations
|
2862
|
+
clients.</p>
|
2862
2863
|
</div>
|
2863
2864
|
</div>
|
2864
2865
|
</section>
|
@@ -2996,9 +2997,11 @@ img {
|
|
2996
2997
|
</div>
|
2997
2998
|
<p>Parameters:</p>
|
2998
2999
|
<ol>
|
2999
|
-
<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>
|
3000
3002
|
<li><a href="Message.html">Message</a> <code>message</code> - message that has received the update</li>
|
3001
|
-
<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>
|
3002
3005
|
</ul>
|
3003
3006
|
</li>
|
3004
3007
|
</ol>
|
@@ -3016,7 +3019,8 @@ img {
|
|
3016
3019
|
</div>
|
3017
3020
|
<p>Parameters:</p>
|
3018
3021
|
<ol>
|
3019
|
-
<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>
|
3020
3024
|
</ol>
|
3021
3025
|
</div>
|
3022
3026
|
</section>
|
@@ -3032,7 +3036,8 @@ img {
|
|
3032
3036
|
</div>
|
3033
3037
|
<p>Parameters:</p>
|
3034
3038
|
<ol>
|
3035
|
-
<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>
|
3036
3041
|
</ol>
|
3037
3042
|
</div>
|
3038
3043
|
</section>
|
@@ -3048,9 +3053,12 @@ img {
|
|
3048
3053
|
</div>
|
3049
3054
|
<p>Parameters:</p>
|
3050
3055
|
<ol>
|
3051
|
-
<li>object <code>data</code> - info object provided with the event. It has the
|
3052
|
-
|
3053
|
-
<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>
|
3054
3062
|
</ul>
|
3055
3063
|
</li>
|
3056
3064
|
</ol>
|
@@ -3064,7 +3072,8 @@ img {
|
|
3064
3072
|
</aside>
|
3065
3073
|
<div class="tsd-comment tsd-typography">
|
3066
3074
|
<div class="lead">
|
3067
|
-
<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>
|
3068
3077
|
</div>
|
3069
3078
|
<p>Parameters:</p>
|
3070
3079
|
<ol>
|
@@ -3084,7 +3093,8 @@ img {
|
|
3084
3093
|
</div>
|
3085
3094
|
<p>Parameters:</p>
|
3086
3095
|
<ol>
|
3087
|
-
<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>
|
3088
3098
|
</ol>
|
3089
3099
|
</div>
|
3090
3100
|
</section>
|
@@ -3100,7 +3110,8 @@ img {
|
|
3100
3110
|
</div>
|
3101
3111
|
<p>Parameters:</p>
|
3102
3112
|
<ol>
|
3103
|
-
<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>
|
3104
3115
|
</ol>
|
3105
3116
|
</div>
|
3106
3117
|
</section>
|
@@ -3116,9 +3127,12 @@ img {
|
|
3116
3127
|
</div>
|
3117
3128
|
<p>Parameters:</p>
|
3118
3129
|
<ol>
|
3119
|
-
<li>object <code>data</code> - info object provided with the event. It has the
|
3120
|
-
|
3121
|
-
<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>
|
3122
3136
|
</ul>
|
3123
3137
|
</li>
|
3124
3138
|
</ol>
|
@@ -3377,7 +3391,7 @@ img {
|
|
3377
3391
|
<a name="add" class="tsd-anchor"></a>
|
3378
3392
|
<h3>add</h3>
|
3379
3393
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
3380
|
-
<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>
|
3381
3395
|
</ul>
|
3382
3396
|
<ul class="tsd-descriptions">
|
3383
3397
|
<li class="tsd-description">
|
@@ -3403,7 +3417,8 @@ img {
|
|
3403
3417
|
</div>
|
3404
3418
|
</li>
|
3405
3419
|
</ul>
|
3406
|
-
<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>
|
3407
3422
|
</li>
|
3408
3423
|
</ul>
|
3409
3424
|
</section>
|
@@ -3411,7 +3426,7 @@ img {
|
|
3411
3426
|
<a name="addNonChatParticipant" class="tsd-anchor"></a>
|
3412
3427
|
<h3>add<wbr>Non<wbr>Chat<wbr>Participant</h3>
|
3413
3428
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
3414
|
-
<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>
|
3415
3430
|
</ul>
|
3416
3431
|
<ul class="tsd-descriptions">
|
3417
3432
|
<li class="tsd-description">
|
@@ -3445,11 +3460,13 @@ img {
|
|
3445
3460
|
<li>
|
3446
3461
|
<h5>bindingOptions: <span class="tsd-signature-type">ParticipantBindingOptions</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
3447
3462
|
<div class="tsd-comment tsd-typography">
|
3448
|
-
<p>Options for adding email participants - name and
|
3463
|
+
<p>Options for adding email participants - name and
|
3464
|
+
CC/To level.</p>
|
3449
3465
|
</div>
|
3450
3466
|
</li>
|
3451
3467
|
</ul>
|
3452
|
-
<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>
|
3453
3470
|
</li>
|
3454
3471
|
</ul>
|
3455
3472
|
</section>
|
@@ -3465,9 +3482,10 @@ img {
|
|
3465
3482
|
</aside>
|
3466
3483
|
<div class="tsd-comment tsd-typography">
|
3467
3484
|
<div class="lead">
|
3468
|
-
<p>Advance the conversation's last read message index to the current read
|
3469
|
-
Rejects if the user is not a participant of the conversation.
|
3470
|
-
|
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>
|
3471
3489
|
</div>
|
3472
3490
|
</div>
|
3473
3491
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
@@ -3542,20 +3560,23 @@ img {
|
|
3542
3560
|
<li>
|
3543
3561
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> pageSize: <span class="tsd-signature-type">number</span></h5>
|
3544
3562
|
<div class="tsd-comment tsd-typography">
|
3545
|
-
<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>
|
3546
3565
|
</div>
|
3547
3566
|
</li>
|
3548
3567
|
<li>
|
3549
3568
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> anchor: <span class="tsd-signature-type">number</span></h5>
|
3550
3569
|
<div class="tsd-comment tsd-typography">
|
3551
|
-
<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>
|
3552
3572
|
</div>
|
3553
3573
|
</li>
|
3554
3574
|
<li>
|
3555
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>
|
3556
3576
|
<div class="tsd-comment tsd-typography">
|
3557
|
-
<p>Query direction. By default it queries backwards
|
3558
|
-
|
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>
|
3559
3580
|
</div>
|
3560
3581
|
</li>
|
3561
3582
|
</ul>
|
@@ -3578,11 +3599,12 @@ img {
|
|
3578
3599
|
<div class="lead">
|
3579
3600
|
<p>Get the total message count in the conversation.</p>
|
3580
3601
|
</div>
|
3581
|
-
<p>This method is semi-realtime. This means that this data will be eventually
|
3582
|
-
but will also be possibly incorrect for a few seconds. The
|
3583
|
-
|
3584
|
-
|
3585
|
-
|
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>
|
3586
3608
|
</div>
|
3587
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>
|
3588
3610
|
</li>
|
@@ -3677,11 +3699,12 @@ img {
|
|
3677
3699
|
<div class="lead">
|
3678
3700
|
<p>Get conversation participants count.</p>
|
3679
3701
|
</div>
|
3680
|
-
<p>This method is semi-realtime. This means that this data will be eventually
|
3681
|
-
but will also be possibly incorrect for a few seconds. The
|
3682
|
-
|
3683
|
-
|
3684
|
-
|
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>
|
3685
3708
|
</div>
|
3686
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>
|
3687
3710
|
</li>
|
@@ -3699,17 +3722,18 @@ img {
|
|
3699
3722
|
</aside>
|
3700
3723
|
<div class="tsd-comment tsd-typography">
|
3701
3724
|
<div class="lead">
|
3702
|
-
<p>Get unread messages count for the user if they are a participant of this
|
3703
|
-
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>
|
3704
3727
|
</div>
|
3705
3728
|
<p>Use this method to obtain the number of unread messages together with
|
3706
3729
|
<a href="Conversation.html#updateLastReadMessageIndex">Conversation.updateLastReadMessageIndex</a> instead of relying on the
|
3707
3730
|
message indices which may have gaps. See <a href="Message.html#index">Message.index</a> for details.</p>
|
3708
|
-
<p>This method is semi-realtime. This means that this data will be eventually
|
3709
|
-
but will also be possibly incorrect for a few seconds. The
|
3710
|
-
|
3711
|
-
|
3712
|
-
|
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>
|
3713
3737
|
</div>
|
3714
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>
|
3715
3739
|
</li>
|
@@ -3766,7 +3790,7 @@ img {
|
|
3766
3790
|
<div class="tsd-comment tsd-typography">
|
3767
3791
|
<div class="lead">
|
3768
3792
|
<p>New interface to prepare for sending a message.
|
3769
|
-
Use instead of
|
3793
|
+
Use this instead of {@link Message.sendMessage}.</p>
|
3770
3794
|
</div>
|
3771
3795
|
</div>
|
3772
3796
|
<h4 class="tsd-returns-title">Returns <a href="MessageBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">MessageBuilder</a></h4>
|
@@ -3824,7 +3848,8 @@ img {
|
|
3824
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>
|
3825
3849
|
<div class="tsd-comment tsd-typography">
|
3826
3850
|
<p>Message body for the text message,
|
3827
|
-
|
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>
|
3828
3853
|
</div>
|
3829
3854
|
</li>
|
3830
3855
|
<li>
|
@@ -3857,7 +3882,8 @@ img {
|
|
3857
3882
|
</aside>
|
3858
3883
|
<div class="tsd-comment tsd-typography">
|
3859
3884
|
<div class="lead">
|
3860
|
-
<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>
|
3861
3887
|
</div>
|
3862
3888
|
</div>
|
3863
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>
|
@@ -3925,8 +3951,10 @@ img {
|
|
3925
3951
|
</aside>
|
3926
3952
|
<div class="tsd-comment tsd-typography">
|
3927
3953
|
<div class="lead">
|
3928
|
-
<p>Send a notification to the server indicating that this client is currently
|
3929
|
-
|
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>
|
3930
3958
|
</div>
|
3931
3959
|
</div>
|
3932
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>
|
@@ -4009,8 +4037,8 @@ img {
|
|
4009
4037
|
<li>
|
4010
4038
|
<h5>index: <span class="tsd-signature-type">number</span></h5>
|
4011
4039
|
<div class="tsd-comment tsd-typography">
|
4012
|
-
<p>Message index to set as last read.
|
4013
|
-
|
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>
|
4014
4042
|
</div>
|
4015
4043
|
</li>
|
4016
4044
|
</ul>
|
@@ -4039,7 +4067,8 @@ img {
|
|
4039
4067
|
<li>
|
4040
4068
|
<h5>uniqueName: <span class="tsd-signature-type">string</span></h5>
|
4041
4069
|
<div class="tsd-comment tsd-typography">
|
4042
|
-
<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>
|
4043
4072
|
</div>
|
4044
4073
|
</li>
|
4045
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>
|
@@ -2753,9 +2753,6 @@ img {
|
|
2753
2753
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
2754
2754
|
<a href="Message.html#type" class="tsd-kind-icon">type</a>
|
2755
2755
|
</li>
|
2756
|
-
<li class=" tsd-kind-method tsd-parent-kind-class">
|
2757
|
-
<a href="Message.html#attachTemporaryUrlsFor" class="tsd-kind-icon">attach<wbr>Temporary<wbr>Urls<wbr>For</a>
|
2758
|
-
</li>
|
2759
2756
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
2760
2757
|
<a href="Message.html#getDetailedDeliveryReceipts" class="tsd-kind-icon">get<wbr>Detailed<wbr>Delivery<wbr>Receipts</a>
|
2761
2758
|
</li>
|
@@ -2766,11 +2763,20 @@ img {
|
|
2766
2763
|
<a href="Message.html#getEmailHistory" class="tsd-kind-icon">get<wbr>Email<wbr>History</a>
|
2767
2764
|
</li>
|
2768
2765
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
2769
|
-
<a href="Message.html#
|
2766
|
+
<a href="Message.html#getMediaByCategories" class="tsd-kind-icon">get<wbr>Media<wbr>ByCategories</a>
|
2770
2767
|
</li>
|
2771
2768
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
2772
2769
|
<a href="Message.html#getParticipant" class="tsd-kind-icon">get<wbr>Participant</a>
|
2773
2770
|
</li>
|
2771
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
2772
|
+
<a href="Message.html#getTemporaryContentUrlsForAttachedMedia" class="tsd-kind-icon">get<wbr>Temporary<wbr>Content<wbr>Urls<wbr>For<wbr>Attached<wbr>Media</a>
|
2773
|
+
</li>
|
2774
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
2775
|
+
<a href="Message.html#getTemporaryContentUrlsForMedia" class="tsd-kind-icon">get<wbr>Temporary<wbr>Content<wbr>Urls<wbr>For<wbr>Media</a>
|
2776
|
+
</li>
|
2777
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
2778
|
+
<a href="Message.html#getTemporaryContentUrlsForMediaSids" class="tsd-kind-icon">get<wbr>Temporary<wbr>Content<wbr>Urls<wbr>For<wbr>Media<wbr>Sids</a>
|
2779
|
+
</li>
|
2774
2780
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
2775
2781
|
<a href="Message.html#remove" class="tsd-kind-icon">remove</a>
|
2776
2782
|
</li>
|
@@ -2839,12 +2845,14 @@ img {
|
|
2839
2845
|
<section class="tsd-index-section ">
|
2840
2846
|
<h3>Methods</h3>
|
2841
2847
|
<ul class="tsd-index-list">
|
2842
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#attachTemporaryUrlsFor" class="tsd-kind-icon">attach<wbr>Temporary<wbr>Urls<wbr>For</a></li>
|
2843
2848
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#getDetailedDeliveryReceipts" class="tsd-kind-icon">get<wbr>Detailed<wbr>Delivery<wbr>Receipts</a></li>
|
2844
2849
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#getEmailBody" class="tsd-kind-icon">get<wbr>Email<wbr>Body</a></li>
|
2845
2850
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#getEmailHistory" class="tsd-kind-icon">get<wbr>Email<wbr>History</a></li>
|
2846
|
-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#
|
2851
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#getMediaByCategories" class="tsd-kind-icon">get<wbr>Media<wbr>ByCategories</a></li>
|
2847
2852
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#getParticipant" class="tsd-kind-icon">get<wbr>Participant</a></li>
|
2853
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#getTemporaryContentUrlsForAttachedMedia" class="tsd-kind-icon">get<wbr>Temporary<wbr>Content<wbr>Urls<wbr>For<wbr>Attached<wbr>Media</a></li>
|
2854
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#getTemporaryContentUrlsForMedia" class="tsd-kind-icon">get<wbr>Temporary<wbr>Content<wbr>Urls<wbr>For<wbr>Media</a></li>
|
2855
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#getTemporaryContentUrlsForMediaSids" class="tsd-kind-icon">get<wbr>Temporary<wbr>Content<wbr>Urls<wbr>For<wbr>Media<wbr>Sids</a></li>
|
2848
2856
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#remove" class="tsd-kind-icon">remove</a></li>
|
2849
2857
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#updateAttributes" class="tsd-kind-icon">update<wbr>Attributes</a></li>
|
2850
2858
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#updateBody" class="tsd-kind-icon">update<wbr>Body</a></li>
|
@@ -3170,34 +3178,6 @@ img {
|
|
3170
3178
|
</section>
|
3171
3179
|
<section class="tsd-panel-group tsd-member-group ">
|
3172
3180
|
<h2>Methods</h2>
|
3173
|
-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
3174
|
-
<a name="attachTemporaryUrlsFor" class="tsd-anchor"></a>
|
3175
|
-
<h3>attach<wbr>Temporary<wbr>Urls<wbr>For</h3>
|
3176
|
-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
3177
|
-
<li class="tsd-signature tsd-kind-icon">attach<wbr>Temporary<wbr>Urls<wbr>For<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">Promise</span><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></li>
|
3178
|
-
</ul>
|
3179
|
-
<ul class="tsd-descriptions">
|
3180
|
-
<li class="tsd-description">
|
3181
|
-
<aside class="tsd-sources">
|
3182
|
-
</aside>
|
3183
|
-
<div class="tsd-comment tsd-typography">
|
3184
|
-
<div class="lead">
|
3185
|
-
<p>Get content URLs for all media attachments in the given set using single operation.</p>
|
3186
|
-
</div>
|
3187
|
-
</div>
|
3188
|
-
<h4 class="tsd-parameters-title">Parameters</h4>
|
3189
|
-
<ul class="tsd-parameters">
|
3190
|
-
<li>
|
3191
|
-
<h5>contentSet: <a href="Media.html" class="tsd-signature-type" data-tsd-kind="Class">Media</a><span class="tsd-signature-symbol">[]</span></h5>
|
3192
|
-
<div class="tsd-comment tsd-typography">
|
3193
|
-
<p>Set of media attachments to query for content URL.</p>
|
3194
|
-
</div>
|
3195
|
-
</li>
|
3196
|
-
</ul>
|
3197
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><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></h4>
|
3198
|
-
</li>
|
3199
|
-
</ul>
|
3200
|
-
</section>
|
3201
3181
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
3202
3182
|
<a name="getDetailedDeliveryReceipts" class="tsd-anchor"></a>
|
3203
3183
|
<h3>get<wbr>Detailed<wbr>Delivery<wbr>Receipts</h3>
|
@@ -3230,7 +3210,7 @@ img {
|
|
3230
3210
|
<div class="tsd-comment tsd-typography">
|
3231
3211
|
<div class="lead">
|
3232
3212
|
<p>Get a media descriptor for an email body attachment of a provided type.
|
3233
|
-
Allowed body types are returned in the Conversation.limits().
|
3213
|
+
Allowed body types are returned in the Conversation.limits().emailBodiesAllowedContentTypes array.</p>
|
3234
3214
|
</div>
|
3235
3215
|
</div>
|
3236
3216
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
@@ -3259,7 +3239,7 @@ img {
|
|
3259
3239
|
<div class="tsd-comment tsd-typography">
|
3260
3240
|
<div class="lead">
|
3261
3241
|
<p>Get a media descriptor for an email history attachment of a provided type.
|
3262
|
-
Allowed body types are returned in the Conversation.limits().
|
3242
|
+
Allowed body types are returned in the Conversation.limits().emailHistoriesAllowedContentTypes array.</p>
|
3263
3243
|
</div>
|
3264
3244
|
</div>
|
3265
3245
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
@@ -3276,10 +3256,10 @@ img {
|
|
3276
3256
|
</ul>
|
3277
3257
|
</section>
|
3278
3258
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
3279
|
-
<a name="
|
3280
|
-
<h3>get<wbr>Media<wbr>
|
3259
|
+
<a name="getMediaByCategories" class="tsd-anchor"></a>
|
3260
|
+
<h3>get<wbr>Media<wbr>ByCategories</h3>
|
3281
3261
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
3282
|
-
<li class="tsd-signature tsd-kind-icon">get<wbr>Media<wbr>
|
3262
|
+
<li class="tsd-signature tsd-kind-icon">get<wbr>Media<wbr>ByCategories<span class="tsd-signature-symbol">(</span>categories<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">MediaCategory</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><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></li>
|
3283
3263
|
</ul>
|
3284
3264
|
<ul class="tsd-descriptions">
|
3285
3265
|
<li class="tsd-description">
|
@@ -3324,6 +3304,81 @@ img {
|
|
3324
3304
|
</li>
|
3325
3305
|
</ul>
|
3326
3306
|
</section>
|
3307
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
3308
|
+
<a name="getTemporaryContentUrlsForAttachedMedia" class="tsd-anchor"></a>
|
3309
|
+
<h3>get<wbr>Temporary<wbr>Content<wbr>Urls<wbr>For<wbr>Attached<wbr>Media</h3>
|
3310
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
3311
|
+
<li class="tsd-signature tsd-kind-icon">get<wbr>Temporary<wbr>Content<wbr>Urls<wbr>For<wbr>Attached<wbr>Media<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>
|
3312
|
+
</ul>
|
3313
|
+
<ul class="tsd-descriptions">
|
3314
|
+
<li class="tsd-description">
|
3315
|
+
<aside class="tsd-sources">
|
3316
|
+
</aside>
|
3317
|
+
<div class="tsd-comment tsd-typography">
|
3318
|
+
<div class="lead">
|
3319
|
+
<p>Get content URLs for all media attached to the message.</p>
|
3320
|
+
</div>
|
3321
|
+
</div>
|
3322
|
+
<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>
|
3323
|
+
</li>
|
3324
|
+
</ul>
|
3325
|
+
</section>
|
3326
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
3327
|
+
<a name="getTemporaryContentUrlsForMedia" class="tsd-anchor"></a>
|
3328
|
+
<h3>get<wbr>Temporary<wbr>Content<wbr>Urls<wbr>For<wbr>Media</h3>
|
3329
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
3330
|
+
<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>
|
3331
|
+
</ul>
|
3332
|
+
<ul class="tsd-descriptions">
|
3333
|
+
<li class="tsd-description">
|
3334
|
+
<aside class="tsd-sources">
|
3335
|
+
</aside>
|
3336
|
+
<div class="tsd-comment tsd-typography">
|
3337
|
+
<div class="lead">
|
3338
|
+
<p>Get content URLs for all media attachments in the given set using a single operation.</p>
|
3339
|
+
</div>
|
3340
|
+
</div>
|
3341
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
3342
|
+
<ul class="tsd-parameters">
|
3343
|
+
<li>
|
3344
|
+
<h5>contentSet: <a href="Media.html" class="tsd-signature-type" data-tsd-kind="Class">Media</a><span class="tsd-signature-symbol">[]</span></h5>
|
3345
|
+
<div class="tsd-comment tsd-typography">
|
3346
|
+
<p>Set of media attachments to query content URLs.</p>
|
3347
|
+
</div>
|
3348
|
+
</li>
|
3349
|
+
</ul>
|
3350
|
+
<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>
|
3351
|
+
</li>
|
3352
|
+
</ul>
|
3353
|
+
</section>
|
3354
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
3355
|
+
<a name="getTemporaryContentUrlsForMediaSids" class="tsd-anchor"></a>
|
3356
|
+
<h3>get<wbr>Temporary<wbr>Content<wbr>Urls<wbr>For<wbr>Media<wbr>Sids</h3>
|
3357
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
3358
|
+
<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>
|
3359
|
+
</ul>
|
3360
|
+
<ul class="tsd-descriptions">
|
3361
|
+
<li class="tsd-description">
|
3362
|
+
<aside class="tsd-sources">
|
3363
|
+
</aside>
|
3364
|
+
<div class="tsd-comment tsd-typography">
|
3365
|
+
<div class="lead">
|
3366
|
+
<p>Get content URLs for all media attachments in the given set of media sids using a single operation.</p>
|
3367
|
+
</div>
|
3368
|
+
</div>
|
3369
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
3370
|
+
<ul class="tsd-parameters">
|
3371
|
+
<li>
|
3372
|
+
<h5>mediaSids: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
3373
|
+
<div class="tsd-comment tsd-typography">
|
3374
|
+
<p>Set of media sids to query for the content URL.</p>
|
3375
|
+
</div>
|
3376
|
+
</li>
|
3377
|
+
</ul>
|
3378
|
+
<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>
|
3379
|
+
</li>
|
3380
|
+
</ul>
|
3381
|
+
</section>
|
3327
3382
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
3328
3383
|
<a name="remove" class="tsd-anchor"></a>
|
3329
3384
|
<h3>remove</h3>
|