@twilio/conversations 3.0.0-rc.8 → 3.0.0
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 +39 -29
- package/builds/browser.esm.js +10838 -0
- package/builds/browser.esm.js.map +1 -0
- package/builds/browser.js +2494 -476
- package/builds/browser.js.map +1 -1
- package/builds/lib.d.ts +805 -70
- package/builds/lib.esm.d.ts +3178 -0
- package/builds/lib.esm.js +10837 -0
- package/builds/lib.js +2494 -476
- package/builds/lib.js.map +1 -1
- package/builds/twilio-conversations.js +29167 -26611
- package/builds/twilio-conversations.js.map +1 -0
- package/builds/twilio-conversations.min.js +2 -1
- package/builds/twilio-conversations.min.js.map +1 -0
- package/dist/aggregated-delivery-receipt.js +10 -5
- package/dist/aggregated-delivery-receipt.js.map +1 -1
- package/dist/channel-metadata-client.js +187 -0
- package/dist/channel-metadata-client.js.map +1 -0
- package/dist/client.js +266 -192
- package/dist/client.js.map +1 -1
- package/dist/command-executor.js +51 -14
- package/dist/command-executor.js.map +1 -1
- package/dist/configuration.js +23 -12
- package/dist/configuration.js.map +1 -1
- package/dist/content-client.js +180 -0
- package/dist/content-client.js.map +1 -0
- package/dist/content-template.js +304 -0
- package/dist/content-template.js.map +1 -0
- package/dist/conversation.js +213 -134
- package/dist/conversation.js.map +1 -1
- package/dist/data/conversations.js +70 -50
- package/dist/data/conversations.js.map +1 -1
- package/dist/data/messages.js +40 -27
- package/dist/data/messages.js.map +1 -1
- package/dist/data/participants.js +38 -32
- package/dist/data/participants.js.map +1 -1
- package/dist/data/users.js +19 -14
- package/dist/data/users.js.map +1 -1
- package/dist/detailed-delivery-receipt.js +9 -4
- package/dist/detailed-delivery-receipt.js.map +1 -1
- package/dist/index.js +26 -41
- package/dist/index.js.map +1 -1
- package/dist/interfaces/notification-types.js +9 -4
- package/dist/interfaces/notification-types.js.map +1 -1
- package/dist/interfaces/{attributes.js → rules.js} +26 -13
- package/dist/interfaces/rules.js.map +1 -0
- package/dist/logger.js +17 -28
- package/dist/logger.js.map +1 -1
- package/dist/media.js +40 -24
- package/dist/media.js.map +1 -1
- package/dist/message-builder.js +79 -12
- package/dist/message-builder.js.map +1 -1
- package/dist/message-recipients-client.js +231 -0
- package/dist/message-recipients-client.js.map +1 -0
- package/dist/message.js +258 -92
- package/dist/message.js.map +1 -1
- package/dist/node_modules/quick-lru/index.js +261 -0
- package/dist/node_modules/quick-lru/index.js.map +1 -0
- package/dist/node_modules/tslib/tslib.es6.js +15 -5
- package/dist/node_modules/tslib/tslib.es6.js.map +1 -1
- package/dist/packages/conversations/package.json.js +12 -7
- package/dist/packages/conversations/package.json.js.map +1 -1
- package/dist/participant.js +42 -38
- package/dist/participant.js.map +1 -1
- package/dist/push-notification.js +9 -4
- package/dist/push-notification.js.map +1 -1
- package/dist/rest-paginator.js +9 -4
- package/dist/rest-paginator.js.map +1 -1
- package/dist/services/network.js +11 -6
- package/dist/services/network.js.map +1 -1
- package/dist/services/typing-indicator.js +17 -11
- package/dist/services/typing-indicator.js.map +1 -1
- package/dist/unsent-message.js +14 -9
- package/dist/unsent-message.js.map +1 -1
- package/dist/user.js +40 -32
- package/dist/user.js.map +1 -1
- package/dist/util/deferred.js +9 -4
- package/dist/util/deferred.js.map +1 -1
- package/dist/util/index.js +44 -8
- 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 +98 -27
- package/docs/classes/ContentTemplate.html +3116 -0
- package/docs/classes/ContentTemplateVariable.html +3116 -0
- package/docs/classes/Conversation.html +46 -9
- package/docs/classes/EmailRecipientDescriptor.html +3098 -0
- package/docs/classes/Message.html +99 -5
- package/docs/classes/MessageBuilder.html +41 -0
- package/docs/classes/Participant.html +2 -2
- package/docs/classes/UnknownRecipientDescriptor.html +3067 -0
- package/docs/index.html +892 -28
- package/docs/interfaces/ClientOptions.html +32 -0
- package/docs/interfaces/CreateConversationOptions.html +17 -0
- package/docs/modules.html +891 -27
- package/package.json +21 -19
- package/CHANGELOG.md +0 -501
- package/dist/interfaces/attributes.js.map +0 -1
package/docs/classes/Client.html
CHANGED
|
@@ -2729,6 +2729,12 @@ img {
|
|
|
2729
2729
|
<li class=" tsd-kind-event tsd-parent-kind-class tsd-is-static">
|
|
2730
2730
|
<a href="Client.html#conversationUpdated" class="tsd-kind-icon">conversation<wbr>Updated</a>
|
|
2731
2731
|
</li>
|
|
2732
|
+
<li class=" tsd-kind-event tsd-parent-kind-class tsd-is-static">
|
|
2733
|
+
<a href="Client.html#initFailed" class="tsd-kind-icon">init<wbr>Failed</a>
|
|
2734
|
+
</li>
|
|
2735
|
+
<li class=" tsd-kind-event tsd-parent-kind-class tsd-is-static">
|
|
2736
|
+
<a href="Client.html#initialized" class="tsd-kind-icon">initialized</a>
|
|
2737
|
+
</li>
|
|
2732
2738
|
<li class=" tsd-kind-event tsd-parent-kind-class tsd-is-static">
|
|
2733
2739
|
<a href="Client.html#messageAdded" class="tsd-kind-icon">message<wbr>Added</a>
|
|
2734
2740
|
</li>
|
|
@@ -2750,9 +2756,6 @@ img {
|
|
|
2750
2756
|
<li class=" tsd-kind-event tsd-parent-kind-class tsd-is-static">
|
|
2751
2757
|
<a href="Client.html#pushNotification" class="tsd-kind-icon">push<wbr>Notification</a>
|
|
2752
2758
|
</li>
|
|
2753
|
-
<li class=" tsd-kind-event tsd-parent-kind-class tsd-is-static">
|
|
2754
|
-
<a href="Client.html#stateChanged" class="tsd-kind-icon">state<wbr>Changed</a>
|
|
2755
|
-
</li>
|
|
2756
2759
|
<li class=" tsd-kind-event tsd-parent-kind-class tsd-is-static">
|
|
2757
2760
|
<a href="Client.html#tokenAboutToExpire" class="tsd-kind-icon">token<wbr>About<wbr>ToExpire</a>
|
|
2758
2761
|
</li>
|
|
@@ -2795,6 +2798,9 @@ img {
|
|
|
2795
2798
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
2796
2799
|
<a href="Client.html#createConversation" class="tsd-kind-icon">create<wbr>Conversation</a>
|
|
2797
2800
|
</li>
|
|
2801
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
2802
|
+
<a href="Client.html#getContentTemplates" class="tsd-kind-icon">get<wbr>Content<wbr>Templates</a>
|
|
2803
|
+
</li>
|
|
2798
2804
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
2799
2805
|
<a href="Client.html#getConversationBySid" class="tsd-kind-icon">get<wbr>Conversation<wbr>BySid</a>
|
|
2800
2806
|
</li>
|
|
@@ -2819,6 +2825,9 @@ img {
|
|
|
2819
2825
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
2820
2826
|
<a href="Client.html#handlePushNotification" class="tsd-kind-icon">handle<wbr>Push<wbr>Notification</a>
|
|
2821
2827
|
</li>
|
|
2828
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
2829
|
+
<a href="Client.html#peekConversationBySid" class="tsd-kind-icon">peek<wbr>Conversation<wbr>BySid</a>
|
|
2830
|
+
</li>
|
|
2822
2831
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
2823
2832
|
<a href="Client.html#removePushRegistrations" class="tsd-kind-icon">remove<wbr>Push<wbr>Registrations</a>
|
|
2824
2833
|
</li>
|
|
@@ -2886,6 +2895,8 @@ img {
|
|
|
2886
2895
|
<li class="tsd-kind-event tsd-parent-kind-class tsd-is-static"><a href="Client.html#conversationLeft" class="tsd-kind-icon">conversation<wbr>Left</a></li>
|
|
2887
2896
|
<li class="tsd-kind-event tsd-parent-kind-class tsd-is-static"><a href="Client.html#conversationRemoved" class="tsd-kind-icon">conversation<wbr>Removed</a></li>
|
|
2888
2897
|
<li class="tsd-kind-event tsd-parent-kind-class tsd-is-static"><a href="Client.html#conversationUpdated" class="tsd-kind-icon">conversation<wbr>Updated</a></li>
|
|
2898
|
+
<li class="tsd-kind-event tsd-parent-kind-class tsd-is-static"><a href="Client.html#initFailed" class="tsd-kind-icon">init<wbr>Failed</a></li>
|
|
2899
|
+
<li class="tsd-kind-event tsd-parent-kind-class tsd-is-static"><a href="Client.html#initialized" class="tsd-kind-icon">initialized</a></li>
|
|
2889
2900
|
<li class="tsd-kind-event tsd-parent-kind-class tsd-is-static"><a href="Client.html#messageAdded" class="tsd-kind-icon">message<wbr>Added</a></li>
|
|
2890
2901
|
<li class="tsd-kind-event tsd-parent-kind-class tsd-is-static"><a href="Client.html#messageRemoved" class="tsd-kind-icon">message<wbr>Removed</a></li>
|
|
2891
2902
|
<li class="tsd-kind-event tsd-parent-kind-class tsd-is-static"><a href="Client.html#messageUpdated" class="tsd-kind-icon">message<wbr>Updated</a></li>
|
|
@@ -2893,7 +2904,6 @@ img {
|
|
|
2893
2904
|
<li class="tsd-kind-event tsd-parent-kind-class tsd-is-static"><a href="Client.html#participantLeft" class="tsd-kind-icon">participant<wbr>Left</a></li>
|
|
2894
2905
|
<li class="tsd-kind-event tsd-parent-kind-class tsd-is-static"><a href="Client.html#participantUpdated" class="tsd-kind-icon">participant<wbr>Updated</a></li>
|
|
2895
2906
|
<li class="tsd-kind-event tsd-parent-kind-class tsd-is-static"><a href="Client.html#pushNotification" class="tsd-kind-icon">push<wbr>Notification</a></li>
|
|
2896
|
-
<li class="tsd-kind-event tsd-parent-kind-class tsd-is-static"><a href="Client.html#stateChanged" class="tsd-kind-icon">state<wbr>Changed</a></li>
|
|
2897
2907
|
<li class="tsd-kind-event tsd-parent-kind-class tsd-is-static"><a href="Client.html#tokenAboutToExpire" class="tsd-kind-icon">token<wbr>About<wbr>ToExpire</a></li>
|
|
2898
2908
|
<li class="tsd-kind-event tsd-parent-kind-class tsd-is-static"><a href="Client.html#tokenExpired" class="tsd-kind-icon">token<wbr>Expired</a></li>
|
|
2899
2909
|
<li class="tsd-kind-event tsd-parent-kind-class tsd-is-static"><a href="Client.html#typingEnded" class="tsd-kind-icon">typing<wbr>Ended</a></li>
|
|
@@ -2923,6 +2933,7 @@ img {
|
|
|
2923
2933
|
<h3>Methods</h3>
|
|
2924
2934
|
<ul class="tsd-index-list">
|
|
2925
2935
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Client.html#createConversation" class="tsd-kind-icon">create<wbr>Conversation</a></li>
|
|
2936
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Client.html#getContentTemplates" class="tsd-kind-icon">get<wbr>Content<wbr>Templates</a></li>
|
|
2926
2937
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Client.html#getConversationBySid" class="tsd-kind-icon">get<wbr>Conversation<wbr>BySid</a></li>
|
|
2927
2938
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Client.html#getConversationByUniqueName" class="tsd-kind-icon">get<wbr>Conversation<wbr>ByUnique<wbr>Name</a></li>
|
|
2928
2939
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Client.html#getSubscribedConversations" class="tsd-kind-icon">get<wbr>Subscribed<wbr>Conversations</a></li>
|
|
@@ -2931,6 +2942,7 @@ img {
|
|
|
2931
2942
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Client.html#getTemporaryContentUrlsForMediaSids" class="tsd-kind-icon">get<wbr>Temporary<wbr>Content<wbr>Urls<wbr>For<wbr>Media<wbr>Sids</a></li>
|
|
2932
2943
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Client.html#getUser" class="tsd-kind-icon">get<wbr>User</a></li>
|
|
2933
2944
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Client.html#handlePushNotification" class="tsd-kind-icon">handle<wbr>Push<wbr>Notification</a></li>
|
|
2945
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Client.html#peekConversationBySid" class="tsd-kind-icon">peek<wbr>Conversation<wbr>BySid</a></li>
|
|
2934
2946
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Client.html#removePushRegistrations" class="tsd-kind-icon">remove<wbr>Push<wbr>Registrations</a></li>
|
|
2935
2947
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Client.html#setPushRegistrationId" class="tsd-kind-icon">set<wbr>Push<wbr>Registration<wbr>Id</a></li>
|
|
2936
2948
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Client.html#shutdown" class="tsd-kind-icon">shutdown</a></li>
|
|
@@ -2958,7 +2970,7 @@ img {
|
|
|
2958
2970
|
</aside>
|
|
2959
2971
|
<div class="tsd-comment tsd-typography">
|
|
2960
2972
|
<div class="lead">
|
|
2961
|
-
<p>Returned Conversations instance is not yet fully initialized. Calling any
|
|
2973
|
+
<p>Returned Conversations Client instance is not yet fully initialized. Calling any
|
|
2962
2974
|
operations will block until it is. Use connection events to monitor when
|
|
2963
2975
|
client becomes fully available (connectionStateChanged with state
|
|
2964
2976
|
'connected') or not available (connectionStateChange with state 'denied',
|
|
@@ -3122,6 +3134,38 @@ img {
|
|
|
3122
3134
|
</ol>
|
|
3123
3135
|
</div>
|
|
3124
3136
|
</section>
|
|
3137
|
+
<section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class tsd-is-static">
|
|
3138
|
+
<a name="initFailed" class="tsd-anchor"></a>
|
|
3139
|
+
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> init<wbr>Failed</h3>
|
|
3140
|
+
<div class="tsd-signature tsd-kind-icon">init<wbr>Failed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"initFailed"</span><span class="tsd-signature-symbol"> = "initFailed"</span></div>
|
|
3141
|
+
<aside class="tsd-sources">
|
|
3142
|
+
</aside>
|
|
3143
|
+
<div class="tsd-comment tsd-typography">
|
|
3144
|
+
<div class="lead">
|
|
3145
|
+
<p>Fired when the client initialization failed.</p>
|
|
3146
|
+
</div>
|
|
3147
|
+
<p>Parameters:</p>
|
|
3148
|
+
<ol>
|
|
3149
|
+
<li>object <code>data</code> - info object provided with the event. It has the
|
|
3150
|
+
following property:<ul>
|
|
3151
|
+
<li>Error? <code>error</code> - the initialization error if present</li>
|
|
3152
|
+
</ul>
|
|
3153
|
+
</li>
|
|
3154
|
+
</ol>
|
|
3155
|
+
</div>
|
|
3156
|
+
</section>
|
|
3157
|
+
<section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class tsd-is-static">
|
|
3158
|
+
<a name="initialized" class="tsd-anchor"></a>
|
|
3159
|
+
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> initialized</h3>
|
|
3160
|
+
<div class="tsd-signature tsd-kind-icon">initialized<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"initialized"</span><span class="tsd-signature-symbol"> = "initialized"</span></div>
|
|
3161
|
+
<aside class="tsd-sources">
|
|
3162
|
+
</aside>
|
|
3163
|
+
<div class="tsd-comment tsd-typography">
|
|
3164
|
+
<div class="lead">
|
|
3165
|
+
<p>Fired when the client has completed initialization successfully.</p>
|
|
3166
|
+
</div>
|
|
3167
|
+
</div>
|
|
3168
|
+
</section>
|
|
3125
3169
|
<section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class tsd-is-static">
|
|
3126
3170
|
<a name="messageAdded" class="tsd-anchor"></a>
|
|
3127
3171
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> message<wbr>Added</h3>
|
|
@@ -3248,27 +3292,6 @@ img {
|
|
|
3248
3292
|
</ol>
|
|
3249
3293
|
</div>
|
|
3250
3294
|
</section>
|
|
3251
|
-
<section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class tsd-is-static">
|
|
3252
|
-
<a name="stateChanged" class="tsd-anchor"></a>
|
|
3253
|
-
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> state<wbr>Changed</h3>
|
|
3254
|
-
<div class="tsd-signature tsd-kind-icon">state<wbr>Changed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"stateChanged"</span><span class="tsd-signature-symbol"> = "stateChanged"</span></div>
|
|
3255
|
-
<aside class="tsd-sources">
|
|
3256
|
-
</aside>
|
|
3257
|
-
<div class="tsd-comment tsd-typography">
|
|
3258
|
-
<div class="lead">
|
|
3259
|
-
<p>Fired when the state of the client has been changed.</p>
|
|
3260
|
-
</div>
|
|
3261
|
-
<p>Parameters:</p>
|
|
3262
|
-
<ol>
|
|
3263
|
-
<li>object <code>data</code> - info object provided with the event. It has the
|
|
3264
|
-
following properties:<ul>
|
|
3265
|
-
<li><a href="../modules.html#State">State</a> <code>state</code> - the new client state</li>
|
|
3266
|
-
<li>Error? <code>error</code> - the initialization error if present</li>
|
|
3267
|
-
</ul>
|
|
3268
|
-
</li>
|
|
3269
|
-
</ol>
|
|
3270
|
-
</div>
|
|
3271
|
-
</section>
|
|
3272
3295
|
<section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class tsd-is-static">
|
|
3273
3296
|
<a name="tokenAboutToExpire" class="tsd-anchor"></a>
|
|
3274
3297
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> token<wbr>About<wbr>ToExpire</h3>
|
|
@@ -3403,7 +3426,7 @@ img {
|
|
|
3403
3426
|
</aside>
|
|
3404
3427
|
<div class="tsd-comment tsd-typography">
|
|
3405
3428
|
<div class="lead">
|
|
3406
|
-
<p>
|
|
3429
|
+
<p>Parse a push notification payload.</p>
|
|
3407
3430
|
</div>
|
|
3408
3431
|
</div>
|
|
3409
3432
|
<div class="tsd-type-declaration">
|
|
@@ -3537,6 +3560,26 @@ img {
|
|
|
3537
3560
|
</li>
|
|
3538
3561
|
</ul>
|
|
3539
3562
|
</section>
|
|
3563
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
3564
|
+
<a name="getContentTemplates" class="tsd-anchor"></a>
|
|
3565
|
+
<h3>get<wbr>Content<wbr>Templates</h3>
|
|
3566
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
3567
|
+
<li class="tsd-signature tsd-kind-icon">get<wbr>Content<wbr>Templates<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">readonly </span><a href="ContentTemplate.html" class="tsd-signature-type" data-tsd-kind="Class">ContentTemplate</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
|
3568
|
+
</ul>
|
|
3569
|
+
<ul class="tsd-descriptions">
|
|
3570
|
+
<li class="tsd-description">
|
|
3571
|
+
<aside class="tsd-sources">
|
|
3572
|
+
</aside>
|
|
3573
|
+
<div class="tsd-comment tsd-typography">
|
|
3574
|
+
<div class="lead">
|
|
3575
|
+
<p>Returns rich content templates belonging to the account. Rich content
|
|
3576
|
+
templates can be created via the Twilio console or the REST API.</p>
|
|
3577
|
+
</div>
|
|
3578
|
+
</div>
|
|
3579
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">readonly </span><a href="ContentTemplate.html" class="tsd-signature-type" data-tsd-kind="Class">ContentTemplate</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
|
3580
|
+
</li>
|
|
3581
|
+
</ul>
|
|
3582
|
+
</section>
|
|
3540
3583
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
3541
3584
|
<a name="getConversationBySid" class="tsd-anchor"></a>
|
|
3542
3585
|
<h3>get<wbr>Conversation<wbr>BySid</h3>
|
|
@@ -3749,6 +3792,34 @@ img {
|
|
|
3749
3792
|
</li>
|
|
3750
3793
|
</ul>
|
|
3751
3794
|
</section>
|
|
3795
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
3796
|
+
<a name="peekConversationBySid" class="tsd-anchor"></a>
|
|
3797
|
+
<h3>peek<wbr>Conversation<wbr>BySid</h3>
|
|
3798
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
3799
|
+
<li class="tsd-signature tsd-kind-icon">peek<wbr>Conversation<wbr>BySid<span class="tsd-signature-symbol">(</span>conversationSid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Conversation.html" class="tsd-signature-type" data-tsd-kind="Class">Conversation</a><span class="tsd-signature-symbol">></span></li>
|
|
3800
|
+
</ul>
|
|
3801
|
+
<ul class="tsd-descriptions">
|
|
3802
|
+
<li class="tsd-description">
|
|
3803
|
+
<aside class="tsd-sources">
|
|
3804
|
+
</aside>
|
|
3805
|
+
<div class="tsd-comment tsd-typography">
|
|
3806
|
+
<div class="lead">
|
|
3807
|
+
<p>Peek a conversation by its SID.</p>
|
|
3808
|
+
</div>
|
|
3809
|
+
</div>
|
|
3810
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
3811
|
+
<ul class="tsd-parameters">
|
|
3812
|
+
<li>
|
|
3813
|
+
<h5>conversationSid: <span class="tsd-signature-type">string</span></h5>
|
|
3814
|
+
<div class="tsd-comment tsd-typography">
|
|
3815
|
+
<p>Conversation sid</p>
|
|
3816
|
+
</div>
|
|
3817
|
+
</li>
|
|
3818
|
+
</ul>
|
|
3819
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Conversation.html" class="tsd-signature-type" data-tsd-kind="Class">Conversation</a><span class="tsd-signature-symbol">></span></h4>
|
|
3820
|
+
</li>
|
|
3821
|
+
</ul>
|
|
3822
|
+
</section>
|
|
3752
3823
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
3753
3824
|
<a name="removePushRegistrations" class="tsd-anchor"></a>
|
|
3754
3825
|
<h3>remove<wbr>Push<wbr>Registrations</h3>
|