@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
package/docs/index.html
CHANGED
@@ -2706,9 +2706,18 @@ img {
|
|
2706
2706
|
<li class=" tsd-kind-class tsd-has-type-parameter">
|
2707
2707
|
<a href="classes/CancellablePromise.html" class="tsd-kind-icon">Cancellable<wbr>Promise</a>
|
2708
2708
|
</li>
|
2709
|
+
<li class=" tsd-kind-class">
|
2710
|
+
<a href="classes/ChannelMetadata.html" class="tsd-kind-icon">Channel<wbr>Metadata</a>
|
2711
|
+
</li>
|
2709
2712
|
<li class=" tsd-kind-class">
|
2710
2713
|
<a href="classes/Client.html" class="tsd-kind-icon">Client</a>
|
2711
2714
|
</li>
|
2715
|
+
<li class=" tsd-kind-class">
|
2716
|
+
<a href="classes/ContentTemplate.html" class="tsd-kind-icon">Content<wbr>Template</a>
|
2717
|
+
</li>
|
2718
|
+
<li class=" tsd-kind-class">
|
2719
|
+
<a href="classes/ContentTemplateVariable.html" class="tsd-kind-icon">Content<wbr>Template<wbr>Variable</a>
|
2720
|
+
</li>
|
2712
2721
|
<li class=" tsd-kind-class">
|
2713
2722
|
<a href="classes/Conversation.html" class="tsd-kind-icon">Conversation</a>
|
2714
2723
|
</li>
|
@@ -2784,6 +2793,54 @@ img {
|
|
2784
2793
|
<li class=" tsd-kind-type-alias">
|
2785
2794
|
<a href="modules.html#ConnectionState" class="tsd-kind-icon">Connection<wbr>State</a>
|
2786
2795
|
</li>
|
2796
|
+
<li class=" tsd-kind-type-alias">
|
2797
|
+
<a href="modules.html#ContentData" class="tsd-kind-icon">Content<wbr>Data</a>
|
2798
|
+
</li>
|
2799
|
+
<li class=" tsd-kind-type-alias">
|
2800
|
+
<a href="modules.html#ContentDataAction" class="tsd-kind-icon">Content<wbr>Data<wbr>Action</a>
|
2801
|
+
</li>
|
2802
|
+
<li class=" tsd-kind-type-alias">
|
2803
|
+
<a href="modules.html#ContentDataActionOther" class="tsd-kind-icon">Content<wbr>Data<wbr>Action<wbr>Other</a>
|
2804
|
+
</li>
|
2805
|
+
<li class=" tsd-kind-type-alias">
|
2806
|
+
<a href="modules.html#ContentDataActionPhone" class="tsd-kind-icon">Content<wbr>Data<wbr>Action<wbr>Phone</a>
|
2807
|
+
</li>
|
2808
|
+
<li class=" tsd-kind-type-alias">
|
2809
|
+
<a href="modules.html#ContentDataActionReply" class="tsd-kind-icon">Content<wbr>Data<wbr>Action<wbr>Reply</a>
|
2810
|
+
</li>
|
2811
|
+
<li class=" tsd-kind-type-alias">
|
2812
|
+
<a href="modules.html#ContentDataActionUrl" class="tsd-kind-icon">Content<wbr>Data<wbr>Action<wbr>Url</a>
|
2813
|
+
</li>
|
2814
|
+
<li class=" tsd-kind-type-alias">
|
2815
|
+
<a href="modules.html#ContentDataCallToAction" class="tsd-kind-icon">Content<wbr>Data<wbr>Call<wbr>ToAction</a>
|
2816
|
+
</li>
|
2817
|
+
<li class=" tsd-kind-type-alias">
|
2818
|
+
<a href="modules.html#ContentDataCard" class="tsd-kind-icon">Content<wbr>Data<wbr>Card</a>
|
2819
|
+
</li>
|
2820
|
+
<li class=" tsd-kind-type-alias">
|
2821
|
+
<a href="modules.html#ContentDataListItem" class="tsd-kind-icon">Content<wbr>Data<wbr>List<wbr>Item</a>
|
2822
|
+
</li>
|
2823
|
+
<li class=" tsd-kind-type-alias">
|
2824
|
+
<a href="modules.html#ContentDataListPicker" class="tsd-kind-icon">Content<wbr>Data<wbr>List<wbr>Picker</a>
|
2825
|
+
</li>
|
2826
|
+
<li class=" tsd-kind-type-alias">
|
2827
|
+
<a href="modules.html#ContentDataLocation" class="tsd-kind-icon">Content<wbr>Data<wbr>Location</a>
|
2828
|
+
</li>
|
2829
|
+
<li class=" tsd-kind-type-alias">
|
2830
|
+
<a href="modules.html#ContentDataMedia" class="tsd-kind-icon">Content<wbr>Data<wbr>Media</a>
|
2831
|
+
</li>
|
2832
|
+
<li class=" tsd-kind-type-alias">
|
2833
|
+
<a href="modules.html#ContentDataOther" class="tsd-kind-icon">Content<wbr>Data<wbr>Other</a>
|
2834
|
+
</li>
|
2835
|
+
<li class=" tsd-kind-type-alias">
|
2836
|
+
<a href="modules.html#ContentDataQuickReply" class="tsd-kind-icon">Content<wbr>Data<wbr>Quick<wbr>Reply</a>
|
2837
|
+
</li>
|
2838
|
+
<li class=" tsd-kind-type-alias">
|
2839
|
+
<a href="modules.html#ContentDataReply" class="tsd-kind-icon">Content<wbr>Data<wbr>Reply</a>
|
2840
|
+
</li>
|
2841
|
+
<li class=" tsd-kind-type-alias">
|
2842
|
+
<a href="modules.html#ContentDataText" class="tsd-kind-icon">Content<wbr>Data<wbr>Text</a>
|
2843
|
+
</li>
|
2787
2844
|
<li class=" tsd-kind-type-alias">
|
2788
2845
|
<a href="modules.html#ConversationStatus" class="tsd-kind-icon">Conversation<wbr>Status</a>
|
2789
2846
|
</li>
|
@@ -2857,29 +2914,33 @@ img {
|
|
2857
2914
|
<p>Using this method, you can <code>require</code> <code>twilio-conversations</code> and then use the
|
2858
2915
|
client:</p>
|
2859
2916
|
<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: #795E26">require</span><span style="color: #000000">(</span><span style="color: #A31515">'@twilio/conversations'</span><span style="color: #000000">);</span>
|
2917
|
+
|
2860
2918
|
<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>
|
2861
|
-
|
2862
|
-
<span style="color: #008000">//
|
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">'
|
2864
|
-
<span style="color: #000000"> </span><span style="color: #
|
2865
|
-
<span style="color: #000000">
|
2866
|
-
|
2867
|
-
<span style="color: #
|
2868
|
-
<span style="color: #
|
2869
|
-
<span style="color: #000000">
|
2870
|
-
<span style="color: #000000">
|
2871
|
-
<span style="color: #000000">}</span>
|
2919
|
+
|
2920
|
+
<span style="color: #008000">// Before you use the client, subscribe to the `'initialized'` event.</span>
|
2921
|
+
<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">'initialized'</span><span style="color: #000000">, () </span><span style="color: #0000FF">=></span><span style="color: #000000"> {</span>
|
2922
|
+
<span style="color: #000000"> </span><span style="color: #008000">// Use the client.</span>
|
2923
|
+
<span style="color: #000000">});</span>
|
2924
|
+
|
2925
|
+
<span style="color: #008000">// To catch client initialization errors, subscribe to the `'initFailed'` event.</span>
|
2926
|
+
<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">'initFailed'</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>
|
2927
|
+
<span style="color: #000000"> </span><span style="color: #008000">// Handle the error.</span>
|
2928
|
+
<span style="color: #000000">});</span>
|
2872
2929
|
</code></pre>
|
2873
2930
|
<p>The SDK could also be imported using the ES module syntax:</p>
|
2874
2931
|
<pre><code><span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">Client</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">'@twilio/conversations'</span><span style="color: #000000">;</span>
|
2932
|
+
|
2875
2933
|
<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>
|
2876
|
-
|
2877
|
-
<span style="color: #008000">//
|
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">'
|
2879
|
-
<span style="color: #000000"> </span><span style="color: #
|
2880
|
-
<span style="color: #000000">
|
2881
|
-
|
2882
|
-
<span style="color: #
|
2934
|
+
|
2935
|
+
<span style="color: #008000">// Before you use the client, subscribe to the `'initialized'` event.</span>
|
2936
|
+
<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">'initialized'</span><span style="color: #000000">, () </span><span style="color: #0000FF">=></span><span style="color: #000000"> {</span>
|
2937
|
+
<span style="color: #000000"> </span><span style="color: #008000">// Use the client.</span>
|
2938
|
+
<span style="color: #000000">});</span>
|
2939
|
+
|
2940
|
+
<span style="color: #008000">// To catch client initialization errors, subscribe to the `'initFailed'` event.</span>
|
2941
|
+
<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">'initFailed'</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>
|
2942
|
+
<span style="color: #000000"> </span><span style="color: #008000">// Handle the error.</span>
|
2943
|
+
<span style="color: #000000">});</span>
|
2883
2944
|
</code></pre>
|
2884
2945
|
<a href="#cdn" id="cdn" style="color: inherit; text-decoration: none;">
|
2885
2946
|
<h3>CDN</h3>
|
@@ -2899,13 +2960,15 @@ img {
|
|
2899
2960
|
<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
|
2900
2961
|
number. While less flexible it is significantly more secure, which is required by some applications.</p>
|
2901
2962
|
<p>To consume securely use the following script snippet format:</p>
|
2902
|
-
<pre><code class="language-html"><span style="color: #800000"><script</span
|
2903
|
-
<span style="color: #000000FF">
|
2904
|
-
<span style="color: #000000FF">
|
2963
|
+
<pre><code class="language-html"><span style="color: #800000"><script</span>
|
2964
|
+
<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/3.0.1/twilio-conversations.min.js"</span>
|
2965
|
+
<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>
|
2966
|
+
<span style="color: #000000FF"> </span><span style="color: #FF0000">crossorigin</span><span style="color: #000000FF">=</span><span style="color: #0000FF">"anonymous"</span>
|
2967
|
+
<span style="color: #800000">></script></span>
|
2905
2968
|
</code></pre>
|
2906
|
-
<p>Find the hash of each release published on the <a href="#
|
2969
|
+
<p>Find the hash of each release published on the <a href="#changelog">Changelog</a> page.</p>
|
2907
2970
|
<a href="#changelog" id="changelog" style="color: inherit; text-decoration: none;">
|
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>
|
2971
|
+
<h2>Supported Browsers</h2><table><thead><tr><th>Browser</th><th>Supported Versions</th></tr></thead><tbody><tr><td>Chrome for Android</td><td>114</td></tr><tr><td>Firefox for Android</td><td>113</td></tr><tr><td>UC Browser for Android</td><td>13.4</td></tr><tr><td>Chrome</td><td>114, 113, 112</td></tr><tr><td>Edge</td><td>114, 113, 112</td></tr><tr><td>Firefox</td><td>113, 112, 111</td></tr><tr><td>Internet Explorer</td><td>11</td></tr><tr><td>Safari for iOS</td><td>16.5, 16.4</td></tr><tr><td>Safari</td><td>16.5, 16.4, 16.3</td></tr><tr><td>Samsung Internet</td><td>21, 20</td></tr></tbody></table><h3>Changelog</h3>
|
2909
2972
|
</a>
|
2910
2973
|
<p>See this <a href="https://www.twilio.com/docs/conversations/javascript/changelog">link</a>.</p>
|
2911
2974
|
</div>
|
@@ -2919,7 +2982,10 @@ img {
|
|
2919
2982
|
<ul class="tsd-index-list">
|
2920
2983
|
<li class="tsd-kind-class"><a href="classes/AggregatedDeliveryReceipt.html" class="tsd-kind-icon">Aggregated<wbr>Delivery<wbr>Receipt</a></li>
|
2921
2984
|
<li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/CancellablePromise.html" class="tsd-kind-icon">Cancellable<wbr>Promise</a></li>
|
2985
|
+
<li class="tsd-kind-class"><a href="classes/ChannelMetadata.html" class="tsd-kind-icon">Channel<wbr>Metadata</a></li>
|
2922
2986
|
<li class="tsd-kind-class"><a href="classes/Client.html" class="tsd-kind-icon">Client</a></li>
|
2987
|
+
<li class="tsd-kind-class"><a href="classes/ContentTemplate.html" class="tsd-kind-icon">Content<wbr>Template</a></li>
|
2988
|
+
<li class="tsd-kind-class"><a href="classes/ContentTemplateVariable.html" class="tsd-kind-icon">Content<wbr>Template<wbr>Variable</a></li>
|
2923
2989
|
<li class="tsd-kind-class"><a href="classes/Conversation.html" class="tsd-kind-icon">Conversation</a></li>
|
2924
2990
|
<li class="tsd-kind-class"><a href="classes/DetailedDeliveryReceipt.html" class="tsd-kind-icon">Detailed<wbr>Delivery<wbr>Receipt</a></li>
|
2925
2991
|
<li class="tsd-kind-class"><a href="classes/Media.html" class="tsd-kind-icon">Media</a></li>
|
@@ -2955,6 +3021,22 @@ img {
|
|
2955
3021
|
<h3>Type aliases</h3>
|
2956
3022
|
<ul class="tsd-index-list">
|
2957
3023
|
<li class="tsd-kind-type-alias"><a href="modules.html#ConnectionState" class="tsd-kind-icon">Connection<wbr>State</a></li>
|
3024
|
+
<li class="tsd-kind-type-alias"><a href="modules.html#ContentData" class="tsd-kind-icon">Content<wbr>Data</a></li>
|
3025
|
+
<li class="tsd-kind-type-alias"><a href="modules.html#ContentDataAction" class="tsd-kind-icon">Content<wbr>Data<wbr>Action</a></li>
|
3026
|
+
<li class="tsd-kind-type-alias"><a href="modules.html#ContentDataActionOther" class="tsd-kind-icon">Content<wbr>Data<wbr>Action<wbr>Other</a></li>
|
3027
|
+
<li class="tsd-kind-type-alias"><a href="modules.html#ContentDataActionPhone" class="tsd-kind-icon">Content<wbr>Data<wbr>Action<wbr>Phone</a></li>
|
3028
|
+
<li class="tsd-kind-type-alias"><a href="modules.html#ContentDataActionReply" class="tsd-kind-icon">Content<wbr>Data<wbr>Action<wbr>Reply</a></li>
|
3029
|
+
<li class="tsd-kind-type-alias"><a href="modules.html#ContentDataActionUrl" class="tsd-kind-icon">Content<wbr>Data<wbr>Action<wbr>Url</a></li>
|
3030
|
+
<li class="tsd-kind-type-alias"><a href="modules.html#ContentDataCallToAction" class="tsd-kind-icon">Content<wbr>Data<wbr>Call<wbr>ToAction</a></li>
|
3031
|
+
<li class="tsd-kind-type-alias"><a href="modules.html#ContentDataCard" class="tsd-kind-icon">Content<wbr>Data<wbr>Card</a></li>
|
3032
|
+
<li class="tsd-kind-type-alias"><a href="modules.html#ContentDataListItem" class="tsd-kind-icon">Content<wbr>Data<wbr>List<wbr>Item</a></li>
|
3033
|
+
<li class="tsd-kind-type-alias"><a href="modules.html#ContentDataListPicker" class="tsd-kind-icon">Content<wbr>Data<wbr>List<wbr>Picker</a></li>
|
3034
|
+
<li class="tsd-kind-type-alias"><a href="modules.html#ContentDataLocation" class="tsd-kind-icon">Content<wbr>Data<wbr>Location</a></li>
|
3035
|
+
<li class="tsd-kind-type-alias"><a href="modules.html#ContentDataMedia" class="tsd-kind-icon">Content<wbr>Data<wbr>Media</a></li>
|
3036
|
+
<li class="tsd-kind-type-alias"><a href="modules.html#ContentDataOther" class="tsd-kind-icon">Content<wbr>Data<wbr>Other</a></li>
|
3037
|
+
<li class="tsd-kind-type-alias"><a href="modules.html#ContentDataQuickReply" class="tsd-kind-icon">Content<wbr>Data<wbr>Quick<wbr>Reply</a></li>
|
3038
|
+
<li class="tsd-kind-type-alias"><a href="modules.html#ContentDataReply" class="tsd-kind-icon">Content<wbr>Data<wbr>Reply</a></li>
|
3039
|
+
<li class="tsd-kind-type-alias"><a href="modules.html#ContentDataText" class="tsd-kind-icon">Content<wbr>Data<wbr>Text</a></li>
|
2958
3040
|
<li class="tsd-kind-type-alias"><a href="modules.html#ConversationStatus" class="tsd-kind-icon">Conversation<wbr>Status</a></li>
|
2959
3041
|
<li class="tsd-kind-type-alias"><a href="modules.html#ConversationUpdateReason" class="tsd-kind-icon">Conversation<wbr>Update<wbr>Reason</a></li>
|
2960
3042
|
<li class="tsd-kind-type-alias"><a href="modules.html#DeliveryAmount" class="tsd-kind-icon">Delivery<wbr>Amount</a></li>
|
@@ -3000,6 +3082,747 @@ img {
|
|
3000
3082
|
</div>
|
3001
3083
|
</div>
|
3002
3084
|
</section>
|
3085
|
+
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
3086
|
+
<a name="ContentData" class="tsd-anchor"></a>
|
3087
|
+
<h3>Content<wbr>Data</h3>
|
3088
|
+
<div class="tsd-signature tsd-kind-icon">Content<wbr>Data<span class="tsd-signature-symbol">:</span> <a href="modules.html#ContentDataText" class="tsd-signature-type" data-tsd-kind="Type alias">ContentDataText</a><span class="tsd-signature-symbol"> | </span><a href="modules.html#ContentDataMedia" class="tsd-signature-type" data-tsd-kind="Type alias">ContentDataMedia</a><span class="tsd-signature-symbol"> | </span><a href="modules.html#ContentDataLocation" class="tsd-signature-type" data-tsd-kind="Type alias">ContentDataLocation</a><span class="tsd-signature-symbol"> | </span><a href="modules.html#ContentDataQuickReply" class="tsd-signature-type" data-tsd-kind="Type alias">ContentDataQuickReply</a><span class="tsd-signature-symbol"> | </span><a href="modules.html#ContentDataCallToAction" class="tsd-signature-type" data-tsd-kind="Type alias">ContentDataCallToAction</a><span class="tsd-signature-symbol"> | </span><a href="modules.html#ContentDataListPicker" class="tsd-signature-type" data-tsd-kind="Type alias">ContentDataListPicker</a><span class="tsd-signature-symbol"> | </span><a href="modules.html#ContentDataCard" class="tsd-signature-type" data-tsd-kind="Type alias">ContentDataCard</a><span class="tsd-signature-symbol"> | </span><a href="modules.html#ContentDataOther" class="tsd-signature-type" data-tsd-kind="Type alias">ContentDataOther</a></div>
|
3089
|
+
<aside class="tsd-sources">
|
3090
|
+
</aside>
|
3091
|
+
<div class="tsd-comment tsd-typography">
|
3092
|
+
<div class="lead">
|
3093
|
+
<p>A union of possible data types in rich content templates.</p>
|
3094
|
+
</div>
|
3095
|
+
</div>
|
3096
|
+
</section>
|
3097
|
+
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
3098
|
+
<a name="ContentDataAction" class="tsd-anchor"></a>
|
3099
|
+
<h3>Content<wbr>Data<wbr>Action</h3>
|
3100
|
+
<div class="tsd-signature tsd-kind-icon">Content<wbr>Data<wbr>Action<span class="tsd-signature-symbol">:</span> <a href="modules.html#ContentDataActionUrl" class="tsd-signature-type" data-tsd-kind="Type alias">ContentDataActionUrl</a><span class="tsd-signature-symbol"> | </span><a href="modules.html#ContentDataActionPhone" class="tsd-signature-type" data-tsd-kind="Type alias">ContentDataActionPhone</a><span class="tsd-signature-symbol"> | </span><a href="modules.html#ContentDataActionReply" class="tsd-signature-type" data-tsd-kind="Type alias">ContentDataActionReply</a><span class="tsd-signature-symbol"> | </span><a href="modules.html#ContentDataActionOther" class="tsd-signature-type" data-tsd-kind="Type alias">ContentDataActionOther</a></div>
|
3101
|
+
<aside class="tsd-sources">
|
3102
|
+
</aside>
|
3103
|
+
<div class="tsd-comment tsd-typography">
|
3104
|
+
<div class="lead">
|
3105
|
+
<p>A union of possible actions used in <a href="modules.html#ContentDataCallToAction">ContentDataCallToAction</a> and
|
3106
|
+
<a href="modules.html#ContentDataCard">ContentDataCard</a>.</p>
|
3107
|
+
</div>
|
3108
|
+
</div>
|
3109
|
+
</section>
|
3110
|
+
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
3111
|
+
<a name="ContentDataActionOther" class="tsd-anchor"></a>
|
3112
|
+
<h3>Content<wbr>Data<wbr>Action<wbr>Other</h3>
|
3113
|
+
<div class="tsd-signature tsd-kind-icon">Content<wbr>Data<wbr>Action<wbr>Other<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>rawData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"other"</span><span class="tsd-signature-symbol"> }</span></div>
|
3114
|
+
<aside class="tsd-sources">
|
3115
|
+
</aside>
|
3116
|
+
<div class="tsd-comment tsd-typography">
|
3117
|
+
<div class="lead">
|
3118
|
+
<p>Used for unknown action types which aren't present in the current version of
|
3119
|
+
the Conversations SDK.</p>
|
3120
|
+
</div>
|
3121
|
+
</div>
|
3122
|
+
<div class="tsd-type-declaration">
|
3123
|
+
<h4>Type declaration</h4>
|
3124
|
+
<ul class="tsd-parameters">
|
3125
|
+
<li class="tsd-parameter">
|
3126
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> raw<wbr>Data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
3127
|
+
<div class="tsd-comment tsd-typography">
|
3128
|
+
<div class="lead">
|
3129
|
+
<p>Full data as a stringified JSON. This could be used for future content
|
3130
|
+
types and fields which are not yet supported by the newest version of
|
3131
|
+
the Conversations SDK, or for using newer types in the older versions of
|
3132
|
+
the SDK.</p>
|
3133
|
+
</div>
|
3134
|
+
</div>
|
3135
|
+
</li>
|
3136
|
+
<li class="tsd-parameter">
|
3137
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"other"</span></h5>
|
3138
|
+
<div class="tsd-comment tsd-typography">
|
3139
|
+
<div class="lead">
|
3140
|
+
<p>The type discriminant.</p>
|
3141
|
+
</div>
|
3142
|
+
</div>
|
3143
|
+
</li>
|
3144
|
+
</ul>
|
3145
|
+
</div>
|
3146
|
+
</section>
|
3147
|
+
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
3148
|
+
<a name="ContentDataActionPhone" class="tsd-anchor"></a>
|
3149
|
+
<h3>Content<wbr>Data<wbr>Action<wbr>Phone</h3>
|
3150
|
+
<div class="tsd-signature tsd-kind-icon">Content<wbr>Data<wbr>Action<wbr>Phone<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>phone<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>rawData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"phone"</span><span class="tsd-signature-symbol"> }</span></div>
|
3151
|
+
<aside class="tsd-sources">
|
3152
|
+
</aside>
|
3153
|
+
<div class="tsd-comment tsd-typography">
|
3154
|
+
<div class="lead">
|
3155
|
+
<p>Shows a button that calls a phone number.</p>
|
3156
|
+
</div>
|
3157
|
+
</div>
|
3158
|
+
<div class="tsd-type-declaration">
|
3159
|
+
<h4>Type declaration</h4>
|
3160
|
+
<ul class="tsd-parameters">
|
3161
|
+
<li class="tsd-parameter">
|
3162
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> phone<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
3163
|
+
<div class="tsd-comment tsd-typography">
|
3164
|
+
<div class="lead">
|
3165
|
+
<p>Phone number to call when the recipient taps the button.</p>
|
3166
|
+
</div>
|
3167
|
+
</div>
|
3168
|
+
</li>
|
3169
|
+
<li class="tsd-parameter">
|
3170
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> raw<wbr>Data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
3171
|
+
<div class="tsd-comment tsd-typography">
|
3172
|
+
<div class="lead">
|
3173
|
+
<p>Full data as a stringified JSON. This could be used for future content
|
3174
|
+
types and fields which are not yet supported by the newest version of
|
3175
|
+
the Conversations SDK, or for using newer types in the older versions of
|
3176
|
+
the SDK.</p>
|
3177
|
+
</div>
|
3178
|
+
</div>
|
3179
|
+
</li>
|
3180
|
+
<li class="tsd-parameter">
|
3181
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
3182
|
+
<div class="tsd-comment tsd-typography">
|
3183
|
+
<div class="lead">
|
3184
|
+
<p>Display value for the action.</p>
|
3185
|
+
</div>
|
3186
|
+
</div>
|
3187
|
+
</li>
|
3188
|
+
<li class="tsd-parameter">
|
3189
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"phone"</span></h5>
|
3190
|
+
<div class="tsd-comment tsd-typography">
|
3191
|
+
<div class="lead">
|
3192
|
+
<p>The type discriminant.</p>
|
3193
|
+
</div>
|
3194
|
+
</div>
|
3195
|
+
</li>
|
3196
|
+
</ul>
|
3197
|
+
</div>
|
3198
|
+
</section>
|
3199
|
+
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
3200
|
+
<a name="ContentDataActionReply" class="tsd-anchor"></a>
|
3201
|
+
<h3>Content<wbr>Data<wbr>Action<wbr>Reply</h3>
|
3202
|
+
<div class="tsd-signature tsd-kind-icon">Content<wbr>Data<wbr>Action<wbr>Reply<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>rawData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"reply"</span><span class="tsd-signature-symbol"> }</span></div>
|
3203
|
+
<aside class="tsd-sources">
|
3204
|
+
</aside>
|
3205
|
+
<div class="tsd-comment tsd-typography">
|
3206
|
+
<div class="lead">
|
3207
|
+
<p>Shows a button that sends back a predefined text.</p>
|
3208
|
+
</div>
|
3209
|
+
</div>
|
3210
|
+
<div class="tsd-type-declaration">
|
3211
|
+
<h4>Type declaration</h4>
|
3212
|
+
<ul class="tsd-parameters">
|
3213
|
+
<li class="tsd-parameter">
|
3214
|
+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
3215
|
+
<div class="tsd-comment tsd-typography">
|
3216
|
+
<div class="lead">
|
3217
|
+
<p>Postback payload. This field is not visible to the end user.</p>
|
3218
|
+
</div>
|
3219
|
+
</div>
|
3220
|
+
</li>
|
3221
|
+
<li class="tsd-parameter">
|
3222
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
|
3223
|
+
<div class="tsd-comment tsd-typography">
|
3224
|
+
<div class="lead">
|
3225
|
+
<p>Index for the action.</p>
|
3226
|
+
</div>
|
3227
|
+
</div>
|
3228
|
+
</li>
|
3229
|
+
<li class="tsd-parameter">
|
3230
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> raw<wbr>Data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
3231
|
+
<div class="tsd-comment tsd-typography">
|
3232
|
+
<div class="lead">
|
3233
|
+
<p>Full data as a stringified JSON. This could be used for future content
|
3234
|
+
types and fields which are not yet supported by the newest version of
|
3235
|
+
the Conversations SDK, or for using newer types in the older versions of
|
3236
|
+
the SDK.</p>
|
3237
|
+
</div>
|
3238
|
+
</div>
|
3239
|
+
</li>
|
3240
|
+
<li class="tsd-parameter">
|
3241
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
3242
|
+
<div class="tsd-comment tsd-typography">
|
3243
|
+
<div class="lead">
|
3244
|
+
<p>Display value for the action. This is the message that will be sent back
|
3245
|
+
when the user taps on the button.</p>
|
3246
|
+
</div>
|
3247
|
+
</div>
|
3248
|
+
</li>
|
3249
|
+
<li class="tsd-parameter">
|
3250
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"reply"</span></h5>
|
3251
|
+
<div class="tsd-comment tsd-typography">
|
3252
|
+
<div class="lead">
|
3253
|
+
<p>The type discriminant.</p>
|
3254
|
+
</div>
|
3255
|
+
</div>
|
3256
|
+
</li>
|
3257
|
+
</ul>
|
3258
|
+
</div>
|
3259
|
+
</section>
|
3260
|
+
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
3261
|
+
<a name="ContentDataActionUrl" class="tsd-anchor"></a>
|
3262
|
+
<h3>Content<wbr>Data<wbr>Action<wbr>Url</h3>
|
3263
|
+
<div class="tsd-signature tsd-kind-icon">Content<wbr>Data<wbr>Action<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>rawData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"url"</span><span class="tsd-signature-symbol">; </span>url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
|
3264
|
+
<aside class="tsd-sources">
|
3265
|
+
</aside>
|
3266
|
+
<div class="tsd-comment tsd-typography">
|
3267
|
+
<div class="lead">
|
3268
|
+
<p>Shows a button that redirects recipient to a predefined URL.</p>
|
3269
|
+
</div>
|
3270
|
+
</div>
|
3271
|
+
<div class="tsd-type-declaration">
|
3272
|
+
<h4>Type declaration</h4>
|
3273
|
+
<ul class="tsd-parameters">
|
3274
|
+
<li class="tsd-parameter">
|
3275
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> raw<wbr>Data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
3276
|
+
<div class="tsd-comment tsd-typography">
|
3277
|
+
<div class="lead">
|
3278
|
+
<p>Full data as a stringified JSON. This could be used for future content
|
3279
|
+
types and fields which are not yet supported by the newest version of
|
3280
|
+
the Conversations SDK, or for using newer types in the older versions of
|
3281
|
+
the SDK.</p>
|
3282
|
+
</div>
|
3283
|
+
</div>
|
3284
|
+
</li>
|
3285
|
+
<li class="tsd-parameter">
|
3286
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
3287
|
+
<div class="tsd-comment tsd-typography">
|
3288
|
+
<div class="lead">
|
3289
|
+
<p>Display value for the action.</p>
|
3290
|
+
</div>
|
3291
|
+
</div>
|
3292
|
+
</li>
|
3293
|
+
<li class="tsd-parameter">
|
3294
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"url"</span></h5>
|
3295
|
+
<div class="tsd-comment tsd-typography">
|
3296
|
+
<div class="lead">
|
3297
|
+
<p>The type discriminant.</p>
|
3298
|
+
</div>
|
3299
|
+
</div>
|
3300
|
+
</li>
|
3301
|
+
<li class="tsd-parameter">
|
3302
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
3303
|
+
<div class="tsd-comment tsd-typography">
|
3304
|
+
<div class="lead">
|
3305
|
+
<p>URL to direct to when the recipient taps the button.</p>
|
3306
|
+
</div>
|
3307
|
+
</div>
|
3308
|
+
</li>
|
3309
|
+
</ul>
|
3310
|
+
</div>
|
3311
|
+
</section>
|
3312
|
+
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
3313
|
+
<a name="ContentDataCallToAction" class="tsd-anchor"></a>
|
3314
|
+
<h3>Content<wbr>Data<wbr>Call<wbr>ToAction</h3>
|
3315
|
+
<div class="tsd-signature tsd-kind-icon">Content<wbr>Data<wbr>Call<wbr>ToAction<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>actions<span class="tsd-signature-symbol">: </span><a href="modules.html#ContentDataAction" class="tsd-signature-type" data-tsd-kind="Type alias">ContentDataAction</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>rawData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"callToAction"</span><span class="tsd-signature-symbol"> }</span></div>
|
3316
|
+
<aside class="tsd-sources">
|
3317
|
+
</aside>
|
3318
|
+
<div class="tsd-comment tsd-typography">
|
3319
|
+
<div class="lead">
|
3320
|
+
<p>Buttons that let recipients tap to trigger actions such as launching a
|
3321
|
+
website or making a phone call. Represents the twilio/call-to-action content
|
3322
|
+
type.</p>
|
3323
|
+
</div>
|
3324
|
+
</div>
|
3325
|
+
<div class="tsd-type-declaration">
|
3326
|
+
<h4>Type declaration</h4>
|
3327
|
+
<ul class="tsd-parameters">
|
3328
|
+
<li class="tsd-parameter">
|
3329
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> actions<span class="tsd-signature-symbol">: </span><a href="modules.html#ContentDataAction" class="tsd-signature-type" data-tsd-kind="Type alias">ContentDataAction</a><span class="tsd-signature-symbol">[]</span></h5>
|
3330
|
+
<div class="tsd-comment tsd-typography">
|
3331
|
+
<div class="lead">
|
3332
|
+
<p>Buttons that recipients can tap on to act on the message.</p>
|
3333
|
+
</div>
|
3334
|
+
</div>
|
3335
|
+
</li>
|
3336
|
+
<li class="tsd-parameter">
|
3337
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
3338
|
+
<div class="tsd-comment tsd-typography">
|
3339
|
+
<div class="lead">
|
3340
|
+
<p>The text of the message you want to send. This is included as a regular
|
3341
|
+
text message.</p>
|
3342
|
+
</div>
|
3343
|
+
</div>
|
3344
|
+
</li>
|
3345
|
+
<li class="tsd-parameter">
|
3346
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> raw<wbr>Data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
3347
|
+
<div class="tsd-comment tsd-typography">
|
3348
|
+
<div class="lead">
|
3349
|
+
<p>Full data as a stringified JSON. This could be used for future content
|
3350
|
+
types and fields which are not yet supported by the newest version of
|
3351
|
+
the Conversations SDK, or for using newer types in the older versions of
|
3352
|
+
the SDK.</p>
|
3353
|
+
</div>
|
3354
|
+
</div>
|
3355
|
+
</li>
|
3356
|
+
<li class="tsd-parameter">
|
3357
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"callToAction"</span></h5>
|
3358
|
+
<div class="tsd-comment tsd-typography">
|
3359
|
+
<div class="lead">
|
3360
|
+
<p>The type discriminant.</p>
|
3361
|
+
</div>
|
3362
|
+
</div>
|
3363
|
+
</li>
|
3364
|
+
</ul>
|
3365
|
+
</div>
|
3366
|
+
</section>
|
3367
|
+
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
3368
|
+
<a name="ContentDataCard" class="tsd-anchor"></a>
|
3369
|
+
<h3>Content<wbr>Data<wbr>Card</h3>
|
3370
|
+
<div class="tsd-signature tsd-kind-icon">Content<wbr>Data<wbr>Card<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>actions<span class="tsd-signature-symbol">: </span><a href="modules.html#ContentDataAction" class="tsd-signature-type" data-tsd-kind="Type alias">ContentDataAction</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>media<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>rawData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>subtitle<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"card"</span><span class="tsd-signature-symbol"> }</span></div>
|
3371
|
+
<aside class="tsd-sources">
|
3372
|
+
</aside>
|
3373
|
+
<div class="tsd-comment tsd-typography">
|
3374
|
+
<div class="lead">
|
3375
|
+
<p>Shows a menu of up to 10 options, which offers a simple way for users to make
|
3376
|
+
a selection. Represents the twilio/card content type.</p>
|
3377
|
+
</div>
|
3378
|
+
</div>
|
3379
|
+
<div class="tsd-type-declaration">
|
3380
|
+
<h4>Type declaration</h4>
|
3381
|
+
<ul class="tsd-parameters">
|
3382
|
+
<li class="tsd-parameter">
|
3383
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> actions<span class="tsd-signature-symbol">: </span><a href="modules.html#ContentDataAction" class="tsd-signature-type" data-tsd-kind="Type alias">ContentDataAction</a><span class="tsd-signature-symbol">[]</span></h5>
|
3384
|
+
<div class="tsd-comment tsd-typography">
|
3385
|
+
<div class="lead">
|
3386
|
+
<p>Buttons that the recipients can tap on to act on the message.</p>
|
3387
|
+
</div>
|
3388
|
+
</div>
|
3389
|
+
</li>
|
3390
|
+
<li class="tsd-parameter">
|
3391
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> media<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
3392
|
+
<div class="tsd-comment tsd-typography">
|
3393
|
+
<div class="lead">
|
3394
|
+
<p>URLs of the media to send with the message.</p>
|
3395
|
+
</div>
|
3396
|
+
</div>
|
3397
|
+
</li>
|
3398
|
+
<li class="tsd-parameter">
|
3399
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> raw<wbr>Data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
3400
|
+
<div class="tsd-comment tsd-typography">
|
3401
|
+
<div class="lead">
|
3402
|
+
<p>Full data as a stringified JSON. This could be used for future content
|
3403
|
+
types and fields which are not yet supported by the newest version of
|
3404
|
+
the Conversations SDK, or for using newer types in the older versions of
|
3405
|
+
the SDK.</p>
|
3406
|
+
</div>
|
3407
|
+
</div>
|
3408
|
+
</li>
|
3409
|
+
<li class="tsd-parameter">
|
3410
|
+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> subtitle<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
3411
|
+
<div class="tsd-comment tsd-typography">
|
3412
|
+
<div class="lead">
|
3413
|
+
<p>Subtitle of the card.</p>
|
3414
|
+
</div>
|
3415
|
+
</div>
|
3416
|
+
</li>
|
3417
|
+
<li class="tsd-parameter">
|
3418
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
3419
|
+
<div class="tsd-comment tsd-typography">
|
3420
|
+
<div class="lead">
|
3421
|
+
<p>Title of the card.</p>
|
3422
|
+
</div>
|
3423
|
+
</div>
|
3424
|
+
</li>
|
3425
|
+
<li class="tsd-parameter">
|
3426
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"card"</span></h5>
|
3427
|
+
<div class="tsd-comment tsd-typography">
|
3428
|
+
<div class="lead">
|
3429
|
+
<p>The type discriminant.</p>
|
3430
|
+
</div>
|
3431
|
+
</div>
|
3432
|
+
</li>
|
3433
|
+
</ul>
|
3434
|
+
</div>
|
3435
|
+
</section>
|
3436
|
+
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
3437
|
+
<a name="ContentDataListItem" class="tsd-anchor"></a>
|
3438
|
+
<h3>Content<wbr>Data<wbr>List<wbr>Item</h3>
|
3439
|
+
<div class="tsd-signature tsd-kind-icon">Content<wbr>Data<wbr>List<wbr>Item<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>description<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>item<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
|
3440
|
+
<aside class="tsd-sources">
|
3441
|
+
</aside>
|
3442
|
+
<div class="tsd-comment tsd-typography">
|
3443
|
+
<div class="lead">
|
3444
|
+
<p>Represents an item in the <a href="modules.html#ContentDataListPicker">ContentDataListPicker</a>.</p>
|
3445
|
+
</div>
|
3446
|
+
</div>
|
3447
|
+
<div class="tsd-type-declaration">
|
3448
|
+
<h4>Type declaration</h4>
|
3449
|
+
<ul class="tsd-parameters">
|
3450
|
+
<li class="tsd-parameter">
|
3451
|
+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> description<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
3452
|
+
<div class="tsd-comment tsd-typography">
|
3453
|
+
<div class="lead">
|
3454
|
+
<p>Description of the item.</p>
|
3455
|
+
</div>
|
3456
|
+
</div>
|
3457
|
+
</li>
|
3458
|
+
<li class="tsd-parameter">
|
3459
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
3460
|
+
<div class="tsd-comment tsd-typography">
|
3461
|
+
<div class="lead">
|
3462
|
+
<p>Unique item identifier. Not visible to the recipient.</p>
|
3463
|
+
</div>
|
3464
|
+
</div>
|
3465
|
+
</li>
|
3466
|
+
<li class="tsd-parameter">
|
3467
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> item<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
3468
|
+
<div class="tsd-comment tsd-typography">
|
3469
|
+
<div class="lead">
|
3470
|
+
<p>Display value of the item.</p>
|
3471
|
+
</div>
|
3472
|
+
</div>
|
3473
|
+
</li>
|
3474
|
+
</ul>
|
3475
|
+
</div>
|
3476
|
+
</section>
|
3477
|
+
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
3478
|
+
<a name="ContentDataListPicker" class="tsd-anchor"></a>
|
3479
|
+
<h3>Content<wbr>Data<wbr>List<wbr>Picker</h3>
|
3480
|
+
<div class="tsd-signature tsd-kind-icon">Content<wbr>Data<wbr>List<wbr>Picker<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>button<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>items<span class="tsd-signature-symbol">: </span><a href="modules.html#ContentDataListItem" class="tsd-signature-type" data-tsd-kind="Type alias">ContentDataListItem</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>rawData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"listPicker"</span><span class="tsd-signature-symbol"> }</span></div>
|
3481
|
+
<aside class="tsd-sources">
|
3482
|
+
</aside>
|
3483
|
+
<div class="tsd-comment tsd-typography">
|
3484
|
+
<div class="lead">
|
3485
|
+
<p>Shows a menu of up to 10 options, which offers a simple way for users to make
|
3486
|
+
a selection. Represents the twilio/list-picker content type.</p>
|
3487
|
+
</div>
|
3488
|
+
</div>
|
3489
|
+
<div class="tsd-type-declaration">
|
3490
|
+
<h4>Type declaration</h4>
|
3491
|
+
<ul class="tsd-parameters">
|
3492
|
+
<li class="tsd-parameter">
|
3493
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
3494
|
+
<div class="tsd-comment tsd-typography">
|
3495
|
+
<div class="lead">
|
3496
|
+
<p>The text of the message you want to send. This is rendered as the body of
|
3497
|
+
the message.</p>
|
3498
|
+
</div>
|
3499
|
+
</div>
|
3500
|
+
</li>
|
3501
|
+
<li class="tsd-parameter">
|
3502
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> button<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
3503
|
+
<div class="tsd-comment tsd-typography">
|
3504
|
+
<div class="lead">
|
3505
|
+
<p>Display value of the primary button.</p>
|
3506
|
+
</div>
|
3507
|
+
</div>
|
3508
|
+
</li>
|
3509
|
+
<li class="tsd-parameter">
|
3510
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> items<span class="tsd-signature-symbol">: </span><a href="modules.html#ContentDataListItem" class="tsd-signature-type" data-tsd-kind="Type alias">ContentDataListItem</a><span class="tsd-signature-symbol">[]</span></h5>
|
3511
|
+
<div class="tsd-comment tsd-typography">
|
3512
|
+
<div class="lead">
|
3513
|
+
<p>List item objects displayed in the list. See <a href="modules.html#ContentDataListItem">ContentDataListItem</a>.</p>
|
3514
|
+
</div>
|
3515
|
+
</div>
|
3516
|
+
</li>
|
3517
|
+
<li class="tsd-parameter">
|
3518
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> raw<wbr>Data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
3519
|
+
<div class="tsd-comment tsd-typography">
|
3520
|
+
<div class="lead">
|
3521
|
+
<p>Full data as a stringified JSON. This could be used for future content
|
3522
|
+
types and fields which are not yet supported by the newest version of
|
3523
|
+
the Conversations SDK, or for using newer types in the older versions of
|
3524
|
+
the SDK.</p>
|
3525
|
+
</div>
|
3526
|
+
</div>
|
3527
|
+
</li>
|
3528
|
+
<li class="tsd-parameter">
|
3529
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"listPicker"</span></h5>
|
3530
|
+
<div class="tsd-comment tsd-typography">
|
3531
|
+
<div class="lead">
|
3532
|
+
<p>The type discriminant.</p>
|
3533
|
+
</div>
|
3534
|
+
</div>
|
3535
|
+
</li>
|
3536
|
+
</ul>
|
3537
|
+
</div>
|
3538
|
+
</section>
|
3539
|
+
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
3540
|
+
<a name="ContentDataLocation" class="tsd-anchor"></a>
|
3541
|
+
<h3>Content<wbr>Data<wbr>Location</h3>
|
3542
|
+
<div class="tsd-signature tsd-kind-icon">Content<wbr>Data<wbr>Location<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>label<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>latitude<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>longitude<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span>rawData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"location"</span><span class="tsd-signature-symbol"> }</span></div>
|
3543
|
+
<aside class="tsd-sources">
|
3544
|
+
</aside>
|
3545
|
+
<div class="tsd-comment tsd-typography">
|
3546
|
+
<div class="lead">
|
3547
|
+
<p>Contains a location pin and an optional label, which can be used to enhance
|
3548
|
+
delivery notifications or connect recipients to physical experiences you
|
3549
|
+
offer. Represents the twilio/location content type.</p>
|
3550
|
+
</div>
|
3551
|
+
</div>
|
3552
|
+
<div class="tsd-type-declaration">
|
3553
|
+
<h4>Type declaration</h4>
|
3554
|
+
<ul class="tsd-parameters">
|
3555
|
+
<li class="tsd-parameter">
|
3556
|
+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> label<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
3557
|
+
<div class="tsd-comment tsd-typography">
|
3558
|
+
<div class="lead">
|
3559
|
+
<p>The label to be displayed to the end user alongside the location pin.</p>
|
3560
|
+
</div>
|
3561
|
+
</div>
|
3562
|
+
</li>
|
3563
|
+
<li class="tsd-parameter">
|
3564
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> latitude<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
|
3565
|
+
<div class="tsd-comment tsd-typography">
|
3566
|
+
<div class="lead">
|
3567
|
+
<p>The latitude value of the location pin you want to send.</p>
|
3568
|
+
</div>
|
3569
|
+
</div>
|
3570
|
+
</li>
|
3571
|
+
<li class="tsd-parameter">
|
3572
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> longitude<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
|
3573
|
+
<div class="tsd-comment tsd-typography">
|
3574
|
+
<div class="lead">
|
3575
|
+
<p>The longitude value of the location pin you want to send.</p>
|
3576
|
+
</div>
|
3577
|
+
</div>
|
3578
|
+
</li>
|
3579
|
+
<li class="tsd-parameter">
|
3580
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> raw<wbr>Data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
3581
|
+
<div class="tsd-comment tsd-typography">
|
3582
|
+
<div class="lead">
|
3583
|
+
<p>Full data as a stringified JSON. This could be used for future content
|
3584
|
+
types and fields which are not yet supported by the newest version of
|
3585
|
+
the Conversations SDK, or for using newer types in the older versions of
|
3586
|
+
the SDK.</p>
|
3587
|
+
</div>
|
3588
|
+
</div>
|
3589
|
+
</li>
|
3590
|
+
<li class="tsd-parameter">
|
3591
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"location"</span></h5>
|
3592
|
+
<div class="tsd-comment tsd-typography">
|
3593
|
+
<div class="lead">
|
3594
|
+
<p>The type discriminant.</p>
|
3595
|
+
</div>
|
3596
|
+
</div>
|
3597
|
+
</li>
|
3598
|
+
</ul>
|
3599
|
+
</div>
|
3600
|
+
</section>
|
3601
|
+
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
3602
|
+
<a name="ContentDataMedia" class="tsd-anchor"></a>
|
3603
|
+
<h3>Content<wbr>Data<wbr>Media</h3>
|
3604
|
+
<div class="tsd-signature tsd-kind-icon">Content<wbr>Data<wbr>Media<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>media<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>rawData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"media"</span><span class="tsd-signature-symbol"> }</span></div>
|
3605
|
+
<aside class="tsd-sources">
|
3606
|
+
</aside>
|
3607
|
+
<div class="tsd-comment tsd-typography">
|
3608
|
+
<div class="lead">
|
3609
|
+
<p>Used to send file attachments, or to send long texts via MMS in the US and
|
3610
|
+
Canada. Represents the twilio/media content type.</p>
|
3611
|
+
</div>
|
3612
|
+
</div>
|
3613
|
+
<div class="tsd-type-declaration">
|
3614
|
+
<h4>Type declaration</h4>
|
3615
|
+
<ul class="tsd-parameters">
|
3616
|
+
<li class="tsd-parameter">
|
3617
|
+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> body<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
3618
|
+
<div class="tsd-comment tsd-typography">
|
3619
|
+
<div class="lead">
|
3620
|
+
<p>The text of the message you want to send.</p>
|
3621
|
+
</div>
|
3622
|
+
</div>
|
3623
|
+
</li>
|
3624
|
+
<li class="tsd-parameter">
|
3625
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> media<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
|
3626
|
+
<div class="tsd-comment tsd-typography">
|
3627
|
+
<div class="lead">
|
3628
|
+
<p>URLs of the media you want to send.</p>
|
3629
|
+
</div>
|
3630
|
+
</div>
|
3631
|
+
</li>
|
3632
|
+
<li class="tsd-parameter">
|
3633
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> raw<wbr>Data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
3634
|
+
<div class="tsd-comment tsd-typography">
|
3635
|
+
<div class="lead">
|
3636
|
+
<p>Full data as a stringified JSON. This could be used for future content
|
3637
|
+
types and fields which are not yet supported by the newest version of
|
3638
|
+
the Conversations SDK, or for using newer types in the older versions of
|
3639
|
+
the SDK.</p>
|
3640
|
+
</div>
|
3641
|
+
</div>
|
3642
|
+
</li>
|
3643
|
+
<li class="tsd-parameter">
|
3644
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"media"</span></h5>
|
3645
|
+
<div class="tsd-comment tsd-typography">
|
3646
|
+
<div class="lead">
|
3647
|
+
<p>The type discriminant.</p>
|
3648
|
+
</div>
|
3649
|
+
</div>
|
3650
|
+
</li>
|
3651
|
+
</ul>
|
3652
|
+
</div>
|
3653
|
+
</section>
|
3654
|
+
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
3655
|
+
<a name="ContentDataOther" class="tsd-anchor"></a>
|
3656
|
+
<h3>Content<wbr>Data<wbr>Other</h3>
|
3657
|
+
<div class="tsd-signature tsd-kind-icon">Content<wbr>Data<wbr>Other<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>rawData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"other"</span><span class="tsd-signature-symbol"> }</span></div>
|
3658
|
+
<aside class="tsd-sources">
|
3659
|
+
</aside>
|
3660
|
+
<div class="tsd-comment tsd-typography">
|
3661
|
+
<div class="lead">
|
3662
|
+
<p>Used for unknown content types which aren't present in the current version of
|
3663
|
+
the Conversations SDK.</p>
|
3664
|
+
</div>
|
3665
|
+
</div>
|
3666
|
+
<div class="tsd-type-declaration">
|
3667
|
+
<h4>Type declaration</h4>
|
3668
|
+
<ul class="tsd-parameters">
|
3669
|
+
<li class="tsd-parameter">
|
3670
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> raw<wbr>Data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
3671
|
+
<div class="tsd-comment tsd-typography">
|
3672
|
+
<div class="lead">
|
3673
|
+
<p>Full data as a stringified JSON. This could be used for future content
|
3674
|
+
types and fields which are not yet supported by the newest version of
|
3675
|
+
the Conversations SDK, or for using newer types in the older versions of
|
3676
|
+
the SDK.</p>
|
3677
|
+
</div>
|
3678
|
+
</div>
|
3679
|
+
</li>
|
3680
|
+
<li class="tsd-parameter">
|
3681
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"other"</span></h5>
|
3682
|
+
<div class="tsd-comment tsd-typography">
|
3683
|
+
<div class="lead">
|
3684
|
+
<p>The type discriminant.</p>
|
3685
|
+
</div>
|
3686
|
+
</div>
|
3687
|
+
</li>
|
3688
|
+
</ul>
|
3689
|
+
</div>
|
3690
|
+
</section>
|
3691
|
+
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
3692
|
+
<a name="ContentDataQuickReply" class="tsd-anchor"></a>
|
3693
|
+
<h3>Content<wbr>Data<wbr>Quick<wbr>Reply</h3>
|
3694
|
+
<div class="tsd-signature tsd-kind-icon">Content<wbr>Data<wbr>Quick<wbr>Reply<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>rawData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>replies<span class="tsd-signature-symbol">: </span><a href="modules.html#ContentDataReply" class="tsd-signature-type" data-tsd-kind="Type alias">ContentDataReply</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"quickReply"</span><span class="tsd-signature-symbol"> }</span></div>
|
3695
|
+
<aside class="tsd-sources">
|
3696
|
+
</aside>
|
3697
|
+
<div class="tsd-comment tsd-typography">
|
3698
|
+
<div class="lead">
|
3699
|
+
<p>Let recipients tap, rather than type, to respond to the message. Represents
|
3700
|
+
the twilio/quick-reply content type.</p>
|
3701
|
+
</div>
|
3702
|
+
</div>
|
3703
|
+
<div class="tsd-type-declaration">
|
3704
|
+
<h4>Type declaration</h4>
|
3705
|
+
<ul class="tsd-parameters">
|
3706
|
+
<li class="tsd-parameter">
|
3707
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
3708
|
+
<div class="tsd-comment tsd-typography">
|
3709
|
+
<div class="lead">
|
3710
|
+
<p>The text of the message you want to send. This is included as a regular
|
3711
|
+
text message.</p>
|
3712
|
+
</div>
|
3713
|
+
</div>
|
3714
|
+
</li>
|
3715
|
+
<li class="tsd-parameter">
|
3716
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> raw<wbr>Data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
3717
|
+
<div class="tsd-comment tsd-typography">
|
3718
|
+
<div class="lead">
|
3719
|
+
<p>Full data as a stringified JSON. This could be used for future content
|
3720
|
+
types and fields which are not yet supported by the newest version of
|
3721
|
+
the Conversations SDK, or for using newer types in the older versions of
|
3722
|
+
the SDK.</p>
|
3723
|
+
</div>
|
3724
|
+
</div>
|
3725
|
+
</li>
|
3726
|
+
<li class="tsd-parameter">
|
3727
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> replies<span class="tsd-signature-symbol">: </span><a href="modules.html#ContentDataReply" class="tsd-signature-type" data-tsd-kind="Type alias">ContentDataReply</a><span class="tsd-signature-symbol">[]</span></h5>
|
3728
|
+
<div class="tsd-comment tsd-typography">
|
3729
|
+
<div class="lead">
|
3730
|
+
<p>Up to 3 buttons can be created for quick reply. See
|
3731
|
+
<a href="modules.html#ContentDataReply">ContentDataReply</a>.</p>
|
3732
|
+
</div>
|
3733
|
+
</div>
|
3734
|
+
</li>
|
3735
|
+
<li class="tsd-parameter">
|
3736
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"quickReply"</span></h5>
|
3737
|
+
<div class="tsd-comment tsd-typography">
|
3738
|
+
<div class="lead">
|
3739
|
+
<p>The type discriminant.</p>
|
3740
|
+
</div>
|
3741
|
+
</div>
|
3742
|
+
</li>
|
3743
|
+
</ul>
|
3744
|
+
</div>
|
3745
|
+
</section>
|
3746
|
+
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
3747
|
+
<a name="ContentDataReply" class="tsd-anchor"></a>
|
3748
|
+
<h3>Content<wbr>Data<wbr>Reply</h3>
|
3749
|
+
<div class="tsd-signature tsd-kind-icon">Content<wbr>Data<wbr>Reply<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
|
3750
|
+
<aside class="tsd-sources">
|
3751
|
+
</aside>
|
3752
|
+
<div class="tsd-comment tsd-typography">
|
3753
|
+
<div class="lead">
|
3754
|
+
<p>Shows a button that sends back a predefined text. Used in
|
3755
|
+
<a href="modules.html#ContentDataQuickReply">ContentDataQuickReply</a>.</p>
|
3756
|
+
</div>
|
3757
|
+
</div>
|
3758
|
+
<div class="tsd-type-declaration">
|
3759
|
+
<h4>Type declaration</h4>
|
3760
|
+
<ul class="tsd-parameters">
|
3761
|
+
<li class="tsd-parameter">
|
3762
|
+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> id<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
3763
|
+
<div class="tsd-comment tsd-typography">
|
3764
|
+
<div class="lead">
|
3765
|
+
<p>Postback payload. This field is not visible to the end user.</p>
|
3766
|
+
</div>
|
3767
|
+
</div>
|
3768
|
+
</li>
|
3769
|
+
<li class="tsd-parameter">
|
3770
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> title<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
3771
|
+
<div class="tsd-comment tsd-typography">
|
3772
|
+
<div class="lead">
|
3773
|
+
<p>Display value of the action. This is the message that will be sent back
|
3774
|
+
when the user taps on the button.</p>
|
3775
|
+
</div>
|
3776
|
+
</div>
|
3777
|
+
</li>
|
3778
|
+
</ul>
|
3779
|
+
</div>
|
3780
|
+
</section>
|
3781
|
+
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
3782
|
+
<a name="ContentDataText" class="tsd-anchor"></a>
|
3783
|
+
<h3>Content<wbr>Data<wbr>Text</h3>
|
3784
|
+
<div class="tsd-signature tsd-kind-icon">Content<wbr>Data<wbr>Text<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>rawData<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"text"</span><span class="tsd-signature-symbol"> }</span></div>
|
3785
|
+
<aside class="tsd-sources">
|
3786
|
+
</aside>
|
3787
|
+
<div class="tsd-comment tsd-typography">
|
3788
|
+
<div class="lead">
|
3789
|
+
<p>Contains only the plain text-based content. Represents the twilio/text
|
3790
|
+
content type.</p>
|
3791
|
+
</div>
|
3792
|
+
</div>
|
3793
|
+
<div class="tsd-type-declaration">
|
3794
|
+
<h4>Type declaration</h4>
|
3795
|
+
<ul class="tsd-parameters">
|
3796
|
+
<li class="tsd-parameter">
|
3797
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> body<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
3798
|
+
<div class="tsd-comment tsd-typography">
|
3799
|
+
<div class="lead">
|
3800
|
+
<p>The text of the message you want to send.</p>
|
3801
|
+
</div>
|
3802
|
+
</div>
|
3803
|
+
</li>
|
3804
|
+
<li class="tsd-parameter">
|
3805
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> raw<wbr>Data<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
3806
|
+
<div class="tsd-comment tsd-typography">
|
3807
|
+
<div class="lead">
|
3808
|
+
<p>Full data as a stringified JSON. This could be used for future content
|
3809
|
+
types and fields which are not yet supported by the newest version of
|
3810
|
+
the Conversations SDK, or for using newer types in the older versions of
|
3811
|
+
the SDK.</p>
|
3812
|
+
</div>
|
3813
|
+
</div>
|
3814
|
+
</li>
|
3815
|
+
<li class="tsd-parameter">
|
3816
|
+
<h5><span class="tsd-flag ts-flagReadonly">Readonly</span> type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"text"</span></h5>
|
3817
|
+
<div class="tsd-comment tsd-typography">
|
3818
|
+
<div class="lead">
|
3819
|
+
<p>The type discriminant.</p>
|
3820
|
+
</div>
|
3821
|
+
</div>
|
3822
|
+
</li>
|
3823
|
+
</ul>
|
3824
|
+
</div>
|
3825
|
+
</section>
|
3003
3826
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
3004
3827
|
<a name="ConversationStatus" class="tsd-anchor"></a>
|
3005
3828
|
<h3>Conversation<wbr>Status</h3>
|
@@ -3182,12 +4005,13 @@ img {
|
|
3182
4005
|
<section class="tsd-panel tsd-member tsd-kind-type-alias">
|
3183
4006
|
<a name="ParticipantType" class="tsd-anchor"></a>
|
3184
4007
|
<h3>Participant<wbr>Type</h3>
|
3185
|
-
<div class="tsd-signature tsd-kind-icon">Participant<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"chat"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"sms"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"whatsapp"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"email"</span></div>
|
4008
|
+
<div class="tsd-signature tsd-kind-icon">Participant<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"chat"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"sms"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"whatsapp"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"email"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
|
3186
4009
|
<aside class="tsd-sources">
|
3187
4010
|
</aside>
|
3188
4011
|
<div class="tsd-comment tsd-typography">
|
3189
4012
|
<div class="lead">
|
3190
|
-
<p>
|
4013
|
+
<p>Participant type. The string variant can be used to denote new types of
|
4014
|
+
participant that aren't supported by this version of the SDK.</p>
|
3191
4015
|
</div>
|
3192
4016
|
</div>
|
3193
4017
|
</section>
|