@twilio/conversations 2.1.0 → 2.2.0-rc.9

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.
Files changed (70) hide show
  1. package/CHANGELOG.md +190 -0
  2. package/README.md +8 -4
  3. package/builds/browser.js +2911 -1974
  4. package/builds/browser.js.map +1 -1
  5. package/builds/lib.d.ts +572 -285
  6. package/builds/lib.js +2911 -1974
  7. package/builds/lib.js.map +1 -1
  8. package/builds/twilio-conversations.js +27136 -11798
  9. package/builds/twilio-conversations.min.js +1 -16
  10. package/dist/aggregated-delivery-receipt.js.map +1 -1
  11. package/dist/client.js +466 -281
  12. package/dist/client.js.map +1 -1
  13. package/dist/command-executor.js.map +1 -1
  14. package/dist/configuration.js +2 -2
  15. package/dist/configuration.js.map +1 -1
  16. package/dist/conversation.js +426 -370
  17. package/dist/conversation.js.map +1 -1
  18. package/dist/data/conversations.js +25 -13
  19. package/dist/data/conversations.js.map +1 -1
  20. package/dist/data/messages.js +56 -32
  21. package/dist/data/messages.js.map +1 -1
  22. package/dist/data/participants.js +21 -12
  23. package/dist/data/participants.js.map +1 -1
  24. package/dist/data/users.js +2 -2
  25. package/dist/data/users.js.map +1 -1
  26. package/dist/detailed-delivery-receipt.js.map +1 -1
  27. package/dist/index.js +6 -4
  28. package/dist/index.js.map +1 -1
  29. package/dist/interfaces/attributes.js.map +1 -1
  30. package/dist/interfaces/notification-types.js.map +1 -1
  31. package/dist/logger.js +2 -4
  32. package/dist/logger.js.map +1 -1
  33. package/dist/media.js +36 -25
  34. package/dist/media.js.map +1 -1
  35. package/dist/message-builder.js +24 -18
  36. package/dist/message-builder.js.map +1 -1
  37. package/dist/message.js +89 -17
  38. package/dist/message.js.map +1 -1
  39. package/dist/node_modules/tslib/tslib.es6.js +1 -1
  40. package/dist/node_modules/tslib/tslib.es6.js.map +1 -1
  41. package/dist/packages/conversations/package.json.js +1 -1
  42. package/dist/participant.js +2 -2
  43. package/dist/participant.js.map +1 -1
  44. package/dist/push-notification.js.map +1 -1
  45. package/dist/rest-paginator.js.map +1 -1
  46. package/dist/services/network.js.map +1 -1
  47. package/dist/services/typing-indicator.js +1 -1
  48. package/dist/services/typing-indicator.js.map +1 -1
  49. package/dist/unsent-message.js +13 -3
  50. package/dist/unsent-message.js.map +1 -1
  51. package/dist/user.js +2 -2
  52. package/dist/user.js.map +1 -1
  53. package/dist/util/deferred.js.map +1 -1
  54. package/dist/util/index.js.map +1 -1
  55. package/docs/assets/js/search.js +1 -1
  56. package/docs/classes/CancellablePromise.html +3213 -0
  57. package/docs/classes/Client.html +243 -58
  58. package/docs/classes/Conversation.html +76 -47
  59. package/docs/classes/Media.html +2 -28
  60. package/docs/classes/Message.html +94 -39
  61. package/docs/classes/MessageBuilder.html +31 -8
  62. package/docs/classes/PushNotification.html +1 -1
  63. package/docs/classes/UnsentMessage.html +2 -2
  64. package/docs/index.html +25 -28
  65. package/docs/interfaces/ConversationLimits.html +12 -12
  66. package/docs/interfaces/ConversationState.html +2 -2
  67. package/docs/interfaces/ConversationUpdatedEventArgs.html +3001 -0
  68. package/docs/interfaces/PushNotificationData.html +48 -0
  69. package/docs/modules.html +24 -27
  70. package/package.json +24 -20
