@twilio/conversations 2.0.1-rc.9 → 2.1.0-rc.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +74 -0
- package/NOTICE.txt +679 -0
- package/builds/browser.js +892 -619
- package/builds/browser.js.map +1 -1
- package/builds/lib.d.ts +371 -124
- package/builds/lib.js +892 -619
- package/builds/lib.js.map +1 -1
- package/builds/twilio-conversations.js +1067 -939
- package/builds/twilio-conversations.min.js +2 -14
- package/dist/aggregated-delivery-receipt.js +6 -1
- package/dist/aggregated-delivery-receipt.js.map +1 -1
- package/dist/client.js +165 -142
- package/dist/client.js.map +1 -1
- package/dist/command-executor.js +16 -14
- package/dist/command-executor.js.map +1 -1
- package/dist/configuration.js +14 -10
- package/dist/configuration.js.map +1 -1
- package/dist/conversation.js +232 -159
- package/dist/conversation.js.map +1 -1
- package/dist/data/conversations.js +82 -78
- package/dist/data/conversations.js.map +1 -1
- package/dist/data/messages.js +43 -39
- package/dist/data/messages.js.map +1 -1
- package/dist/data/participants.js +100 -78
- package/dist/data/participants.js.map +1 -1
- package/dist/data/users.js +24 -22
- package/dist/data/users.js.map +1 -1
- package/dist/detailed-delivery-receipt.js +1 -1
- package/dist/detailed-delivery-receipt.js.map +1 -1
- package/dist/index.js +1 -0
- package/dist/index.js.map +1 -1
- package/dist/interfaces/attributes.js +147 -0
- package/dist/interfaces/attributes.js.map +1 -0
- package/dist/interfaces/notification-types.js +5 -5
- package/dist/interfaces/notification-types.js.map +1 -1
- package/dist/logger.js +36 -15
- package/dist/logger.js.map +1 -1
- package/dist/media.js +21 -9
- package/dist/media.js.map +1 -1
- package/dist/message-builder.js +56 -3
- package/dist/message-builder.js.map +1 -1
- package/dist/message.js +158 -78
- package/dist/message.js.map +1 -1
- package/dist/packages/conversations/package.json.js +1 -1
- package/dist/participant.js +101 -50
- package/dist/participant.js.map +1 -1
- package/dist/push-notification.js.map +1 -1
- package/dist/rest-paginator.js +16 -6
- package/dist/rest-paginator.js.map +1 -1
- package/dist/services/network.js +18 -14
- package/dist/services/network.js.map +1 -1
- package/dist/services/typing-indicator.js +20 -17
- package/dist/services/typing-indicator.js.map +1 -1
- package/dist/unsent-message.js.map +1 -1
- package/dist/user.js +87 -60
- package/dist/user.js.map +1 -1
- package/dist/util/deferred.js +3 -1
- package/dist/util/deferred.js.map +1 -1
- package/dist/util/index.js +6 -6
- package/dist/util/index.js.map +1 -1
- package/docs/assets/js/search.js +1 -1
- package/docs/classes/AggregatedDeliveryReceipt.html +15 -0
- package/docs/classes/Client.html +39 -30
- package/docs/classes/Conversation.html +52 -30
- package/docs/classes/DetailedDeliveryReceipt.html +16 -1
- package/docs/classes/Media.html +15 -0
- package/docs/classes/Message.html +88 -7
- package/docs/classes/MessageBuilder.html +93 -2
- package/docs/classes/Participant.html +52 -8
- package/docs/classes/PushNotification.html +15 -0
- package/docs/classes/RestPaginator.html +15 -0
- package/docs/classes/UnsentMessage.html +15 -0
- package/docs/classes/User.html +22 -7
- package/docs/index.html +37 -3
- package/docs/interfaces/ClientOptions.html +15 -0
- package/docs/interfaces/ConversationBindings.html +3118 -0
- package/docs/interfaces/ConversationEmailBinding.html +3118 -0
- package/docs/interfaces/ConversationState.html +15 -0
- package/docs/interfaces/CreateConversationOptions.html +16 -1
- package/docs/interfaces/LastMessage.html +15 -0
- package/docs/interfaces/Paginator.html +15 -0
- package/docs/interfaces/ParticipantBindings.html +3118 -0
- package/docs/interfaces/ParticipantEmailBinding.html +3118 -0
- package/docs/interfaces/PushNotificationData.html +15 -0
- package/docs/interfaces/SendEmailOptions.html +15 -0
- package/docs/interfaces/SendMediaOptions.html +15 -0
- package/docs/modules.html +37 -3
- package/package.json +24 -18
@@ -2884,6 +2884,12 @@ img {
|
|
2884
2884
|
<li class=" tsd-kind-interface">
|
2885
2885
|
<a href="../interfaces/ClientOptions.html" class="tsd-kind-icon">Client<wbr>Options</a>
|
2886
2886
|
</li>
|
2887
|
+
<li class=" tsd-kind-interface">
|
2888
|
+
<a href="../interfaces/ConversationBindings.html" class="tsd-kind-icon">Conversation<wbr>Bindings</a>
|
2889
|
+
</li>
|
2890
|
+
<li class=" tsd-kind-interface">
|
2891
|
+
<a href="../interfaces/ConversationEmailBinding.html" class="tsd-kind-icon">Conversation<wbr>Email<wbr>Binding</a>
|
2892
|
+
</li>
|
2887
2893
|
<li class=" tsd-kind-interface">
|
2888
2894
|
<a href="../interfaces/ConversationState.html" class="tsd-kind-icon">Conversation<wbr>State</a>
|
2889
2895
|
</li>
|
@@ -2896,6 +2902,12 @@ img {
|
|
2896
2902
|
<li class=" tsd-kind-interface tsd-has-type-parameter">
|
2897
2903
|
<a href="../interfaces/Paginator.html" class="tsd-kind-icon">Paginator</a>
|
2898
2904
|
</li>
|
2905
|
+
<li class=" tsd-kind-interface">
|
2906
|
+
<a href="../interfaces/ParticipantBindings.html" class="tsd-kind-icon">Participant<wbr>Bindings</a>
|
2907
|
+
</li>
|
2908
|
+
<li class=" tsd-kind-interface">
|
2909
|
+
<a href="../interfaces/ParticipantEmailBinding.html" class="tsd-kind-icon">Participant<wbr>Email<wbr>Binding</a>
|
2910
|
+
</li>
|
2899
2911
|
<li class=" tsd-kind-interface">
|
2900
2912
|
<a href="../interfaces/PushNotificationData.html" class="tsd-kind-icon">Push<wbr>Notification<wbr>Data</a>
|
2901
2913
|
</li>
|
@@ -2935,6 +2947,9 @@ img {
|
|
2935
2947
|
<li class=" tsd-kind-type-alias">
|
2936
2948
|
<a href="../modules.html#NotificationsChannelType" class="tsd-kind-icon">Notifications<wbr>Channel<wbr>Type</a>
|
2937
2949
|
</li>
|
2950
|
+
<li class=" tsd-kind-type-alias">
|
2951
|
+
<a href="../modules.html#ParticipantEmailLevel" class="tsd-kind-icon">Participant<wbr>Email<wbr>Level</a>
|
2952
|
+
</li>
|
2938
2953
|
<li class=" tsd-kind-type-alias">
|
2939
2954
|
<a href="../modules.html#ParticipantType" class="tsd-kind-icon">Participant<wbr>Type</a>
|
2940
2955
|
</li>
|
@@ -3053,7 +3068,7 @@ img {
|
|
3053
3068
|
<section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class tsd-is-static">
|
3054
3069
|
<a name="messageAdded" class="tsd-anchor"></a>
|
3055
3070
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> message<wbr>Added</h3>
|
3056
|
-
<div class="tsd-signature tsd-kind-icon">message<wbr>Added<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"messageAdded"</span><span class="tsd-signature-symbol"> =
|
3071
|
+
<div class="tsd-signature tsd-kind-icon">message<wbr>Added<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"messageAdded"</span><span class="tsd-signature-symbol"> = "messageAdded"</span></div>
|
3057
3072
|
<aside class="tsd-sources">
|
3058
3073
|
</aside>
|
3059
3074
|
<div class="tsd-comment tsd-typography">
|
@@ -3069,7 +3084,7 @@ img {
|
|
3069
3084
|
<section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class tsd-is-static">
|
3070
3085
|
<a name="messageRemoved" class="tsd-anchor"></a>
|
3071
3086
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> message<wbr>Removed</h3>
|
3072
|
-
<div class="tsd-signature tsd-kind-icon">message<wbr>Removed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"messageRemoved"</span><span class="tsd-signature-symbol"> =
|
3087
|
+
<div class="tsd-signature tsd-kind-icon">message<wbr>Removed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"messageRemoved"</span><span class="tsd-signature-symbol"> = "messageRemoved"</span></div>
|
3073
3088
|
<aside class="tsd-sources">
|
3074
3089
|
</aside>
|
3075
3090
|
<div class="tsd-comment tsd-typography">
|
@@ -3085,7 +3100,7 @@ img {
|
|
3085
3100
|
<section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class tsd-is-static">
|
3086
3101
|
<a name="messageUpdated" class="tsd-anchor"></a>
|
3087
3102
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> message<wbr>Updated</h3>
|
3088
|
-
<div class="tsd-signature tsd-kind-icon">message<wbr>Updated<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"messageUpdated"</span><span class="tsd-signature-symbol"> =
|
3103
|
+
<div class="tsd-signature tsd-kind-icon">message<wbr>Updated<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"messageUpdated"</span><span class="tsd-signature-symbol"> = "messageUpdated"</span></div>
|
3089
3104
|
<aside class="tsd-sources">
|
3090
3105
|
</aside>
|
3091
3106
|
<div class="tsd-comment tsd-typography">
|
@@ -3105,7 +3120,7 @@ img {
|
|
3105
3120
|
<section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class tsd-is-static">
|
3106
3121
|
<a name="participantJoined" class="tsd-anchor"></a>
|
3107
3122
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> participant<wbr>Joined</h3>
|
3108
|
-
<div class="tsd-signature tsd-kind-icon">participant<wbr>Joined<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"participantJoined"</span><span class="tsd-signature-symbol"> =
|
3123
|
+
<div class="tsd-signature tsd-kind-icon">participant<wbr>Joined<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"participantJoined"</span><span class="tsd-signature-symbol"> = "participantJoined"</span></div>
|
3109
3124
|
<aside class="tsd-sources">
|
3110
3125
|
</aside>
|
3111
3126
|
<div class="tsd-comment tsd-typography">
|
@@ -3121,7 +3136,7 @@ img {
|
|
3121
3136
|
<section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class tsd-is-static">
|
3122
3137
|
<a name="participantLeft" class="tsd-anchor"></a>
|
3123
3138
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> participant<wbr>Left</h3>
|
3124
|
-
<div class="tsd-signature tsd-kind-icon">participant<wbr>Left<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"participantLeft"</span><span class="tsd-signature-symbol"> =
|
3139
|
+
<div class="tsd-signature tsd-kind-icon">participant<wbr>Left<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"participantLeft"</span><span class="tsd-signature-symbol"> = "participantLeft"</span></div>
|
3125
3140
|
<aside class="tsd-sources">
|
3126
3141
|
</aside>
|
3127
3142
|
<div class="tsd-comment tsd-typography">
|
@@ -3137,7 +3152,7 @@ img {
|
|
3137
3152
|
<section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class tsd-is-static">
|
3138
3153
|
<a name="participantUpdated" class="tsd-anchor"></a>
|
3139
3154
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> participant<wbr>Updated</h3>
|
3140
|
-
<div class="tsd-signature tsd-kind-icon">participant<wbr>Updated<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"participantUpdated"</span><span class="tsd-signature-symbol"> =
|
3155
|
+
<div class="tsd-signature tsd-kind-icon">participant<wbr>Updated<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"participantUpdated"</span><span class="tsd-signature-symbol"> = "participantUpdated"</span></div>
|
3141
3156
|
<aside class="tsd-sources">
|
3142
3157
|
</aside>
|
3143
3158
|
<div class="tsd-comment tsd-typography">
|
@@ -3157,7 +3172,7 @@ img {
|
|
3157
3172
|
<section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class tsd-is-static">
|
3158
3173
|
<a name="removed" class="tsd-anchor"></a>
|
3159
3174
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> removed</h3>
|
3160
|
-
<div class="tsd-signature tsd-kind-icon">removed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"removed"</span><span class="tsd-signature-symbol"> =
|
3175
|
+
<div class="tsd-signature tsd-kind-icon">removed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"removed"</span><span class="tsd-signature-symbol"> = "removed"</span></div>
|
3161
3176
|
<aside class="tsd-sources">
|
3162
3177
|
</aside>
|
3163
3178
|
<div class="tsd-comment tsd-typography">
|
@@ -3173,7 +3188,7 @@ img {
|
|
3173
3188
|
<section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class tsd-is-static">
|
3174
3189
|
<a name="typingEnded" class="tsd-anchor"></a>
|
3175
3190
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> typing<wbr>Ended</h3>
|
3176
|
-
<div class="tsd-signature tsd-kind-icon">typing<wbr>Ended<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"typingEnded"</span><span class="tsd-signature-symbol"> =
|
3191
|
+
<div class="tsd-signature tsd-kind-icon">typing<wbr>Ended<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"typingEnded"</span><span class="tsd-signature-symbol"> = "typingEnded"</span></div>
|
3177
3192
|
<aside class="tsd-sources">
|
3178
3193
|
</aside>
|
3179
3194
|
<div class="tsd-comment tsd-typography">
|
@@ -3189,7 +3204,7 @@ img {
|
|
3189
3204
|
<section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class tsd-is-static">
|
3190
3205
|
<a name="typingStarted" class="tsd-anchor"></a>
|
3191
3206
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> typing<wbr>Started</h3>
|
3192
|
-
<div class="tsd-signature tsd-kind-icon">typing<wbr>Started<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"typingStarted"</span><span class="tsd-signature-symbol"> =
|
3207
|
+
<div class="tsd-signature tsd-kind-icon">typing<wbr>Started<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"typingStarted"</span><span class="tsd-signature-symbol"> = "typingStarted"</span></div>
|
3193
3208
|
<aside class="tsd-sources">
|
3194
3209
|
</aside>
|
3195
3210
|
<div class="tsd-comment tsd-typography">
|
@@ -3205,7 +3220,7 @@ img {
|
|
3205
3220
|
<section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class tsd-is-static">
|
3206
3221
|
<a name="updated" class="tsd-anchor"></a>
|
3207
3222
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> updated</h3>
|
3208
|
-
<div class="tsd-signature tsd-kind-icon">updated<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"updated"</span><span class="tsd-signature-symbol"> =
|
3223
|
+
<div class="tsd-signature tsd-kind-icon">updated<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"updated"</span><span class="tsd-signature-symbol"> = "updated"</span></div>
|
3209
3224
|
<aside class="tsd-sources">
|
3210
3225
|
</aside>
|
3211
3226
|
<div class="tsd-comment tsd-typography">
|
@@ -3244,7 +3259,7 @@ img {
|
|
3244
3259
|
<a name="attributes" class="tsd-anchor"></a>
|
3245
3260
|
<h3>attributes</h3>
|
3246
3261
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
|
3247
|
-
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> attributes<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">
|
3262
|
+
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> attributes<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">JSONValue</span></li>
|
3248
3263
|
</ul>
|
3249
3264
|
<ul class="tsd-descriptions">
|
3250
3265
|
<li class="tsd-description">
|
@@ -3255,7 +3270,7 @@ img {
|
|
3255
3270
|
<p>Custom attributes of the conversation.</p>
|
3256
3271
|
</div>
|
3257
3272
|
</div>
|
3258
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">
|
3273
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">JSONValue</span></h4>
|
3259
3274
|
</li>
|
3260
3275
|
</ul>
|
3261
3276
|
</section>
|
@@ -3282,7 +3297,7 @@ img {
|
|
3282
3297
|
<a name="dateCreated" class="tsd-anchor"></a>
|
3283
3298
|
<h3>date<wbr>Created</h3>
|
3284
3299
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
|
3285
|
-
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> dateCreated<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">
|
3300
|
+
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> dateCreated<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span></li>
|
3286
3301
|
</ul>
|
3287
3302
|
<ul class="tsd-descriptions">
|
3288
3303
|
<li class="tsd-description">
|
@@ -3293,7 +3308,7 @@ img {
|
|
3293
3308
|
<p>Date this conversation was created on.</p>
|
3294
3309
|
</div>
|
3295
3310
|
</div>
|
3296
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">
|
3311
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4>
|
3297
3312
|
</li>
|
3298
3313
|
</ul>
|
3299
3314
|
</section>
|
@@ -3301,7 +3316,7 @@ img {
|
|
3301
3316
|
<a name="dateUpdated" class="tsd-anchor"></a>
|
3302
3317
|
<h3>date<wbr>Updated</h3>
|
3303
3318
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
|
3304
|
-
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> dateUpdated<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">
|
3319
|
+
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> dateUpdated<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span></li>
|
3305
3320
|
</ul>
|
3306
3321
|
<ul class="tsd-descriptions">
|
3307
3322
|
<li class="tsd-description">
|
@@ -3312,7 +3327,7 @@ img {
|
|
3312
3327
|
<p>Date this conversation was last updated on.</p>
|
3313
3328
|
</div>
|
3314
3329
|
</div>
|
3315
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">
|
3330
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Date</span></h4>
|
3316
3331
|
</li>
|
3317
3332
|
</ul>
|
3318
3333
|
</section>
|
@@ -3456,7 +3471,7 @@ img {
|
|
3456
3471
|
<a name="add" class="tsd-anchor"></a>
|
3457
3472
|
<h3>add</h3>
|
3458
3473
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
3459
|
-
<li class="tsd-signature tsd-kind-icon">add<span class="tsd-signature-symbol">(</span>identity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, attributes<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">
|
3474
|
+
<li class="tsd-signature tsd-kind-icon">add<span class="tsd-signature-symbol">(</span>identity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, attributes<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">JSONValue</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ParticipantResponse</span><span class="tsd-signature-symbol">></span></li>
|
3460
3475
|
</ul>
|
3461
3476
|
<ul class="tsd-descriptions">
|
3462
3477
|
<li class="tsd-description">
|
@@ -3476,13 +3491,13 @@ img {
|
|
3476
3491
|
</div>
|
3477
3492
|
</li>
|
3478
3493
|
<li>
|
3479
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> attributes: <span class="tsd-signature-type">
|
3494
|
+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> attributes: <span class="tsd-signature-type">JSONValue</span></h5>
|
3480
3495
|
<div class="tsd-comment tsd-typography">
|
3481
3496
|
<p>Attributes to be attached to the participant.</p>
|
3482
3497
|
</div>
|
3483
3498
|
</li>
|
3484
3499
|
</ul>
|
3485
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">
|
3500
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ParticipantResponse</span><span class="tsd-signature-symbol">></span></h4>
|
3486
3501
|
</li>
|
3487
3502
|
</ul>
|
3488
3503
|
</section>
|
@@ -3490,7 +3505,7 @@ img {
|
|
3490
3505
|
<a name="addNonChatParticipant" class="tsd-anchor"></a>
|
3491
3506
|
<h3>add<wbr>Non<wbr>Chat<wbr>Participant</h3>
|
3492
3507
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
3493
|
-
<li class="tsd-signature tsd-kind-icon">add<wbr>Non<wbr>Chat<wbr>Participant<span class="tsd-signature-symbol">(</span>proxyAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, attributes<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">
|
3508
|
+
<li class="tsd-signature tsd-kind-icon">add<wbr>Non<wbr>Chat<wbr>Participant<span class="tsd-signature-symbol">(</span>proxyAddress<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, address<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, attributes<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">JSONValue</span>, bindingOptions<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">ParticipantBindingOptions</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ParticipantResponse</span><span class="tsd-signature-symbol">></span></li>
|
3494
3509
|
</ul>
|
3495
3510
|
<ul class="tsd-descriptions">
|
3496
3511
|
<li class="tsd-description">
|
@@ -3516,13 +3531,19 @@ img {
|
|
3516
3531
|
</div>
|
3517
3532
|
</li>
|
3518
3533
|
<li>
|
3519
|
-
<h5
|
3534
|
+
<h5>attributes: <span class="tsd-signature-type">JSONValue</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
3520
3535
|
<div class="tsd-comment tsd-typography">
|
3521
3536
|
<p>Attributes to be attached to the participant.</p>
|
3522
3537
|
</div>
|
3523
3538
|
</li>
|
3539
|
+
<li>
|
3540
|
+
<h5>bindingOptions: <span class="tsd-signature-type">ParticipantBindingOptions</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
3541
|
+
<div class="tsd-comment tsd-typography">
|
3542
|
+
<p>Options for adding email participants - name and CC/To level.</p>
|
3543
|
+
</div>
|
3544
|
+
</li>
|
3524
3545
|
</ul>
|
3525
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">
|
3546
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">ParticipantResponse</span><span class="tsd-signature-symbol">></span></h4>
|
3526
3547
|
</li>
|
3527
3548
|
</ul>
|
3528
3549
|
</section>
|
@@ -3580,7 +3601,7 @@ img {
|
|
3580
3601
|
<a name="getAttributes" class="tsd-anchor"></a>
|
3581
3602
|
<h3>get<wbr>Attributes</h3>
|
3582
3603
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
3583
|
-
<li class="tsd-signature tsd-kind-icon">get<wbr>Attributes<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">
|
3604
|
+
<li class="tsd-signature tsd-kind-icon">get<wbr>Attributes<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">JSONValue</span><span class="tsd-signature-symbol">></span></li>
|
3584
3605
|
</ul>
|
3585
3606
|
<ul class="tsd-descriptions">
|
3586
3607
|
<li class="tsd-description">
|
@@ -3591,7 +3612,7 @@ img {
|
|
3591
3612
|
<p>Get the custom attributes of this Conversation.</p>
|
3592
3613
|
</div>
|
3593
3614
|
</div>
|
3594
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">
|
3615
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">JSONValue</span><span class="tsd-signature-symbol">></span></h4>
|
3595
3616
|
</li>
|
3596
3617
|
</ul>
|
3597
3618
|
</section>
|
@@ -3665,7 +3686,7 @@ img {
|
|
3665
3686
|
<a name="getParticipantByIdentity" class="tsd-anchor"></a>
|
3666
3687
|
<h3>get<wbr>Participant<wbr>ByIdentity</h3>
|
3667
3688
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
3668
|
-
<li class="tsd-signature tsd-kind-icon">get<wbr>Participant<wbr>ByIdentity<span class="tsd-signature-symbol">(</span>identity<span class="tsd-signature-symbol"
|
3689
|
+
<li class="tsd-signature tsd-kind-icon">get<wbr>Participant<wbr>ByIdentity<span class="tsd-signature-symbol">(</span>identity<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="Participant.html" class="tsd-signature-type" data-tsd-kind="Class">Participant</a><span class="tsd-signature-symbol">></span></li>
|
3669
3690
|
</ul>
|
3670
3691
|
<ul class="tsd-descriptions">
|
3671
3692
|
<li class="tsd-description">
|
@@ -3679,7 +3700,7 @@ img {
|
|
3679
3700
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
3680
3701
|
<ul class="tsd-parameters">
|
3681
3702
|
<li>
|
3682
|
-
<h5>identity: <span class="tsd-signature-type">string</span></h5>
|
3703
|
+
<h5>identity: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ""</span></h5>
|
3683
3704
|
<div class="tsd-comment tsd-typography">
|
3684
3705
|
<p>Participant identity.</p>
|
3685
3706
|
</div>
|
@@ -3843,6 +3864,7 @@ img {
|
|
3843
3864
|
</div>
|
3844
3865
|
</div>
|
3845
3866
|
<h4 class="tsd-returns-title">Returns <a href="MessageBuilder.html" class="tsd-signature-type" data-tsd-kind="Class">MessageBuilder</a></h4>
|
3867
|
+
<p>A MessageBuilder to help set all message sending options.</p>
|
3846
3868
|
</li>
|
3847
3869
|
</ul>
|
3848
3870
|
</section>
|
@@ -3879,7 +3901,7 @@ img {
|
|
3879
3901
|
<a name="sendMessage" class="tsd-anchor"></a>
|
3880
3902
|
<h3>send<wbr>Message</h3>
|
3881
3903
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
3882
|
-
<li class="tsd-signature tsd-kind-icon">send<wbr>Message<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">FormData</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/SendMediaOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SendMediaOptions</a>, messageAttributes<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">
|
3904
|
+
<li class="tsd-signature tsd-kind-icon">send<wbr>Message<span class="tsd-signature-symbol">(</span>message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">FormData</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/SendMediaOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SendMediaOptions</a>, messageAttributes<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">JSONValue</span>, emailOptions<span class="tsd-signature-symbol">?: </span><a href="../interfaces/SendEmailOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">SendEmailOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></li>
|
3883
3905
|
</ul>
|
3884
3906
|
<ul class="tsd-descriptions">
|
3885
3907
|
<li class="tsd-description">
|
@@ -3900,7 +3922,7 @@ img {
|
|
3900
3922
|
</div>
|
3901
3923
|
</li>
|
3902
3924
|
<li>
|
3903
|
-
<h5><span class="tsd-flag ts-flagOptional">Optional</span> messageAttributes: <span class="tsd-signature-type">
|
3925
|
+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> messageAttributes: <span class="tsd-signature-type">JSONValue</span></h5>
|
3904
3926
|
<div class="tsd-comment tsd-typography">
|
3905
3927
|
<p>Attributes for the message.</p>
|
3906
3928
|
</div>
|
@@ -4009,7 +4031,7 @@ img {
|
|
4009
4031
|
<a name="updateAttributes" class="tsd-anchor"></a>
|
4010
4032
|
<h3>update<wbr>Attributes</h3>
|
4011
4033
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
4012
|
-
<li class="tsd-signature tsd-kind-icon">update<wbr>Attributes<span class="tsd-signature-symbol">(</span>attributes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">
|
4034
|
+
<li class="tsd-signature tsd-kind-icon">update<wbr>Attributes<span class="tsd-signature-symbol">(</span>attributes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">JSONValue</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>
|
4013
4035
|
</ul>
|
4014
4036
|
<ul class="tsd-descriptions">
|
4015
4037
|
<li class="tsd-description">
|
@@ -4023,7 +4045,7 @@ img {
|
|
4023
4045
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
4024
4046
|
<ul class="tsd-parameters">
|
4025
4047
|
<li>
|
4026
|
-
<h5>attributes: <span class="tsd-signature-type">
|
4048
|
+
<h5>attributes: <span class="tsd-signature-type">JSONValue</span></h5>
|
4027
4049
|
<div class="tsd-comment tsd-typography">
|
4028
4050
|
<p>New attributes.</p>
|
4029
4051
|
</div>
|
@@ -2770,6 +2770,12 @@ img {
|
|
2770
2770
|
<li class=" tsd-kind-interface">
|
2771
2771
|
<a href="../interfaces/ClientOptions.html" class="tsd-kind-icon">Client<wbr>Options</a>
|
2772
2772
|
</li>
|
2773
|
+
<li class=" tsd-kind-interface">
|
2774
|
+
<a href="../interfaces/ConversationBindings.html" class="tsd-kind-icon">Conversation<wbr>Bindings</a>
|
2775
|
+
</li>
|
2776
|
+
<li class=" tsd-kind-interface">
|
2777
|
+
<a href="../interfaces/ConversationEmailBinding.html" class="tsd-kind-icon">Conversation<wbr>Email<wbr>Binding</a>
|
2778
|
+
</li>
|
2773
2779
|
<li class=" tsd-kind-interface">
|
2774
2780
|
<a href="../interfaces/ConversationState.html" class="tsd-kind-icon">Conversation<wbr>State</a>
|
2775
2781
|
</li>
|
@@ -2782,6 +2788,12 @@ img {
|
|
2782
2788
|
<li class=" tsd-kind-interface tsd-has-type-parameter">
|
2783
2789
|
<a href="../interfaces/Paginator.html" class="tsd-kind-icon">Paginator</a>
|
2784
2790
|
</li>
|
2791
|
+
<li class=" tsd-kind-interface">
|
2792
|
+
<a href="../interfaces/ParticipantBindings.html" class="tsd-kind-icon">Participant<wbr>Bindings</a>
|
2793
|
+
</li>
|
2794
|
+
<li class=" tsd-kind-interface">
|
2795
|
+
<a href="../interfaces/ParticipantEmailBinding.html" class="tsd-kind-icon">Participant<wbr>Email<wbr>Binding</a>
|
2796
|
+
</li>
|
2785
2797
|
<li class=" tsd-kind-interface">
|
2786
2798
|
<a href="../interfaces/PushNotificationData.html" class="tsd-kind-icon">Push<wbr>Notification<wbr>Data</a>
|
2787
2799
|
</li>
|
@@ -2821,6 +2833,9 @@ img {
|
|
2821
2833
|
<li class=" tsd-kind-type-alias">
|
2822
2834
|
<a href="../modules.html#NotificationsChannelType" class="tsd-kind-icon">Notifications<wbr>Channel<wbr>Type</a>
|
2823
2835
|
</li>
|
2836
|
+
<li class=" tsd-kind-type-alias">
|
2837
|
+
<a href="../modules.html#ParticipantEmailLevel" class="tsd-kind-icon">Participant<wbr>Email<wbr>Level</a>
|
2838
|
+
</li>
|
2824
2839
|
<li class=" tsd-kind-type-alias">
|
2825
2840
|
<a href="../modules.html#ParticipantType" class="tsd-kind-icon">Participant<wbr>Type</a>
|
2826
2841
|
</li>
|
@@ -2929,7 +2944,7 @@ img {
|
|
2929
2944
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
2930
2945
|
<a name="errorCode" class="tsd-anchor"></a>
|
2931
2946
|
<h3>error<wbr>Code</h3>
|
2932
|
-
<div class="tsd-signature tsd-kind-icon">error<wbr>Code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">
|
2947
|
+
<div class="tsd-signature tsd-kind-icon">error<wbr>Code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">0</span></div>
|
2933
2948
|
<aside class="tsd-sources">
|
2934
2949
|
</aside>
|
2935
2950
|
<div class="tsd-comment tsd-typography">
|
package/docs/classes/Media.html
CHANGED
@@ -2764,6 +2764,12 @@ img {
|
|
2764
2764
|
<li class=" tsd-kind-interface">
|
2765
2765
|
<a href="../interfaces/ClientOptions.html" class="tsd-kind-icon">Client<wbr>Options</a>
|
2766
2766
|
</li>
|
2767
|
+
<li class=" tsd-kind-interface">
|
2768
|
+
<a href="../interfaces/ConversationBindings.html" class="tsd-kind-icon">Conversation<wbr>Bindings</a>
|
2769
|
+
</li>
|
2770
|
+
<li class=" tsd-kind-interface">
|
2771
|
+
<a href="../interfaces/ConversationEmailBinding.html" class="tsd-kind-icon">Conversation<wbr>Email<wbr>Binding</a>
|
2772
|
+
</li>
|
2767
2773
|
<li class=" tsd-kind-interface">
|
2768
2774
|
<a href="../interfaces/ConversationState.html" class="tsd-kind-icon">Conversation<wbr>State</a>
|
2769
2775
|
</li>
|
@@ -2776,6 +2782,12 @@ img {
|
|
2776
2782
|
<li class=" tsd-kind-interface tsd-has-type-parameter">
|
2777
2783
|
<a href="../interfaces/Paginator.html" class="tsd-kind-icon">Paginator</a>
|
2778
2784
|
</li>
|
2785
|
+
<li class=" tsd-kind-interface">
|
2786
|
+
<a href="../interfaces/ParticipantBindings.html" class="tsd-kind-icon">Participant<wbr>Bindings</a>
|
2787
|
+
</li>
|
2788
|
+
<li class=" tsd-kind-interface">
|
2789
|
+
<a href="../interfaces/ParticipantEmailBinding.html" class="tsd-kind-icon">Participant<wbr>Email<wbr>Binding</a>
|
2790
|
+
</li>
|
2779
2791
|
<li class=" tsd-kind-interface">
|
2780
2792
|
<a href="../interfaces/PushNotificationData.html" class="tsd-kind-icon">Push<wbr>Notification<wbr>Data</a>
|
2781
2793
|
</li>
|
@@ -2815,6 +2827,9 @@ img {
|
|
2815
2827
|
<li class=" tsd-kind-type-alias">
|
2816
2828
|
<a href="../modules.html#NotificationsChannelType" class="tsd-kind-icon">Notifications<wbr>Channel<wbr>Type</a>
|
2817
2829
|
</li>
|
2830
|
+
<li class=" tsd-kind-type-alias">
|
2831
|
+
<a href="../modules.html#ParticipantEmailLevel" class="tsd-kind-icon">Participant<wbr>Email<wbr>Level</a>
|
2832
|
+
</li>
|
2818
2833
|
<li class=" tsd-kind-type-alias">
|
2819
2834
|
<a href="../modules.html#ParticipantType" class="tsd-kind-icon">Participant<wbr>Type</a>
|
2820
2835
|
</li>
|
@@ -2774,6 +2774,12 @@ img {
|
|
2774
2774
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
2775
2775
|
<a href="Message.html#getDetailedDeliveryReceipts" class="tsd-kind-icon">get<wbr>Detailed<wbr>Delivery<wbr>Receipts</a>
|
2776
2776
|
</li>
|
2777
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
2778
|
+
<a href="Message.html#getEmailBody" class="tsd-kind-icon">get<wbr>Email<wbr>Body</a>
|
2779
|
+
</li>
|
2780
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
2781
|
+
<a href="Message.html#getEmailHistory" class="tsd-kind-icon">get<wbr>Email<wbr>History</a>
|
2782
|
+
</li>
|
2777
2783
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
2778
2784
|
<a href="Message.html#getMediaByCategory" class="tsd-kind-icon">get<wbr>Media<wbr>ByCategory</a>
|
2779
2785
|
</li>
|
@@ -2812,6 +2818,12 @@ img {
|
|
2812
2818
|
<li class=" tsd-kind-interface">
|
2813
2819
|
<a href="../interfaces/ClientOptions.html" class="tsd-kind-icon">Client<wbr>Options</a>
|
2814
2820
|
</li>
|
2821
|
+
<li class=" tsd-kind-interface">
|
2822
|
+
<a href="../interfaces/ConversationBindings.html" class="tsd-kind-icon">Conversation<wbr>Bindings</a>
|
2823
|
+
</li>
|
2824
|
+
<li class=" tsd-kind-interface">
|
2825
|
+
<a href="../interfaces/ConversationEmailBinding.html" class="tsd-kind-icon">Conversation<wbr>Email<wbr>Binding</a>
|
2826
|
+
</li>
|
2815
2827
|
<li class=" tsd-kind-interface">
|
2816
2828
|
<a href="../interfaces/ConversationState.html" class="tsd-kind-icon">Conversation<wbr>State</a>
|
2817
2829
|
</li>
|
@@ -2824,6 +2836,12 @@ img {
|
|
2824
2836
|
<li class=" tsd-kind-interface tsd-has-type-parameter">
|
2825
2837
|
<a href="../interfaces/Paginator.html" class="tsd-kind-icon">Paginator</a>
|
2826
2838
|
</li>
|
2839
|
+
<li class=" tsd-kind-interface">
|
2840
|
+
<a href="../interfaces/ParticipantBindings.html" class="tsd-kind-icon">Participant<wbr>Bindings</a>
|
2841
|
+
</li>
|
2842
|
+
<li class=" tsd-kind-interface">
|
2843
|
+
<a href="../interfaces/ParticipantEmailBinding.html" class="tsd-kind-icon">Participant<wbr>Email<wbr>Binding</a>
|
2844
|
+
</li>
|
2827
2845
|
<li class=" tsd-kind-interface">
|
2828
2846
|
<a href="../interfaces/PushNotificationData.html" class="tsd-kind-icon">Push<wbr>Notification<wbr>Data</a>
|
2829
2847
|
</li>
|
@@ -2863,6 +2881,9 @@ img {
|
|
2863
2881
|
<li class=" tsd-kind-type-alias">
|
2864
2882
|
<a href="../modules.html#NotificationsChannelType" class="tsd-kind-icon">Notifications<wbr>Channel<wbr>Type</a>
|
2865
2883
|
</li>
|
2884
|
+
<li class=" tsd-kind-type-alias">
|
2885
|
+
<a href="../modules.html#ParticipantEmailLevel" class="tsd-kind-icon">Participant<wbr>Email<wbr>Level</a>
|
2886
|
+
</li>
|
2866
2887
|
<li class=" tsd-kind-type-alias">
|
2867
2888
|
<a href="../modules.html#ParticipantType" class="tsd-kind-icon">Participant<wbr>Type</a>
|
2868
2889
|
</li>
|
@@ -2937,6 +2958,8 @@ img {
|
|
2937
2958
|
<ul class="tsd-index-list">
|
2938
2959
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#attachTemporaryUrlsFor" class="tsd-kind-icon">attach<wbr>Temporary<wbr>Urls<wbr>For</a></li>
|
2939
2960
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#getDetailedDeliveryReceipts" class="tsd-kind-icon">get<wbr>Detailed<wbr>Delivery<wbr>Receipts</a></li>
|
2961
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#getEmailBody" class="tsd-kind-icon">get<wbr>Email<wbr>Body</a></li>
|
2962
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#getEmailHistory" class="tsd-kind-icon">get<wbr>Email<wbr>History</a></li>
|
2940
2963
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#getMediaByCategory" class="tsd-kind-icon">get<wbr>Media<wbr>ByCategory</a></li>
|
2941
2964
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#getParticipant" class="tsd-kind-icon">get<wbr>Participant</a></li>
|
2942
2965
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Message.html#remove" class="tsd-kind-icon">remove</a></li>
|
@@ -2964,7 +2987,7 @@ img {
|
|
2964
2987
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
|
2965
2988
|
<a name="updated" class="tsd-anchor"></a>
|
2966
2989
|
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> updated</h3>
|
2967
|
-
<div class="tsd-signature tsd-kind-icon">updated<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"updated"</span><span class="tsd-signature-symbol"> =
|
2990
|
+
<div class="tsd-signature tsd-kind-icon">updated<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"updated"</span><span class="tsd-signature-symbol"> = "updated"</span></div>
|
2968
2991
|
<aside class="tsd-sources">
|
2969
2992
|
</aside>
|
2970
2993
|
<div class="tsd-comment tsd-typography">
|
@@ -3026,7 +3049,7 @@ img {
|
|
3026
3049
|
<a name="attributes" class="tsd-anchor"></a>
|
3027
3050
|
<h3>attributes</h3>
|
3028
3051
|
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class">
|
3029
|
-
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> attributes<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">
|
3052
|
+
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> attributes<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">JSONValue</span></li>
|
3030
3053
|
</ul>
|
3031
3054
|
<ul class="tsd-descriptions">
|
3032
3055
|
<li class="tsd-description">
|
@@ -3037,7 +3060,7 @@ img {
|
|
3037
3060
|
<p>Custom attributes of the message.</p>
|
3038
3061
|
</div>
|
3039
3062
|
</div>
|
3040
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">
|
3063
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">JSONValue</span></h4>
|
3041
3064
|
</li>
|
3042
3065
|
</ul>
|
3043
3066
|
</section>
|
@@ -3173,7 +3196,7 @@ img {
|
|
3173
3196
|
</aside>
|
3174
3197
|
<div class="tsd-comment tsd-typography">
|
3175
3198
|
<div class="lead">
|
3176
|
-
<p>One of the attached media.</p>
|
3199
|
+
<p>One of the attached media (if present).</p>
|
3177
3200
|
</div>
|
3178
3201
|
<dl class="tsd-comment-tags">
|
3179
3202
|
<dt>deprecated</dt>
|
@@ -3254,7 +3277,7 @@ img {
|
|
3254
3277
|
</aside>
|
3255
3278
|
<div class="tsd-comment tsd-typography">
|
3256
3279
|
<div class="lead">
|
3257
|
-
<p>
|
3280
|
+
<p>Type of the message.</p>
|
3258
3281
|
</div>
|
3259
3282
|
</div>
|
3260
3283
|
<h4 class="tsd-returns-title">Returns <a href="../modules.html#MessageType" class="tsd-signature-type" data-tsd-kind="Type alias">MessageType</a></h4>
|
@@ -3311,6 +3334,64 @@ img {
|
|
3311
3334
|
</li>
|
3312
3335
|
</ul>
|
3313
3336
|
</section>
|
3337
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
3338
|
+
<a name="getEmailBody" class="tsd-anchor"></a>
|
3339
|
+
<h3>get<wbr>Email<wbr>Body</h3>
|
3340
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
3341
|
+
<li class="tsd-signature tsd-kind-icon">get<wbr>Email<wbr>Body<span class="tsd-signature-symbol">(</span>type<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><a href="Media.html" class="tsd-signature-type" data-tsd-kind="Class">Media</a></li>
|
3342
|
+
</ul>
|
3343
|
+
<ul class="tsd-descriptions">
|
3344
|
+
<li class="tsd-description">
|
3345
|
+
<aside class="tsd-sources">
|
3346
|
+
</aside>
|
3347
|
+
<div class="tsd-comment tsd-typography">
|
3348
|
+
<div class="lead">
|
3349
|
+
<p>Get a media descriptor for an email body attachment of a provided type.
|
3350
|
+
Allowed body types are returned in the Conversation.limits().emailBodiesAllowedMimeTypes array.</p>
|
3351
|
+
</div>
|
3352
|
+
</div>
|
3353
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
3354
|
+
<ul class="tsd-parameters">
|
3355
|
+
<li>
|
3356
|
+
<h5>type: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "text/plain"</span></h5>
|
3357
|
+
<div class="tsd-comment tsd-typography">
|
3358
|
+
<p>Type of email body to request, defaults to <code>text/plain</code>.</p>
|
3359
|
+
</div>
|
3360
|
+
</li>
|
3361
|
+
</ul>
|
3362
|
+
<h4 class="tsd-returns-title">Returns <a href="Media.html" class="tsd-signature-type" data-tsd-kind="Class">Media</a></h4>
|
3363
|
+
</li>
|
3364
|
+
</ul>
|
3365
|
+
</section>
|
3366
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
3367
|
+
<a name="getEmailHistory" class="tsd-anchor"></a>
|
3368
|
+
<h3>get<wbr>Email<wbr>History</h3>
|
3369
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
3370
|
+
<li class="tsd-signature tsd-kind-icon">get<wbr>Email<wbr>History<span class="tsd-signature-symbol">(</span>type<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><a href="Media.html" class="tsd-signature-type" data-tsd-kind="Class">Media</a></li>
|
3371
|
+
</ul>
|
3372
|
+
<ul class="tsd-descriptions">
|
3373
|
+
<li class="tsd-description">
|
3374
|
+
<aside class="tsd-sources">
|
3375
|
+
</aside>
|
3376
|
+
<div class="tsd-comment tsd-typography">
|
3377
|
+
<div class="lead">
|
3378
|
+
<p>Get a media descriptor for an email history attachment of a provided type.
|
3379
|
+
Allowed body types are returned in the Conversation.limits().emailHistoriesAllowedMimeTypes array.</p>
|
3380
|
+
</div>
|
3381
|
+
</div>
|
3382
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
3383
|
+
<ul class="tsd-parameters">
|
3384
|
+
<li>
|
3385
|
+
<h5>type: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "text/plain"</span></h5>
|
3386
|
+
<div class="tsd-comment tsd-typography">
|
3387
|
+
<p>Type of email history to request, defaults to <code>text/plain</code>.</p>
|
3388
|
+
</div>
|
3389
|
+
</li>
|
3390
|
+
</ul>
|
3391
|
+
<h4 class="tsd-returns-title">Returns <a href="Media.html" class="tsd-signature-type" data-tsd-kind="Class">Media</a></h4>
|
3392
|
+
</li>
|
3393
|
+
</ul>
|
3394
|
+
</section>
|
3314
3395
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
3315
3396
|
<a name="getMediaByCategory" class="tsd-anchor"></a>
|
3316
3397
|
<h3>get<wbr>Media<wbr>ByCategory</h3>
|
@@ -3383,7 +3464,7 @@ img {
|
|
3383
3464
|
<a name="updateAttributes" class="tsd-anchor"></a>
|
3384
3465
|
<h3>update<wbr>Attributes</h3>
|
3385
3466
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
3386
|
-
<li class="tsd-signature tsd-kind-icon">update<wbr>Attributes<span class="tsd-signature-symbol">(</span>attributes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">
|
3467
|
+
<li class="tsd-signature tsd-kind-icon">update<wbr>Attributes<span class="tsd-signature-symbol">(</span>attributes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">JSONValue</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="Message.html" class="tsd-signature-type" data-tsd-kind="Class">Message</a><span class="tsd-signature-symbol">></span></li>
|
3387
3468
|
</ul>
|
3388
3469
|
<ul class="tsd-descriptions">
|
3389
3470
|
<li class="tsd-description">
|
@@ -3397,7 +3478,7 @@ img {
|
|
3397
3478
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
3398
3479
|
<ul class="tsd-parameters">
|
3399
3480
|
<li>
|
3400
|
-
<h5>attributes: <span class="tsd-signature-type">
|
3481
|
+
<h5>attributes: <span class="tsd-signature-type">JSONValue</span></h5>
|
3401
3482
|
<div class="tsd-comment tsd-typography">
|
3402
3483
|
<p>New attributes.</p>
|
3403
3484
|
</div>
|