@twilio/conversations 2.1.0 → 2.2.0-rc.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +216 -0
- package/README.md +8 -4
- package/builds/browser.js +2911 -1974
- package/builds/browser.js.map +1 -1
- package/builds/lib.d.ts +572 -285
- package/builds/lib.js +2911 -1974
- package/builds/lib.js.map +1 -1
- package/builds/twilio-conversations.js +4995 -3430
- package/builds/twilio-conversations.min.js +1 -16
- package/dist/aggregated-delivery-receipt.js.map +1 -1
- package/dist/client.js +466 -281
- 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 +426 -370
- package/dist/conversation.js.map +1 -1
- package/dist/data/conversations.js +25 -13
- package/dist/data/conversations.js.map +1 -1
- package/dist/data/messages.js +56 -32
- package/dist/data/messages.js.map +1 -1
- package/dist/data/participants.js +21 -12
- 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 +89 -17
- 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 +2 -2
- 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/CancellablePromise.html +3213 -0
- package/docs/classes/Client.html +243 -58
- package/docs/classes/Conversation.html +76 -47
- 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 +25 -28
- 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 +24 -27
- package/package.json +24 -20
|
@@ -2711,6 +2711,9 @@ img {
|
|
|
2711
2711
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
2712
2712
|
<a href="MessageBuilder.html#build" class="tsd-kind-icon">build</a>
|
|
2713
2713
|
</li>
|
|
2714
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
2715
|
+
<a href="MessageBuilder.html#buildAndSend" class="tsd-kind-icon">build<wbr>And<wbr>Send</a>
|
|
2716
|
+
</li>
|
|
2714
2717
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
2715
2718
|
<a href="MessageBuilder.html#setAttributes" class="tsd-kind-icon">set<wbr>Attributes</a>
|
|
2716
2719
|
</li>
|
|
@@ -2765,6 +2768,7 @@ img {
|
|
|
2765
2768
|
<ul class="tsd-index-list">
|
|
2766
2769
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="MessageBuilder.html#addMedia" class="tsd-kind-icon">add<wbr>Media</a></li>
|
|
2767
2770
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="MessageBuilder.html#build" class="tsd-kind-icon">build</a></li>
|
|
2771
|
+
<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>
|
|
2768
2772
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="MessageBuilder.html#setAttributes" class="tsd-kind-icon">set<wbr>Attributes</a></li>
|
|
2769
2773
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="MessageBuilder.html#setBody" class="tsd-kind-icon">set<wbr>Body</a></li>
|
|
2770
2774
|
<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>
|
|
@@ -2824,6 +2828,25 @@ img {
|
|
|
2824
2828
|
</li>
|
|
2825
2829
|
</ul>
|
|
2826
2830
|
</section>
|
|
2831
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
2832
|
+
<a name="buildAndSend" class="tsd-anchor"></a>
|
|
2833
|
+
<h3>build<wbr>And<wbr>Send</h3>
|
|
2834
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
2835
|
+
<li class="tsd-signature tsd-kind-icon">build<wbr>And<wbr>Send<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><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></li>
|
|
2836
|
+
</ul>
|
|
2837
|
+
<ul class="tsd-descriptions">
|
|
2838
|
+
<li class="tsd-description">
|
|
2839
|
+
<aside class="tsd-sources">
|
|
2840
|
+
</aside>
|
|
2841
|
+
<div class="tsd-comment tsd-typography">
|
|
2842
|
+
<div class="lead">
|
|
2843
|
+
<p>Prepares a message and sends it to the conversation.</p>
|
|
2844
|
+
</div>
|
|
2845
|
+
</div>
|
|
2846
|
+
<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><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4>
|
|
2847
|
+
</li>
|
|
2848
|
+
</ul>
|
|
2849
|
+
</section>
|
|
2827
2850
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
2828
2851
|
<a name="setAttributes" class="tsd-anchor"></a>
|
|
2829
2852
|
<h3>set<wbr>Attributes</h3>
|
|
@@ -2884,7 +2907,7 @@ img {
|
|
|
2884
2907
|
<a name="setEmailBody" class="tsd-anchor"></a>
|
|
2885
2908
|
<h3>set<wbr>Email<wbr>Body</h3>
|
|
2886
2909
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
2887
|
-
<li class="tsd-signature tsd-kind-icon">set<wbr>Email<wbr>Body<span class="tsd-signature-symbol">(</span>
|
|
2910
|
+
<li class="tsd-signature tsd-kind-icon">set<wbr>Email<wbr>Body<span class="tsd-signature-symbol">(</span>contentType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, body<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><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>
|
|
2888
2911
|
</ul>
|
|
2889
2912
|
<ul class="tsd-descriptions">
|
|
2890
2913
|
<li class="tsd-description">
|
|
@@ -2892,13 +2915,13 @@ img {
|
|
|
2892
2915
|
</aside>
|
|
2893
2916
|
<div class="tsd-comment tsd-typography">
|
|
2894
2917
|
<div class="lead">
|
|
2895
|
-
<p>Set email body with given
|
|
2918
|
+
<p>Set the email body with a given content type.</p>
|
|
2896
2919
|
</div>
|
|
2897
2920
|
</div>
|
|
2898
2921
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
2899
2922
|
<ul class="tsd-parameters">
|
|
2900
2923
|
<li>
|
|
2901
|
-
<h5>
|
|
2924
|
+
<h5>contentType: <span class="tsd-signature-type">string</span></h5>
|
|
2902
2925
|
<div class="tsd-comment tsd-typography">
|
|
2903
2926
|
<p>Format of the body to set (text/plain or text/html).</p>
|
|
2904
2927
|
</div>
|
|
@@ -2906,7 +2929,7 @@ img {
|
|
|
2906
2929
|
<li>
|
|
2907
2930
|
<h5>body: <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>
|
|
2908
2931
|
<div class="tsd-comment tsd-typography">
|
|
2909
|
-
<p>Body payload in selected format.</p>
|
|
2932
|
+
<p>Body payload in the selected format.</p>
|
|
2910
2933
|
</div>
|
|
2911
2934
|
</li>
|
|
2912
2935
|
</ul>
|
|
@@ -2918,7 +2941,7 @@ img {
|
|
|
2918
2941
|
<a name="setEmailHistory" class="tsd-anchor"></a>
|
|
2919
2942
|
<h3>set<wbr>Email<wbr>History</h3>
|
|
2920
2943
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
2921
|
-
<li class="tsd-signature tsd-kind-icon">set<wbr>Email<wbr>History<span class="tsd-signature-symbol">(</span>
|
|
2944
|
+
<li class="tsd-signature tsd-kind-icon">set<wbr>Email<wbr>History<span class="tsd-signature-symbol">(</span>contentType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, history<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><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>
|
|
2922
2945
|
</ul>
|
|
2923
2946
|
<ul class="tsd-descriptions">
|
|
2924
2947
|
<li class="tsd-description">
|
|
@@ -2926,13 +2949,13 @@ img {
|
|
|
2926
2949
|
</aside>
|
|
2927
2950
|
<div class="tsd-comment tsd-typography">
|
|
2928
2951
|
<div class="lead">
|
|
2929
|
-
<p>Set email history with given
|
|
2952
|
+
<p>Set the email history with a given content type.</p>
|
|
2930
2953
|
</div>
|
|
2931
2954
|
</div>
|
|
2932
2955
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
2933
2956
|
<ul class="tsd-parameters">
|
|
2934
2957
|
<li>
|
|
2935
|
-
<h5>
|
|
2958
|
+
<h5>contentType: <span class="tsd-signature-type">string</span></h5>
|
|
2936
2959
|
<div class="tsd-comment tsd-typography">
|
|
2937
2960
|
<p>Format of the history to set (text/plain or text/html).</p>
|
|
2938
2961
|
</div>
|
|
@@ -2940,7 +2963,7 @@ img {
|
|
|
2940
2963
|
<li>
|
|
2941
2964
|
<h5>history: <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>
|
|
2942
2965
|
<div class="tsd-comment tsd-typography">
|
|
2943
|
-
<p>History payload in selected format.</p>
|
|
2966
|
+
<p>History payload in the selected format.</p>
|
|
2944
2967
|
</div>
|
|
2945
2968
|
</li>
|
|
2946
2969
|
</ul>
|
|
@@ -2843,7 +2843,7 @@ img {
|
|
|
2843
2843
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
2844
2844
|
<a name="type" class="tsd-anchor"></a>
|
|
2845
2845
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3>
|
|
2846
|
-
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <
|
|
2846
|
+
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">PushNotificationType</span></div>
|
|
2847
2847
|
<aside class="tsd-sources">
|
|
2848
2848
|
</aside>
|
|
2849
2849
|
<div class="tsd-comment tsd-typography">
|
|
@@ -2748,7 +2748,7 @@ img {
|
|
|
2748
2748
|
<a name="send" class="tsd-anchor"></a>
|
|
2749
2749
|
<h3>send</h3>
|
|
2750
2750
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
2751
|
-
<li class="tsd-signature tsd-kind-icon">send<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><
|
|
2751
|
+
<li class="tsd-signature tsd-kind-icon">send<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><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></li>
|
|
2752
2752
|
</ul>
|
|
2753
2753
|
<ul class="tsd-descriptions">
|
|
2754
2754
|
<li class="tsd-description">
|
|
@@ -2759,7 +2759,7 @@ img {
|
|
|
2759
2759
|
<p>Send the prepared message to the conversation.</p>
|
|
2760
2760
|
</div>
|
|
2761
2761
|
</div>
|
|
2762
|
-
<h4 class="tsd-returns-title">Returns <
|
|
2762
|
+
<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><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4>
|
|
2763
2763
|
<p>Index of the new message in the conversation.</p>
|
|
2764
2764
|
</li>
|
|
2765
2765
|
</ul>
|
package/docs/index.html
CHANGED
|
@@ -2703,6 +2703,9 @@ img {
|
|
|
2703
2703
|
<li class=" tsd-kind-class">
|
|
2704
2704
|
<a href="classes/AggregatedDeliveryReceipt.html" class="tsd-kind-icon">Aggregated<wbr>Delivery<wbr>Receipt</a>
|
|
2705
2705
|
</li>
|
|
2706
|
+
<li class=" tsd-kind-class tsd-has-type-parameter">
|
|
2707
|
+
<a href="classes/CancellablePromise.html" class="tsd-kind-icon">Cancellable<wbr>Promise</a>
|
|
2708
|
+
</li>
|
|
2706
2709
|
<li class=" tsd-kind-class">
|
|
2707
2710
|
<a href="classes/Client.html" class="tsd-kind-icon">Client</a>
|
|
2708
2711
|
</li>
|
|
@@ -2751,6 +2754,9 @@ img {
|
|
|
2751
2754
|
<li class=" tsd-kind-interface">
|
|
2752
2755
|
<a href="interfaces/ConversationState.html" class="tsd-kind-icon">Conversation<wbr>State</a>
|
|
2753
2756
|
</li>
|
|
2757
|
+
<li class=" tsd-kind-interface">
|
|
2758
|
+
<a href="interfaces/ConversationUpdatedEventArgs.html" class="tsd-kind-icon">Conversation<wbr>Updated<wbr>Event<wbr>Args</a>
|
|
2759
|
+
</li>
|
|
2754
2760
|
<li class=" tsd-kind-interface">
|
|
2755
2761
|
<a href="interfaces/CreateConversationOptions.html" class="tsd-kind-icon">Create<wbr>Conversation<wbr>Options</a>
|
|
2756
2762
|
</li>
|
|
@@ -2823,9 +2829,6 @@ img {
|
|
|
2823
2829
|
<li class=" tsd-kind-type-alias">
|
|
2824
2830
|
<a href="modules.html#ParticipantUpdateReason" class="tsd-kind-icon">Participant<wbr>Update<wbr>Reason</a>
|
|
2825
2831
|
</li>
|
|
2826
|
-
<li class=" tsd-kind-type-alias">
|
|
2827
|
-
<a href="modules.html#PushNotificationType" class="tsd-kind-icon">Push<wbr>Notification<wbr>Type</a>
|
|
2828
|
-
</li>
|
|
2829
2832
|
<li class=" tsd-kind-type-alias">
|
|
2830
2833
|
<a href="modules.html#State" class="tsd-kind-icon">State</a>
|
|
2831
2834
|
</li>
|
|
@@ -2857,10 +2860,14 @@ img {
|
|
|
2857
2860
|
<span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">client</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #795E26">Client</span><span style="color: #000000">(</span><span style="color: #001080">token</span><span style="color: #000000">);</span>
|
|
2858
2861
|
<span style="color: #008000">// Before you use the client, subscribe to the `'stateChanged'` event and wait </span>
|
|
2859
2862
|
<span style="color: #008000">// for the `'initialized'` state to be reported.</span>
|
|
2860
|
-
<span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">'stateChanged'</span><span style="color: #000000">, (</span><span style="color: #001080">state</span><span style="color: #000000">) </span><span style="color: #0000FF">=></span><span style="color: #000000"> {</span>
|
|
2863
|
+
<span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">'stateChanged'</span><span style="color: #000000">, ({ </span><span style="color: #001080">state</span><span style="color: #000000">, </span><span style="color: #001080">error</span><span style="color: #000000"> }) </span><span style="color: #0000FF">=></span><span style="color: #000000"> {</span>
|
|
2861
2864
|
<span style="color: #000000"> </span><span style="color: #AF00DB">if</span><span style="color: #000000"> (</span><span style="color: #001080">state</span><span style="color: #000000"> === </span><span style="color: #A31515">'initialized'</span><span style="color: #000000">) {</span>
|
|
2862
2865
|
<span style="color: #000000"> </span><span style="color: #008000">// Use the client</span>
|
|
2863
2866
|
<span style="color: #000000"> }</span>
|
|
2867
|
+
<span style="color: #000000"> </span>
|
|
2868
|
+
<span style="color: #000000"> </span><span style="color: #AF00DB">if</span><span style="color: #000000"> (</span><span style="color: #001080">error</span><span style="color: #000000">) {</span>
|
|
2869
|
+
<span style="color: #000000"> </span><span style="color: #008000">// Handle error</span>
|
|
2870
|
+
<span style="color: #000000"> }</span>
|
|
2864
2871
|
<span style="color: #000000">}</span>
|
|
2865
2872
|
</code></pre>
|
|
2866
2873
|
<p>The SDK could also be imported using the ES module syntax:</p>
|
|
@@ -2868,7 +2875,7 @@ img {
|
|
|
2868
2875
|
<span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">client</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #795E26">Client</span><span style="color: #000000">(</span><span style="color: #001080">token</span><span style="color: #000000">);</span>
|
|
2869
2876
|
<span style="color: #008000">// Before you use the client, subscribe to the `'stateChanged'` event and wait </span>
|
|
2870
2877
|
<span style="color: #008000">// for the `'initialized'` state to be reported.</span>
|
|
2871
|
-
<span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">'stateChanged'</span><span style="color: #000000">, (</span><span style="color: #001080">state</span><span style="color: #000000">) </span><span style="color: #0000FF">=></span><span style="color: #000000"> {</span>
|
|
2878
|
+
<span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">on</span><span style="color: #000000">(</span><span style="color: #A31515">'stateChanged'</span><span style="color: #000000">, ({ </span><span style="color: #001080">state</span><span style="color: #000000">, </span><span style="color: #001080">error</span><span style="color: #000000"> }) </span><span style="color: #0000FF">=></span><span style="color: #000000"> {</span>
|
|
2872
2879
|
<span style="color: #000000"> </span><span style="color: #AF00DB">if</span><span style="color: #000000"> (</span><span style="color: #001080">state</span><span style="color: #000000"> === </span><span style="color: #A31515">'initialized'</span><span style="color: #000000">) {</span>
|
|
2873
2880
|
<span style="color: #000000"> </span><span style="color: #008000">// Use the client</span>
|
|
2874
2881
|
<span style="color: #000000"> }</span>
|
|
@@ -2879,7 +2886,7 @@ img {
|
|
|
2879
2886
|
</a>
|
|
2880
2887
|
<p>Releases of <code>twilio-conversations.js</code> are hosted on a CDN, and you can include these
|
|
2881
2888
|
directly in your web app using a <code><script></code> tag.</p>
|
|
2882
|
-
<pre><code class="language-html"><span style="color: #800000"><script</span><span style="color: #000000FF"> </span><span style="color: #FF0000">src</span><span style="color: #000000FF">=</span><span style="color: #0000FF">"https://media.twiliocdn.com/sdk/js/conversations/v2.
|
|
2889
|
+
<pre><code class="language-html"><span style="color: #800000"><script</span><span style="color: #000000FF"> </span><span style="color: #FF0000">src</span><span style="color: #000000FF">=</span><span style="color: #0000FF">"https://media.twiliocdn.com/sdk/js/conversations/v2.2/twilio-conversations.min.js"</span><span style="color: #800000">></script></span>
|
|
2883
2890
|
</code></pre>
|
|
2884
2891
|
<p>Using this method, <code>twilio-conversations.js</code> will set a browser global <code>Twilio.Conversations</code> through which you can use the client:</p>
|
|
2885
2892
|
<pre><code><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">client</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #001080">Twilio</span><span style="color: #000000">.</span><span style="color: #001080">Conversations</span><span style="color: #000000">.</span><span style="color: #795E26">Client</span><span style="color: #000000">(</span><span style="color: #001080">token</span><span style="color: #000000">);</span>
|
|
@@ -2892,13 +2899,13 @@ img {
|
|
|
2892
2899
|
<p>If you require more security you will have to consume SDK by using <a href="https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity">SRI</a> and using an exact version
|
|
2893
2900
|
number. While less flexible it is significantly more secure, which is required by some applications.</p>
|
|
2894
2901
|
<p>To consume securely use the following script snippet format:</p>
|
|
2895
|
-
<pre><code class="language-html"><span style="color: #800000"><script</span><span style="color: #000000FF"> </span><span style="color: #FF0000">src</span><span style="color: #000000FF">=</span><span style="color: #0000FF">"https://media.twiliocdn.com/sdk/js/conversations/releases/2.0
|
|
2902
|
+
<pre><code class="language-html"><span style="color: #800000"><script</span><span style="color: #000000FF"> </span><span style="color: #FF0000">src</span><span style="color: #000000FF">=</span><span style="color: #0000FF">"https://media.twiliocdn.com/sdk/js/conversations/releases/2.2.0/twilio-conversations.min.js"</span>
|
|
2896
2903
|
<span style="color: #000000FF"> </span><span style="color: #FF0000">integrity</span><span style="color: #000000FF">=</span><span style="color: #0000FF">"sha256-<HASH FROM THE CHANGELOGS PAGE>"</span>
|
|
2897
2904
|
<span style="color: #000000FF"> </span><span style="color: #FF0000">crossorigin</span><span style="color: #000000FF">=</span><span style="color: #0000FF">"anonymous"</span><span style="color: #800000">></script></span>
|
|
2898
2905
|
</code></pre>
|
|
2899
2906
|
<p>Find the hash of each release published on the <a href="#Changelog">Changelog</a> page.</p>
|
|
2900
2907
|
<a href="#changelog" id="changelog" style="color: inherit; text-decoration: none;">
|
|
2901
|
-
<h2>Supported Browsers</h2><table><thead><tr><th>Browser</th><th>Supported Versions</th></tr></thead><tbody><tr><td>Chrome for Android</td><td>
|
|
2908
|
+
<h2>Supported Browsers</h2><table><thead><tr><th>Browser</th><th>Supported Versions</th></tr></thead><tbody><tr><td>Chrome for Android</td><td>104</td></tr><tr><td>Firefox for Android</td><td>101</td></tr><tr><td>UC Browser for Android</td><td>12.12</td></tr><tr><td>Chrome</td><td>104, 103, 102</td></tr><tr><td>Edge</td><td>104, 103, 102</td></tr><tr><td>Firefox</td><td>103, 102, 101</td></tr><tr><td>Internet Explorer</td><td>11</td></tr><tr><td>Safari for iOS</td><td>15.6, 15.5</td></tr><tr><td>Safari</td><td>15.6, 15.5, 15.4</td></tr><tr><td>Samsung Internet</td><td>18.0, 17.0</td></tr></tbody></table><h3>Changelog</h3>
|
|
2902
2909
|
</a>
|
|
2903
2910
|
<p>See this <a href="https://www.twilio.com/docs/conversations/javascript/changelog">link</a>.</p>
|
|
2904
2911
|
</div>
|
|
@@ -2911,6 +2918,7 @@ img {
|
|
|
2911
2918
|
<h3>Classes</h3>
|
|
2912
2919
|
<ul class="tsd-index-list">
|
|
2913
2920
|
<li class="tsd-kind-class"><a href="classes/AggregatedDeliveryReceipt.html" class="tsd-kind-icon">Aggregated<wbr>Delivery<wbr>Receipt</a></li>
|
|
2921
|
+
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/CancellablePromise.html" class="tsd-kind-icon">Cancellable<wbr>Promise</a></li>
|
|
2914
2922
|
<li class="tsd-kind-class"><a href="classes/Client.html" class="tsd-kind-icon">Client</a></li>
|
|
2915
2923
|
<li class="tsd-kind-class"><a href="classes/Conversation.html" class="tsd-kind-icon">Conversation</a></li>
|
|
2916
2924
|
<li class="tsd-kind-class"><a href="classes/DetailedDeliveryReceipt.html" class="tsd-kind-icon">Detailed<wbr>Delivery<wbr>Receipt</a></li>
|
|
@@ -2932,6 +2940,7 @@ img {
|
|
|
2932
2940
|
<li class="tsd-kind-interface"><a href="interfaces/ConversationEmailBinding.html" class="tsd-kind-icon">Conversation<wbr>Email<wbr>Binding</a></li>
|
|
2933
2941
|
<li class="tsd-kind-interface"><a href="interfaces/ConversationLimits.html" class="tsd-kind-icon">Conversation<wbr>Limits</a></li>
|
|
2934
2942
|
<li class="tsd-kind-interface"><a href="interfaces/ConversationState.html" class="tsd-kind-icon">Conversation<wbr>State</a></li>
|
|
2943
|
+
<li class="tsd-kind-interface"><a href="interfaces/ConversationUpdatedEventArgs.html" class="tsd-kind-icon">Conversation<wbr>Updated<wbr>Event<wbr>Args</a></li>
|
|
2935
2944
|
<li class="tsd-kind-interface"><a href="interfaces/CreateConversationOptions.html" class="tsd-kind-icon">Create<wbr>Conversation<wbr>Options</a></li>
|
|
2936
2945
|
<li class="tsd-kind-interface"><a href="interfaces/LastMessage.html" class="tsd-kind-icon">Last<wbr>Message</a></li>
|
|
2937
2946
|
<li class="tsd-kind-interface tsd-has-type-parameter"><a href="interfaces/Paginator.html" class="tsd-kind-icon">Paginator</a></li>
|
|
@@ -2961,7 +2970,6 @@ img {
|
|
|
2961
2970
|
<li class="tsd-kind-type-alias"><a href="modules.html#ParticipantEmailLevel" class="tsd-kind-icon">Participant<wbr>Email<wbr>Level</a></li>
|
|
2962
2971
|
<li class="tsd-kind-type-alias"><a href="modules.html#ParticipantType" class="tsd-kind-icon">Participant<wbr>Type</a></li>
|
|
2963
2972
|
<li class="tsd-kind-type-alias"><a href="modules.html#ParticipantUpdateReason" class="tsd-kind-icon">Participant<wbr>Update<wbr>Reason</a></li>
|
|
2964
|
-
<li class="tsd-kind-type-alias"><a href="modules.html#PushNotificationType" class="tsd-kind-icon">Push<wbr>Notification<wbr>Type</a></li>
|
|
2965
2973
|
<li class="tsd-kind-type-alias"><a href="modules.html#State" class="tsd-kind-icon">State</a></li>
|
|
2966
2974
|
<li class="tsd-kind-type-alias"><a href="modules.html#UserUpdateReason" class="tsd-kind-icon">User<wbr>Update<wbr>Reason</a></li>
|
|
2967
2975
|
</ul>
|
|
@@ -2984,8 +2992,10 @@ img {
|
|
|
2984
2992
|
<li><code>'connecting'</code> - client is offline and connection attempt is in process</li>
|
|
2985
2993
|
<li><code>'connected'</code> - client is online and ready</li>
|
|
2986
2994
|
<li><code>'disconnecting'</code> - client is going offline as disconnection is in process</li>
|
|
2987
|
-
<li><code>'disconnected'</code> - client is offline and no connection attempt is in
|
|
2988
|
-
|
|
2995
|
+
<li><code>'disconnected'</code> - client is offline and no connection attempt is in
|
|
2996
|
+
process</li>
|
|
2997
|
+
<li><code>'denied'</code> - client connection is denied because of invalid JWT access
|
|
2998
|
+
token. User must refresh token in order to proceed</li>
|
|
2989
2999
|
</ul>
|
|
2990
3000
|
</div>
|
|
2991
3001
|
</div>
|
|
@@ -2998,9 +3008,8 @@ img {
|
|
|
2998
3008
|
</aside>
|
|
2999
3009
|
<div class="tsd-comment tsd-typography">
|
|
3000
3010
|
<div class="lead">
|
|
3001
|
-
<p>
|
|
3002
|
-
|
|
3003
|
-
<code>notParticipating</code> in the conversation.</p>
|
|
3011
|
+
<p>Status of the conversation, relative to the client: whether the conversation
|
|
3012
|
+
has been <code>joined</code> or the client is <code>notParticipating</code> in the conversation.</p>
|
|
3004
3013
|
</div>
|
|
3005
3014
|
</div>
|
|
3006
3015
|
</section>
|
|
@@ -3012,7 +3021,7 @@ img {
|
|
|
3012
3021
|
</aside>
|
|
3013
3022
|
<div class="tsd-comment tsd-typography">
|
|
3014
3023
|
<div class="lead">
|
|
3015
|
-
<p>
|
|
3024
|
+
<p>Reason for the <code>updated</code> event emission by a conversation.</p>
|
|
3016
3025
|
</div>
|
|
3017
3026
|
</div>
|
|
3018
3027
|
</section>
|
|
@@ -3133,7 +3142,7 @@ img {
|
|
|
3133
3142
|
</aside>
|
|
3134
3143
|
<div class="tsd-comment tsd-typography">
|
|
3135
3144
|
<div class="lead">
|
|
3136
|
-
<p>
|
|
3145
|
+
<p>User's notification level for the conversation. Determines
|
|
3137
3146
|
whether the currently logged-in user will receive pushes for events
|
|
3138
3147
|
in this conversation. Can be either <code>muted</code> or <code>default</code>, where
|
|
3139
3148
|
<code>default</code> defers to the global service push configuration.</p>
|
|
@@ -3194,18 +3203,6 @@ img {
|
|
|
3194
3203
|
</div>
|
|
3195
3204
|
</div>
|
|
3196
3205
|
</section>
|
|
3197
|
-
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
3198
|
-
<a name="PushNotificationType" class="tsd-anchor"></a>
|
|
3199
|
-
<h3>Push<wbr>Notification<wbr>Type</h3>
|
|
3200
|
-
<div class="tsd-signature tsd-kind-icon">Push<wbr>Notification<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"twilio.conversations.new_message"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"twilio.conversations.added_to_conversation"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"twilio.conversations.removed_from_conversation"</span></div>
|
|
3201
|
-
<aside class="tsd-sources">
|
|
3202
|
-
</aside>
|
|
3203
|
-
<div class="tsd-comment tsd-typography">
|
|
3204
|
-
<div class="lead">
|
|
3205
|
-
<p>Push notification type.</p>
|
|
3206
|
-
</div>
|
|
3207
|
-
</div>
|
|
3208
|
-
</section>
|
|
3209
3206
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
|
3210
3207
|
<a name="State" class="tsd-anchor"></a>
|
|
3211
3208
|
<h3>State</h3>
|
|
@@ -2706,10 +2706,10 @@ img {
|
|
|
2706
2706
|
<a href="ConversationLimits.html" class="tsd-kind-icon">Conversation<wbr>Limits</a>
|
|
2707
2707
|
<ul>
|
|
2708
2708
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
2709
|
-
<a href="ConversationLimits.html#
|
|
2709
|
+
<a href="ConversationLimits.html#emailBodiesAllowedContentTypes" class="tsd-kind-icon">email<wbr>Bodies<wbr>Allowed<wbr>Content<wbr>Types</a>
|
|
2710
2710
|
</li>
|
|
2711
2711
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
2712
|
-
<a href="ConversationLimits.html#
|
|
2712
|
+
<a href="ConversationLimits.html#emailHistoriesAllowedContentTypes" class="tsd-kind-icon">email<wbr>Histories<wbr>Allowed<wbr>Content<wbr>Types</a>
|
|
2713
2713
|
</li>
|
|
2714
2714
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
2715
2715
|
<a href="ConversationLimits.html#mediaAttachmentSizeLimitInMb" class="tsd-kind-icon">media<wbr>Attachment<wbr>Size<wbr>Limit<wbr>InMb</a>
|
|
@@ -2748,8 +2748,8 @@ img {
|
|
|
2748
2748
|
<section class="tsd-index-section ">
|
|
2749
2749
|
<h3>Properties</h3>
|
|
2750
2750
|
<ul class="tsd-index-list">
|
|
2751
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ConversationLimits.html#
|
|
2752
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ConversationLimits.html#
|
|
2751
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ConversationLimits.html#emailBodiesAllowedContentTypes" class="tsd-kind-icon">email<wbr>Bodies<wbr>Allowed<wbr>Content<wbr>Types</a></li>
|
|
2752
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ConversationLimits.html#emailHistoriesAllowedContentTypes" class="tsd-kind-icon">email<wbr>Histories<wbr>Allowed<wbr>Content<wbr>Types</a></li>
|
|
2753
2753
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ConversationLimits.html#mediaAttachmentSizeLimitInMb" class="tsd-kind-icon">media<wbr>Attachment<wbr>Size<wbr>Limit<wbr>InMb</a></li>
|
|
2754
2754
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ConversationLimits.html#mediaAttachmentsCountLimit" class="tsd-kind-icon">media<wbr>Attachments<wbr>Count<wbr>Limit</a></li>
|
|
2755
2755
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="ConversationLimits.html#mediaAttachmentsTotalSizeLimitInMb" class="tsd-kind-icon">media<wbr>Attachments<wbr>Total<wbr>Size<wbr>Limit<wbr>InMb</a></li>
|
|
@@ -2761,26 +2761,26 @@ img {
|
|
|
2761
2761
|
<section class="tsd-panel-group tsd-member-group ">
|
|
2762
2762
|
<h2>Properties</h2>
|
|
2763
2763
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
2764
|
-
<a name="
|
|
2765
|
-
<h3>email<wbr>Bodies<wbr>Allowed<wbr>
|
|
2766
|
-
<div class="tsd-signature tsd-kind-icon">email<wbr>Bodies<wbr>Allowed<wbr>
|
|
2764
|
+
<a name="emailBodiesAllowedContentTypes" class="tsd-anchor"></a>
|
|
2765
|
+
<h3>email<wbr>Bodies<wbr>Allowed<wbr>Content<wbr>Types</h3>
|
|
2766
|
+
<div class="tsd-signature tsd-kind-icon">email<wbr>Bodies<wbr>Allowed<wbr>Content<wbr>Types<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
2767
2767
|
<aside class="tsd-sources">
|
|
2768
2768
|
</aside>
|
|
2769
2769
|
<div class="tsd-comment tsd-typography">
|
|
2770
2770
|
<div class="lead">
|
|
2771
|
-
<p>Allowed
|
|
2771
|
+
<p>Allowed content types for E-Mail bodies.</p>
|
|
2772
2772
|
</div>
|
|
2773
2773
|
</div>
|
|
2774
2774
|
</section>
|
|
2775
2775
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
2776
|
-
<a name="
|
|
2777
|
-
<h3>email<wbr>Histories<wbr>Allowed<wbr>
|
|
2778
|
-
<div class="tsd-signature tsd-kind-icon">email<wbr>Histories<wbr>Allowed<wbr>
|
|
2776
|
+
<a name="emailHistoriesAllowedContentTypes" class="tsd-anchor"></a>
|
|
2777
|
+
<h3>email<wbr>Histories<wbr>Allowed<wbr>Content<wbr>Types</h3>
|
|
2778
|
+
<div class="tsd-signature tsd-kind-icon">email<wbr>Histories<wbr>Allowed<wbr>Content<wbr>Types<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
2779
2779
|
<aside class="tsd-sources">
|
|
2780
2780
|
</aside>
|
|
2781
2781
|
<div class="tsd-comment tsd-typography">
|
|
2782
2782
|
<div class="lead">
|
|
2783
|
-
<p>Allowed
|
|
2783
|
+
<p>Allowed content types for E-Mail histories.</p>
|
|
2784
2784
|
</div>
|
|
2785
2785
|
</div>
|
|
2786
2786
|
</section>
|
|
@@ -2720,7 +2720,7 @@ img {
|
|
|
2720
2720
|
<section class="tsd-panel tsd-comment">
|
|
2721
2721
|
<div class="tsd-comment tsd-typography">
|
|
2722
2722
|
<div class="lead">
|
|
2723
|
-
<p>
|
|
2723
|
+
<p>State of the conversation.</p>
|
|
2724
2724
|
</div>
|
|
2725
2725
|
</div>
|
|
2726
2726
|
</section>
|
|
@@ -2756,7 +2756,7 @@ img {
|
|
|
2756
2756
|
</aside>
|
|
2757
2757
|
<div class="tsd-comment tsd-typography">
|
|
2758
2758
|
<div class="lead">
|
|
2759
|
-
<p>
|
|
2759
|
+
<p>Current state.</p>
|
|
2760
2760
|
</div>
|
|
2761
2761
|
</div>
|
|
2762
2762
|
</section>
|