@@ -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>
@@ -2777,6 +2780,9 @@ img {
2777
2780
  <li class=" tsd-kind-property tsd-parent-kind-class">
2778
2781
  <a href="Client.html#connectionState" class="tsd-kind-icon">connection<wbr>State</a>
2779
2782
  </li>
2783
+ <li class=" tsd-kind-property tsd-parent-kind-class">
2784
+ <a href="Client.html#parsePushNotification" class="tsd-kind-icon">parse<wbr>Push<wbr>Notification</a>
2785
+ </li>
2780
2786
  <li class=" tsd-kind-property tsd-parent-kind-class">
2781
2787
  <a href="Client.html#version" class="tsd-kind-icon">version</a>
2782
2788
  </li>
@@ -2804,6 +2810,12 @@ img {
2804
2810
  <li class=" tsd-kind-method tsd-parent-kind-class">
2805
2811
  <a href="Client.html#getSubscribedUsers" class="tsd-kind-icon">get<wbr>Subscribed<wbr>Users</a>
2806
2812
  </li>
2813
+ <li class=" tsd-kind-method tsd-parent-kind-class">
2814
+ <a href="Client.html#getTemporaryContentUrlsForMedia" class="tsd-kind-icon">get<wbr>Temporary<wbr>Content<wbr>Urls<wbr>For<wbr>Media</a>
2815
+ </li>
2816
+ <li class=" tsd-kind-method tsd-parent-kind-class">
2817
+ <a href="Client.html#getTemporaryContentUrlsForMediaSids" class="tsd-kind-icon">get<wbr>Temporary<wbr>Content<wbr>Urls<wbr>For<wbr>Media<wbr>Sids</a>
2818
+ </li>
2807
2819
  <li class=" tsd-kind-method tsd-parent-kind-class">
2808
2820
  <a href="Client.html#getUser" class="tsd-kind-icon">get<wbr>User</a>
2809
2821
  </li>
@@ -2826,7 +2838,10 @@ img {
2826
2838
  <a href="Client.html#updateToken" class="tsd-kind-icon">update<wbr>Token</a>
2827
2839
  </li>
2828
2840
  <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
2829
- <a href="Client.html#parsePushNotification" class="tsd-kind-icon">parse<wbr>Push<wbr>Notification</a>
2841
+ <a href="Client.html#parsePushNotification-1" class="tsd-kind-icon">parse<wbr>Push<wbr>Notification</a>
2842
+ </li>
2843
+ <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
2844
+ <a href="Client.html#populateInitRegistrations" class="tsd-kind-icon">populate<wbr>Init<wbr>Registrations</a>
2830
2845
  </li>
2831
2846
  </ul>
2832
2847
  </li>
@@ -2874,6 +2889,8 @@ img {
2874
2889
  <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>
2875
2890
  <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>
2876
2891
  <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>
2892
+ <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>
2893
+ <li class="tsd-kind-event tsd-parent-kind-class tsd-is-static"><a href="Client.html#initialized" class="tsd-kind-icon">initialized</a></li>
2877
2894
  <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>
2878
2895
  <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>
2879
2896
  <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>
@@ -2881,7 +2898,6 @@ img {
2881
2898
  <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>
2882
2899
  <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>
2883
2900
  <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>
2884
- <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>
2885
2901
  <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>
2886
2902
  <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>
2887
2903
  <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>
@@ -2895,6 +2911,7 @@ img {
2895
2911
  <h3>Properties</h3>
2896
2912
  <ul class="tsd-index-list">
2897
2913
  <li class="tsd-kind-property tsd-parent-kind-class"><a href="Client.html#connectionState" class="tsd-kind-icon">connection<wbr>State</a></li>
2914
+ <li class="tsd-kind-property tsd-parent-kind-class"><a href="Client.html#parsePushNotification" class="tsd-kind-icon">parse<wbr>Push<wbr>Notification</a></li>
2898
2915
  <li class="tsd-kind-property tsd-parent-kind-class"><a href="Client.html#version" class="tsd-kind-icon">version</a></li>
2899
2916
  <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="Client.html#version-1" class="tsd-kind-icon">version</a></li>
2900
2917
  </ul>
@@ -2914,6 +2931,8 @@ img {
2914
2931
  <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>
2915
2932
  <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>
2916
2933
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="Client.html#getSubscribedUsers" class="tsd-kind-icon">get<wbr>Subscribed<wbr>Users</a></li>
2934
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="Client.html#getTemporaryContentUrlsForMedia" class="tsd-kind-icon">get<wbr>Temporary<wbr>Content<wbr>Urls<wbr>For<wbr>Media</a></li>
2935
+ <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>
2917
2936
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="Client.html#getUser" class="tsd-kind-icon">get<wbr>User</a></li>
2918
2937
  <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>
2919
2938
  <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>
@@ -2921,7 +2940,8 @@ img {
2921
2940
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="Client.html#shutdown" class="tsd-kind-icon">shutdown</a></li>
2922
2941
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="Client.html#unsetPushRegistrationId" class="tsd-kind-icon">unset<wbr>Push<wbr>Registration<wbr>Id</a></li>
2923
2942
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="Client.html#updateToken" class="tsd-kind-icon">update<wbr>Token</a></li>
2924
- <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Client.html#parsePushNotification" class="tsd-kind-icon">parse<wbr>Push<wbr>Notification</a></li>
2943
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Client.html#parsePushNotification-1" class="tsd-kind-icon">parse<wbr>Push<wbr>Notification</a></li>
2944
+ <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="Client.html#populateInitRegistrations" class="tsd-kind-icon">populate<wbr>Init<wbr>Registrations</a></li>
2925
2945
  </ul>
2926
2946
  </section>
2927
2947
  </div>
@@ -2942,9 +2962,11 @@ img {
2942
2962
  </aside>
2943
2963
  <div class="tsd-comment tsd-typography">
2944
2964
  <div class="lead">
2945
- <p>Returned Conversations instance is not yet fully initialized. Calling any operations will block until it is.
2946
- Use connection events to monitor when client becomes fully available (connectionStateChanged with state
2947
- &#39;connected&#39;) or not available (connectionStateChange with state &#39;denied&#39;, event tokenExpired, event connectionError).</p>
2965
+ <p>Returned Conversations instance is not yet fully initialized. Calling any
2966
+ operations will block until it is. Use connection events to monitor when
2967
+ client becomes fully available (connectionStateChanged with state
2968
+ &#39;connected&#39;) or not available (connectionStateChange with state &#39;denied&#39;,
2969
+ event tokenExpired, event connectionError).</p>
2948
2970
  </div>
2949
2971
  </div>
2950
2972
  <h4 class="tsd-parameters-title">Parameters</h4>
@@ -2986,7 +3008,8 @@ img {
2986
3008
  </div>
2987
3009
  <p>Parameters:</p>
2988
3010
  <ol>
2989
- <li>object <code>data</code> - info object provided with the event. It has the following properties:<ul>
3011
+ <li>object <code>data</code> - info object provided with the event. It has the
3012
+ following properties:<ul>
2990
3013
  <li>boolean <code>terminal</code> - Twilsock will stop connection attempts if true</li>
2991
3014
  <li>string <code>message</code> - the error message of the root cause</li>
2992
3015
  <li>number? <code>httpStatusCode</code> - http status code if available</li>
@@ -3006,7 +3029,7 @@ img {
3006
3029
  <div class="lead">
3007
3030
  <p>Fired when the connection state of the client has been changed.</p>
3008
3031
  </div>
3009
- <p>Paremeters:</p>
3032
+ <p>Parameters:</p>
3010
3033
  <ol>
3011
3034
  <li><a href="../modules.html#ConnectionState">ConnectionState</a> <code>state</code> - the new connection state</li>
3012
3035
  </ol>
@@ -3020,8 +3043,9 @@ img {
3020
3043
  </aside>
3021
3044
  <div class="tsd-comment tsd-typography">
3022
3045
  <div class="lead">
3023
- <p>Fired when a conversation becomes visible to the client. The event is also triggered when the client creates a new conversation.
3024
- Fired for all conversations client has joined.</p>
3046
+ <p>Fired when a conversation becomes visible to the client. The event is also
3047
+ triggered when the client creates a new conversation.
3048
+ Fired for all conversations that the client has joined.</p>
3025
3049
  </div>
3026
3050
  <p>Parameters:</p>
3027
3051
  <ol>
@@ -3085,20 +3109,59 @@ img {
3085
3109
  </aside>
3086
3110
  <div class="tsd-comment tsd-typography">
3087
3111
  <div class="lead">
3088
- <p>Fired when the attributes or the metadata of a conversation have been updated.
3089
- During conversation&#39;s creation and initialization, this event might be fired multiple times
3090
- for same joined or created conversation as new data is arriving from different sources.</p>
3112
+ <p>Fired when the attributes or the metadata of a conversation have been
3113
+ updated. During conversation&#39;s creation and initialization, this event
3114
+ might be fired multiple times for same joined or created conversation as
3115
+ new data is arriving from different sources.</p>
3091
3116
  </div>
3092
3117
  <p>Parameters:</p>
3093
3118
  <ol>
3094
- <li>object <code>data</code> - info object provided with the event. It has the following properties:<ul>
3119
+ <li>object <code>data</code> - info object provided with the event. It has the
3120
+ following properties:<ul>
3095
3121
  <li><a href="Conversation.html">Conversation</a> <code>conversation</code> - the conversation in question</li>
3096
- <li><a href="../modules.html#ConversationUpdateReason">ConversationUpdateReason</a>[] <code>updateReasons</code> - array of reasons for the update</li>
3122
+ <li><a href="../modules.html#ConversationUpdateReason">ConversationUpdateReason</a>[] <code>updateReasons</code> - array of reasons
3123
+ for the update</li>
3097
3124
  </ul>
3098
3125
  </li>
3099
3126
  </ol>
3100
3127
  </div>
3101
3128
  </section>
3129
+ <section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class tsd-is-static">
3130
+ <a name="initFailed" class="tsd-anchor"></a>
3131
+ <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> init<wbr>Failed</h3>
3132
+ <div class="tsd-signature tsd-kind-icon">init<wbr>Failed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;initFailed&quot;</span><span class="tsd-signature-symbol"> = &quot;initFailed&quot;</span></div>
3133
+ <aside class="tsd-sources">
3134
+ </aside>
3135
+ <div class="tsd-comment tsd-typography">
3136
+ <div class="lead">
3137
+ <p>Fired when the client initialization failed.</p>
3138
+ </div>
3139
+ <p>Parameters:</p>
3140
+ <ol>
3141
+ <li>object <code>data</code> - info object provided with the event. It has the
3142
+ following property:<ul>
3143
+ <li>Error? <code>error</code> - the initialization error if present</li>
3144
+ </ul>
3145
+ </li>
3146
+ </ol>
3147
+ </div>
3148
+ </section>
3149
+ <section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class tsd-is-static">
3150
+ <a name="initialized" class="tsd-anchor"></a>
3151
+ <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> initialized</h3>
3152
+ <div class="tsd-signature tsd-kind-icon">initialized<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;initialized&quot;</span><span class="tsd-signature-symbol"> = &quot;initialized&quot;</span></div>
3153
+ <aside class="tsd-sources">
3154
+ </aside>
3155
+ <div class="tsd-comment tsd-typography">
3156
+ <div class="lead">
3157
+ <p>Fired when the client has completed initialization successfully.</p>
3158
+ </div>
3159
+ <p>Parameters:</p>
3160
+ <ol>
3161
+ <li>object <code>data</code> - Optional info object provided with the event</li>
3162
+ </ol>
3163
+ </div>
3164
+ </section>
3102
3165
  <section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class tsd-is-static">
3103
3166
  <a name="messageAdded" class="tsd-anchor"></a>
3104
3167
  <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> message<wbr>Added</h3>
@@ -3143,9 +3206,11 @@ img {
3143
3206
  </div>
3144
3207
  <p>Parameters:</p>
3145
3208
  <ol>
3146
- <li>object <code>data</code> - info object provided with the event. It has the following properties:<ul>
3209
+ <li>object <code>data</code> - info object provided with the event. It has the
3210
+ following properties:<ul>
3147
3211
  <li><a href="Message.html">Message</a> <code>message</code> - the message in question</li>
3148
- <li><a href="../modules.html#MessageUpdateReason">MessageUpdateReason</a>[] <code>updateReasons</code> - array of reasons for the update</li>
3212
+ <li><a href="../modules.html#MessageUpdateReason">MessageUpdateReason</a>[] <code>updateReasons</code> - array of reasons for
3213
+ the update</li>
3149
3214
  </ul>
3150
3215
  </li>
3151
3216
  </ol>
@@ -3195,9 +3260,11 @@ img {
3195
3260
  </div>
3196
3261
  <p>Parameters:</p>
3197
3262
  <ol>
3198
- <li>object <code>data</code> - info object provided with the event. It has the following properties:<ul>
3263
+ <li>object <code>data</code> - info object provided with the event. It has the
3264
+ following properties:<ul>
3199
3265
  <li><a href="Participant.html">Participant</a> <code>participant</code> - the participant in question</li>
3200
- <li><a href="../modules.html#ParticipantUpdateReason">ParticipantUpdateReason</a>[] <code>updateReasons</code> - array of reasons for the update</li>
3266
+ <li><a href="../modules.html#ParticipantUpdateReason">ParticipantUpdateReason</a>[] <code>updateReasons</code> - array of reasons
3267
+ for the update</li>
3201
3268
  </ul>
3202
3269
  </li>
3203
3270
  </ol>
@@ -3211,27 +3278,13 @@ img {
3211
3278
  </aside>
3212
3279
  <div class="tsd-comment tsd-typography">
3213
3280
  <div class="lead">
3214
- <p>Fired when the client has received (and parsed) a push notification via one of the push channels (apn or fcm).</p>
3281
+ <p>Fired when the client has received (and parsed) a push notification via one
3282
+ of the push channels (apn or fcm).</p>
3215
3283
  </div>
3216
3284
  <p>Parameters:</p>
3217
3285
  <ol>
3218
- <li><a href="PushNotification.html">PushNotification</a> <code>pushNotification</code> - the push notification in question</li>
3219
- </ol>
3220
- </div>
3221
- </section>
3222
- <section class="tsd-panel tsd-member tsd-kind-event tsd-parent-kind-class tsd-is-static">
3223
- <a name="stateChanged" class="tsd-anchor"></a>
3224
- <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> state<wbr>Changed</h3>
3225
- <div class="tsd-signature tsd-kind-icon">state<wbr>Changed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;stateChanged&quot;</span><span class="tsd-signature-symbol"> = &quot;stateChanged&quot;</span></div>
3226
- <aside class="tsd-sources">
3227
- </aside>
3228
- <div class="tsd-comment tsd-typography">
3229
- <div class="lead">
3230
- <p>Fired when the state of the client has been changed.</p>
3231
- </div>
3232
- <p>Parameters:</p>
3233
- <ol>
3234
- <li><a href="../modules.html#State">State</a> <code>state</code> - the new client state</li>
3286
+ <li><a href="PushNotification.html">PushNotification</a> <code>pushNotification</code> - the push notification in
3287
+ question</li>
3235
3288
  </ol>
3236
3289
  </div>
3237
3290
  </section>
@@ -3244,12 +3297,6 @@ img {
3244
3297
  <div class="tsd-comment tsd-typography">
3245
3298
  <div class="lead">
3246
3299
  <p>Fired when the token is about to expire and needs to be updated.</p>
3247
- <ul>
3248
- <li>Parameters:</li>
3249
- </ul>
3250
- <ol>
3251
- <li>number <code>message</code> - token&#39;s time to live</li>
3252
- </ol>
3253
3300
  </div>
3254
3301
  </div>
3255
3302
  </section>
@@ -3337,13 +3384,16 @@ img {
3337
3384
  </aside>
3338
3385
  <div class="tsd-comment tsd-typography">
3339
3386
  <div class="lead">
3340
- <p>Fired when the properties or the reachability status of a user have been updated.</p>
3387
+ <p>Fired when the properties or the reachability status of a user have been
3388
+ updated.</p>
3341
3389
  </div>
3342
3390
  <p>Parameters:</p>
3343
3391
  <ol>
3344
- <li>object <code>data</code> - info object provided with the event. It has the following properties:<ul>
3392
+ <li>object <code>data</code> - info object provided with the event. It has the
3393
+ following properties:<ul>
3345
3394
  <li><a href="User.html">User</a> <code>user</code> - the user in question</li>
3346
- <li><a href="../modules.html#UserUpdateReason">UserUpdateReason</a>[] <code>updateReasons</code> - array of reasons for the update</li>
3395
+ <li><a href="../modules.html#UserUpdateReason">UserUpdateReason</a>[] <code>updateReasons</code> - array of reasons for the
3396
+ update</li>
3347
3397
  </ul>
3348
3398
  </li>
3349
3399
  </ol>
@@ -3364,6 +3414,48 @@ img {
3364
3414
  </div>
3365
3415
  </div>
3366
3416
  </section>
3417
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
3418
+ <a name="parsePushNotification" class="tsd-anchor"></a>
3419
+ <h3>parse<wbr>Push<wbr>Notification</h3>
3420
+ <div class="tsd-signature tsd-kind-icon">parse<wbr>Push<wbr>Notification<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span>notificationPayload<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><a href="PushNotification.html" class="tsd-signature-type" data-tsd-kind="Class">PushNotification</a><span class="tsd-signature-symbol"> = ...</span></div>
3421
+ <aside class="tsd-sources">
3422
+ </aside>
3423
+ <div class="tsd-comment tsd-typography">
3424
+ <div class="lead">
3425
+ <p>Current version of the Conversations client.</p>
3426
+ </div>
3427
+ </div>
3428
+ <div class="tsd-type-declaration">
3429
+ <h4>Type declaration</h4>
3430
+ <ul class="tsd-parameters">
3431
+ <li class="tsd-parameter-signature">
3432
+ <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-class">
3433
+ <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>notificationPayload<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="PushNotification.html" class="tsd-signature-type" data-tsd-kind="Class">PushNotification</a></li>
3434
+ </ul>
3435
+ <ul class="tsd-descriptions">
3436
+ <li class="tsd-description">
3437
+ <div class="tsd-comment tsd-typography">
3438
+ <div class="lead">
3439
+ <p>Static method for push notification payload parsing. Returns parsed push as
3440
+ a <a href="PushNotification.html">PushNotification</a> object.</p>
3441
+ </div>
3442
+ </div>
3443
+ <h4 class="tsd-parameters-title">Parameters</h4>
3444
+ <ul class="tsd-parameters">
3445
+ <li>
3446
+ <h5>notificationPayload: <span class="tsd-signature-type">any</span></h5>
3447
+ <div class="tsd-comment tsd-typography">
3448
+ <p>Push notification payload.</p>
3449
+ </div>
3450
+ </li>
3451
+ </ul>
3452
+ <h4 class="tsd-returns-title">Returns <a href="PushNotification.html" class="tsd-signature-type" data-tsd-kind="Class">PushNotification</a></h4>
3453
+ </li>
3454
+ </ul>
3455
+ </li>
3456
+ </ul>
3457
+ </div>
3458
+ </section>
3367
3459
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
3368
3460
  <a name="version" class="tsd-anchor"></a>
3369
3461
  <h3><span class="tsd-flag ts-flagReadonly">Readonly</span> version</h3>
@@ -3403,7 +3495,7 @@ img {
3403
3495
  </aside>
3404
3496
  <div class="tsd-comment tsd-typography">
3405
3497
  <div class="lead">
3406
- <p>Client reachability state. Throws if accessed before the client
3498
+ <p>Client reachability state. Throws an error if accessed before the client
3407
3499
  initialization was completed.</p>
3408
3500
  </div>
3409
3501
  </div>
@@ -3558,6 +3650,64 @@ img {
3558
3650
  </li>
3559
3651
  </ul>
3560
3652
  </section>
3653
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
3654
+ <a name="getTemporaryContentUrlsForMedia" class="tsd-anchor"></a>
3655
+ <h3>get<wbr>Temporary<wbr>Content<wbr>Urls<wbr>For<wbr>Media</h3>
3656
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
3657
+ <li class="tsd-signature tsd-kind-icon">get<wbr>Temporary<wbr>Content<wbr>Urls<wbr>For<wbr>Media<span class="tsd-signature-symbol">(</span>contentSet<span class="tsd-signature-symbol">: </span><a href="Media.html" class="tsd-signature-type" data-tsd-kind="Class">Media</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CancellablePromise.html" class="tsd-signature-type" data-tsd-kind="Class">CancellablePromise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li>
3658
+ </ul>
3659
+ <ul class="tsd-descriptions">
3660
+ <li class="tsd-description">
3661
+ <aside class="tsd-sources">
3662
+ </aside>
3663
+ <div class="tsd-comment tsd-typography">
3664
+ <div class="lead">
3665
+ <p>Get content URLs for all media attachments in the given set using a single
3666
+ operation.</p>
3667
+ </div>
3668
+ </div>
3669
+ <h4 class="tsd-parameters-title">Parameters</h4>
3670
+ <ul class="tsd-parameters">
3671
+ <li>
3672
+ <h5>contentSet: <a href="Media.html" class="tsd-signature-type" data-tsd-kind="Class">Media</a><span class="tsd-signature-symbol">[]</span></h5>
3673
+ <div class="tsd-comment tsd-typography">
3674
+ <p>Set of media attachments to query content URLs.</p>
3675
+ </div>
3676
+ </li>
3677
+ </ul>
3678
+ <h4 class="tsd-returns-title">Returns <a href="CancellablePromise.html" class="tsd-signature-type" data-tsd-kind="Class">CancellablePromise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
3679
+ </li>
3680
+ </ul>
3681
+ </section>
3682
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
3683
+ <a name="getTemporaryContentUrlsForMediaSids" class="tsd-anchor"></a>
3684
+ <h3>get<wbr>Temporary<wbr>Content<wbr>Urls<wbr>For<wbr>Media<wbr>Sids</h3>
3685
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
3686
+ <li class="tsd-signature tsd-kind-icon">get<wbr>Temporary<wbr>Content<wbr>Urls<wbr>For<wbr>Media<wbr>Sids<span class="tsd-signature-symbol">(</span>mediaSids<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-symbol">: </span><a href="CancellablePromise.html" class="tsd-signature-type" data-tsd-kind="Class">CancellablePromise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></li>
3687
+ </ul>
3688
+ <ul class="tsd-descriptions">
3689
+ <li class="tsd-description">
3690
+ <aside class="tsd-sources">
3691
+ </aside>
3692
+ <div class="tsd-comment tsd-typography">
3693
+ <div class="lead">
3694
+ <p>Get content URLs for all media attachments in the given set of media sids
3695
+ using a single operation.</p>
3696
+ </div>
3697
+ </div>
3698
+ <h4 class="tsd-parameters-title">Parameters</h4>
3699
+ <ul class="tsd-parameters">
3700
+ <li>
3701
+ <h5>mediaSids: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
3702
+ <div class="tsd-comment tsd-typography">
3703
+ <p>Set of media sids to query for the content URL.</p>
3704
+ </div>
3705
+ </li>
3706
+ </ul>
3707
+ <h4 class="tsd-returns-title">Returns <a href="CancellablePromise.html" class="tsd-signature-type" data-tsd-kind="Class">CancellablePromise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4>
3708
+ </li>
3709
+ </ul>
3710
+ </section>
3561
3711
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
3562
3712
  <a name="getUser" class="tsd-anchor"></a>
3563
3713
  <h3>get<wbr>User</h3>
@@ -3570,7 +3720,8 @@ img {
3570
3720
  </aside>
3571
3721
  <div class="tsd-comment tsd-typography">
3572
3722
  <div class="lead">
3573
- <p>Gets a user with the given identity. If it&#39;s in the subscribed list, then return the user object from it;
3723
+ <p>Gets a user with the given identity. If it&#39;s in the subscribed list, then
3724
+ return the user object from it;
3574
3725
  if not, then subscribe and add user to the subscribed list.</p>
3575
3726
  </div>
3576
3727
  </div>
@@ -3600,7 +3751,8 @@ img {
3600
3751
  </aside>
3601
3752
  <div class="tsd-comment tsd-typography">
3602
3753
  <div class="lead">
3603
- <p>Handle push notification payload parsing and emit the <a href="Client.html#pushNotification">Client.pushNotification</a> event on this <a href="Client.html">Client</a> instance.</p>
3754
+ <p>Handle push notification payload parsing and emit the
3755
+ <a href="Client.html#pushNotification">Client.pushNotification</a> event on this <a href="Client.html">Client</a> instance.</p>
3604
3756
  </div>
3605
3757
  </div>
3606
3758
  <h4 class="tsd-parameters-title">Parameters</h4>
@@ -3631,8 +3783,10 @@ img {
3631
3783
  <p>Clear existing registrations directly using provided device token.
3632
3784
  This is useful to ensure stopped subscriptions without resubscribing.</p>
3633
3785
  </div>
3634
- <p>This function goes completely beside the state machine and removes all registrations.
3635
- Use with caution: if it races with current state machine operations, madness will ensue.</p>
3786
+ <p>This function goes completely beside the state machine and removes all
3787
+ registrations.
3788
+ Use with caution: if it races with current state machine operations,
3789
+ madness will ensue.</p>
3636
3790
  </div>
3637
3791
  <h4 class="tsd-parameters-title">Parameters</h4>
3638
3792
  <ul class="tsd-parameters">
@@ -3645,7 +3799,8 @@ img {
3645
3799
  <li>
3646
3800
  <h5>registrationId: <span class="tsd-signature-type">string</span></h5>
3647
3801
  <div class="tsd-comment tsd-typography">
3648
- <p>Push notification ID provided by the FCM/APNS service on the platform.</p>
3802
+ <p>Push notification ID provided by the FCM/APNS service
3803
+ on the platform.</p>
3649
3804
  </div>
3650
3805
  </li>
3651
3806
  </ul>
@@ -3679,7 +3834,8 @@ img {
3679
3834
  <li>
3680
3835
  <h5>registrationId: <span class="tsd-signature-type">string</span></h5>
3681
3836
  <div class="tsd-comment tsd-typography">
3682
- <p>Push notification ID provided by the FCM/APNS service on the platform.</p>
3837
+ <p>Push notification ID provided by the FCM/APNS service
3838
+ on the platform.</p>
3683
3839
  </div>
3684
3840
  </li>
3685
3841
  </ul>
@@ -3768,7 +3924,7 @@ img {
3768
3924
  </ul>
3769
3925
  </section>
3770
3926
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
3771
- <a name="parsePushNotification" class="tsd-anchor"></a>
3927
+ <a name="parsePushNotification-1" class="tsd-anchor"></a>
3772
3928
  <h3><span class="tsd-flag ts-flagStatic">Static</span> parse<wbr>Push<wbr>Notification</h3>
3773
3929
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
3774
3930
  <li class="tsd-signature tsd-kind-icon">parse<wbr>Push<wbr>Notification<span class="tsd-signature-symbol">(</span>notificationPayload<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="PushNotification.html" class="tsd-signature-type" data-tsd-kind="Class">PushNotification</a></li>
@@ -3779,7 +3935,8 @@ img {
3779
3935
  </aside>
3780
3936
  <div class="tsd-comment tsd-typography">
3781
3937
  <div class="lead">
3782
- <p>Static method for push notification payload parsing. Returns parsed push as a <a href="PushNotification.html">PushNotification</a> object.</p>
3938
+ <p>Static method for push notification payload parsing. Returns parsed push as
3939
+ a <a href="PushNotification.html">PushNotification</a> object.</p>
3783
3940
  </div>
3784
3941
  </div>
3785
3942
  <h4 class="tsd-parameters-title">Parameters</h4>
@@ -3795,6 +3952,34 @@ img {
3795
3952
  </li>
3796
3953
  </ul>
3797
3954
  </section>
3955
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
3956
+ <a name="populateInitRegistrations" class="tsd-anchor"></a>
3957
+ <h3><span class="tsd-flag ts-flagStatic">Static</span> populate<wbr>Init<wbr>Registrations</h3>
3958
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
3959
+ <li class="tsd-signature tsd-kind-icon">populate<wbr>Init<wbr>Registrations<span class="tsd-signature-symbol">(</span>reg<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">InitRegistration</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
3960
+ </ul>
3961
+ <ul class="tsd-descriptions">
3962
+ <li class="tsd-description">
3963
+ <aside class="tsd-sources">
3964
+ </aside>
3965
+ <div class="tsd-comment tsd-typography">
3966
+ <div class="lead">
3967
+ <p>Populate the client with init registrations.</p>
3968
+ </div>
3969
+ </div>
3970
+ <h4 class="tsd-parameters-title">Parameters</h4>
3971
+ <ul class="tsd-parameters">
3972
+ <li>
3973
+ <h5>reg: <span class="tsd-signature-type">InitRegistration</span></h5>
3974
+ <div class="tsd-comment tsd-typography">
3975
+ <p>The init registration to populate.</p>
3976
+ </div>
3977
+ </li>
3978
+ </ul>
3979
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
3980
+ </li>
3981
+ </ul>
3982
+ </section>
3798
3983
  </section>
3799
3984
  <footer>
3800
3985
  <div class="container">