@twilio/conversations 3.0.0-rc.9 → 3.0.1-rc.102
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 +38 -28
- package/builds/browser.js +1659 -264
- package/builds/browser.js.map +1 -1
- package/builds/lib.d.ts +650 -25
- package/builds/lib.js +1650 -264
- package/builds/lib.js.map +1 -1
- package/builds/twilio-conversations.js +4300 -1842
- package/builds/twilio-conversations.min.js +1 -1
- package/dist/aggregated-delivery-receipt.js +10 -1
- package/dist/aggregated-delivery-receipt.js.map +1 -1
- package/dist/channel-metadata-client.js +192 -0
- package/dist/channel-metadata-client.js.map +1 -0
- package/dist/client.js +70 -10
- package/dist/client.js.map +1 -1
- package/dist/command-executor.js +48 -6
- package/dist/command-executor.js.map +1 -1
- package/dist/configuration.js +14 -3
- package/dist/configuration.js.map +1 -1
- package/dist/content-client.js +184 -0
- package/dist/content-client.js.map +1 -0
- package/dist/content-template.js +310 -0
- package/dist/content-template.js.map +1 -0
- package/dist/conversation.js +59 -16
- package/dist/conversation.js.map +1 -1
- package/dist/data/conversations.js +25 -3
- package/dist/data/conversations.js.map +1 -1
- package/dist/data/messages.js +23 -6
- package/dist/data/messages.js.map +1 -1
- package/dist/data/participants.js +17 -8
- package/dist/data/participants.js.map +1 -1
- package/dist/data/users.js +9 -0
- package/dist/data/users.js.map +1 -1
- package/dist/detailed-delivery-receipt.js +9 -0
- package/dist/detailed-delivery-receipt.js.map +1 -1
- package/dist/index.js +14 -0
- package/dist/index.js.map +1 -1
- package/dist/interfaces/notification-types.js +9 -0
- package/dist/interfaces/notification-types.js.map +1 -1
- package/dist/interfaces/{attributes.js → rules.js} +26 -7
- package/dist/interfaces/rules.js.map +1 -0
- package/dist/logger.js +9 -0
- package/dist/logger.js.map +1 -1
- package/dist/media.js +9 -0
- package/dist/media.js.map +1 -1
- package/dist/message-builder.js +77 -6
- package/dist/message-builder.js.map +1 -1
- package/dist/message.js +156 -12
- package/dist/message.js.map +1 -1
- package/dist/node_modules/quick-lru/index.js +265 -0
- package/dist/node_modules/quick-lru/index.js.map +1 -0
- package/dist/node_modules/tslib/tslib.es6.js +9 -0
- package/dist/node_modules/tslib/tslib.es6.js.map +1 -1
- package/dist/packages/conversations/package.json.js +10 -1
- package/dist/packages/conversations/package.json.js.map +1 -1
- package/dist/participant.js +11 -2
- package/dist/participant.js.map +1 -1
- package/dist/push-notification.js +9 -0
- package/dist/push-notification.js.map +1 -1
- package/dist/rest-paginator.js +9 -0
- package/dist/rest-paginator.js.map +1 -1
- package/dist/services/network.js +9 -0
- package/dist/services/network.js.map +1 -1
- package/dist/services/typing-indicator.js +9 -0
- package/dist/services/typing-indicator.js.map +1 -1
- package/dist/unsent-message.js +9 -0
- package/dist/unsent-message.js.map +1 -1
- package/dist/user.js +20 -3
- package/dist/user.js.map +1 -1
- package/dist/util/deferred.js +9 -0
- package/dist/util/deferred.js.map +1 -1
- package/dist/util/index.js +9 -0
- package/dist/util/index.js.map +1 -1
- package/docs/assets/js/search.js +1 -1
- package/docs/classes/AggregatedDeliveryReceipt.html +1 -1
- package/docs/classes/ChannelMetadata.html +3050 -0
- package/docs/classes/Client.html +64 -25
- package/docs/classes/ContentTemplate.html +3116 -0
- package/docs/classes/ContentTemplateVariable.html +3116 -0
- package/docs/classes/Conversation.html +14 -9
- package/docs/classes/Message.html +76 -5
- package/docs/classes/MessageBuilder.html +41 -0
- package/docs/classes/Participant.html +2 -2
- package/docs/index.html +849 -25
- package/docs/interfaces/ClientOptions.html +16 -0
- package/docs/modules.html +848 -24
- package/package.json +18 -14
- package/CHANGELOG.md +0 -509
- package/dist/interfaces/attributes.js.map +0 -1
@@ -3391,7 +3391,7 @@ img {
|
|
3391
3391
|
<a name="add" class="tsd-anchor"></a>
|
3392
3392
|
<h3>add</h3>
|
3393
3393
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
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><
|
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><span class="tsd-signature-type">ParticipantResponse</span><span class="tsd-signature-symbol">></span></li>
|
3395
3395
|
</ul>
|
3396
3396
|
<ul class="tsd-descriptions">
|
3397
3397
|
<li class="tsd-description">
|
@@ -3417,7 +3417,7 @@ img {
|
|
3417
3417
|
</div>
|
3418
3418
|
</li>
|
3419
3419
|
</ul>
|
3420
|
-
<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><span class="tsd-signature-type">ParticipantResponse</span><span class="tsd-signature-symbol">></span></h4>
|
3421
3421
|
<p>The added participant.</p>
|
3422
3422
|
</li>
|
3423
3423
|
</ul>
|
@@ -3426,7 +3426,7 @@ img {
|
|
3426
3426
|
<a name="addNonChatParticipant" class="tsd-anchor"></a>
|
3427
3427
|
<h3>add<wbr>Non<wbr>Chat<wbr>Participant</h3>
|
3428
3428
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
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><
|
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><span class="tsd-signature-type">ParticipantResponse</span><span class="tsd-signature-symbol">></span></li>
|
3430
3430
|
</ul>
|
3431
3431
|
<ul class="tsd-descriptions">
|
3432
3432
|
<li class="tsd-description">
|
@@ -3465,7 +3465,7 @@ img {
|
|
3465
3465
|
</div>
|
3466
3466
|
</li>
|
3467
3467
|
</ul>
|
3468
|
-
<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><span class="tsd-signature-type">ParticipantResponse</span><span class="tsd-signature-symbol">></span></h4>
|
3469
3469
|
<p>The added participant.</p>
|
3470
3470
|
</li>
|
3471
3471
|
</ul>
|
@@ -3722,20 +3722,25 @@ img {
|
|
3722
3722
|
</aside>
|
3723
3723
|
<div class="tsd-comment tsd-typography">
|
3724
3724
|
<div class="lead">
|
3725
|
-
<p>Get unread messages
|
3725
|
+
<p>Get count of unread messages for the user if they are a participant of this
|
3726
3726
|
conversation. Rejects if the user is not a participant of the conversation.</p>
|
3727
3727
|
</div>
|
3728
3728
|
<p>Use this method to obtain the number of unread messages together with
|
3729
3729
|
<a href="Conversation.html#updateLastReadMessageIndex">Conversation.updateLastReadMessageIndex</a> instead of relying on the
|
3730
3730
|
message indices which may have gaps. See <a href="Message.html#index">Message.index</a> for details.</p>
|
3731
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
|
3732
|
+
correct, but it will also be possibly incorrect for a few seconds. The
|
3733
3733
|
Conversations system does not provide real time events for counter values
|
3734
3734
|
changes.</p>
|
3735
3735
|
<p>This is useful for any UI badges, but it is not recommended to build any
|
3736
3736
|
core application logic based on these counters being accurate in real time.</p>
|
3737
|
+
<p>If the read horizon is not set, this function will return null. This could mean
|
3738
|
+
that all messages in the conversation are unread, or that the read horizon system
|
3739
|
+
is not being used. How to interpret this <code>null</code> value is up to the customer application.</p>
|
3737
3740
|
</div>
|
3738
3741
|
<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>
|
3742
|
+
<p>Number of unread messages based on the current read horizon set for
|
3743
|
+
the user or <code>null</code> if the read horizon is not set.</p>
|
3739
3744
|
</li>
|
3740
3745
|
</ul>
|
3741
3746
|
</section>
|
@@ -3790,7 +3795,7 @@ img {
|
|
3790
3795
|
<div class="tsd-comment tsd-typography">
|
3791
3796
|
<div class="lead">
|
3792
3797
|
<p>New interface to prepare for sending a message.
|
3793
|
-
Use this instead of
|
3798
|
+
Use this instead of <a href="Conversation.html#sendMessage">Conversation.sendMessage</a>.</p>
|
3794
3799
|
</div>
|
3795
3800
|
</div>
|
3796
3801
|
<h4 class="tsd-returns-title">Returns <a href="MessageBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">MessageBuilder</a></h4>
|
@@ -3907,7 +3912,7 @@ img {
|
|
3907
3912
|
</div>
|
3908
3913
|
</div>
|
3909
3914
|
<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>
|
3910
|
-
<p>
|
3915
|
+
<p>New count of unread messages after this update.</p>
|
3911
3916
|
</li>
|
3912
3917
|
</ul>
|
3913
3918
|
</section>
|
@@ -4043,7 +4048,7 @@ img {
|
|
4043
4048
|
</li>
|
4044
4049
|
</ul>
|
4045
4050
|
<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>
|
4046
|
-
<p>
|
4051
|
+
<p>New count of unread messages after this update.</p>
|
4047
4052
|
</li>
|
4048
4053
|
</ul>
|
4049
4054
|
</section>
|
@@ -2726,6 +2726,9 @@ img {
|
|
2726
2726
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
2727
2727
|
<a href="Message.html#body" class="tsd-kind-icon">body</a>
|
2728
2728
|
</li>
|
2729
|
+
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
2730
|
+
<a href="Message.html#contentSid" class="tsd-kind-icon">content<wbr>Sid</a>
|
2731
|
+
</li>
|
2729
2732
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
2730
2733
|
<a href="Message.html#dateCreated" class="tsd-kind-icon">date<wbr>Created</a>
|
2731
2734
|
</li>
|
@@ -2753,6 +2756,12 @@ img {
|
|
2753
2756
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
2754
2757
|
<a href="Message.html#type" class="tsd-kind-icon">type</a>
|
2755
2758
|
</li>
|
2759
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
2760
|
+
<a href="Message.html#getChannelMetadata" class="tsd-kind-icon">get<wbr>Channel<wbr>Metadata</a>
|
2761
|
+
</li>
|
2762
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
2763
|
+
<a href="Message.html#getContentData" class="tsd-kind-icon">get<wbr>Content<wbr>Data</a>
|
2764
|
+
</li>
|
2756
2765
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
2757
2766
|
<a href="Message.html#getDetailedDeliveryReceipts" class="tsd-kind-icon">get<wbr>Detailed<wbr>Delivery<wbr>Receipts</a>
|
2758
2767
|
</li>
|
@@ -2831,6 +2840,7 @@ img {
|
|
2831
2840
|
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Message.html#attributes" class="tsd-kind-icon">attributes</a></li>
|
2832
2841
|
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Message.html#author" class="tsd-kind-icon">author</a></li>
|
2833
2842
|
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Message.html#body" class="tsd-kind-icon">body</a></li>
|
2843
|
+
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Message.html#contentSid" class="tsd-kind-icon">content<wbr>Sid</a></li>
|
2834
2844
|
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Message.html#dateCreated" class="tsd-kind-icon">date<wbr>Created</a></li>
|
2835
2845
|
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Message.html#dateUpdated" class="tsd-kind-icon">date<wbr>Updated</a></li>
|
2836
2846
|
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Message.html#index" class="tsd-kind-icon">index</a></li>
|
@@ -2845,6 +2855,8 @@ img {
|
|
2845
2855
|
<section class="tsd-index-section ">
|
2846
2856
|
<h3>Methods</h3>
|
2847
2857
|
<ul class="tsd-index-list">
|
2858
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#getChannelMetadata" class="tsd-kind-icon">get<wbr>Channel<wbr>Metadata</a></li>
|
2859
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#getContentData" class="tsd-kind-icon">get<wbr>Content<wbr>Data</a></li>
|
2848
2860
|
<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>
|
2849
2861
|
<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>
|
2850
2862
|
<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>
|
@@ -2993,6 +3005,25 @@ img {
|
|
2993
3005
|
</li>
|
2994
3006
|
</ul>
|
2995
3007
|
</section>
|
3008
|
+
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
3009
|
+
<a name="contentSid" class="tsd-anchor"></a>
|
3010
|
+
<h3>content<wbr>Sid</h3>
|
3011
|
+
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
|
3012
|
+
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> contentSid<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
3013
|
+
</ul>
|
3014
|
+
<ul class="tsd-descriptions">
|
3015
|
+
<li class="tsd-description">
|
3016
|
+
<aside class="tsd-sources">
|
3017
|
+
</aside>
|
3018
|
+
<div class="tsd-comment tsd-typography">
|
3019
|
+
<div class="lead">
|
3020
|
+
<p>Unique identifier of <a href="ContentTemplate.html">ContentTemplate</a> for this message.</p>
|
3021
|
+
</div>
|
3022
|
+
</div>
|
3023
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
3024
|
+
</li>
|
3025
|
+
</ul>
|
3026
|
+
</section>
|
2996
3027
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
2997
3028
|
<a name="dateCreated" class="tsd-anchor"></a>
|
2998
3029
|
<h3>date<wbr>Created</h3>
|
@@ -3043,13 +3074,13 @@ img {
|
|
3043
3074
|
</aside>
|
3044
3075
|
<div class="tsd-comment tsd-typography">
|
3045
3076
|
<div class="lead">
|
3046
|
-
<p>Index of
|
3047
|
-
By design of the Conversations system, the message indices may have arbitrary gaps between them,
|
3048
|
-
that does not necessarily mean they were deleted or otherwise modified - just that
|
3049
|
-
messages may have some non-contiguous indices even if they are being sent immediately one after another.</p>
|
3077
|
+
<p>Index of this message in the conversation's list of messages.</p>
|
3050
3078
|
</div>
|
3079
|
+
<p>By design, the message indices may have arbitrary gaps between them,
|
3080
|
+
that does not necessarily mean they were deleted or otherwise modified - just that
|
3081
|
+
messages may have some non-contiguous indices even if they are being sent immediately one after another.</p>
|
3051
3082
|
<p>Trying to use indices for some calculations is going to be unreliable.</p>
|
3052
|
-
<p>To calculate the number of unread messages it is better to use the
|
3083
|
+
<p>To calculate the number of unread messages, it is better to use the Read Horizon API.
|
3053
3084
|
See <a href="Conversation.html#getUnreadMessagesCount">Conversation.getUnreadMessagesCount</a> for details.</p>
|
3054
3085
|
</div>
|
3055
3086
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
@@ -3178,6 +3209,46 @@ img {
|
|
3178
3209
|
</section>
|
3179
3210
|
<section class="tsd-panel-group tsd-member-group ">
|
3180
3211
|
<h2>Methods</h2>
|
3212
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
3213
|
+
<a name="getChannelMetadata" class="tsd-anchor"></a>
|
3214
|
+
<h3>get<wbr>Channel<wbr>Metadata</h3>
|
3215
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
3216
|
+
<li class="tsd-signature tsd-kind-icon">get<wbr>Channel<wbr>Metadata<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="ChannelMetadata.html" class="tsd-signature-type" data-tsd-kind="Class">ChannelMetadata</a><span class="tsd-signature-symbol">></span></li>
|
3217
|
+
</ul>
|
3218
|
+
<ul class="tsd-descriptions">
|
3219
|
+
<li class="tsd-description">
|
3220
|
+
<aside class="tsd-sources">
|
3221
|
+
</aside>
|
3222
|
+
<div class="tsd-comment tsd-typography">
|
3223
|
+
<div class="lead">
|
3224
|
+
<p>Get the <a href="ChannelMetadata.html">ChannelMetadata</a> for this message. Resolves to <code>null</code> if
|
3225
|
+
the message doesn't have any channel metadata.</p>
|
3226
|
+
</div>
|
3227
|
+
</div>
|
3228
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="ChannelMetadata.html" class="tsd-signature-type" data-tsd-kind="Class">ChannelMetadata</a><span class="tsd-signature-symbol">></span></h4>
|
3229
|
+
</li>
|
3230
|
+
</ul>
|
3231
|
+
</section>
|
3232
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
3233
|
+
<a name="getContentData" class="tsd-anchor"></a>
|
3234
|
+
<h3>get<wbr>Content<wbr>Data</h3>
|
3235
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
3236
|
+
<li class="tsd-signature tsd-kind-icon">get<wbr>Content<wbr>Data<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancellablePromise.html" class="tsd-signature-type" data-tsd-kind="Class">CancellablePromise</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#ContentData" class="tsd-signature-type" data-tsd-kind="Type alias">ContentData</a><span class="tsd-signature-symbol">></span></li>
|
3237
|
+
</ul>
|
3238
|
+
<ul class="tsd-descriptions">
|
3239
|
+
<li class="tsd-description">
|
3240
|
+
<aside class="tsd-sources">
|
3241
|
+
</aside>
|
3242
|
+
<div class="tsd-comment tsd-typography">
|
3243
|
+
<div class="lead">
|
3244
|
+
<p>Get the <a href="../modules.html#ContentData">ContentData</a> for this message. Resolves to <code>null</code> when
|
3245
|
+
<a href="Message.html#contentSid">Message.contentSid</a> is null.</p>
|
3246
|
+
</div>
|
3247
|
+
</div>
|
3248
|
+
<h4 class="tsd-returns-title">Returns <a href="CancellablePromise.html" class="tsd-signature-type" data-tsd-kind="Class">CancellablePromise</a><span class="tsd-signature-symbol"><</span><a href="../modules.html#ContentData" class="tsd-signature-type" data-tsd-kind="Type alias">ContentData</a><span class="tsd-signature-symbol">></span></h4>
|
3249
|
+
</li>
|
3250
|
+
</ul>
|
3251
|
+
</section>
|
3181
3252
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
3182
3253
|
<a name="getDetailedDeliveryReceipts" class="tsd-anchor"></a>
|
3183
3254
|
<h3>get<wbr>Detailed<wbr>Delivery<wbr>Receipts</h3>
|
@@ -2720,6 +2720,9 @@ img {
|
|
2720
2720
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
2721
2721
|
<a href="MessageBuilder.html#setBody" class="tsd-kind-icon">set<wbr>Body</a>
|
2722
2722
|
</li>
|
2723
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
2724
|
+
<a href="MessageBuilder.html#setContentTemplate" class="tsd-kind-icon">set<wbr>Content<wbr>Template</a>
|
2725
|
+
</li>
|
2723
2726
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
2724
2727
|
<a href="MessageBuilder.html#setEmailBody" class="tsd-kind-icon">set<wbr>Email<wbr>Body</a>
|
2725
2728
|
</li>
|
@@ -2771,6 +2774,7 @@ img {
|
|
2771
2774
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="MessageBuilder.html#buildAndSend" class="tsd-kind-icon">build<wbr>And<wbr>Send</a></li>
|
2772
2775
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="MessageBuilder.html#setAttributes" class="tsd-kind-icon">set<wbr>Attributes</a></li>
|
2773
2776
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="MessageBuilder.html#setBody" class="tsd-kind-icon">set<wbr>Body</a></li>
|
2777
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="MessageBuilder.html#setContentTemplate" class="tsd-kind-icon">set<wbr>Content<wbr>Template</a></li>
|
2774
2778
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="MessageBuilder.html#setEmailBody" class="tsd-kind-icon">set<wbr>Email<wbr>Body</a></li>
|
2775
2779
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="MessageBuilder.html#setEmailHistory" class="tsd-kind-icon">set<wbr>Email<wbr>History</a></li>
|
2776
2780
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="MessageBuilder.html#setSubject" class="tsd-kind-icon">set<wbr>Subject</a></li>
|
@@ -2903,6 +2907,43 @@ img {
|
|
2903
2907
|
</li>
|
2904
2908
|
</ul>
|
2905
2909
|
</section>
|
2910
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
2911
|
+
<a name="setContentTemplate" class="tsd-anchor"></a>
|
2912
|
+
<h3>set<wbr>Content<wbr>Template</h3>
|
2913
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
2914
|
+
<li class="tsd-signature tsd-kind-icon">set<wbr>Content<wbr>Template<span class="tsd-signature-symbol">(</span>contentSid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, contentVariables<span class="tsd-signature-symbol">?: </span><a href="ContentTemplateVariable.html" class="tsd-signature-type" data-tsd-kind="Class">ContentTemplateVariable</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="MessageBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">MessageBuilder</a></li>
|
2915
|
+
</ul>
|
2916
|
+
<ul class="tsd-descriptions">
|
2917
|
+
<li class="tsd-description">
|
2918
|
+
<aside class="tsd-sources">
|
2919
|
+
</aside>
|
2920
|
+
<div class="tsd-comment tsd-typography">
|
2921
|
+
<div class="lead">
|
2922
|
+
<p>Adds <a href="ContentTemplate.html">ContentTemplate</a> SID for the message alongside optional
|
2923
|
+
variables. When no variables provided, the default values will be used.</p>
|
2924
|
+
</div>
|
2925
|
+
<p>Adding the content SID converts the message to a rich message. In this
|
2926
|
+
case, other fields are ignored and the message is sent using the content
|
2927
|
+
from the the <a href="ContentTemplate.html">ContentTemplate</a>.</p>
|
2928
|
+
<p>Use <a href="Client.html#getContentTemplates">Client.getContentTemplates</a> to request all available
|
2929
|
+
<a href="ContentTemplate.html">ContentTemplate</a>s.</p>
|
2930
|
+
</div>
|
2931
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
2932
|
+
<ul class="tsd-parameters">
|
2933
|
+
<li>
|
2934
|
+
<h5>contentSid: <span class="tsd-signature-type">string</span></h5>
|
2935
|
+
<div class="tsd-comment tsd-typography">
|
2936
|
+
<p>SID of the <a href="ContentTemplate.html">ContentTemplate</a></p>
|
2937
|
+
</div>
|
2938
|
+
</li>
|
2939
|
+
<li>
|
2940
|
+
<h5>contentVariables: <a href="ContentTemplateVariable.html" class="tsd-signature-type" data-tsd-kind="Class">ContentTemplateVariable</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></h5>
|
2941
|
+
</li>
|
2942
|
+
</ul>
|
2943
|
+
<h4 class="tsd-returns-title">Returns <a href="MessageBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">MessageBuilder</a></h4>
|
2944
|
+
</li>
|
2945
|
+
</ul>
|
2946
|
+
</section>
|
2906
2947
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
2907
2948
|
<a name="setEmailBody" class="tsd-anchor"></a>
|
2908
2949
|
<h3>set<wbr>Email<wbr>Body</h3>
|
@@ -3082,7 +3082,7 @@ img {
|
|
3082
3082
|
<a name="type" class="tsd-anchor"></a>
|
3083
3083
|
<h3>type</h3>
|
3084
3084
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
|
3085
|
-
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> type<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><
|
3085
|
+
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> type<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
|
3086
3086
|
</ul>
|
3087
3087
|
<ul class="tsd-descriptions">
|
3088
3088
|
<li class="tsd-description">
|
@@ -3093,7 +3093,7 @@ img {
|
|
3093
3093
|
<p>Type of the participant.</p>
|
3094
3094
|
</div>
|
3095
3095
|
</div>
|
3096
|
-
<h4 class="tsd-returns-title">Returns <
|
3096
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
3097
3097
|
</li>
|
3098
3098
|
</ul>
|
3099
3099
|
</section>
|