@twilio/conversations 1.3.0-rc8 → 2.0.0-rc.4

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 (282) hide show
  1. package/CHANGELOG.md +210 -0
  2. package/README.md +22 -17
  3. package/dist/browser.js +7873 -0
  4. package/dist/browser.js.map +1 -0
  5. package/dist/docs/assets/css/main.css +2660 -0
  6. package/dist/docs/assets/images/icons.png +0 -0
  7. package/dist/docs/assets/images/icons@2x.png +0 -0
  8. package/dist/docs/assets/images/widgets.png +0 -0
  9. package/dist/docs/assets/images/widgets@2x.png +0 -0
  10. package/dist/docs/assets/js/main.js +248 -0
  11. package/dist/docs/assets/js/search.js +1 -0
  12. package/dist/docs/classes/AggregatedDeliveryReceipt.html +3286 -0
  13. package/dist/docs/classes/Client.html +4181 -0
  14. package/dist/docs/classes/Conversation.html +4397 -0
  15. package/dist/docs/classes/DetailedDeliveryReceipt.html +3265 -0
  16. package/dist/docs/classes/Media.html +3295 -0
  17. package/dist/docs/classes/Message.html +3713 -0
  18. package/dist/docs/classes/MessageBuilder.html +3280 -0
  19. package/dist/docs/classes/Participant.html +3517 -0
  20. package/dist/docs/classes/PushNotification.html +3232 -0
  21. package/dist/docs/classes/RestPaginator.html +3262 -0
  22. package/dist/docs/classes/UnsentMessage.html +3144 -0
  23. package/dist/docs/classes/User.html +3451 -0
  24. package/dist/docs/index.html +3394 -212
  25. package/dist/docs/interfaces/ClientOptions.html +3136 -0
  26. package/dist/docs/interfaces/ConversationState.html +3152 -0
  27. package/dist/docs/interfaces/CreateConversationOptions.html +3168 -0
  28. package/dist/docs/interfaces/LastMessage.html +3152 -0
  29. package/dist/docs/interfaces/Paginator.html +3243 -0
  30. package/dist/docs/interfaces/PushNotificationData.html +3168 -0
  31. package/dist/docs/interfaces/SendEmailOptions.html +3136 -0
  32. package/dist/docs/interfaces/SendMediaOptions.html +3170 -0
  33. package/dist/docs/modules.html +3425 -0
  34. package/dist/lib.d.ts +1952 -0
  35. package/dist/lib.js +7873 -0
  36. package/dist/lib.js.map +1 -0
  37. package/dist/post-install.js +29 -0
  38. package/dist/react-native.js +4038 -0
  39. package/dist/react-native.js.map +1 -0
  40. package/dist/twilio-conversations.js +40912 -0
  41. package/dist/twilio-conversations.min.js +156 -0
  42. package/package.json +59 -48
  43. package/.circleci/config.yml +0 -650
  44. package/.deepsource.toml +0 -6
  45. package/.env.example +0 -13
  46. package/browser/aggregateddeliveryreceipt.js +0 -152
  47. package/browser/client.js +0 -991
  48. package/browser/configuration.js +0 -80
  49. package/browser/conversation.js +0 -1826
  50. package/browser/data/conversations.js +0 -632
  51. package/browser/data/messages.js +0 -522
  52. package/browser/data/participants.js +0 -411
  53. package/browser/data/users.js +0 -281
  54. package/browser/detaileddeliveryreceipt.js +0 -44
  55. package/browser/index.js +0 -4
  56. package/browser/interfaces/limits.js +0 -3
  57. package/browser/interfaces/notificationtypes.js +0 -21
  58. package/browser/interfaces/paginator.js +0 -53
  59. package/browser/interfaces/responsecodes.js +0 -20
  60. package/browser/interfaces/transport.js +0 -3
  61. package/browser/logger.js +0 -141
  62. package/browser/media.js +0 -198
  63. package/browser/message.js +0 -685
  64. package/browser/participant.js +0 -415
  65. package/browser/pushnotification.js +0 -49
  66. package/browser/restpaginator.js +0 -74
  67. package/browser/services/network.js +0 -223
  68. package/browser/services/readhorizon.js +0 -181
  69. package/browser/services/typingindicator.js +0 -142
  70. package/browser/session.js +0 -505
  71. package/browser/sessionerror.js +0 -93
  72. package/browser/sri.json +0 -1
  73. package/browser/synclist.js +0 -90
  74. package/browser/synclistdescriptor.js +0 -29
  75. package/browser/syncpaginator.js +0 -63
  76. package/browser/user.js +0 -431
  77. package/browser/util/deferred.js +0 -56
  78. package/browser/util/index.js +0 -108
  79. package/dist/@twilio/conversations.js +0 -35533
  80. package/dist/@twilio/conversations.min.js +0 -204
  81. package/dist/docs/AggregatedDeliveryReceipt.html +0 -948
  82. package/dist/docs/Client.html +0 -5075
  83. package/dist/docs/Conversation.html +0 -6018
  84. package/dist/docs/DetailedDeliveryReceipt.html +0 -641
  85. package/dist/docs/Media.html +0 -694
  86. package/dist/docs/Message.html +0 -1934
  87. package/dist/docs/Paginator.html +0 -605
  88. package/dist/docs/Participant.html +0 -1510
  89. package/dist/docs/PushNotification.html +0 -836
  90. package/dist/docs/SessionError.html +0 -379
  91. package/dist/docs/User.html +0 -1315
  92. package/dist/docs/classes.list.html +0 -4431
  93. package/dist/docs/fonts/glyphicons-halflings-regular.eot +0 -0
  94. package/dist/docs/fonts/glyphicons-halflings-regular.svg +0 -288
  95. package/dist/docs/fonts/glyphicons-halflings-regular.ttf +0 -0
  96. package/dist/docs/fonts/glyphicons-halflings-regular.woff +0 -0
  97. package/dist/docs/fonts/glyphicons-halflings-regular.woff2 +0 -0
  98. package/dist/docs/img/glyphicons-halflings-white.png +0 -0
  99. package/dist/docs/img/glyphicons-halflings.png +0 -0
  100. package/dist/docs/quicksearch.html +0 -31
  101. package/dist/docs/scripts/docstrap.lib.js +0 -11
  102. package/dist/docs/scripts/fulltext-search-ui.js +0 -89
  103. package/dist/docs/scripts/fulltext-search.js +0 -36
  104. package/dist/docs/scripts/lunr.min.js +0 -6
  105. package/dist/docs/scripts/prettify/Apache-License-2.0.txt +0 -202
  106. package/dist/docs/scripts/prettify/jquery.min.js +0 -6
  107. package/dist/docs/scripts/prettify/lang-css.js +0 -21
  108. package/dist/docs/scripts/prettify/prettify.js +0 -496
  109. package/dist/docs/scripts/sunlight.js +0 -1157
  110. package/dist/docs/scripts/toc.js +0 -203
  111. package/dist/docs/styles/darkstrap.css +0 -960
  112. package/dist/docs/styles/prettify-tomorrow.css +0 -132
  113. package/dist/docs/styles/site.cerulean.css +0 -7008
  114. package/dist/docs/styles/site.cosmo.css +0 -7061
  115. package/dist/docs/styles/site.cyborg.css +0 -7048
  116. package/dist/docs/styles/site.darkly.css +0 -7171
  117. package/dist/docs/styles/site.darkstrap.css +0 -5638
  118. package/dist/docs/styles/site.dibs-bootstrap.css +0 -5899
  119. package/dist/docs/styles/site.flatly.css +0 -7147
  120. package/dist/docs/styles/site.journal.css +0 -6973
  121. package/dist/docs/styles/site.lumen.css +0 -7298
  122. package/dist/docs/styles/site.paper.css +0 -7623
  123. package/dist/docs/styles/site.readable.css +0 -6997
  124. package/dist/docs/styles/site.sandstone.css +0 -7035
  125. package/dist/docs/styles/site.simplex.css +0 -7023
  126. package/dist/docs/styles/site.slate.css +0 -7343
  127. package/dist/docs/styles/site.spacelab.css +0 -7055
  128. package/dist/docs/styles/site.superhero.css +0 -7131
  129. package/dist/docs/styles/site.united.css +0 -6895
  130. package/dist/docs/styles/site.yeti.css +0 -7195
  131. package/dist/docs/styles/sunlight.dark.css +0 -345
  132. package/dist/docs/styles/sunlight.default.css +0 -344
  133. package/dist/sri.json +0 -1
  134. package/lib/aggregateddeliveryreceipt.d.ts +0 -98
  135. package/lib/aggregateddeliveryreceipt.js +0 -112
  136. package/lib/client.d.ts +0 -317
  137. package/lib/client.js +0 -633
  138. package/lib/configuration.d.ts +0 -21
  139. package/lib/configuration.js +0 -41
  140. package/lib/conversation.d.ts +0 -460
  141. package/lib/conversation.js +0 -940
  142. package/lib/data/conversations.d.ts +0 -57
  143. package/lib/data/conversations.js +0 -296
  144. package/lib/data/messages.d.ts +0 -75
  145. package/lib/data/messages.js +0 -208
  146. package/lib/data/participants.d.ts +0 -94
  147. package/lib/data/participants.js +0 -204
  148. package/lib/data/users.d.ts +0 -42
  149. package/lib/data/users.js +0 -113
  150. package/lib/detaileddeliveryreceipt.d.ts +0 -45
  151. package/lib/detaileddeliveryreceipt.js +0 -34
  152. package/lib/index.d.ts +0 -1
  153. package/lib/index.js +0 -3
  154. package/lib/interfaces/limits.d.ts +0 -8
  155. package/lib/interfaces/limits.js +0 -2
  156. package/lib/interfaces/notificationtypes.d.ts +0 -8
  157. package/lib/interfaces/notificationtypes.js +0 -11
  158. package/lib/interfaces/paginator.d.ts +0 -52
  159. package/lib/interfaces/paginator.js +0 -28
  160. package/lib/interfaces/responsecodes.d.ts +0 -8
  161. package/lib/interfaces/responsecodes.js +0 -10
  162. package/lib/interfaces/transport.d.ts +0 -13
  163. package/lib/interfaces/transport.js +0 -2
  164. package/lib/logger.d.ts +0 -18
  165. package/lib/logger.js +0 -35
  166. package/lib/media.d.ts +0 -52
  167. package/lib/media.js +0 -69
  168. package/lib/message.d.ts +0 -136
  169. package/lib/message.js +0 -305
  170. package/lib/participant.d.ts +0 -142
  171. package/lib/participant.js +0 -219
  172. package/lib/pushnotification.d.ts +0 -48
  173. package/lib/pushnotification.js +0 -39
  174. package/lib/restpaginator.d.ts +0 -19
  175. package/lib/restpaginator.js +0 -36
  176. package/lib/services/network.d.ts +0 -22
  177. package/lib/services/network.js +0 -87
  178. package/lib/services/readhorizon.d.ts +0 -28
  179. package/lib/services/readhorizon.js +0 -112
  180. package/lib/services/typingindicator.d.ts +0 -50
  181. package/lib/services/typingindicator.js +0 -102
  182. package/lib/session.d.ts +0 -63
  183. package/lib/session.js +0 -213
  184. package/lib/sessionerror.d.ts +0 -12
  185. package/lib/sessionerror.js +0 -24
  186. package/lib/sri.json +0 -1
  187. package/lib/synclist.d.ts +0 -24
  188. package/lib/synclist.js +0 -28
  189. package/lib/synclistdescriptor.d.ts +0 -27
  190. package/lib/synclistdescriptor.js +0 -19
  191. package/lib/syncpaginator.d.ts +0 -22
  192. package/lib/syncpaginator.js +0 -37
  193. package/lib/user.d.ts +0 -98
  194. package/lib/user.js +0 -219
  195. package/lib/util/deferred.d.ts +0 -12
  196. package/lib/util/deferred.js +0 -22
  197. package/lib/util/index.d.ts +0 -28
  198. package/lib/util/index.js +0 -82
  199. package/tools/rtd-sdk-cdn-pin/.gitrepo +0 -12
  200. package/tools/rtd-sdk-cdn-pin/README.md +0 -54
  201. package/tools/rtd-sdk-cdn-pin/bintray-settings.xml.template +0 -16
  202. package/tools/rtd-sdk-cdn-pin/cdn-common/cdn-prepare.sh +0 -67
  203. package/tools/rtd-sdk-cdn-pin/cdn-pin-latest.sh +0 -19
  204. package/tools/rtd-sdk-cdn-pin/cdn-pin.sh +0 -19
  205. package/tools/rtd-sdk-cdn-pin/cdn-upload.sh +0 -13
  206. package/tools/rtd-sdk-cdn-pin/fetch/common/fetch-bintray-android.sh +0 -34
  207. package/tools/rtd-sdk-cdn-pin/fetch/common/fetch-npm.sh +0 -18
  208. package/tools/rtd-sdk-cdn-pin/fetch/twilio-chat-android.sh +0 -5
  209. package/tools/rtd-sdk-cdn-pin/fetch/twilio-chat-js.sh +0 -5
  210. package/tools/rtd-sdk-cdn-pin/fetch/twilio-conversations-android.sh +0 -6
  211. package/tools/rtd-sdk-cdn-pin/fetch/twilio-conversations-js.sh +0 -5
  212. package/tools/rtd-sdk-cdn-pin/fetch/twilio-sync-android.sh +0 -5
  213. package/tools/rtd-sdk-cdn-pin/fetch/twilio-sync-js.sh +0 -5
  214. package/tools/rtd-sdk-cdn-pin/fetch-artifact.sh +0 -26
  215. package/tools/sdk-release-tool/.gitrepo +0 -12
  216. package/tools/sdk-release-tool/Makefile +0 -49
  217. package/tools/sdk-release-tool/README.md +0 -275
  218. package/tools/sdk-release-tool/delete +0 -3
  219. package/tools/sdk-release-tool/download +0 -3
  220. package/tools/sdk-release-tool/get-cors +0 -3
  221. package/tools/sdk-release-tool/list +0 -3
  222. package/tools/sdk-release-tool/pin +0 -3
  223. package/tools/sdk-release-tool/pin-latest +0 -3
  224. package/tools/sdk-release-tool/requirements.txt +0 -4
  225. package/tools/sdk-release-tool/sdk-release-tool +0 -3
  226. package/tools/sdk-release-tool/sdk_release_tools/__init__.py +0 -0
  227. package/tools/sdk-release-tool/sdk_release_tools/__main__.py +0 -110
  228. package/tools/sdk-release-tool/sdk_release_tools/aws.py +0 -70
  229. package/tools/sdk-release-tool/sdk_release_tools/cli.py +0 -181
  230. package/tools/sdk-release-tool/sdk_release_tools/log.py +0 -24
  231. package/tools/sdk-release-tool/sdk_release_tools/ops.py +0 -295
  232. package/tools/sdk-release-tool/sdk_release_tools/rpm.py +0 -28
  233. package/tools/sdk-release-tool/sdk_release_tools/util.py +0 -186
  234. package/tools/sdk-release-tool/sdk_release_tools/versions.py +0 -362
  235. package/tools/sdk-release-tool/signal-sdk-js.json +0 -28
  236. package/tools/sdk-release-tool/tests/test_versions.py +0 -94
  237. package/tools/sdk-release-tool/twilio-accessmanager-android.json +0 -19
  238. package/tools/sdk-release-tool/twilio-accessmanager-ios.json +0 -26
  239. package/tools/sdk-release-tool/twilio-auth-ios.json +0 -29
  240. package/tools/sdk-release-tool/twilio-authenticator-ios.json +0 -29
  241. package/tools/sdk-release-tool/twilio-chat-android-2.json +0 -19
  242. package/tools/sdk-release-tool/twilio-chat-android.json +0 -22
  243. package/tools/sdk-release-tool/twilio-chat-ios.json +0 -26
  244. package/tools/sdk-release-tool/twilio-chat-js.json +0 -27
  245. package/tools/sdk-release-tool/twilio-client-android-aar.json +0 -22
  246. package/tools/sdk-release-tool/twilio-client-android.json +0 -22
  247. package/tools/sdk-release-tool/twilio-client-ios.json +0 -20
  248. package/tools/sdk-release-tool/twilio-client-js.json +0 -17
  249. package/tools/sdk-release-tool/twilio-client-sounds-js.json +0 -14
  250. package/tools/sdk-release-tool/twilio-common-android-maven.json +0 -16
  251. package/tools/sdk-release-tool/twilio-common-android.json +0 -22
  252. package/tools/sdk-release-tool/twilio-common-ios-rtc.json +0 -25
  253. package/tools/sdk-release-tool/twilio-common-ios.json +0 -25
  254. package/tools/sdk-release-tool/twilio-common-js.json +0 -19
  255. package/tools/sdk-release-tool/twilio-conversations-android.json +0 -22
  256. package/tools/sdk-release-tool/twilio-conversations-ios.json +0 -26
  257. package/tools/sdk-release-tool/twilio-conversations-js.json +0 -27
  258. package/tools/sdk-release-tool/twilio-flex-js.json +0 -20
  259. package/tools/sdk-release-tool/twilio-flex-webchat-js.json +0 -16
  260. package/tools/sdk-release-tool/twilio-frame-chat-android.json +0 -22
  261. package/tools/sdk-release-tool/twilio-frame-chat-ios.json +0 -23
  262. package/tools/sdk-release-tool/twilio-frame-chat-js.json +0 -23
  263. package/tools/sdk-release-tool/twilio-ip-messaging-android-maven.json +0 -16
  264. package/tools/sdk-release-tool/twilio-ip-messaging-android.json +0 -22
  265. package/tools/sdk-release-tool/twilio-ip-messaging-ios.json +0 -25
  266. package/tools/sdk-release-tool/twilio-ip-messaging-js.json +0 -21
  267. package/tools/sdk-release-tool/twilio-sync-android.json +0 -22
  268. package/tools/sdk-release-tool/twilio-sync-ios.json +0 -26
  269. package/tools/sdk-release-tool/twilio-sync-js.json +0 -39
  270. package/tools/sdk-release-tool/twilio-taskrouter-js.json +0 -17
  271. package/tools/sdk-release-tool/twilio-video-android.json +0 -22
  272. package/tools/sdk-release-tool/twilio-video-cpp-linux-cross-rootfs.json +0 -13
  273. package/tools/sdk-release-tool/twilio-video-cpp.json +0 -33
  274. package/tools/sdk-release-tool/twilio-video-ios.json +0 -25
  275. package/tools/sdk-release-tool/twilio-video-js.json +0 -19
  276. package/tools/sdk-release-tool/twilio-video-jsdocs.json +0 -14
  277. package/tools/sdk-release-tool/twilio-voice-android.json +0 -22
  278. package/tools/sdk-release-tool/twilio-voice-ios.json +0 -29
  279. package/tools/sdk-release-tool/unpin +0 -3
  280. package/tools/sdk-release-tool/unpin-latest +0 -3
  281. package/tools/sdk-release-tool/upload +0 -3
  282. package/twilio-chat.js.iml +0 -9
package/dist/docs/quicksearch.html DELETED
@@ -1,31 +0,0 @@
1
- <html><head>
2
- </head>
3
- <body style="background: transparent;">
4
- <script src="scripts/docstrap.lib.js"></script>
5
- <script src="scripts/lunr.min.js"></script>
6
- <script src="scripts/fulltext-search.js"></script>
7
-
8
- <script type="text/x-docstrap-searchdb">
9
- {"classes.list.html":{"id":"classes.list.html","title":"Classes","body":" Documentation Classes AggregatedDeliveryReceiptClientConversationDetailedDeliveryReceiptMediaMessagePaginatorParticipantPushNotificationSessionErrorUser Events Client#event:connectionErrorClient#event:connectionStateChangedClient#event:conversationAddedClient#event:conversationJoinedClient#event:conversationLeftClient#event:conversationRemovedClient#event:conversationUpdatedClient#event:messageAddedClient#event:messageRemovedClient#event:messageUpdatedClient#event:participantJoinedClient#event:participantLeftClient#event:participantUpdatedClient#event:pushNotificationClient#event:tokenAboutToExpireClient#event:tokenExpiredClient#event:typingEndedClient#event:typingStartedClient#event:userSubscribedClient#event:userUnsubscribedClient#event:userUpdatedConversation#event:messageAddedConversation#event:messageRemovedConversation#event:messageUpdatedConversation#event:participantJoinedConversation#event:participantLeftConversation#event:participantUpdatedConversation#event:removedConversation#event:typingEndedConversation#event:typingStartedConversation#event:updatedMessage#event:updatedParticipant#event:typingEndedParticipant#event:typingStartedParticipant#event:updatedUser#event:updatedUser#event:userSubscribedUser#event:userUnsubscribed Classes Classes AggregatedDeliveryReceipt Client Conversation DetailedDeliveryReceipt Media Message Paginator Participant PushNotification SessionError User Events connectionError Fired when connection is interrupted by unexpected reason Type: Object Properties: Name Type Argument Description terminal Boolean twilsock will stop connection attempts message String root cause httpStatusCode Number &lt;optional&gt; http status code if available errorCode Number &lt;optional&gt; Twilio public error code if available connectionStateChanged Fired when Client's connection state has been changed. Type: Client#ConnectionState conversationAdded Fired when a Conversation becomes visible to the Client. The event is also triggered when the client creates a new Conversation. Fired for all conversations Client has joined. Type: Conversation conversationJoined Fired when the Client joins a Conversation. Type: Conversation conversationLeft Fired when the Client leaves a Conversation. Type: Conversation conversationRemoved Fired when a Conversation is no longer visible to the Client. Type: Conversation conversationUpdated Fired when a Conversation's attributes or metadata have been updated. During Conversation's creation and initialization this event might be fired multiple times for same joined or created Conversation as new data is arriving from different sources. Type: Object Properties: Name Type Description conversation Conversation Updated Conversation updateReasons Array.&lt;Conversation#UpdateReason&gt; Array of Conversation's updated event reasons messageAdded Fired when a new Message has been added to the Conversation on the server. Type: Message messageRemoved Fired when Message is removed from Conversation's message list. Type: Message messageUpdated Fired when an existing Message's fields are updated with new values. Type: Object Properties: Name Type Description message Message Updated Message updateReasons Array.&lt;Message#UpdateReason&gt; Array of Message's updated event reasons participantJoined Fired when a Participant has joined the Conversation. Type: Participant participantLeft Fired when a Participant has left the Conversation. Type: Participant participantUpdated Fired when a Participant's fields has been updated. Type: Object Properties: Name Type Description participant Participant Updated Participant updateReasons Array.&lt;Participant#UpdateReason&gt; Array of Participant's updated event reasons pushNotification Fired when client received (and parsed) push notification via one of push channels (apn or fcm). Type: PushNotification tokenAboutToExpire Fired when token is about to expire and needs to be updated. Type: void tokenExpired Fired when token is expired. Type: void typingEnded Fired when a Participant has stopped typing. Type: Participant typingStarted Fired when a Participant has started typing. Type: Participant userSubscribed Fired when the Client is subscribed to a User. Type: User userUnsubscribed Fired when the Client is unsubscribed from a User. Type: User userUpdated Fired when the User's properties or reachability status have been updated. Type: Object Properties: Name Type Description user User Updated User updateReasons Array.&lt;User#UpdateReason&gt; Array of User's updated event reasons messageAdded Fired when a new Message has been added to the Conversation. Type: Message messageRemoved Fired when Message is removed from Conversation's message list. Type: Message messageUpdated Fired when an existing Message's fields are updated with new values. Type: Object Properties: Name Type Description message Message Updated Message updateReasons Array.&lt;Message#UpdateReason&gt; Array of Message's updated event reasons participantJoined Fired when a Participant has joined the Conversation. Type: Participant participantLeft Fired when a Participant has left the Conversation. Type: Participant participantUpdated Fired when a Participant's fields has been updated. Type: Object Properties: Name Type Description participant Participant Updated Participant updateReasons Array.&lt;Participant#UpdateReason&gt; Array of Participant's updated event reasons removed Fired when the Conversation was destroyed or currently logged in User has left private Conversation Type: Conversation typingEnded Fired when a Participant has stopped typing. Type: Participant typingStarted Fired when a Participant has started typing. Type: Participant updated Fired when a Conversation's attributes or metadata have been updated. Type: Object Properties: Name Type Description conversation Conversation Updated Conversation updateReasons Array.&lt;Conversation#UpdateReason&gt; Array of Conversation's updated event reasons updated Fired when the Message's properties or body has been updated. Type: Object Properties: Name Type Description message Message Updated Message updateReasons Array.&lt;Message#UpdateReason&gt; Array of Message's updated event reasons typingEnded Fired when Participant ended to type. Type: Participant typingStarted Fired when Participant started to type. Type: Participant updated Fired when Participant's fields has been updated. Type: Object Properties: Name Type Description participant Participant Updated Participant updateReasons Array.&lt;Participant#UpdateReason&gt; Array of Participant's updated event reasons updated Fired when User's properties or reachability status have been updated. Type: Object Properties: Name Type Description user User Updated User updateReasons Array.&lt;User#UpdateReason&gt; Array of User's updated event reasons userSubscribed Fired when Client is subscribed to User. Type: User userUnsubscribed Fired when Client is unsubscribed from this User. Type: User × Search results Close Documentation generated by JSDoc 3.5.5 on 2021-06-30T16:21:28+00:00 using the DocStrap template. "},"index.html":{"id":"index.html","title":"Index","body":" Documentation Classes AggregatedDeliveryReceiptClientConversationDetailedDeliveryReceiptMediaMessagePaginatorParticipantPushNotificationSessionErrorUser Events Client#event:connectionErrorClient#event:connectionStateChangedClient#event:conversationAddedClient#event:conversationJoinedClient#event:conversationLeftClient#event:conversationRemovedClient#event:conversationUpdatedClient#event:messageAddedClient#event:messageRemovedClient#event:messageUpdatedClient#event:participantJoinedClient#event:participantLeftClient#event:participantUpdatedClient#event:pushNotificationClient#event:tokenAboutToExpireClient#event:tokenExpiredClient#event:typingEndedClient#event:typingStartedClient#event:userSubscribedClient#event:userUnsubscribedClient#event:userUpdatedConversation#event:messageAddedConversation#event:messageRemovedConversation#event:messageUpdatedConversation#event:participantJoinedConversation#event:participantLeftConversation#event:participantUpdatedConversation#event:removedConversation#event:typingEndedConversation#event:typingStartedConversation#event:updatedMessage#event:updatedParticipant#event:typingEndedParticipant#event:typingStartedParticipant#event:updatedUser#event:updatedUser#event:userSubscribedUser#event:userUnsubscribed Twilio Conversations client libraryTwilio Conversations: Create meaningful connections with customers across various communication channels. Visit our official site for more detalis: https://www.twilio.com/conversations Instantiating and usingTo use the library you need to generate a token and pass it to the conversations Client create factory. NPMnpm install --save @twilio/conversationsUsing this method, you can require twilio-conversations and then use the client: const Conversations = require('twilio-conversations'); Conversations.Client.create(token).then(client =&gt; { // Use client });Or, if you prefer async/await syntax: const Conversations = require('twilio-conversations'); const client = await Conversations.Client.create(token); // Use clientThe SDK could also be imported using the ES module syntax: import Conversations from '@twilio/conversations'; const client = await Conversations.Client.create(token); // Use clientCDNReleases of twilio-conversations.js are hosted on a CDN, and you can include these directly in your web app using a &lt;script&gt; tag. &lt;script src=\"https://media.twiliocdn.com/sdk/js/conversations/v1.2/twilio-conversations.min.js\"&gt;&lt;/script&gt;Using this method, twilio-conversations.js will set a browser global Twilio.Conversations through which you can use the client : Twilio.Conversations.Client.create(token).then(client =&gt; { // Use client });or, if you prefer async/await syntax: let client = await Twilio.Conversations.Client.create(token); // Use clientSecurityThe CDN consumption described above allows you to consume latest bug fixed versions automatically, but does not prevent from detecting malicious modifications in the SDK code. If you require more security you will have to consume SDK by using SRI and using an exact version number. While less flexible it is significantly more secure, which is required by some applications. To consume securely use the following script snippet format: &lt;script src=\"https://media.twiliocdn.com/sdk/js/conversations/releases/1.2.0/twilio-conversations.min.js\" integrity=\"sha256-&lt;HASH FROM THE CHANGELOGS PAGE&gt;\" crossorigin=\"anonymous\"&gt;&lt;/script&gt;Find the hash of each release published on the Changelog page. ChangelogSee this link. × Search results Close Documentation generated by JSDoc 3.5.5 on 2021-06-30T16:21:28+00:00 using the DocStrap template. "},"AggregatedDeliveryReceipt.html":{"id":"AggregatedDeliveryReceipt.html","title":"Class: AggregatedDeliveryReceipt","body":" Documentation Classes AggregatedDeliveryReceiptClientConversationDetailedDeliveryReceiptMediaMessagePaginatorParticipantPushNotificationSessionErrorUser Events Client#event:connectionErrorClient#event:connectionStateChangedClient#event:conversationAddedClient#event:conversationJoinedClient#event:conversationLeftClient#event:conversationRemovedClient#event:conversationUpdatedClient#event:messageAddedClient#event:messageRemovedClient#event:messageUpdatedClient#event:participantJoinedClient#event:participantLeftClient#event:participantUpdatedClient#event:pushNotificationClient#event:tokenAboutToExpireClient#event:tokenExpiredClient#event:typingEndedClient#event:typingStartedClient#event:userSubscribedClient#event:userUnsubscribedClient#event:userUpdatedConversation#event:messageAddedConversation#event:messageRemovedConversation#event:messageUpdatedConversation#event:participantJoinedConversation#event:participantLeftConversation#event:participantUpdatedConversation#event:removedConversation#event:typingEndedConversation#event:typingStartedConversation#event:updatedMessage#event:updatedParticipant#event:typingEndedParticipant#event:typingStartedParticipant#event:updatedUser#event:updatedUser#event:userSubscribedUser#event:userUnsubscribed Class: AggregatedDeliveryReceipt AggregatedDeliveryReceipt Contains aggregated information about a Message's delivery statuses across all Participants of a Conversation. At any moment during delivering message to a Participant the message can have zero or more of following delivery statuses: Message considered as sent to a participant, if the nearest upstream carrier accepted the message. Message considered as delivered to a participant, if Twilio has received confirmation of message delivery from the upstream carrier, and, where available, the destination handset. Message considered as undelivered to a participant, if Twilio has received a delivery receipt indicating that the message was not delivered. This can happen for many reasons including carrier content filtering and the availability of the destination handset. Message considered as read by a participant, if the message has been delivered and opened by the recipient in the conversation. The recipient must have enabled read receipts. Message considered as failed to be delivered to a participant if the message could not be sent. This can happen for various reasons including queue overflows, account suspensions and media errors (in the case of MMS for instance). AggregatedDeliveryReceipt class contains aggregated value AggregatedDeliveryReceipt#DeliveryAmount for each delivery status. new AggregatedDeliveryReceipt() Properties: Name Type Description total number Maximum number of delivery events expected for the message sent AggregatedDeliveryReceipt#DeliveryAmount Amount of participants that have sent delivery status for the message. delivered AggregatedDeliveryReceipt#DeliveryAmount Amount of participants that have delivered delivery status for the message. read AggregatedDeliveryReceipt#DeliveryAmount Amount of participants that have read delivery status for the message. undelivered AggregatedDeliveryReceipt#DeliveryAmount Amount of participants that have undelivered delivery status for the message. failed AggregatedDeliveryReceipt#DeliveryAmount Amount of participants that have failed delivery status for the message. Members delivered Message considered as delivered to a participant, if Twilio has received confirmation of message delivery from the upstream carrier, and, where available, the destination handset. failed Message considered as failed to be delivered to a participant if the message could not be sent. This can happen for various reasons including queue overflows, account suspensions and media errors (in the case of MMS for instance). Twilio does not charge you for failed messages. read Message considered as read by a participant, if the message has been delivered and opened by the recipient in the conversation. The recipient must have enabled read receipts. sent Message considered as sent to a participant, if the nearest upstream carrier accepted the message. total undelivered Message considered as undelivered to a participant, if Twilio has received a delivery receipt indicating that the message was not delivered. This can happen for many reasons including carrier content filtering and the availability of the destination handset. Type Definitions DeliveryAmount Signifies amount of participants which have the status for the message. Type: 'none' | 'some' | 'all' × Search results Close Documentation generated by JSDoc 3.5.5 on 2021-06-30T16:21:28+00:00 using the DocStrap template. "},"Client.html":{"id":"Client.html","title":"Class: Client","body":" Documentation Classes AggregatedDeliveryReceiptClientConversationDetailedDeliveryReceiptMediaMessagePaginatorParticipantPushNotificationSessionErrorUser Events Client#event:connectionErrorClient#event:connectionStateChangedClient#event:conversationAddedClient#event:conversationJoinedClient#event:conversationLeftClient#event:conversationRemovedClient#event:conversationUpdatedClient#event:messageAddedClient#event:messageRemovedClient#event:messageUpdatedClient#event:participantJoinedClient#event:participantLeftClient#event:participantUpdatedClient#event:pushNotificationClient#event:tokenAboutToExpireClient#event:tokenExpiredClient#event:typingEndedClient#event:typingStartedClient#event:userSubscribedClient#event:userUnsubscribedClient#event:userUpdatedConversation#event:messageAddedConversation#event:messageRemovedConversation#event:messageUpdatedConversation#event:participantJoinedConversation#event:participantLeftConversation#event:participantUpdatedConversation#event:removedConversation#event:typingEndedConversation#event:typingStartedConversation#event:updatedMessage#event:updatedParticipant#event:typingEndedParticipant#event:typingStartedParticipant#event:updatedUser#event:updatedUser#event:userSubscribedUser#event:userUnsubscribed Class: Client Client A Client is a starting point to access Twilio Conversations functionality. new Client() Properties: Name Type Description connectionState Client#ConnectionState Client connection state reachabilityEnabled Boolean Client reachability state user User Information for logged in user version String Current version of Conversations client Fires: Client#event:connectionError Client#event:connectionStateChanged Client#event:conversationAdded Client#event:conversationJoined Client#event:conversationLeft Client#event:conversationRemoved Client#event:conversationUpdated Client#event:participantJoined Client#event:participantLeft Client#event:participantUpdated Client#event:messageAdded Client#event:messageRemoved Client#event:messageUpdated Client#event:pushNotification Client#event:tokenAboutToExpire Client#event:tokenExpired Client#event:typingEnded Client#event:typingStarted Client#event:userSubscribed Client#event:userUnsubscribed Client#event:userUpdated Methods &lt;static&gt; create(token [, options]) Factory method to create Conversations client instance. Parameters: Name Type Argument Description token String Access token options Client#ClientOptions &lt;optional&gt; Options to customize the Client Returns: Type Promise.&lt;Client&gt; &lt;static&gt; parsePushNotification(notificationPayload) Static method for push notification payload parsing. Returns parsed push as PushNotification object Parameters: Name Type Description notificationPayload Object Push notification payload Returns: Type PushNotification | Error createConversation( [options]) Create a Conversation on the server and subscribe to its events. The default is a Conversation with an empty friendlyName. Parameters: Name Type Argument Description options Client#CreateConversationOptions &lt;optional&gt; Options for the Conversation Returns: Type Promise.&lt;Conversation&gt; getConversationBySid(conversationSid) Get a known Conversation by its SID. Parameters: Name Type Description conversationSid String Conversation sid Returns: Type Promise.&lt;Conversation&gt; getConversationByUniqueName(uniqueName) Get a known Conversation by its unique identifier name. Parameters: Name Type Description uniqueName String The unique identifier name of the Conversation to get Returns: Type Promise.&lt;Conversation&gt; getSubscribedConversations() Get the current list of all subscribed Conversations. Returns: Type Promise.&lt;Paginator.&lt;Conversation&gt;&gt; getSubscribedUsers() Returns: List of subscribed User objects Type Promise.&lt;Array.&lt;User&gt;&gt; getUser(identity) Gets user for given identity, if it's in subscribed list - then return the user object from it, if not - then subscribes and adds user to the subscribed list. Parameters: Name Type Description identity String Identity of User Returns: Fully initialized user Type Promise.&lt;User&gt; handlePushNotification(notificationPayload) Handle push notification payload parsing and emits event Client#event:pushNotification on this Client instance. Parameters: Name Type Description notificationPayload Object Push notification payload Returns: Type Promise.&lt;void&gt; setPushRegistrationId(channelType, registrationId) Registers for push notifications. Parameters: Name Type Description channelType Client#NotificationsChannelType 'apn' and 'fcm' are supported registrationId string Push notification id provided by the platform Returns: Type Promise.&lt;void&gt; shutdown() Gracefully shutting down library instance. Returns: Type Promise.&lt;void&gt; unsetPushRegistrationId(channelType) Unregisters from push notifications. Parameters: Name Type Description channelType Client#NotificationsChannelType 'apn' and 'fcm' are supported Returns: Type Promise.&lt;void&gt; updateToken(token) Update the token used by the Client and re-register with Conversations services. Parameters: Name Type Description token String Access token Returns: Type Promise.&lt;Client&gt; Type Definitions ClientOptions These options can be passed to Client constructor. Type: Object Properties: Name Type Argument Default Description logLevel String &lt;optional&gt; 'error' The level of logging to enable. Valid options (from strictest to broadest): ['silent', 'error', 'warn', 'info', 'debug', 'trace'] ConnectionState Connection state of Client. Type: 'connecting' | 'connected' | 'disconnecting' | 'disconnected' | 'denied' CreateConversationOptions These options can be passed to Client#createConversation. Type: Object Properties: Name Type Argument Description attributes any &lt;optional&gt; Any custom attributes to attach to the Conversation friendlyName String &lt;optional&gt; The non-unique display name of the Conversation uniqueName String &lt;optional&gt; The unique identifier of the Conversation NotificationsChannelType Notifications channel type. Type: 'fcm' | 'apn' Events connectionError Fired when connection is interrupted by unexpected reason Type: Object Properties: Name Type Argument Description terminal Boolean twilsock will stop connection attempts message String root cause httpStatusCode Number &lt;optional&gt; http status code if available errorCode Number &lt;optional&gt; Twilio public error code if available connectionStateChanged Fired when Client's connection state has been changed. Type: Client#ConnectionState conversationAdded Fired when a Conversation becomes visible to the Client. The event is also triggered when the client creates a new Conversation. Fired for all conversations Client has joined. Type: Conversation conversationJoined Fired when the Client joins a Conversation. Type: Conversation conversationLeft Fired when the Client leaves a Conversation. Type: Conversation conversationRemoved Fired when a Conversation is no longer visible to the Client. Type: Conversation conversationUpdated Fired when a Conversation's attributes or metadata have been updated. During Conversation's creation and initialization this event might be fired multiple times for same joined or created Conversation as new data is arriving from different sources. Type: Object Properties: Name Type Description conversation Conversation Updated Conversation updateReasons Array.&lt;Conversation#UpdateReason&gt; Array of Conversation's updated event reasons messageAdded Fired when a new Message has been added to the Conversation on the server. Type: Message messageRemoved Fired when Message is removed from Conversation's message list. Type: Message messageUpdated Fired when an existing Message's fields are updated with new values. Type: Object Properties: Name Type Description message Message Updated Message updateReasons Array.&lt;Message#UpdateReason&gt; Array of Message's updated event reasons participantJoined Fired when a Participant has joined the Conversation. Type: Participant participantLeft Fired when a Participant has left the Conversation. Type: Participant participantUpdated Fired when a Participant's fields has been updated. Type: Object Properties: Name Type Description participant Participant Updated Participant updateReasons Array.&lt;Participant#UpdateReason&gt; Array of Participant's updated event reasons pushNotification Fired when client received (and parsed) push notification via one of push channels (apn or fcm). Type: PushNotification tokenAboutToExpire Fired when token is about to expire and needs to be updated. Type: void tokenExpired Fired when token is expired. Type: void typingEnded Fired when a Participant has stopped typing. Type: Participant typingStarted Fired when a Participant has started typing. Type: Participant userSubscribed Fired when the Client is subscribed to a User. Type: User userUnsubscribed Fired when the Client is unsubscribed from a User. Type: User userUpdated Fired when the User's properties or reachability status have been updated. Type: Object Properties: Name Type Description user User Updated User updateReasons Array.&lt;User#UpdateReason&gt; Array of User's updated event reasons × Search results Close Documentation generated by JSDoc 3.5.5 on 2021-06-30T16:21:28+00:00 using the DocStrap template. "},"Conversation.html":{"id":"Conversation.html","title":"Class: Conversation","body":" Documentation Classes AggregatedDeliveryReceiptClientConversationDetailedDeliveryReceiptMediaMessagePaginatorParticipantPushNotificationSessionErrorUser Events Client#event:connectionErrorClient#event:connectionStateChangedClient#event:conversationAddedClient#event:conversationJoinedClient#event:conversationLeftClient#event:conversationRemovedClient#event:conversationUpdatedClient#event:messageAddedClient#event:messageRemovedClient#event:messageUpdatedClient#event:participantJoinedClient#event:participantLeftClient#event:participantUpdatedClient#event:pushNotificationClient#event:tokenAboutToExpireClient#event:tokenExpiredClient#event:typingEndedClient#event:typingStartedClient#event:userSubscribedClient#event:userUnsubscribedClient#event:userUpdatedConversation#event:messageAddedConversation#event:messageRemovedConversation#event:messageUpdatedConversation#event:participantJoinedConversation#event:participantLeftConversation#event:participantUpdatedConversation#event:removedConversation#event:typingEndedConversation#event:typingStartedConversation#event:updatedMessage#event:updatedParticipant#event:typingEndedParticipant#event:typingStartedParticipant#event:updatedUser#event:updatedUser#event:userSubscribedUser#event:userUnsubscribed Class: Conversation Conversation A Conversation represents communication between multiple Conversations Clients new Conversation() Properties: Name Type Argument Description attributes any The Conversation's custom attributes createdBy String The identity of the User that created this Conversation dateCreated Date The Date this Conversation was created dateUpdated Date The Date this Conversation was last updated friendlyName String &lt;optional&gt; The Conversation's name lastReadMessageIndex Number | null Index of the last Message the User has read in this Conversation lastMessage Conversation#LastMessage Last Message sent to this Conversation notificationLevel Conversation#NotificationLevel User Notification level for this Conversation sid String The Conversation's unique system identifier status Conversation#Status The Conversation's status state Conversation#State The Conversation's state uniqueName String The Conversation's unique name Fires: Conversation#event:participantJoined Conversation#event:participantLeft Conversation#event:participantUpdated Conversation#event:messageAdded Conversation#event:messageRemoved Conversation#event:messageUpdated Conversation#event:typingEnded Conversation#event:typingStarted Conversation#event:updated Conversation#event:removed Methods add(identity [, attributes]) Add a participant to the Conversation by its Identity. Parameters: Name Type Argument Description identity String Identity of the Client to add attributes any &lt;optional&gt; Attributes to be attached to the participant Returns: Type Promise.&lt;void&gt; addNonChatParticipant(proxyAddress, address [, attributes]) Add a non-chat participant to the Conversation. Parameters: Name Type Argument Description proxyAddress String Proxy (Twilio) address of the participant address String User address of the participant attributes any &lt;optional&gt; Attributes to be attached to the participant Returns: Type Promise.&lt;void&gt; advanceLastReadMessageIndex(index) Advance Conversation's last read Message index to current read horizon. Rejects if User is not Participant of Conversation. Last read Message index is updated only if new index value is higher than previous. Parameters: Name Type Description index Number Message index to advance to as last read Returns: resulting unread messages count in the conversation Type Promise.&lt;number&gt; delete() Delete the Conversation and unsubscribe from its events. Returns: Type Promise.&lt;Conversation&gt; getAttributes() Get the custom attributes of this Conversation. Returns: attributes of this Conversation Type Promise.&lt;any&gt; getMessages( [pageSize] [, anchor] [, direction]) Returns messages from conversation using paginator interface. Parameters: Name Type Argument Default Description pageSize Number &lt;optional&gt; 30 Number of messages to return in single chunk anchor Number &lt;optional&gt; Index of newest Message to fetch. From the end by default direction 'backwards' | 'forward' &lt;optional&gt; backwards Query direction. By default it query backwards from newer to older. 'forward' will query in opposite direction Returns: page of messages Type Promise.&lt;Paginator.&lt;Message&gt;&gt; getMessagesCount() Get total message count in a conversation. This method is semi-realtime. This means that this data will be eventually correct, but will also possibly be incorrect for a few seconds. The Conversations system does not provide real time events for counter values changes. So this is quite useful for any UI badges, but is not recommended to build any core application logic based on these counters being accurate in real time. Returns: Type Promise.&lt;number&gt; getParticipantByIdentity(identity) Get a Participant by its identity. Parameters: Name Type Description identity String Participant identity Returns: Type Promise.&lt;Participant&gt; getParticipantBySid(participantSid) Get a Participant by its SID. Parameters: Name Type Description participantSid String Participant sid Returns: Type Promise.&lt;Participant&gt; getParticipants() Get a list of all Participants joined to this Conversation. Returns: Type Promise.&lt;Array.&lt;Participant&gt;&gt; getParticipantsCount() Get conversation participants count. This method is semi-realtime. This means that this data will be eventually correct, but will also possibly be incorrect for a few seconds. The Conversation system does not provide real time events for counter values changes. So this is quite useful for any UI badges, but is not recommended to build any core application logic based on these counters being accurate in real time. Returns: Type Promise.&lt;number&gt; getUnreadMessagesCount() Get unread messages count for the User if they are a Participant of this Conversation. Rejects if the User is not a Participant of the Conversation. Use this method to obtain the number of unread messages together with updateLastReadMessageIndex() instead of relying on the Message indices which may have gaps. See Message.index for details. This method is semi-realtime. This means that this data will be eventually correct, but will also possibly be incorrect for a few seconds. The Chat system does not provide real time events for counter values changes. This is quite useful for any “unread messages count” badges, but is not recommended to build any core application logic based on these counters being accurate in real time. Returns: Type Promise.&lt;(number|null)&gt; join() Join the Conversation and subscribe to its events. Returns: Type Promise.&lt;Conversation&gt; leave() Leave the Conversation. Returns: Type Promise.&lt;Conversation&gt; removeParticipant(participant) Remove a Participant from the Conversation. When a string is passed as the argument, it will assume that the string is an identity. Parameters: Name Type Description participant String | Participant identity or participant object to remove Returns: Type Promise.&lt;void&gt; sendMessage(message [, messageAttributes] [, emailOptions]) Send a Message in the Conversation. Parameters: Name Type Argument Description message String | FormData | Conversation#SendMediaOptions | null The message body for text message, FormData or MediaOptions for media content. Sending FormData supported only with browser engine messageAttributes any &lt;optional&gt; attributes for the message emailOptions Conversation#SendEmailOptions &lt;optional&gt; email options for the message Returns: new Message's index in the Conversation's messages list Type Promise.&lt;number&gt; setAllMessagesRead() Set last read Conversation's Message index to last known Message's index in this Conversation. Returns: resulting unread messages count in the conversation Type Promise.&lt;number&gt; setAllMessagesUnread() Set all messages in the conversation unread. Returns: resulting unread messages count in the conversation Type Promise.&lt;number&gt; setUserNotificationLevel(notificationLevel) Set User Notification level for this conversation. Parameters: Name Type Description notificationLevel Conversation#NotificationLevel The new user notification level Returns: Type Promise.&lt;void&gt; typing() Send a notification to the server indicating that this Client is currently typing in this Conversation. Typing ended notification is sent after a while automatically, but by calling again this method you ensure typing ended is not received. Returns: Type Promise.&lt;void&gt; updateAttributes(attributes) Update the Conversation's attributes. Parameters: Name Type Description attributes any The new attributes object Returns: Type Promise.&lt;Conversation&gt; updateFriendlyName(name) Update the Conversation's friendlyName. Parameters: Name Type Description name String | null The new Conversation friendlyName Returns: Type Promise.&lt;Conversation&gt; updateLastReadMessageIndex(index) Set Conversation's last read Message index to current read horizon. Parameters: Name Type Description index Number | null Message index to set as last read. If null provided, then the behavior is identical to Conversation#setAllMessagesUnread Returns: resulting unread messages count in the conversation Type Promise.&lt;number&gt; updateUniqueName(uniqueName) Update the Conversation's unique name. Parameters: Name Type Description uniqueName String | null New unique name for the Conversation. Setting unique name to null removes it. Returns: Type Promise.&lt;Conversation&gt; Type Definitions LastMessage The Conversation's last message's information. Type: Object Properties: Name Type Description index Number Message's index dateCreated Date Message's creation date NotificationLevel The User's Notification level for Conversation, determines whether the currently logged-in User will receive pushes for events in this Conversation. Can be either muted or default, where default defers to global Service push configuration. Type: 'default' | 'muted' SendEmailOptions These options can be passed to Conversation#sendMessage. Type: Object Properties: Name Type Description subject String subject for the message. Ignored for media messages. SendMediaOptions These options can be passed to Conversation#sendMessage. Type: Object Properties: Name Type Description contentType String content type of media media String | Buffer content to post State The Conversation's state. Type: Object Properties: Name Type Description current 'active' | 'inactive' | 'closed' the current state dateUpdated Date date at which the latest conversation state update happened Status The status of the Conversation, relative to the Client: whether the Conversation has been joined or the Client is notParticipating in the Conversation. Type: 'notParticipating' | 'joined' UpdateReason The update reason for updated event emitted on Conversation Type: 'attributes' | 'createdBy' | 'dateCreated' | 'dateUpdated' | 'friendlyName' | 'lastReadMessageIndex' | 'state' | 'status' | 'uniqueName' | 'lastMessage' | 'notificationLevel' | 'bindings' Events messageAdded Fired when a new Message has been added to the Conversation. Type: Message messageRemoved Fired when Message is removed from Conversation's message list. Type: Message messageUpdated Fired when an existing Message's fields are updated with new values. Type: Object Properties: Name Type Description message Message Updated Message updateReasons Array.&lt;Message#UpdateReason&gt; Array of Message's updated event reasons participantJoined Fired when a Participant has joined the Conversation. Type: Participant participantLeft Fired when a Participant has left the Conversation. Type: Participant participantUpdated Fired when a Participant's fields has been updated. Type: Object Properties: Name Type Description participant Participant Updated Participant updateReasons Array.&lt;Participant#UpdateReason&gt; Array of Participant's updated event reasons removed Fired when the Conversation was destroyed or currently logged in User has left private Conversation Type: Conversation typingEnded Fired when a Participant has stopped typing. Type: Participant typingStarted Fired when a Participant has started typing. Type: Participant updated Fired when a Conversation's attributes or metadata have been updated. Type: Object Properties: Name Type Description conversation Conversation Updated Conversation updateReasons Array.&lt;Conversation#UpdateReason&gt; Array of Conversation's updated event reasons × Search results Close Documentation generated by JSDoc 3.5.5 on 2021-06-30T16:21:28+00:00 using the DocStrap template. "},"DetailedDeliveryReceipt.html":{"id":"DetailedDeliveryReceipt.html","title":"Class: DetailedDeliveryReceipt","body":" Documentation Classes AggregatedDeliveryReceiptClientConversationDetailedDeliveryReceiptMediaMessagePaginatorParticipantPushNotificationSessionErrorUser Events Client#event:connectionErrorClient#event:connectionStateChangedClient#event:conversationAddedClient#event:conversationJoinedClient#event:conversationLeftClient#event:conversationRemovedClient#event:conversationUpdatedClient#event:messageAddedClient#event:messageRemovedClient#event:messageUpdatedClient#event:participantJoinedClient#event:participantLeftClient#event:participantUpdatedClient#event:pushNotificationClient#event:tokenAboutToExpireClient#event:tokenExpiredClient#event:typingEndedClient#event:typingStartedClient#event:userSubscribedClient#event:userUnsubscribedClient#event:userUpdatedConversation#event:messageAddedConversation#event:messageRemovedConversation#event:messageUpdatedConversation#event:participantJoinedConversation#event:participantLeftConversation#event:participantUpdatedConversation#event:removedConversation#event:typingEndedConversation#event:typingStartedConversation#event:updatedMessage#event:updatedParticipant#event:typingEndedParticipant#event:typingStartedParticipant#event:updatedUser#event:updatedUser#event:userSubscribedUser#event:userUnsubscribed Class: DetailedDeliveryReceipt DetailedDeliveryReceipt Represents a delivery receipt of a Message. new DetailedDeliveryReceipt() Properties: Name Type Description sid String The unique identifier for Delivery Receipt messageSid String The unique identifier for Conversation Message conversationSid String The unique identifier for Conversation channelMessageSid String The unique identifier for the ‘channel’ message e.g WAxx for Whatsapp, SMxx for SMS participantSid String Participant's unique identifier status DetailedDeliveryReceipt#Status Message delivery status errorCode number | null Numeric error code mapped from Status callback code. Information about the error codes can be found here. dateCreated String When Delivery Receipt was created dateUpdated String When Delivery Receipt was updated Type Definitions Status Signifies the message delivery status. Type: 'sent' | 'delivered' | 'failed' | 'read' | 'undelivered' | 'queued' × Search results Close Documentation generated by JSDoc 3.5.5 on 2021-06-30T16:21:28+00:00 using the DocStrap template. "},"Media.html":{"id":"Media.html","title":"Class: Media","body":" Documentation Classes AggregatedDeliveryReceiptClientConversationDetailedDeliveryReceiptMediaMessagePaginatorParticipantPushNotificationSessionErrorUser Events Client#event:connectionErrorClient#event:connectionStateChangedClient#event:conversationAddedClient#event:conversationJoinedClient#event:conversationLeftClient#event:conversationRemovedClient#event:conversationUpdatedClient#event:messageAddedClient#event:messageRemovedClient#event:messageUpdatedClient#event:participantJoinedClient#event:participantLeftClient#event:participantUpdatedClient#event:pushNotificationClient#event:tokenAboutToExpireClient#event:tokenExpiredClient#event:typingEndedClient#event:typingStartedClient#event:userSubscribedClient#event:userUnsubscribedClient#event:userUpdatedConversation#event:messageAddedConversation#event:messageRemovedConversation#event:messageUpdatedConversation#event:participantJoinedConversation#event:participantLeftConversation#event:participantUpdatedConversation#event:removedConversation#event:typingEndedConversation#event:typingStartedConversation#event:updatedMessage#event:updatedParticipant#event:typingEndedParticipant#event:typingStartedParticipant#event:updatedUser#event:updatedUser#event:userSubscribedUser#event:userUnsubscribed Class: Media Media A Media represents media information of a Message in a Conversation. new Media() Properties: Name Type Argument Description sid String The server-assigned unique identifier for Media category String media category, can be one of the {MediaCategory} values. filename String &lt;optional&gt; file name if present, null otherwise contentType String content type of media size Number Size of media, bytes s Methods getCachedTemporaryUrl() Returns cached direct content URL for the media. This URL will expire in several minutes. This function does not refresh the URL and can be used to query it several times without causing network traffic. If the URL becomes expired, you need to request a new one using getContentTemporaryUrl(). Returns: Type Promise.&lt;String&gt; getContentTemporaryUrl() Returns direct content URL for the media. This URL is impermanent, it will expire in several minutes and cannot be cached. If the URL becomes expired, you need to request a new one. Each call to this function produces a new temporary URL. Returns: Type Promise.&lt;String&gt; × Search results Close Documentation generated by JSDoc 3.5.5 on 2021-06-30T16:21:28+00:00 using the DocStrap template. "},"Message.html":{"id":"Message.html","title":"Class: Message","body":" Documentation Classes AggregatedDeliveryReceiptClientConversationDetailedDeliveryReceiptMediaMessagePaginatorParticipantPushNotificationSessionErrorUser Events Client#event:connectionErrorClient#event:connectionStateChangedClient#event:conversationAddedClient#event:conversationJoinedClient#event:conversationLeftClient#event:conversationRemovedClient#event:conversationUpdatedClient#event:messageAddedClient#event:messageRemovedClient#event:messageUpdatedClient#event:participantJoinedClient#event:participantLeftClient#event:participantUpdatedClient#event:pushNotificationClient#event:tokenAboutToExpireClient#event:tokenExpiredClient#event:typingEndedClient#event:typingStartedClient#event:userSubscribedClient#event:userUnsubscribedClient#event:userUpdatedConversation#event:messageAddedConversation#event:messageRemovedConversation#event:messageUpdatedConversation#event:participantJoinedConversation#event:participantLeftConversation#event:participantUpdatedConversation#event:removedConversation#event:typingEndedConversation#event:typingStartedConversation#event:updatedMessage#event:updatedParticipant#event:typingEndedParticipant#event:typingStartedParticipant#event:updatedUser#event:updatedUser#event:userSubscribedUser#event:userUnsubscribed Class: Message Message A Message represents a Message in a Conversation. new Message() Properties: Name Type Description author String The name of the user that sent Message subject String | null Message subject. Used only in email conversations body String The body of the Message. Is null if Message is Media Message attributes any Message custom attributes conversation Conversation Conversation Message belongs to dateCreated Date When Message was created dateUpdated Date When Message was updated index Number Index of Message in the Conversation's messages list By design of the conversations system the message indices may have arbitrary gaps between them, that does not necessarily mean they were deleted or otherwise modified - just that messages may have non-contiguous indices even if they are sent immediately one after another. Trying to use indices for some calculations is going to be unreliable. To calculate the number of unread messages it is better to use the read horizon API. See Conversation#getUnreadMessagesCount for details. lastUpdatedBy String Identity of the last user that updated Message media Media Contains Media information (if present) participantSid String Authoring Participant's server-assigned unique identifier sid String The server-assigned unique identifier for Message type 'text' | 'media' Type of message: 'text' or 'media' aggregatedDeliveryReceipt AggregatedDeliveryReceipt | null Aggregated information about Message delivery statuses across all Participants of a Conversation. Fires: Message#event:updated Members attachedMedia Return all media attachments, except email body/history attachments, without temporary urls. media One of the attached media. Deprecated: Use attachedMedia instead. Note that the latter is now an array. Methods attachTemporaryUrlsFor(contentSet) Get content URLs for all media attachments in the given set using single operation. Parameters: Name Type Description contentSet Set of media attachments to query for content URL. getDetailedDeliveryReceipts() Get delivery receipts of the message Returns: Type Promise.&lt;Array.&lt;DetailedDeliveryReceipt&gt;&gt; getMediaByCategory(categories) Return a (possibly empty) array of media matching a specific set of categories. Allowed categories are 'media', 'body' and 'history'. Parameters: Name Type Description categories Array of categories to match. Returns: Array of media descriptors matching given categories. getParticipant() Get Participant who is author of the Message Returns: Type Promise.&lt;Participant&gt; remove() Remove the Message. Returns: Type Promise.&lt;Message&gt; updateAttributes(attributes) Edit message attributes. Parameters: Name Type Description attributes any new attributes for Message. Returns: Type Promise.&lt;Message&gt; updateBody(body) Edit message body. Parameters: Name Type Description body String new body of Message. Returns: Type Promise.&lt;Message&gt; Type Definitions UpdateReason The update reason for updated event emitted on Message Type: 'body' | 'lastUpdatedBy' | 'dateCreated' | 'dateUpdated' | 'attributes' | 'author' | 'deliveryReceipt' | 'subject' Events updated Fired when the Message's properties or body has been updated. Type: Object Properties: Name Type Description message Message Updated Message updateReasons Array.&lt;Message#UpdateReason&gt; Array of Message's updated event reasons × Search results Close Documentation generated by JSDoc 3.5.5 on 2021-06-30T16:21:28+00:00 using the DocStrap template. "},"Paginator.html":{"id":"Paginator.html","title":"Class: Paginator","body":" Documentation Classes AggregatedDeliveryReceiptClientConversationDetailedDeliveryReceiptMediaMessagePaginatorParticipantPushNotificationSessionErrorUser Events Client#event:connectionErrorClient#event:connectionStateChangedClient#event:conversationAddedClient#event:conversationJoinedClient#event:conversationLeftClient#event:conversationRemovedClient#event:conversationUpdatedClient#event:messageAddedClient#event:messageRemovedClient#event:messageUpdatedClient#event:participantJoinedClient#event:participantLeftClient#event:participantUpdatedClient#event:pushNotificationClient#event:tokenAboutToExpireClient#event:tokenExpiredClient#event:typingEndedClient#event:typingStartedClient#event:userSubscribedClient#event:userUnsubscribedClient#event:userUpdatedConversation#event:messageAddedConversation#event:messageRemovedConversation#event:messageUpdatedConversation#event:participantJoinedConversation#event:participantLeftConversation#event:participantUpdatedConversation#event:removedConversation#event:typingEndedConversation#event:typingStartedConversation#event:updatedMessage#event:updatedParticipant#event:typingEndedParticipant#event:typingStartedParticipant#event:updatedUser#event:updatedUser#event:userSubscribedUser#event:userUnsubscribed Class: Paginator Paginator Pagination helper class. new Paginator() Properties: Name Type Description items Array Array of elements of type T on current page hasNextPage boolean Indicates the existence of next page hasPrevPage boolean Indicates the existence of previous page Methods nextPage() Request next page. Does not modify existing object. Returns: Type Promise.&lt;Paginator.&lt;T&gt;&gt; prevPage() Request previous page. Does not modify existing object. Returns: Type Promise.&lt;Paginator.&lt;T&gt;&gt; × Search results Close Documentation generated by JSDoc 3.5.5 on 2021-06-30T16:21:28+00:00 using the DocStrap template. "},"Participant.html":{"id":"Participant.html","title":"Class: Participant","body":" Documentation Classes AggregatedDeliveryReceiptClientConversationDetailedDeliveryReceiptMediaMessagePaginatorParticipantPushNotificationSessionErrorUser Events Client#event:connectionErrorClient#event:connectionStateChangedClient#event:conversationAddedClient#event:conversationJoinedClient#event:conversationLeftClient#event:conversationRemovedClient#event:conversationUpdatedClient#event:messageAddedClient#event:messageRemovedClient#event:messageUpdatedClient#event:participantJoinedClient#event:participantLeftClient#event:participantUpdatedClient#event:pushNotificationClient#event:tokenAboutToExpireClient#event:tokenExpiredClient#event:typingEndedClient#event:typingStartedClient#event:userSubscribedClient#event:userUnsubscribedClient#event:userUpdatedConversation#event:messageAddedConversation#event:messageRemovedConversation#event:messageUpdatedConversation#event:participantJoinedConversation#event:participantLeftConversation#event:participantUpdatedConversation#event:removedConversation#event:typingEndedConversation#event:typingStartedConversation#event:updatedMessage#event:updatedParticipant#event:typingEndedParticipant#event:typingStartedParticipant#event:updatedUser#event:updatedUser#event:userSubscribedUser#event:userUnsubscribed Class: Participant Participant A Participant represents a remote Client in a Conversation. new Participant() Properties: Name Type Description attributes any Object with custom attributes for Participant conversation Conversation The Conversation the remote Client is a Participant of dateCreated Date The Date this Participant was created dateUpdated Date The Date this Participant was last updated identity String The identity of the remote Client isTyping Boolean Whether or not this Participant is currently typing lastReadMessageIndex Number | null Latest read Message index by this Participant. Note that just retrieving messages on a client endpoint does not mean that messages are read, please consider reading about Read Horizon feature to find out how to mark messages as read. lastReadTimestamp Date Date when Participant has updated his read horizon sid String The server-assigned unique identifier for the Participant type Participant#Type The type of Participant Fires: Participant#event:typingEnded Participant#event:typingStarted Participant#event:updated Members bindings Get the bindings mapping for the current participant. Available binding depends on the participant type. You could access it as `participant.bindings.sms?.address` or using the type dynamically `participant.bindings[participant.type]` just be aware that the binding information has different structure for each participant type. See also {EmailBinding}, the only available binding descriptor available currently. Methods getUser() Gets User for this participant and subscribes to it. Supported only for chat type of Participants Returns: Type Promise.&lt;User&gt; remove() Remove Participant from the Conversation. Returns: Type Promise.&lt;void&gt; updateAttributes(attributes) Edit participant attributes. Parameters: Name Type Description attributes any new attributes for Participant. Returns: Type Promise.&lt;Participant&gt; Type Definitions Type The type of Participant Type: 'chat' | 'sms' | 'whatsapp' | 'email' UpdateReason The update reason for updated event emitted on Participant Type: 'attributes' | 'dateCreated' | 'dateUpdated' | 'roleSid' | 'lastReadMessageIndex' | 'lastReadTimestamp' | 'bindings' Events typingEnded Fired when Participant ended to type. Type: Participant typingStarted Fired when Participant started to type. Type: Participant updated Fired when Participant's fields has been updated. Type: Object Properties: Name Type Description participant Participant Updated Participant updateReasons Array.&lt;Participant#UpdateReason&gt; Array of Participant's updated event reasons × Search results Close Documentation generated by JSDoc 3.5.5 on 2021-06-30T16:21:28+00:00 using the DocStrap template. "},"PushNotification.html":{"id":"PushNotification.html","title":"Class: PushNotification","body":" Documentation Classes AggregatedDeliveryReceiptClientConversationDetailedDeliveryReceiptMediaMessagePaginatorParticipantPushNotificationSessionErrorUser Events Client#event:connectionErrorClient#event:connectionStateChangedClient#event:conversationAddedClient#event:conversationJoinedClient#event:conversationLeftClient#event:conversationRemovedClient#event:conversationUpdatedClient#event:messageAddedClient#event:messageRemovedClient#event:messageUpdatedClient#event:participantJoinedClient#event:participantLeftClient#event:participantUpdatedClient#event:pushNotificationClient#event:tokenAboutToExpireClient#event:tokenExpiredClient#event:typingEndedClient#event:typingStartedClient#event:userSubscribedClient#event:userUnsubscribedClient#event:userUpdatedConversation#event:messageAddedConversation#event:messageRemovedConversation#event:messageUpdatedConversation#event:participantJoinedConversation#event:participantLeftConversation#event:participantUpdatedConversation#event:removedConversation#event:typingEndedConversation#event:typingStartedConversation#event:updatedMessage#event:updatedParticipant#event:typingEndedParticipant#event:typingStartedParticipant#event:updatedUser#event:updatedUser#event:userSubscribedUser#event:userUnsubscribed Class: PushNotification PushNotification Push notification representation within Conversations Client new PushNotification(data) Parameters: Name Type Description data PushNotification.Descriptor initial data for PushNotification Properties: Name Type Argument Description action String &lt;optional&gt; Notification action (`click_action` in FCM/GCM terms and `category` in APN terms) badge Number &lt;optional&gt; Number for the badge body String Notification text data PushNotification#ConversationData Additional Conversation data sound String &lt;optional&gt; Notification sound title String &lt;optional&gt; Notification title type PushNotification#NotificationType Notification type Type Definitions ConversationData Additional Conversations data for given Push Notification Type: Object Properties: Name Type Argument Description conversationSid String &lt;optional&gt; SID of Conversation messageIndex Number &lt;optional&gt; Index of Message in Conversation messageSid String &lt;optional&gt; SID of Message NotificationType Conversation push notification type Type: 'twilio.conversations.new_message' | 'twilio.conversations.added_to_conversation' | 'twilio.conversations.removed_from_conversation' × Search results Close Documentation generated by JSDoc 3.5.5 on 2021-06-30T16:21:28+00:00 using the DocStrap template. "},"SessionError.html":{"id":"SessionError.html","title":"Class: SessionError","body":" Documentation Classes AggregatedDeliveryReceiptClientConversationDetailedDeliveryReceiptMediaMessagePaginatorParticipantPushNotificationSessionErrorUser Events Client#event:connectionErrorClient#event:connectionStateChangedClient#event:conversationAddedClient#event:conversationJoinedClient#event:conversationLeftClient#event:conversationRemovedClient#event:conversationUpdatedClient#event:messageAddedClient#event:messageRemovedClient#event:messageUpdatedClient#event:participantJoinedClient#event:participantLeftClient#event:participantUpdatedClient#event:pushNotificationClient#event:tokenAboutToExpireClient#event:tokenExpiredClient#event:typingEndedClient#event:typingStartedClient#event:userSubscribedClient#event:userUnsubscribedClient#event:userUpdatedConversation#event:messageAddedConversation#event:messageRemovedConversation#event:messageUpdatedConversation#event:participantJoinedConversation#event:participantLeftConversation#event:participantUpdatedConversation#event:removedConversation#event:typingEndedConversation#event:typingStartedConversation#event:updatedMessage#event:updatedParticipant#event:typingEndedParticipant#event:typingStartedParticipant#event:updatedUser#event:updatedUser#event:userSubscribedUser#event:userUnsubscribed Class: SessionError SessionError Exception type for service-side errors. new SessionError() Properties: Name Type Description code Number Error code message String Error description × Search results Close Documentation generated by JSDoc 3.5.5 on 2021-06-30T16:21:28+00:00 using the DocStrap template. "},"User.html":{"id":"User.html","title":"Class: User","body":" Documentation Classes AggregatedDeliveryReceiptClientConversationDetailedDeliveryReceiptMediaMessagePaginatorParticipantPushNotificationSessionErrorUser Events Client#event:connectionErrorClient#event:connectionStateChangedClient#event:conversationAddedClient#event:conversationJoinedClient#event:conversationLeftClient#event:conversationRemovedClient#event:conversationUpdatedClient#event:messageAddedClient#event:messageRemovedClient#event:messageUpdatedClient#event:participantJoinedClient#event:participantLeftClient#event:participantUpdatedClient#event:pushNotificationClient#event:tokenAboutToExpireClient#event:tokenExpiredClient#event:typingEndedClient#event:typingStartedClient#event:userSubscribedClient#event:userUnsubscribedClient#event:userUpdatedConversation#event:messageAddedConversation#event:messageRemovedConversation#event:messageUpdatedConversation#event:participantJoinedConversation#event:participantLeftConversation#event:participantUpdatedConversation#event:removedConversation#event:typingEndedConversation#event:typingStartedConversation#event:updatedMessage#event:updatedParticipant#event:typingEndedParticipant#event:typingStartedParticipant#event:updatedUser#event:updatedUser#event:userSubscribedUser#event:userUnsubscribed Class: User User Extended user information. Note that isOnline and isNotifiable properties are eligible to use only if reachability function is enabled. You may check if it is enabled by reading value of Client's reachabilityEnabled property. new User(identity, entityId, datasync, session) Parameters: Name Type Description identity String Identity of user entityId String id of user's object datasync Object datasync service session Object session service Properties: Name Type Description identity String User identity friendlyName String User friendly name, null if not set attributes any Object with custom attributes for user isOnline Boolean User real-time conversation connection status isNotifiable Boolean User push notification registration status isSubscribed Boolean Check if this user receives real-time status updates Fires: User#event:updated User#event:userSubscribed User#event:userUnsubscribed Methods unsubscribe() Removes User from subscription list. Returns: Promise of completion Type Promise.&lt;void&gt; updateAttributes(attributes) Updates user attributes. Parameters: Name Type Description attributes any new attributes for User. Returns: Type Promise.&lt;User&gt; updateFriendlyName(friendlyName) Update Users friendlyName. Parameters: Name Type Description friendlyName String | null Updated friendlyName Returns: Type Promise.&lt;User&gt; Type Definitions UpdateReason The update reason for updated event emitted on User Type: 'friendlyName' | 'attributes' | 'reachabilityOnline' | 'reachabilityNotifiable' Events updated Fired when User's properties or reachability status have been updated. Type: Object Properties: Name Type Description user User Updated User updateReasons Array.&lt;User#UpdateReason&gt; Array of User's updated event reasons userSubscribed Fired when Client is subscribed to User. Type: User userUnsubscribed Fired when Client is unsubscribed from this User. Type: User × Search results Close Documentation generated by JSDoc 3.5.5 on 2021-06-30T16:21:28+00:00 using the DocStrap template. "}}
10
- </script>
11
-
12
- <script type="text/javascript">
13
- $(document).ready(function() {
14
- Searcher.init();
15
- });
16
-
17
- $(window).on("message", function(msg) {
18
- var msgData = msg.originalEvent.data;
19
-
20
- if (msgData.msgid != "docstrap.quicksearch.start") {
21
- return;
22
- }
23
-
24
- var results = Searcher.search(msgData.searchTerms);
25
-
26
- window.parent.postMessage({"results": results, "msgid": "docstrap.quicksearch.done"}, "*");
27
- });
28
- </script>
29
-
30
-
31
- </body></html>