@twilio/conversations 1.3.0-rc7 → 2.0.0-rc.3

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 +201 -0
  2. package/README.md +5 -5
  3. package/dist/browser.js +7866 -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 +3387 -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 +3169 -0
  33. package/dist/docs/modules.html +3418 -0
  34. package/dist/lib.d.ts +1944 -0
  35. package/dist/lib.js +7866 -0
  36. package/dist/lib.js.map +1 -0
  37. package/dist/post-install.js +29 -0
  38. package/dist/react-native.js +4031 -0
  39. package/dist/react-native.js.map +1 -0
  40. package/dist/twilio-conversations.js +40905 -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 -665
  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 -35565
  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 -318
  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
@@ -1,5075 +0,0 @@
1
- <!DOCTYPE html><html lang="en"><head>
2
- <meta charset="utf-8">
3
- <meta name="viewport" content="width=device-width">
4
- <title>Documentation Class: Client</title>
5
-
6
- <!--[if lt IE 9]>
7
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
8
- <![endif]-->
9
- <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
10
-
11
- <link type="text/css" rel="stylesheet" href="styles/site.simplex.css">
12
-
13
- </head>
14
-
15
- <body>
16
-
17
- <div class="navbar navbar-default navbar-fixed-top ">
18
- <div class="container">
19
- <div class="navbar-header">
20
- <a class="navbar-brand" href="index.html">Documentation</a>
21
- <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation">
22
- <span class="icon-bar"></span>
23
- <span class="icon-bar"></span>
24
- <span class="icon-bar"></span>
25
- </button>
26
- </div>
27
- <div class="navbar-collapse collapse" id="topNavigation">
28
- <ul class="nav navbar-nav"><li class="dropdown"><a class="dropdown-toggle" data-toggle="dropdown" aria-expanded="false">Classes<b class="caret"></b></a><ul class="dropdown-menu"><li><a href="Client.html"><span style="color: #999">Twilio.Conversations.</span>Client</a></li><li><a href="Conversation.html">Conversation</a></li><li><a href="Participant.html">Participant</a></li><li><a href="Message.html">Message</a></li><li><a href="Media.html">Media</a></li><li><a href="AggregatedDeliveryReceipt.html">AggregatedDeliveryReceipt</a></li><li><a href="DetailedDeliveryReceipt.html">DetailedDeliveryReceipt</a></li><li><a href="User.html">User</a></li><li><a href="Paginator.html">Paginator</a></li><li><a href="PushNotification.html">PushNotification</a></li></ul></li><li class="dropdown"><a class="dropdown-toggle" data-toggle="dropdown" aria-expanded="false">Exceptions<b class="caret"></b></a><ul class="dropdown-menu"><li><a href="SessionError.html">SessionError</a></li></ul></li></ul>
29
-
30
- <div class="col-sm-3 col-md-3">
31
- <form class="navbar-form" role="search">
32
- <div class="input-group">
33
- <input type="text" class="form-control" placeholder="Search" name="q" id="search-input">
34
- <div class="input-group-btn">
35
- <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button>
36
- </div>
37
- </div>
38
- </form>
39
- </div>
40
-
41
- </div>
42
-
43
- </div>
44
- </div>
45
-
46
-
47
- <div class="container" id="toc-content">
48
- <div class="row">
49
-
50
-
51
- <div class="col-md-8">
52
-
53
- <div id="main">
54
-
55
-
56
- <h1 class="page-title">Class: Client</h1>
57
- <section>
58
-
59
- <header>
60
-
61
- <h2>
62
- Client
63
- </h2>
64
-
65
- <div class="class-description">A Client is a starting point to access Twilio Conversations functionality.</div>
66
-
67
-
68
- </header>
69
-
70
-
71
- <article>
72
- <div class="container-overview">
73
-
74
-
75
- <hr>
76
- <dt>
77
-
78
-
79
-
80
- </dt>
81
- <dd>
82
-
83
-
84
-
85
-
86
-
87
-
88
-
89
-
90
-
91
-
92
-
93
- <dl class="details">
94
-
95
-
96
- <h5 class="subsection-title">Properties:</h5>
97
-
98
- <dl>
99
-
100
- <table class="props table table-striped">
101
- <thead>
102
- <tr>
103
-
104
- <th>Name</th>
105
-
106
-
107
- <th>Type</th>
108
-
109
-
110
-
111
-
112
-
113
- <th class="last">Description</th>
114
- </tr>
115
- </thead>
116
-
117
- <tbody>
118
-
119
-
120
- <tr>
121
-
122
- <td class="name"><code>connectionState</code></td>
123
-
124
-
125
- <td class="type">
126
-
127
-
128
- <span class="param-type"><a href="Client.html#ConnectionState">Client#ConnectionState</a></span>
129
-
130
-
131
-
132
-
133
- </td>
134
-
135
-
136
-
137
-
138
-
139
- <td class="description last">Client connection state</td>
140
- </tr>
141
-
142
-
143
-
144
- <tr>
145
-
146
- <td class="name"><code>reachabilityEnabled</code></td>
147
-
148
-
149
- <td class="type">
150
-
151
-
152
- <span class="param-type">Boolean</span>
153
-
154
-
155
-
156
-
157
- </td>
158
-
159
-
160
-
161
-
162
-
163
- <td class="description last">Client reachability state</td>
164
- </tr>
165
-
166
-
167
-
168
- <tr>
169
-
170
- <td class="name"><code>user</code></td>
171
-
172
-
173
- <td class="type">
174
-
175
-
176
- <span class="param-type"><a href="User.html">User</a></span>
177
-
178
-
179
-
180
-
181
- </td>
182
-
183
-
184
-
185
-
186
-
187
- <td class="description last">Information for logged in user</td>
188
- </tr>
189
-
190
-
191
-
192
- <tr>
193
-
194
- <td class="name"><code>version</code></td>
195
-
196
-
197
- <td class="type">
198
-
199
-
200
- <span class="param-type">String</span>
201
-
202
-
203
-
204
-
205
- </td>
206
-
207
-
208
-
209
-
210
-
211
- <td class="description last">Current version of Conversations client</td>
212
- </tr>
213
-
214
-
215
- </tbody>
216
- </table>
217
- </dl>
218
-
219
-
220
-
221
-
222
-
223
-
224
-
225
-
226
-
227
-
228
-
229
-
230
-
231
-
232
-
233
-
234
-
235
-
236
-
237
-
238
-
239
-
240
-
241
-
242
-
243
-
244
-
245
-
246
-
247
-
248
-
249
-
250
-
251
-
252
-
253
-
254
- </dl>
255
-
256
-
257
-
258
-
259
-
260
- <h5>Fires:</h5>
261
- <ul>
262
- <li><a href="Client.html#event:connectionError">Client#event:connectionError</a></li>
263
-
264
- <li><a href="Client.html#event:connectionStateChanged">Client#event:connectionStateChanged</a></li>
265
-
266
- <li><a href="Client.html#event:conversationAdded">Client#event:conversationAdded</a></li>
267
-
268
- <li><a href="Client.html#event:conversationJoined">Client#event:conversationJoined</a></li>
269
-
270
- <li><a href="Client.html#event:conversationLeft">Client#event:conversationLeft</a></li>
271
-
272
- <li><a href="Client.html#event:conversationRemoved">Client#event:conversationRemoved</a></li>
273
-
274
- <li><a href="Client.html#event:conversationUpdated">Client#event:conversationUpdated</a></li>
275
-
276
- <li><a href="Client.html#event:participantJoined">Client#event:participantJoined</a></li>
277
-
278
- <li><a href="Client.html#event:participantLeft">Client#event:participantLeft</a></li>
279
-
280
- <li><a href="Client.html#event:participantUpdated">Client#event:participantUpdated</a></li>
281
-
282
- <li><a href="Client.html#event:messageAdded">Client#event:messageAdded</a></li>
283
-
284
- <li><a href="Client.html#event:messageRemoved">Client#event:messageRemoved</a></li>
285
-
286
- <li><a href="Client.html#event:messageUpdated">Client#event:messageUpdated</a></li>
287
-
288
- <li><a href="Client.html#event:pushNotification">Client#event:pushNotification</a></li>
289
-
290
- <li><a href="Client.html#event:tokenAboutToExpire">Client#event:tokenAboutToExpire</a></li>
291
-
292
- <li><a href="Client.html#event:tokenExpired">Client#event:tokenExpired</a></li>
293
-
294
- <li><a href="Client.html#event:typingEnded">Client#event:typingEnded</a></li>
295
-
296
- <li><a href="Client.html#event:typingStarted">Client#event:typingStarted</a></li>
297
-
298
- <li><a href="Client.html#event:userSubscribed">Client#event:userSubscribed</a></li>
299
-
300
- <li><a href="Client.html#event:userUnsubscribed">Client#event:userUnsubscribed</a></li>
301
-
302
- <li><a href="Client.html#event:userUpdated">Client#event:userUpdated</a></li>
303
- </ul>
304
-
305
-
306
-
307
-
308
-
309
-
310
-
311
-
312
-
313
-
314
-
315
- </dd>
316
-
317
-
318
- </div>
319
-
320
-
321
-
322
-
323
-
324
-
325
-
326
-
327
-
328
-
329
-
330
-
331
-
332
-
333
- <h3 class="subsection-title">Methods</h3>
334
-
335
- <dl>
336
-
337
- <hr>
338
- <dt>
339
- <h4 class="name" id=".create"><span class="type-signature">&lt;static&gt; </span>create(token [, options])</h4>
340
-
341
-
342
- </dt>
343
- <dd>
344
-
345
-
346
- <div class="description">
347
- Factory method to create Conversations client instance.
348
- </div>
349
-
350
-
351
-
352
-
353
-
354
-
355
-
356
-
357
- <h5>Parameters:</h5>
358
-
359
-
360
- <table class="params table table-striped">
361
- <thead>
362
- <tr>
363
-
364
- <th>Name</th>
365
-
366
-
367
- <th>Type</th>
368
-
369
-
370
- <th>Argument</th>
371
-
372
-
373
-
374
-
375
- <th class="last">Description</th>
376
- </tr>
377
- </thead>
378
-
379
- <tbody>
380
-
381
-
382
- <tr>
383
-
384
- <td class="name"><code>token</code></td>
385
-
386
-
387
- <td class="type">
388
-
389
-
390
- <span class="param-type">String</span>
391
-
392
-
393
-
394
-
395
- </td>
396
-
397
-
398
- <td class="attributes">
399
-
400
-
401
-
402
-
403
-
404
- </td>
405
-
406
-
407
-
408
-
409
- <td class="description last">Access token</td>
410
- </tr>
411
-
412
-
413
-
414
- <tr>
415
-
416
- <td class="name"><code>options</code></td>
417
-
418
-
419
- <td class="type">
420
-
421
-
422
- <span class="param-type"><a href="Client.html#ClientOptions">Client#ClientOptions</a></span>
423
-
424
-
425
-
426
-
427
- </td>
428
-
429
-
430
- <td class="attributes">
431
-
432
- &lt;optional&gt;<br>
433
-
434
-
435
-
436
-
437
-
438
- </td>
439
-
440
-
441
-
442
-
443
- <td class="description last">Options to customize the Client</td>
444
- </tr>
445
-
446
-
447
- </tbody>
448
- </table>
449
-
450
-
451
-
452
-
453
- <dl class="details">
454
-
455
-
456
-
457
-
458
-
459
-
460
-
461
-
462
-
463
-
464
-
465
-
466
-
467
-
468
-
469
-
470
-
471
-
472
-
473
-
474
-
475
-
476
-
477
-
478
-
479
-
480
-
481
-
482
-
483
-
484
-
485
-
486
-
487
-
488
-
489
- </dl>
490
-
491
-
492
-
493
-
494
-
495
-
496
-
497
-
498
-
499
-
500
-
501
-
502
-
503
- <h5>Returns:</h5>
504
-
505
-
506
-
507
-
508
- <dl>
509
- <dt>
510
- Type
511
- </dt>
512
- <dd>
513
-
514
- <span class="param-type">Promise.&lt;<a href="Client.html">Client</a>&gt;</span>
515
-
516
-
517
-
518
- </dd>
519
- </dl>
520
-
521
-
522
-
523
-
524
-
525
- </dd>
526
-
527
-
528
-
529
- <hr>
530
- <dt>
531
- <h4 class="name" id=".parsePushNotification"><span class="type-signature">&lt;static&gt; </span>parsePushNotification(notificationPayload)</h4>
532
-
533
-
534
- </dt>
535
- <dd>
536
-
537
-
538
- <div class="description">
539
- Static method for push notification payload parsing. Returns parsed push as <a href="PushNotification.html">PushNotification</a> object
540
- </div>
541
-
542
-
543
-
544
-
545
-
546
-
547
-
548
-
549
- <h5>Parameters:</h5>
550
-
551
-
552
- <table class="params table table-striped">
553
- <thead>
554
- <tr>
555
-
556
- <th>Name</th>
557
-
558
-
559
- <th>Type</th>
560
-
561
-
562
-
563
-
564
-
565
- <th class="last">Description</th>
566
- </tr>
567
- </thead>
568
-
569
- <tbody>
570
-
571
-
572
- <tr>
573
-
574
- <td class="name"><code>notificationPayload</code></td>
575
-
576
-
577
- <td class="type">
578
-
579
-
580
- <span class="param-type">Object</span>
581
-
582
-
583
-
584
-
585
- </td>
586
-
587
-
588
-
589
-
590
-
591
- <td class="description last">Push notification payload</td>
592
- </tr>
593
-
594
-
595
- </tbody>
596
- </table>
597
-
598
-
599
-
600
-
601
- <dl class="details">
602
-
603
-
604
-
605
-
606
-
607
-
608
-
609
-
610
-
611
-
612
-
613
-
614
-
615
-
616
-
617
-
618
-
619
-
620
-
621
-
622
-
623
-
624
-
625
-
626
-
627
-
628
-
629
-
630
-
631
-
632
-
633
-
634
-
635
-
636
-
637
- </dl>
638
-
639
-
640
-
641
-
642
-
643
-
644
-
645
-
646
-
647
-
648
-
649
-
650
-
651
- <h5>Returns:</h5>
652
-
653
-
654
-
655
-
656
- <dl>
657
- <dt>
658
- Type
659
- </dt>
660
- <dd>
661
-
662
- <span class="param-type"><a href="PushNotification.html">PushNotification</a></span>
663
- |
664
-
665
- <span class="param-type">Error</span>
666
-
667
-
668
-
669
- </dd>
670
- </dl>
671
-
672
-
673
-
674
-
675
-
676
- </dd>
677
-
678
-
679
-
680
- <hr>
681
- <dt>
682
- <h4 class="name" id="createConversation"><span class="type-signature"></span>createConversation( [options])</h4>
683
-
684
-
685
- </dt>
686
- <dd>
687
-
688
-
689
- <div class="description">
690
- Create a Conversation on the server and subscribe to its events.
691
- The default is a Conversation with an empty friendlyName.
692
- </div>
693
-
694
-
695
-
696
-
697
-
698
-
699
-
700
-
701
- <h5>Parameters:</h5>
702
-
703
-
704
- <table class="params table table-striped">
705
- <thead>
706
- <tr>
707
-
708
- <th>Name</th>
709
-
710
-
711
- <th>Type</th>
712
-
713
-
714
- <th>Argument</th>
715
-
716
-
717
-
718
-
719
- <th class="last">Description</th>
720
- </tr>
721
- </thead>
722
-
723
- <tbody>
724
-
725
-
726
- <tr>
727
-
728
- <td class="name"><code>options</code></td>
729
-
730
-
731
- <td class="type">
732
-
733
-
734
- <span class="param-type"><a href="Client.html#CreateConversationOptions">Client#CreateConversationOptions</a></span>
735
-
736
-
737
-
738
-
739
- </td>
740
-
741
-
742
- <td class="attributes">
743
-
744
- &lt;optional&gt;<br>
745
-
746
-
747
-
748
-
749
-
750
- </td>
751
-
752
-
753
-
754
-
755
- <td class="description last">Options for the Conversation</td>
756
- </tr>
757
-
758
-
759
- </tbody>
760
- </table>
761
-
762
-
763
-
764
-
765
- <dl class="details">
766
-
767
-
768
-
769
-
770
-
771
-
772
-
773
-
774
-
775
-
776
-
777
-
778
-
779
-
780
-
781
-
782
-
783
-
784
-
785
-
786
-
787
-
788
-
789
-
790
-
791
-
792
-
793
-
794
-
795
-
796
-
797
-
798
-
799
-
800
-
801
- </dl>
802
-
803
-
804
-
805
-
806
-
807
-
808
-
809
-
810
-
811
-
812
-
813
-
814
-
815
- <h5>Returns:</h5>
816
-
817
-
818
-
819
-
820
- <dl>
821
- <dt>
822
- Type
823
- </dt>
824
- <dd>
825
-
826
- <span class="param-type">Promise.&lt;<a href="Conversation.html">Conversation</a>&gt;</span>
827
-
828
-
829
-
830
- </dd>
831
- </dl>
832
-
833
-
834
-
835
-
836
-
837
- </dd>
838
-
839
-
840
-
841
- <hr>
842
- <dt>
843
- <h4 class="name" id="getConversationBySid"><span class="type-signature"></span>getConversationBySid(conversationSid)</h4>
844
-
845
-
846
- </dt>
847
- <dd>
848
-
849
-
850
- <div class="description">
851
- Get a known Conversation by its SID.
852
- </div>
853
-
854
-
855
-
856
-
857
-
858
-
859
-
860
-
861
- <h5>Parameters:</h5>
862
-
863
-
864
- <table class="params table table-striped">
865
- <thead>
866
- <tr>
867
-
868
- <th>Name</th>
869
-
870
-
871
- <th>Type</th>
872
-
873
-
874
-
875
-
876
-
877
- <th class="last">Description</th>
878
- </tr>
879
- </thead>
880
-
881
- <tbody>
882
-
883
-
884
- <tr>
885
-
886
- <td class="name"><code>conversationSid</code></td>
887
-
888
-
889
- <td class="type">
890
-
891
-
892
- <span class="param-type">String</span>
893
-
894
-
895
-
896
-
897
- </td>
898
-
899
-
900
-
901
-
902
-
903
- <td class="description last">Conversation sid</td>
904
- </tr>
905
-
906
-
907
- </tbody>
908
- </table>
909
-
910
-
911
-
912
-
913
- <dl class="details">
914
-
915
-
916
-
917
-
918
-
919
-
920
-
921
-
922
-
923
-
924
-
925
-
926
-
927
-
928
-
929
-
930
-
931
-
932
-
933
-
934
-
935
-
936
-
937
-
938
-
939
-
940
-
941
-
942
-
943
-
944
-
945
-
946
-
947
-
948
-
949
- </dl>
950
-
951
-
952
-
953
-
954
-
955
-
956
-
957
-
958
-
959
-
960
-
961
-
962
-
963
- <h5>Returns:</h5>
964
-
965
-
966
-
967
-
968
- <dl>
969
- <dt>
970
- Type
971
- </dt>
972
- <dd>
973
-
974
- <span class="param-type">Promise.&lt;<a href="Conversation.html">Conversation</a>&gt;</span>
975
-
976
-
977
-
978
- </dd>
979
- </dl>
980
-
981
-
982
-
983
-
984
-
985
- </dd>
986
-
987
-
988
-
989
- <hr>
990
- <dt>
991
- <h4 class="name" id="getConversationByUniqueName"><span class="type-signature"></span>getConversationByUniqueName(uniqueName)</h4>
992
-
993
-
994
- </dt>
995
- <dd>
996
-
997
-
998
- <div class="description">
999
- Get a known Conversation by its unique identifier name.
1000
- </div>
1001
-
1002
-
1003
-
1004
-
1005
-
1006
-
1007
-
1008
-
1009
- <h5>Parameters:</h5>
1010
-
1011
-
1012
- <table class="params table table-striped">
1013
- <thead>
1014
- <tr>
1015
-
1016
- <th>Name</th>
1017
-
1018
-
1019
- <th>Type</th>
1020
-
1021
-
1022
-
1023
-
1024
-
1025
- <th class="last">Description</th>
1026
- </tr>
1027
- </thead>
1028
-
1029
- <tbody>
1030
-
1031
-
1032
- <tr>
1033
-
1034
- <td class="name"><code>uniqueName</code></td>
1035
-
1036
-
1037
- <td class="type">
1038
-
1039
-
1040
- <span class="param-type">String</span>
1041
-
1042
-
1043
-
1044
-
1045
- </td>
1046
-
1047
-
1048
-
1049
-
1050
-
1051
- <td class="description last">The unique identifier name of the Conversation to get</td>
1052
- </tr>
1053
-
1054
-
1055
- </tbody>
1056
- </table>
1057
-
1058
-
1059
-
1060
-
1061
- <dl class="details">
1062
-
1063
-
1064
-
1065
-
1066
-
1067
-
1068
-
1069
-
1070
-
1071
-
1072
-
1073
-
1074
-
1075
-
1076
-
1077
-
1078
-
1079
-
1080
-
1081
-
1082
-
1083
-
1084
-
1085
-
1086
-
1087
-
1088
-
1089
-
1090
-
1091
-
1092
-
1093
-
1094
-
1095
-
1096
-
1097
- </dl>
1098
-
1099
-
1100
-
1101
-
1102
-
1103
-
1104
-
1105
-
1106
-
1107
-
1108
-
1109
-
1110
-
1111
- <h5>Returns:</h5>
1112
-
1113
-
1114
-
1115
-
1116
- <dl>
1117
- <dt>
1118
- Type
1119
- </dt>
1120
- <dd>
1121
-
1122
- <span class="param-type">Promise.&lt;<a href="Conversation.html">Conversation</a>&gt;</span>
1123
-
1124
-
1125
-
1126
- </dd>
1127
- </dl>
1128
-
1129
-
1130
-
1131
-
1132
-
1133
- </dd>
1134
-
1135
-
1136
-
1137
- <hr>
1138
- <dt>
1139
- <h4 class="name" id="getSubscribedConversations"><span class="type-signature"></span>getSubscribedConversations()</h4>
1140
-
1141
-
1142
- </dt>
1143
- <dd>
1144
-
1145
-
1146
- <div class="description">
1147
- Get the current list of all subscribed Conversations.
1148
- </div>
1149
-
1150
-
1151
-
1152
-
1153
-
1154
-
1155
-
1156
-
1157
-
1158
-
1159
- <dl class="details">
1160
-
1161
-
1162
-
1163
-
1164
-
1165
-
1166
-
1167
-
1168
-
1169
-
1170
-
1171
-
1172
-
1173
-
1174
-
1175
-
1176
-
1177
-
1178
-
1179
-
1180
-
1181
-
1182
-
1183
-
1184
-
1185
-
1186
-
1187
-
1188
-
1189
-
1190
-
1191
-
1192
-
1193
-
1194
-
1195
- </dl>
1196
-
1197
-
1198
-
1199
-
1200
-
1201
-
1202
-
1203
-
1204
-
1205
-
1206
-
1207
-
1208
-
1209
- <h5>Returns:</h5>
1210
-
1211
-
1212
-
1213
-
1214
- <dl>
1215
- <dt>
1216
- Type
1217
- </dt>
1218
- <dd>
1219
-
1220
- <span class="param-type">Promise.&lt;<a href="Paginator.html">Paginator</a>.&lt;<a href="Conversation.html">Conversation</a>&gt;&gt;</span>
1221
-
1222
-
1223
-
1224
- </dd>
1225
- </dl>
1226
-
1227
-
1228
-
1229
-
1230
-
1231
- </dd>
1232
-
1233
-
1234
-
1235
- <hr>
1236
- <dt>
1237
- <h4 class="name" id="getSubscribedUsers"><span class="type-signature"></span>getSubscribedUsers()</h4>
1238
-
1239
-
1240
- </dt>
1241
- <dd>
1242
-
1243
-
1244
-
1245
-
1246
-
1247
-
1248
-
1249
-
1250
-
1251
-
1252
-
1253
- <dl class="details">
1254
-
1255
-
1256
-
1257
-
1258
-
1259
-
1260
-
1261
-
1262
-
1263
-
1264
-
1265
-
1266
-
1267
-
1268
-
1269
-
1270
-
1271
-
1272
-
1273
-
1274
-
1275
-
1276
-
1277
-
1278
-
1279
-
1280
-
1281
-
1282
-
1283
-
1284
-
1285
-
1286
-
1287
-
1288
-
1289
- </dl>
1290
-
1291
-
1292
-
1293
-
1294
-
1295
-
1296
-
1297
-
1298
-
1299
-
1300
-
1301
-
1302
-
1303
- <h5>Returns:</h5>
1304
-
1305
-
1306
- <div class="param-desc">
1307
- List of subscribed User objects
1308
- </div>
1309
-
1310
-
1311
-
1312
- <dl>
1313
- <dt>
1314
- Type
1315
- </dt>
1316
- <dd>
1317
-
1318
- <span class="param-type">Promise.&lt;Array.&lt;<a href="User.html">User</a>&gt;&gt;</span>
1319
-
1320
-
1321
-
1322
- </dd>
1323
- </dl>
1324
-
1325
-
1326
-
1327
-
1328
-
1329
- </dd>
1330
-
1331
-
1332
-
1333
- <hr>
1334
- <dt>
1335
- <h4 class="name" id="getUser"><span class="type-signature"></span>getUser(identity)</h4>
1336
-
1337
-
1338
- </dt>
1339
- <dd>
1340
-
1341
-
1342
- <div class="description">
1343
- Gets user for given identity, if it&apos;s in subscribed list - then return the user object from it,
1344
- if not - then subscribes and adds user to the subscribed list.
1345
- </div>
1346
-
1347
-
1348
-
1349
-
1350
-
1351
-
1352
-
1353
-
1354
- <h5>Parameters:</h5>
1355
-
1356
-
1357
- <table class="params table table-striped">
1358
- <thead>
1359
- <tr>
1360
-
1361
- <th>Name</th>
1362
-
1363
-
1364
- <th>Type</th>
1365
-
1366
-
1367
-
1368
-
1369
-
1370
- <th class="last">Description</th>
1371
- </tr>
1372
- </thead>
1373
-
1374
- <tbody>
1375
-
1376
-
1377
- <tr>
1378
-
1379
- <td class="name"><code>identity</code></td>
1380
-
1381
-
1382
- <td class="type">
1383
-
1384
-
1385
- <span class="param-type">String</span>
1386
-
1387
-
1388
-
1389
-
1390
- </td>
1391
-
1392
-
1393
-
1394
-
1395
-
1396
- <td class="description last">Identity of User</td>
1397
- </tr>
1398
-
1399
-
1400
- </tbody>
1401
- </table>
1402
-
1403
-
1404
-
1405
-
1406
- <dl class="details">
1407
-
1408
-
1409
-
1410
-
1411
-
1412
-
1413
-
1414
-
1415
-
1416
-
1417
-
1418
-
1419
-
1420
-
1421
-
1422
-
1423
-
1424
-
1425
-
1426
-
1427
-
1428
-
1429
-
1430
-
1431
-
1432
-
1433
-
1434
-
1435
-
1436
-
1437
-
1438
-
1439
-
1440
-
1441
-
1442
- </dl>
1443
-
1444
-
1445
-
1446
-
1447
-
1448
-
1449
-
1450
-
1451
-
1452
-
1453
-
1454
-
1455
-
1456
- <h5>Returns:</h5>
1457
-
1458
-
1459
- <div class="param-desc">
1460
- Fully initialized user
1461
- </div>
1462
-
1463
-
1464
-
1465
- <dl>
1466
- <dt>
1467
- Type
1468
- </dt>
1469
- <dd>
1470
-
1471
- <span class="param-type">Promise.&lt;<a href="User.html">User</a>&gt;</span>
1472
-
1473
-
1474
-
1475
- </dd>
1476
- </dl>
1477
-
1478
-
1479
-
1480
-
1481
-
1482
- </dd>
1483
-
1484
-
1485
-
1486
- <hr>
1487
- <dt>
1488
- <h4 class="name" id="handlePushNotification"><span class="type-signature"></span>handlePushNotification(notificationPayload)</h4>
1489
-
1490
-
1491
- </dt>
1492
- <dd>
1493
-
1494
-
1495
- <div class="description">
1496
- Handle push notification payload parsing and emits event <a href="Client.html#event:pushNotification">Client#event:pushNotification</a> on this <a href="Client.html">Client</a> instance.
1497
- </div>
1498
-
1499
-
1500
-
1501
-
1502
-
1503
-
1504
-
1505
-
1506
- <h5>Parameters:</h5>
1507
-
1508
-
1509
- <table class="params table table-striped">
1510
- <thead>
1511
- <tr>
1512
-
1513
- <th>Name</th>
1514
-
1515
-
1516
- <th>Type</th>
1517
-
1518
-
1519
-
1520
-
1521
-
1522
- <th class="last">Description</th>
1523
- </tr>
1524
- </thead>
1525
-
1526
- <tbody>
1527
-
1528
-
1529
- <tr>
1530
-
1531
- <td class="name"><code>notificationPayload</code></td>
1532
-
1533
-
1534
- <td class="type">
1535
-
1536
-
1537
- <span class="param-type">Object</span>
1538
-
1539
-
1540
-
1541
-
1542
- </td>
1543
-
1544
-
1545
-
1546
-
1547
-
1548
- <td class="description last">Push notification payload</td>
1549
- </tr>
1550
-
1551
-
1552
- </tbody>
1553
- </table>
1554
-
1555
-
1556
-
1557
-
1558
- <dl class="details">
1559
-
1560
-
1561
-
1562
-
1563
-
1564
-
1565
-
1566
-
1567
-
1568
-
1569
-
1570
-
1571
-
1572
-
1573
-
1574
-
1575
-
1576
-
1577
-
1578
-
1579
-
1580
-
1581
-
1582
-
1583
-
1584
-
1585
-
1586
-
1587
-
1588
-
1589
-
1590
-
1591
-
1592
-
1593
-
1594
- </dl>
1595
-
1596
-
1597
-
1598
-
1599
-
1600
-
1601
-
1602
-
1603
-
1604
-
1605
-
1606
-
1607
-
1608
- <h5>Returns:</h5>
1609
-
1610
-
1611
-
1612
-
1613
- <dl>
1614
- <dt>
1615
- Type
1616
- </dt>
1617
- <dd>
1618
-
1619
- <span class="param-type">Promise.&lt;void&gt;</span>
1620
-
1621
-
1622
-
1623
- </dd>
1624
- </dl>
1625
-
1626
-
1627
-
1628
-
1629
-
1630
- </dd>
1631
-
1632
-
1633
-
1634
- <hr>
1635
- <dt>
1636
- <h4 class="name" id="setPushRegistrationId"><span class="type-signature"></span>setPushRegistrationId(channelType, registrationId)</h4>
1637
-
1638
-
1639
- </dt>
1640
- <dd>
1641
-
1642
-
1643
- <div class="description">
1644
- Registers for push notifications.
1645
- </div>
1646
-
1647
-
1648
-
1649
-
1650
-
1651
-
1652
-
1653
-
1654
- <h5>Parameters:</h5>
1655
-
1656
-
1657
- <table class="params table table-striped">
1658
- <thead>
1659
- <tr>
1660
-
1661
- <th>Name</th>
1662
-
1663
-
1664
- <th>Type</th>
1665
-
1666
-
1667
-
1668
-
1669
-
1670
- <th class="last">Description</th>
1671
- </tr>
1672
- </thead>
1673
-
1674
- <tbody>
1675
-
1676
-
1677
- <tr>
1678
-
1679
- <td class="name"><code>channelType</code></td>
1680
-
1681
-
1682
- <td class="type">
1683
-
1684
-
1685
- <span class="param-type"><a href="Client.html#NotificationsChannelType">Client#NotificationsChannelType</a></span>
1686
-
1687
-
1688
-
1689
-
1690
- </td>
1691
-
1692
-
1693
-
1694
-
1695
-
1696
- <td class="description last">&apos;apn&apos; and &apos;fcm&apos; are supported</td>
1697
- </tr>
1698
-
1699
-
1700
-
1701
- <tr>
1702
-
1703
- <td class="name"><code>registrationId</code></td>
1704
-
1705
-
1706
- <td class="type">
1707
-
1708
-
1709
- <span class="param-type">string</span>
1710
-
1711
-
1712
-
1713
-
1714
- </td>
1715
-
1716
-
1717
-
1718
-
1719
-
1720
- <td class="description last">Push notification id provided by the platform</td>
1721
- </tr>
1722
-
1723
-
1724
- </tbody>
1725
- </table>
1726
-
1727
-
1728
-
1729
-
1730
- <dl class="details">
1731
-
1732
-
1733
-
1734
-
1735
-
1736
-
1737
-
1738
-
1739
-
1740
-
1741
-
1742
-
1743
-
1744
-
1745
-
1746
-
1747
-
1748
-
1749
-
1750
-
1751
-
1752
-
1753
-
1754
-
1755
-
1756
-
1757
-
1758
-
1759
-
1760
-
1761
-
1762
-
1763
-
1764
-
1765
-
1766
- </dl>
1767
-
1768
-
1769
-
1770
-
1771
-
1772
-
1773
-
1774
-
1775
-
1776
-
1777
-
1778
-
1779
-
1780
- <h5>Returns:</h5>
1781
-
1782
-
1783
-
1784
-
1785
- <dl>
1786
- <dt>
1787
- Type
1788
- </dt>
1789
- <dd>
1790
-
1791
- <span class="param-type">Promise.&lt;void&gt;</span>
1792
-
1793
-
1794
-
1795
- </dd>
1796
- </dl>
1797
-
1798
-
1799
-
1800
-
1801
-
1802
- </dd>
1803
-
1804
-
1805
-
1806
- <hr>
1807
- <dt>
1808
- <h4 class="name" id="shutdown"><span class="type-signature"></span>shutdown()</h4>
1809
-
1810
-
1811
- </dt>
1812
- <dd>
1813
-
1814
-
1815
- <div class="description">
1816
- Gracefully shutting down library instance.
1817
- </div>
1818
-
1819
-
1820
-
1821
-
1822
-
1823
-
1824
-
1825
-
1826
-
1827
-
1828
- <dl class="details">
1829
-
1830
-
1831
-
1832
-
1833
-
1834
-
1835
-
1836
-
1837
-
1838
-
1839
-
1840
-
1841
-
1842
-
1843
-
1844
-
1845
-
1846
-
1847
-
1848
-
1849
-
1850
-
1851
-
1852
-
1853
-
1854
-
1855
-
1856
-
1857
-
1858
-
1859
-
1860
-
1861
-
1862
-
1863
-
1864
- </dl>
1865
-
1866
-
1867
-
1868
-
1869
-
1870
-
1871
-
1872
-
1873
-
1874
-
1875
-
1876
-
1877
-
1878
- <h5>Returns:</h5>
1879
-
1880
-
1881
-
1882
-
1883
- <dl>
1884
- <dt>
1885
- Type
1886
- </dt>
1887
- <dd>
1888
-
1889
- <span class="param-type">Promise.&lt;void&gt;</span>
1890
-
1891
-
1892
-
1893
- </dd>
1894
- </dl>
1895
-
1896
-
1897
-
1898
-
1899
-
1900
- </dd>
1901
-
1902
-
1903
-
1904
- <hr>
1905
- <dt>
1906
- <h4 class="name" id="unsetPushRegistrationId"><span class="type-signature"></span>unsetPushRegistrationId(channelType)</h4>
1907
-
1908
-
1909
- </dt>
1910
- <dd>
1911
-
1912
-
1913
- <div class="description">
1914
- Unregisters from push notifications.
1915
- </div>
1916
-
1917
-
1918
-
1919
-
1920
-
1921
-
1922
-
1923
-
1924
- <h5>Parameters:</h5>
1925
-
1926
-
1927
- <table class="params table table-striped">
1928
- <thead>
1929
- <tr>
1930
-
1931
- <th>Name</th>
1932
-
1933
-
1934
- <th>Type</th>
1935
-
1936
-
1937
-
1938
-
1939
-
1940
- <th class="last">Description</th>
1941
- </tr>
1942
- </thead>
1943
-
1944
- <tbody>
1945
-
1946
-
1947
- <tr>
1948
-
1949
- <td class="name"><code>channelType</code></td>
1950
-
1951
-
1952
- <td class="type">
1953
-
1954
-
1955
- <span class="param-type"><a href="Client.html#NotificationsChannelType">Client#NotificationsChannelType</a></span>
1956
-
1957
-
1958
-
1959
-
1960
- </td>
1961
-
1962
-
1963
-
1964
-
1965
-
1966
- <td class="description last">&apos;apn&apos; and &apos;fcm&apos; are supported</td>
1967
- </tr>
1968
-
1969
-
1970
- </tbody>
1971
- </table>
1972
-
1973
-
1974
-
1975
-
1976
- <dl class="details">
1977
-
1978
-
1979
-
1980
-
1981
-
1982
-
1983
-
1984
-
1985
-
1986
-
1987
-
1988
-
1989
-
1990
-
1991
-
1992
-
1993
-
1994
-
1995
-
1996
-
1997
-
1998
-
1999
-
2000
-
2001
-
2002
-
2003
-
2004
-
2005
-
2006
-
2007
-
2008
-
2009
-
2010
-
2011
-
2012
- </dl>
2013
-
2014
-
2015
-
2016
-
2017
-
2018
-
2019
-
2020
-
2021
-
2022
-
2023
-
2024
-
2025
-
2026
- <h5>Returns:</h5>
2027
-
2028
-
2029
-
2030
-
2031
- <dl>
2032
- <dt>
2033
- Type
2034
- </dt>
2035
- <dd>
2036
-
2037
- <span class="param-type">Promise.&lt;void&gt;</span>
2038
-
2039
-
2040
-
2041
- </dd>
2042
- </dl>
2043
-
2044
-
2045
-
2046
-
2047
-
2048
- </dd>
2049
-
2050
-
2051
-
2052
- <hr>
2053
- <dt>
2054
- <h4 class="name" id="updateToken"><span class="type-signature"></span>updateToken(token)</h4>
2055
-
2056
-
2057
- </dt>
2058
- <dd>
2059
-
2060
-
2061
- <div class="description">
2062
- Update the token used by the Client and re-register with Conversations services.
2063
- </div>
2064
-
2065
-
2066
-
2067
-
2068
-
2069
-
2070
-
2071
-
2072
- <h5>Parameters:</h5>
2073
-
2074
-
2075
- <table class="params table table-striped">
2076
- <thead>
2077
- <tr>
2078
-
2079
- <th>Name</th>
2080
-
2081
-
2082
- <th>Type</th>
2083
-
2084
-
2085
-
2086
-
2087
-
2088
- <th class="last">Description</th>
2089
- </tr>
2090
- </thead>
2091
-
2092
- <tbody>
2093
-
2094
-
2095
- <tr>
2096
-
2097
- <td class="name"><code>token</code></td>
2098
-
2099
-
2100
- <td class="type">
2101
-
2102
-
2103
- <span class="param-type">String</span>
2104
-
2105
-
2106
-
2107
-
2108
- </td>
2109
-
2110
-
2111
-
2112
-
2113
-
2114
- <td class="description last">Access token</td>
2115
- </tr>
2116
-
2117
-
2118
- </tbody>
2119
- </table>
2120
-
2121
-
2122
-
2123
-
2124
- <dl class="details">
2125
-
2126
-
2127
-
2128
-
2129
-
2130
-
2131
-
2132
-
2133
-
2134
-
2135
-
2136
-
2137
-
2138
-
2139
-
2140
-
2141
-
2142
-
2143
-
2144
-
2145
-
2146
-
2147
-
2148
-
2149
-
2150
-
2151
-
2152
-
2153
-
2154
-
2155
-
2156
-
2157
-
2158
-
2159
-
2160
- </dl>
2161
-
2162
-
2163
-
2164
-
2165
-
2166
-
2167
-
2168
-
2169
-
2170
-
2171
-
2172
-
2173
-
2174
- <h5>Returns:</h5>
2175
-
2176
-
2177
-
2178
-
2179
- <dl>
2180
- <dt>
2181
- Type
2182
- </dt>
2183
- <dd>
2184
-
2185
- <span class="param-type">Promise.&lt;<a href="Client.html">Client</a>&gt;</span>
2186
-
2187
-
2188
-
2189
- </dd>
2190
- </dl>
2191
-
2192
-
2193
-
2194
-
2195
-
2196
- </dd>
2197
-
2198
- </dl>
2199
-
2200
-
2201
-
2202
- <h3 class="subsection-title">Type Definitions</h3>
2203
-
2204
- <dl>
2205
-
2206
- <hr>
2207
- <dt class="name" id="ClientOptions">
2208
- <h4 id="ClientOptions">ClientOptions</h4>
2209
-
2210
-
2211
- </dt>
2212
- <dd>
2213
-
2214
- <div class="description">
2215
- These options can be passed to Client constructor.
2216
- </div>
2217
-
2218
-
2219
-
2220
- <h5>Type:</h5>
2221
- <ul>
2222
- <li>
2223
-
2224
- <span class="param-type">Object</span>
2225
-
2226
-
2227
-
2228
- </li>
2229
- </ul>
2230
-
2231
-
2232
-
2233
- <dl class="details">
2234
-
2235
-
2236
- <h5 class="subsection-title">Properties:</h5>
2237
-
2238
- <dl>
2239
-
2240
- <table class="props table table-striped">
2241
- <thead>
2242
- <tr>
2243
-
2244
- <th>Name</th>
2245
-
2246
-
2247
- <th>Type</th>
2248
-
2249
-
2250
- <th>Argument</th>
2251
-
2252
-
2253
-
2254
- <th>Default</th>
2255
-
2256
-
2257
- <th class="last">Description</th>
2258
- </tr>
2259
- </thead>
2260
-
2261
- <tbody>
2262
-
2263
-
2264
- <tr>
2265
-
2266
- <td class="name"><code>logLevel</code></td>
2267
-
2268
-
2269
- <td class="type">
2270
-
2271
-
2272
- <span class="param-type">String</span>
2273
-
2274
-
2275
-
2276
-
2277
- </td>
2278
-
2279
-
2280
- <td class="attributes">
2281
-
2282
- &lt;optional&gt;<br>
2283
-
2284
-
2285
-
2286
- </td>
2287
-
2288
-
2289
-
2290
- <td class="default">
2291
-
2292
- &apos;error&apos;
2293
-
2294
- </td>
2295
-
2296
-
2297
- <td class="description last">The level of logging to enable. Valid options
2298
- (from strictest to broadest): [&apos;silent&apos;, &apos;error&apos;, &apos;warn&apos;, &apos;info&apos;, &apos;debug&apos;, &apos;trace&apos;]</td>
2299
- </tr>
2300
-
2301
-
2302
- </tbody>
2303
- </table>
2304
- </dl>
2305
-
2306
-
2307
-
2308
-
2309
-
2310
-
2311
-
2312
-
2313
-
2314
-
2315
-
2316
-
2317
-
2318
-
2319
-
2320
-
2321
-
2322
-
2323
-
2324
-
2325
-
2326
-
2327
-
2328
-
2329
-
2330
-
2331
-
2332
-
2333
-
2334
-
2335
-
2336
-
2337
-
2338
-
2339
-
2340
-
2341
- </dl>
2342
-
2343
-
2344
-
2345
- </dd>
2346
-
2347
-
2348
-
2349
- <hr>
2350
- <dt class="name" id="ConnectionState">
2351
- <h4 id="ConnectionState">ConnectionState</h4>
2352
-
2353
-
2354
- </dt>
2355
- <dd>
2356
-
2357
- <div class="description">
2358
- Connection state of Client.
2359
- </div>
2360
-
2361
-
2362
-
2363
- <h5>Type:</h5>
2364
- <ul>
2365
- <li>
2366
-
2367
- <span class="param-type">&apos;connecting&apos;</span>
2368
- |
2369
-
2370
- <span class="param-type">&apos;connected&apos;</span>
2371
- |
2372
-
2373
- <span class="param-type">&apos;disconnecting&apos;</span>
2374
- |
2375
-
2376
- <span class="param-type">&apos;disconnected&apos;</span>
2377
- |
2378
-
2379
- <span class="param-type">&apos;denied&apos;</span>
2380
-
2381
-
2382
-
2383
- </li>
2384
- </ul>
2385
-
2386
-
2387
-
2388
- <dl class="details">
2389
-
2390
-
2391
-
2392
-
2393
-
2394
-
2395
-
2396
-
2397
-
2398
-
2399
-
2400
-
2401
-
2402
-
2403
-
2404
-
2405
-
2406
-
2407
-
2408
-
2409
-
2410
-
2411
-
2412
-
2413
-
2414
-
2415
-
2416
-
2417
-
2418
-
2419
-
2420
-
2421
-
2422
-
2423
-
2424
- </dl>
2425
-
2426
-
2427
-
2428
- </dd>
2429
-
2430
-
2431
-
2432
- <hr>
2433
- <dt class="name" id="CreateConversationOptions">
2434
- <h4 id="CreateConversationOptions">CreateConversationOptions</h4>
2435
-
2436
-
2437
- </dt>
2438
- <dd>
2439
-
2440
- <div class="description">
2441
- These options can be passed to <a href="Client.html#createConversation">Client#createConversation</a>.
2442
- </div>
2443
-
2444
-
2445
-
2446
- <h5>Type:</h5>
2447
- <ul>
2448
- <li>
2449
-
2450
- <span class="param-type">Object</span>
2451
-
2452
-
2453
-
2454
- </li>
2455
- </ul>
2456
-
2457
-
2458
-
2459
- <dl class="details">
2460
-
2461
-
2462
- <h5 class="subsection-title">Properties:</h5>
2463
-
2464
- <dl>
2465
-
2466
- <table class="props table table-striped">
2467
- <thead>
2468
- <tr>
2469
-
2470
- <th>Name</th>
2471
-
2472
-
2473
- <th>Type</th>
2474
-
2475
-
2476
- <th>Argument</th>
2477
-
2478
-
2479
-
2480
-
2481
- <th class="last">Description</th>
2482
- </tr>
2483
- </thead>
2484
-
2485
- <tbody>
2486
-
2487
-
2488
- <tr>
2489
-
2490
- <td class="name"><code>attributes</code></td>
2491
-
2492
-
2493
- <td class="type">
2494
-
2495
-
2496
- <span class="param-type">any</span>
2497
-
2498
-
2499
-
2500
-
2501
- </td>
2502
-
2503
-
2504
- <td class="attributes">
2505
-
2506
- &lt;optional&gt;<br>
2507
-
2508
-
2509
-
2510
- </td>
2511
-
2512
-
2513
-
2514
-
2515
- <td class="description last">Any custom attributes to attach to the Conversation</td>
2516
- </tr>
2517
-
2518
-
2519
-
2520
- <tr>
2521
-
2522
- <td class="name"><code>friendlyName</code></td>
2523
-
2524
-
2525
- <td class="type">
2526
-
2527
-
2528
- <span class="param-type">String</span>
2529
-
2530
-
2531
-
2532
-
2533
- </td>
2534
-
2535
-
2536
- <td class="attributes">
2537
-
2538
- &lt;optional&gt;<br>
2539
-
2540
-
2541
-
2542
- </td>
2543
-
2544
-
2545
-
2546
-
2547
- <td class="description last">The non-unique display name of the Conversation</td>
2548
- </tr>
2549
-
2550
-
2551
-
2552
- <tr>
2553
-
2554
- <td class="name"><code>uniqueName</code></td>
2555
-
2556
-
2557
- <td class="type">
2558
-
2559
-
2560
- <span class="param-type">String</span>
2561
-
2562
-
2563
-
2564
-
2565
- </td>
2566
-
2567
-
2568
- <td class="attributes">
2569
-
2570
- &lt;optional&gt;<br>
2571
-
2572
-
2573
-
2574
- </td>
2575
-
2576
-
2577
-
2578
-
2579
- <td class="description last">The unique identifier of the Conversation</td>
2580
- </tr>
2581
-
2582
-
2583
- </tbody>
2584
- </table>
2585
- </dl>
2586
-
2587
-
2588
-
2589
-
2590
-
2591
-
2592
-
2593
-
2594
-
2595
-
2596
-
2597
-
2598
-
2599
-
2600
-
2601
-
2602
-
2603
-
2604
-
2605
-
2606
-
2607
-
2608
-
2609
-
2610
-
2611
-
2612
-
2613
-
2614
-
2615
-
2616
-
2617
-
2618
-
2619
-
2620
-
2621
-
2622
- </dl>
2623
-
2624
-
2625
-
2626
- </dd>
2627
-
2628
-
2629
-
2630
- <hr>
2631
- <dt class="name" id="NotificationsChannelType">
2632
- <h4 id="NotificationsChannelType">NotificationsChannelType</h4>
2633
-
2634
-
2635
- </dt>
2636
- <dd>
2637
-
2638
- <div class="description">
2639
- Notifications channel type.
2640
- </div>
2641
-
2642
-
2643
-
2644
- <h5>Type:</h5>
2645
- <ul>
2646
- <li>
2647
-
2648
- <span class="param-type">&apos;fcm&apos;</span>
2649
- |
2650
-
2651
- <span class="param-type">&apos;apn&apos;</span>
2652
-
2653
-
2654
-
2655
- </li>
2656
- </ul>
2657
-
2658
-
2659
-
2660
- <dl class="details">
2661
-
2662
-
2663
-
2664
-
2665
-
2666
-
2667
-
2668
-
2669
-
2670
-
2671
-
2672
-
2673
-
2674
-
2675
-
2676
-
2677
-
2678
-
2679
-
2680
-
2681
-
2682
-
2683
-
2684
-
2685
-
2686
-
2687
-
2688
-
2689
-
2690
-
2691
-
2692
-
2693
-
2694
-
2695
-
2696
- </dl>
2697
-
2698
-
2699
-
2700
- </dd>
2701
-
2702
- </dl>
2703
-
2704
-
2705
-
2706
- <h3 class="subsection-title">Events</h3>
2707
-
2708
- <dl>
2709
-
2710
- <hr>
2711
- <dt>
2712
- <h4 class="name" id="event:connectionError">connectionError</h4>
2713
-
2714
-
2715
- </dt>
2716
- <dd>
2717
-
2718
-
2719
- <div class="description">
2720
- Fired when connection is interrupted by unexpected reason
2721
- </div>
2722
-
2723
-
2724
-
2725
-
2726
-
2727
- <h5>Type:
2728
- <span class="param-type">Object</span>
2729
-
2730
-
2731
- </h5>
2732
-
2733
-
2734
-
2735
-
2736
-
2737
-
2738
- <dl class="details">
2739
-
2740
-
2741
- <h5 class="subsection-title">Properties:</h5>
2742
-
2743
- <dl>
2744
-
2745
- <table class="props table table-striped">
2746
- <thead>
2747
- <tr>
2748
-
2749
- <th>Name</th>
2750
-
2751
-
2752
- <th>Type</th>
2753
-
2754
-
2755
- <th>Argument</th>
2756
-
2757
-
2758
-
2759
-
2760
- <th class="last">Description</th>
2761
- </tr>
2762
- </thead>
2763
-
2764
- <tbody>
2765
-
2766
-
2767
- <tr>
2768
-
2769
- <td class="name"><code>terminal</code></td>
2770
-
2771
-
2772
- <td class="type">
2773
-
2774
-
2775
- <span class="param-type">Boolean</span>
2776
-
2777
-
2778
-
2779
-
2780
- </td>
2781
-
2782
-
2783
- <td class="attributes">
2784
-
2785
-
2786
-
2787
- </td>
2788
-
2789
-
2790
-
2791
-
2792
- <td class="description last">twilsock will stop connection attempts</td>
2793
- </tr>
2794
-
2795
-
2796
-
2797
- <tr>
2798
-
2799
- <td class="name"><code>message</code></td>
2800
-
2801
-
2802
- <td class="type">
2803
-
2804
-
2805
- <span class="param-type">String</span>
2806
-
2807
-
2808
-
2809
-
2810
- </td>
2811
-
2812
-
2813
- <td class="attributes">
2814
-
2815
-
2816
-
2817
- </td>
2818
-
2819
-
2820
-
2821
-
2822
- <td class="description last">root cause</td>
2823
- </tr>
2824
-
2825
-
2826
-
2827
- <tr>
2828
-
2829
- <td class="name"><code>httpStatusCode</code></td>
2830
-
2831
-
2832
- <td class="type">
2833
-
2834
-
2835
- <span class="param-type">Number</span>
2836
-
2837
-
2838
-
2839
-
2840
- </td>
2841
-
2842
-
2843
- <td class="attributes">
2844
-
2845
- &lt;optional&gt;<br>
2846
-
2847
-
2848
-
2849
- </td>
2850
-
2851
-
2852
-
2853
-
2854
- <td class="description last">http status code if available</td>
2855
- </tr>
2856
-
2857
-
2858
-
2859
- <tr>
2860
-
2861
- <td class="name"><code>errorCode</code></td>
2862
-
2863
-
2864
- <td class="type">
2865
-
2866
-
2867
- <span class="param-type">Number</span>
2868
-
2869
-
2870
-
2871
-
2872
- </td>
2873
-
2874
-
2875
- <td class="attributes">
2876
-
2877
- &lt;optional&gt;<br>
2878
-
2879
-
2880
-
2881
- </td>
2882
-
2883
-
2884
-
2885
-
2886
- <td class="description last">Twilio public error code if available</td>
2887
- </tr>
2888
-
2889
-
2890
- </tbody>
2891
- </table>
2892
- </dl>
2893
-
2894
-
2895
-
2896
-
2897
-
2898
-
2899
-
2900
-
2901
-
2902
-
2903
-
2904
-
2905
-
2906
-
2907
-
2908
-
2909
-
2910
-
2911
-
2912
-
2913
-
2914
-
2915
-
2916
-
2917
-
2918
-
2919
-
2920
-
2921
-
2922
-
2923
-
2924
-
2925
-
2926
-
2927
-
2928
-
2929
- </dl>
2930
-
2931
-
2932
-
2933
-
2934
-
2935
-
2936
-
2937
-
2938
-
2939
-
2940
-
2941
-
2942
-
2943
-
2944
-
2945
- </dd>
2946
-
2947
-
2948
-
2949
- <hr>
2950
- <dt>
2951
- <h4 class="name" id="event:connectionStateChanged">connectionStateChanged</h4>
2952
-
2953
-
2954
- </dt>
2955
- <dd>
2956
-
2957
-
2958
- <div class="description">
2959
- Fired when Client&apos;s connection state has been changed.
2960
- </div>
2961
-
2962
-
2963
-
2964
-
2965
-
2966
- <h5>Type:
2967
- <span class="param-type"><a href="Client.html#ConnectionState">Client#ConnectionState</a></span>
2968
-
2969
-
2970
- </h5>
2971
-
2972
-
2973
-
2974
-
2975
-
2976
-
2977
- <dl class="details">
2978
-
2979
-
2980
-
2981
-
2982
-
2983
-
2984
-
2985
-
2986
-
2987
-
2988
-
2989
-
2990
-
2991
-
2992
-
2993
-
2994
-
2995
-
2996
-
2997
-
2998
-
2999
-
3000
-
3001
-
3002
-
3003
-
3004
-
3005
-
3006
-
3007
-
3008
-
3009
-
3010
-
3011
-
3012
-
3013
- </dl>
3014
-
3015
-
3016
-
3017
-
3018
-
3019
-
3020
-
3021
-
3022
-
3023
-
3024
-
3025
-
3026
-
3027
-
3028
-
3029
- </dd>
3030
-
3031
-
3032
-
3033
- <hr>
3034
- <dt>
3035
- <h4 class="name" id="event:conversationAdded">conversationAdded</h4>
3036
-
3037
-
3038
- </dt>
3039
- <dd>
3040
-
3041
-
3042
- <div class="description">
3043
- Fired when a Conversation becomes visible to the Client. The event is also triggered when the client creates a new Conversation.
3044
- Fired for all conversations Client has joined.
3045
- </div>
3046
-
3047
-
3048
-
3049
-
3050
-
3051
- <h5>Type:
3052
- <span class="param-type"><a href="Conversation.html">Conversation</a></span>
3053
-
3054
-
3055
- </h5>
3056
-
3057
-
3058
-
3059
-
3060
-
3061
-
3062
- <dl class="details">
3063
-
3064
-
3065
-
3066
-
3067
-
3068
-
3069
-
3070
-
3071
-
3072
-
3073
-
3074
-
3075
-
3076
-
3077
-
3078
-
3079
-
3080
-
3081
-
3082
-
3083
-
3084
-
3085
-
3086
-
3087
-
3088
-
3089
-
3090
-
3091
-
3092
-
3093
-
3094
-
3095
-
3096
-
3097
-
3098
- </dl>
3099
-
3100
-
3101
-
3102
-
3103
-
3104
-
3105
-
3106
-
3107
-
3108
-
3109
-
3110
-
3111
-
3112
-
3113
-
3114
- </dd>
3115
-
3116
-
3117
-
3118
- <hr>
3119
- <dt>
3120
- <h4 class="name" id="event:conversationJoined">conversationJoined</h4>
3121
-
3122
-
3123
- </dt>
3124
- <dd>
3125
-
3126
-
3127
- <div class="description">
3128
- Fired when the Client joins a Conversation.
3129
- </div>
3130
-
3131
-
3132
-
3133
-
3134
-
3135
- <h5>Type:
3136
- <span class="param-type"><a href="Conversation.html">Conversation</a></span>
3137
-
3138
-
3139
- </h5>
3140
-
3141
-
3142
-
3143
-
3144
-
3145
-
3146
- <dl class="details">
3147
-
3148
-
3149
-
3150
-
3151
-
3152
-
3153
-
3154
-
3155
-
3156
-
3157
-
3158
-
3159
-
3160
-
3161
-
3162
-
3163
-
3164
-
3165
-
3166
-
3167
-
3168
-
3169
-
3170
-
3171
-
3172
-
3173
-
3174
-
3175
-
3176
-
3177
-
3178
-
3179
-
3180
-
3181
-
3182
- </dl>
3183
-
3184
-
3185
-
3186
-
3187
-
3188
-
3189
-
3190
-
3191
-
3192
-
3193
-
3194
-
3195
-
3196
-
3197
-
3198
- </dd>
3199
-
3200
-
3201
-
3202
- <hr>
3203
- <dt>
3204
- <h4 class="name" id="event:conversationLeft">conversationLeft</h4>
3205
-
3206
-
3207
- </dt>
3208
- <dd>
3209
-
3210
-
3211
- <div class="description">
3212
- Fired when the Client leaves a Conversation.
3213
- </div>
3214
-
3215
-
3216
-
3217
-
3218
-
3219
- <h5>Type:
3220
- <span class="param-type"><a href="Conversation.html">Conversation</a></span>
3221
-
3222
-
3223
- </h5>
3224
-
3225
-
3226
-
3227
-
3228
-
3229
-
3230
- <dl class="details">
3231
-
3232
-
3233
-
3234
-
3235
-
3236
-
3237
-
3238
-
3239
-
3240
-
3241
-
3242
-
3243
-
3244
-
3245
-
3246
-
3247
-
3248
-
3249
-
3250
-
3251
-
3252
-
3253
-
3254
-
3255
-
3256
-
3257
-
3258
-
3259
-
3260
-
3261
-
3262
-
3263
-
3264
-
3265
-
3266
- </dl>
3267
-
3268
-
3269
-
3270
-
3271
-
3272
-
3273
-
3274
-
3275
-
3276
-
3277
-
3278
-
3279
-
3280
-
3281
-
3282
- </dd>
3283
-
3284
-
3285
-
3286
- <hr>
3287
- <dt>
3288
- <h4 class="name" id="event:conversationRemoved">conversationRemoved</h4>
3289
-
3290
-
3291
- </dt>
3292
- <dd>
3293
-
3294
-
3295
- <div class="description">
3296
- Fired when a Conversation is no longer visible to the Client.
3297
- </div>
3298
-
3299
-
3300
-
3301
-
3302
-
3303
- <h5>Type:
3304
- <span class="param-type"><a href="Conversation.html">Conversation</a></span>
3305
-
3306
-
3307
- </h5>
3308
-
3309
-
3310
-
3311
-
3312
-
3313
-
3314
- <dl class="details">
3315
-
3316
-
3317
-
3318
-
3319
-
3320
-
3321
-
3322
-
3323
-
3324
-
3325
-
3326
-
3327
-
3328
-
3329
-
3330
-
3331
-
3332
-
3333
-
3334
-
3335
-
3336
-
3337
-
3338
-
3339
-
3340
-
3341
-
3342
-
3343
-
3344
-
3345
-
3346
-
3347
-
3348
-
3349
-
3350
- </dl>
3351
-
3352
-
3353
-
3354
-
3355
-
3356
-
3357
-
3358
-
3359
-
3360
-
3361
-
3362
-
3363
-
3364
-
3365
-
3366
- </dd>
3367
-
3368
-
3369
-
3370
- <hr>
3371
- <dt>
3372
- <h4 class="name" id="event:conversationUpdated">conversationUpdated</h4>
3373
-
3374
-
3375
- </dt>
3376
- <dd>
3377
-
3378
-
3379
- <div class="description">
3380
- Fired when a Conversation&apos;s attributes or metadata have been updated.
3381
- During Conversation&apos;s <a href="Client.html#.create"> creation and initialization</a> this event might be fired multiple times
3382
- for same joined or created Conversation as new data is arriving from different sources.
3383
- </div>
3384
-
3385
-
3386
-
3387
-
3388
-
3389
- <h5>Type:
3390
- <span class="param-type">Object</span>
3391
-
3392
-
3393
- </h5>
3394
-
3395
-
3396
-
3397
-
3398
-
3399
-
3400
- <dl class="details">
3401
-
3402
-
3403
- <h5 class="subsection-title">Properties:</h5>
3404
-
3405
- <dl>
3406
-
3407
- <table class="props table table-striped">
3408
- <thead>
3409
- <tr>
3410
-
3411
- <th>Name</th>
3412
-
3413
-
3414
- <th>Type</th>
3415
-
3416
-
3417
-
3418
-
3419
-
3420
- <th class="last">Description</th>
3421
- </tr>
3422
- </thead>
3423
-
3424
- <tbody>
3425
-
3426
-
3427
- <tr>
3428
-
3429
- <td class="name"><code>conversation</code></td>
3430
-
3431
-
3432
- <td class="type">
3433
-
3434
-
3435
- <span class="param-type"><a href="Conversation.html">Conversation</a></span>
3436
-
3437
-
3438
-
3439
-
3440
- </td>
3441
-
3442
-
3443
-
3444
-
3445
-
3446
- <td class="description last">Updated Conversation</td>
3447
- </tr>
3448
-
3449
-
3450
-
3451
- <tr>
3452
-
3453
- <td class="name"><code>updateReasons</code></td>
3454
-
3455
-
3456
- <td class="type">
3457
-
3458
-
3459
- <span class="param-type">Array.&lt;<a href="Conversation.html#UpdateReason">Conversation#UpdateReason</a>&gt;</span>
3460
-
3461
-
3462
-
3463
-
3464
- </td>
3465
-
3466
-
3467
-
3468
-
3469
-
3470
- <td class="description last">Array of Conversation&apos;s updated event reasons</td>
3471
- </tr>
3472
-
3473
-
3474
- </tbody>
3475
- </table>
3476
- </dl>
3477
-
3478
-
3479
-
3480
-
3481
-
3482
-
3483
-
3484
-
3485
-
3486
-
3487
-
3488
-
3489
-
3490
-
3491
-
3492
-
3493
-
3494
-
3495
-
3496
-
3497
-
3498
-
3499
-
3500
-
3501
-
3502
-
3503
-
3504
-
3505
-
3506
-
3507
-
3508
-
3509
-
3510
-
3511
-
3512
-
3513
- </dl>
3514
-
3515
-
3516
-
3517
-
3518
-
3519
-
3520
-
3521
-
3522
-
3523
-
3524
-
3525
-
3526
-
3527
-
3528
-
3529
- </dd>
3530
-
3531
-
3532
-
3533
- <hr>
3534
- <dt>
3535
- <h4 class="name" id="event:messageAdded">messageAdded</h4>
3536
-
3537
-
3538
- </dt>
3539
- <dd>
3540
-
3541
-
3542
- <div class="description">
3543
- Fired when a new Message has been added to the Conversation on the server.
3544
- </div>
3545
-
3546
-
3547
-
3548
-
3549
-
3550
- <h5>Type:
3551
- <span class="param-type"><a href="Message.html">Message</a></span>
3552
-
3553
-
3554
- </h5>
3555
-
3556
-
3557
-
3558
-
3559
-
3560
-
3561
- <dl class="details">
3562
-
3563
-
3564
-
3565
-
3566
-
3567
-
3568
-
3569
-
3570
-
3571
-
3572
-
3573
-
3574
-
3575
-
3576
-
3577
-
3578
-
3579
-
3580
-
3581
-
3582
-
3583
-
3584
-
3585
-
3586
-
3587
-
3588
-
3589
-
3590
-
3591
-
3592
-
3593
-
3594
-
3595
-
3596
-
3597
- </dl>
3598
-
3599
-
3600
-
3601
-
3602
-
3603
-
3604
-
3605
-
3606
-
3607
-
3608
-
3609
-
3610
-
3611
-
3612
-
3613
- </dd>
3614
-
3615
-
3616
-
3617
- <hr>
3618
- <dt>
3619
- <h4 class="name" id="event:messageRemoved">messageRemoved</h4>
3620
-
3621
-
3622
- </dt>
3623
- <dd>
3624
-
3625
-
3626
- <div class="description">
3627
- Fired when Message is removed from Conversation&apos;s message list.
3628
- </div>
3629
-
3630
-
3631
-
3632
-
3633
-
3634
- <h5>Type:
3635
- <span class="param-type"><a href="Message.html">Message</a></span>
3636
-
3637
-
3638
- </h5>
3639
-
3640
-
3641
-
3642
-
3643
-
3644
-
3645
- <dl class="details">
3646
-
3647
-
3648
-
3649
-
3650
-
3651
-
3652
-
3653
-
3654
-
3655
-
3656
-
3657
-
3658
-
3659
-
3660
-
3661
-
3662
-
3663
-
3664
-
3665
-
3666
-
3667
-
3668
-
3669
-
3670
-
3671
-
3672
-
3673
-
3674
-
3675
-
3676
-
3677
-
3678
-
3679
-
3680
-
3681
- </dl>
3682
-
3683
-
3684
-
3685
-
3686
-
3687
-
3688
-
3689
-
3690
-
3691
-
3692
-
3693
-
3694
-
3695
-
3696
-
3697
- </dd>
3698
-
3699
-
3700
-
3701
- <hr>
3702
- <dt>
3703
- <h4 class="name" id="event:messageUpdated">messageUpdated</h4>
3704
-
3705
-
3706
- </dt>
3707
- <dd>
3708
-
3709
-
3710
- <div class="description">
3711
- Fired when an existing Message&apos;s fields are updated with new values.
3712
- </div>
3713
-
3714
-
3715
-
3716
-
3717
-
3718
- <h5>Type:
3719
- <span class="param-type">Object</span>
3720
-
3721
-
3722
- </h5>
3723
-
3724
-
3725
-
3726
-
3727
-
3728
-
3729
- <dl class="details">
3730
-
3731
-
3732
- <h5 class="subsection-title">Properties:</h5>
3733
-
3734
- <dl>
3735
-
3736
- <table class="props table table-striped">
3737
- <thead>
3738
- <tr>
3739
-
3740
- <th>Name</th>
3741
-
3742
-
3743
- <th>Type</th>
3744
-
3745
-
3746
-
3747
-
3748
-
3749
- <th class="last">Description</th>
3750
- </tr>
3751
- </thead>
3752
-
3753
- <tbody>
3754
-
3755
-
3756
- <tr>
3757
-
3758
- <td class="name"><code>message</code></td>
3759
-
3760
-
3761
- <td class="type">
3762
-
3763
-
3764
- <span class="param-type"><a href="Message.html">Message</a></span>
3765
-
3766
-
3767
-
3768
-
3769
- </td>
3770
-
3771
-
3772
-
3773
-
3774
-
3775
- <td class="description last">Updated Message</td>
3776
- </tr>
3777
-
3778
-
3779
-
3780
- <tr>
3781
-
3782
- <td class="name"><code>updateReasons</code></td>
3783
-
3784
-
3785
- <td class="type">
3786
-
3787
-
3788
- <span class="param-type">Array.&lt;<a href="Message.html#UpdateReason">Message#UpdateReason</a>&gt;</span>
3789
-
3790
-
3791
-
3792
-
3793
- </td>
3794
-
3795
-
3796
-
3797
-
3798
-
3799
- <td class="description last">Array of Message&apos;s updated event reasons</td>
3800
- </tr>
3801
-
3802
-
3803
- </tbody>
3804
- </table>
3805
- </dl>
3806
-
3807
-
3808
-
3809
-
3810
-
3811
-
3812
-
3813
-
3814
-
3815
-
3816
-
3817
-
3818
-
3819
-
3820
-
3821
-
3822
-
3823
-
3824
-
3825
-
3826
-
3827
-
3828
-
3829
-
3830
-
3831
-
3832
-
3833
-
3834
-
3835
-
3836
-
3837
-
3838
-
3839
-
3840
-
3841
-
3842
- </dl>
3843
-
3844
-
3845
-
3846
-
3847
-
3848
-
3849
-
3850
-
3851
-
3852
-
3853
-
3854
-
3855
-
3856
-
3857
-
3858
- </dd>
3859
-
3860
-
3861
-
3862
- <hr>
3863
- <dt>
3864
- <h4 class="name" id="event:participantJoined">participantJoined</h4>
3865
-
3866
-
3867
- </dt>
3868
- <dd>
3869
-
3870
-
3871
- <div class="description">
3872
- Fired when a Participant has joined the Conversation.
3873
- </div>
3874
-
3875
-
3876
-
3877
-
3878
-
3879
- <h5>Type:
3880
- <span class="param-type"><a href="Participant.html">Participant</a></span>
3881
-
3882
-
3883
- </h5>
3884
-
3885
-
3886
-
3887
-
3888
-
3889
-
3890
- <dl class="details">
3891
-
3892
-
3893
-
3894
-
3895
-
3896
-
3897
-
3898
-
3899
-
3900
-
3901
-
3902
-
3903
-
3904
-
3905
-
3906
-
3907
-
3908
-
3909
-
3910
-
3911
-
3912
-
3913
-
3914
-
3915
-
3916
-
3917
-
3918
-
3919
-
3920
-
3921
-
3922
-
3923
-
3924
-
3925
-
3926
- </dl>
3927
-
3928
-
3929
-
3930
-
3931
-
3932
-
3933
-
3934
-
3935
-
3936
-
3937
-
3938
-
3939
-
3940
-
3941
-
3942
- </dd>
3943
-
3944
-
3945
-
3946
- <hr>
3947
- <dt>
3948
- <h4 class="name" id="event:participantLeft">participantLeft</h4>
3949
-
3950
-
3951
- </dt>
3952
- <dd>
3953
-
3954
-
3955
- <div class="description">
3956
- Fired when a Participant has left the Conversation.
3957
- </div>
3958
-
3959
-
3960
-
3961
-
3962
-
3963
- <h5>Type:
3964
- <span class="param-type"><a href="Participant.html">Participant</a></span>
3965
-
3966
-
3967
- </h5>
3968
-
3969
-
3970
-
3971
-
3972
-
3973
-
3974
- <dl class="details">
3975
-
3976
-
3977
-
3978
-
3979
-
3980
-
3981
-
3982
-
3983
-
3984
-
3985
-
3986
-
3987
-
3988
-
3989
-
3990
-
3991
-
3992
-
3993
-
3994
-
3995
-
3996
-
3997
-
3998
-
3999
-
4000
-
4001
-
4002
-
4003
-
4004
-
4005
-
4006
-
4007
-
4008
-
4009
-
4010
- </dl>
4011
-
4012
-
4013
-
4014
-
4015
-
4016
-
4017
-
4018
-
4019
-
4020
-
4021
-
4022
-
4023
-
4024
-
4025
-
4026
- </dd>
4027
-
4028
-
4029
-
4030
- <hr>
4031
- <dt>
4032
- <h4 class="name" id="event:participantUpdated">participantUpdated</h4>
4033
-
4034
-
4035
- </dt>
4036
- <dd>
4037
-
4038
-
4039
- <div class="description">
4040
- Fired when a Participant&apos;s fields has been updated.
4041
- </div>
4042
-
4043
-
4044
-
4045
-
4046
-
4047
- <h5>Type:
4048
- <span class="param-type">Object</span>
4049
-
4050
-
4051
- </h5>
4052
-
4053
-
4054
-
4055
-
4056
-
4057
-
4058
- <dl class="details">
4059
-
4060
-
4061
- <h5 class="subsection-title">Properties:</h5>
4062
-
4063
- <dl>
4064
-
4065
- <table class="props table table-striped">
4066
- <thead>
4067
- <tr>
4068
-
4069
- <th>Name</th>
4070
-
4071
-
4072
- <th>Type</th>
4073
-
4074
-
4075
-
4076
-
4077
-
4078
- <th class="last">Description</th>
4079
- </tr>
4080
- </thead>
4081
-
4082
- <tbody>
4083
-
4084
-
4085
- <tr>
4086
-
4087
- <td class="name"><code>participant</code></td>
4088
-
4089
-
4090
- <td class="type">
4091
-
4092
-
4093
- <span class="param-type"><a href="Participant.html">Participant</a></span>
4094
-
4095
-
4096
-
4097
-
4098
- </td>
4099
-
4100
-
4101
-
4102
-
4103
-
4104
- <td class="description last">Updated Participant</td>
4105
- </tr>
4106
-
4107
-
4108
-
4109
- <tr>
4110
-
4111
- <td class="name"><code>updateReasons</code></td>
4112
-
4113
-
4114
- <td class="type">
4115
-
4116
-
4117
- <span class="param-type">Array.&lt;<a href="Participant.html#UpdateReason">Participant#UpdateReason</a>&gt;</span>
4118
-
4119
-
4120
-
4121
-
4122
- </td>
4123
-
4124
-
4125
-
4126
-
4127
-
4128
- <td class="description last">Array of Participant&apos;s updated event reasons</td>
4129
- </tr>
4130
-
4131
-
4132
- </tbody>
4133
- </table>
4134
- </dl>
4135
-
4136
-
4137
-
4138
-
4139
-
4140
-
4141
-
4142
-
4143
-
4144
-
4145
-
4146
-
4147
-
4148
-
4149
-
4150
-
4151
-
4152
-
4153
-
4154
-
4155
-
4156
-
4157
-
4158
-
4159
-
4160
-
4161
-
4162
-
4163
-
4164
-
4165
-
4166
-
4167
-
4168
-
4169
-
4170
-
4171
- </dl>
4172
-
4173
-
4174
-
4175
-
4176
-
4177
-
4178
-
4179
-
4180
-
4181
-
4182
-
4183
-
4184
-
4185
-
4186
-
4187
- </dd>
4188
-
4189
-
4190
-
4191
- <hr>
4192
- <dt>
4193
- <h4 class="name" id="event:pushNotification">pushNotification</h4>
4194
-
4195
-
4196
- </dt>
4197
- <dd>
4198
-
4199
-
4200
- <div class="description">
4201
- Fired when client received (and parsed) push notification via one of push channels (apn or fcm).
4202
- </div>
4203
-
4204
-
4205
-
4206
-
4207
-
4208
- <h5>Type:
4209
- <span class="param-type"><a href="PushNotification.html">PushNotification</a></span>
4210
-
4211
-
4212
- </h5>
4213
-
4214
-
4215
-
4216
-
4217
-
4218
-
4219
- <dl class="details">
4220
-
4221
-
4222
-
4223
-
4224
-
4225
-
4226
-
4227
-
4228
-
4229
-
4230
-
4231
-
4232
-
4233
-
4234
-
4235
-
4236
-
4237
-
4238
-
4239
-
4240
-
4241
-
4242
-
4243
-
4244
-
4245
-
4246
-
4247
-
4248
-
4249
-
4250
-
4251
-
4252
-
4253
-
4254
-
4255
- </dl>
4256
-
4257
-
4258
-
4259
-
4260
-
4261
-
4262
-
4263
-
4264
-
4265
-
4266
-
4267
-
4268
-
4269
-
4270
-
4271
- </dd>
4272
-
4273
-
4274
-
4275
- <hr>
4276
- <dt>
4277
- <h4 class="name" id="event:tokenAboutToExpire">tokenAboutToExpire</h4>
4278
-
4279
-
4280
- </dt>
4281
- <dd>
4282
-
4283
-
4284
- <div class="description">
4285
- Fired when token is about to expire and needs to be updated.
4286
- </div>
4287
-
4288
-
4289
-
4290
-
4291
-
4292
- <h5>Type:
4293
- <span class="param-type">void</span>
4294
-
4295
-
4296
- </h5>
4297
-
4298
-
4299
-
4300
-
4301
-
4302
-
4303
- <dl class="details">
4304
-
4305
-
4306
-
4307
-
4308
-
4309
-
4310
-
4311
-
4312
-
4313
-
4314
-
4315
-
4316
-
4317
-
4318
-
4319
-
4320
-
4321
-
4322
-
4323
-
4324
-
4325
-
4326
-
4327
-
4328
-
4329
-
4330
-
4331
-
4332
-
4333
-
4334
-
4335
-
4336
-
4337
-
4338
-
4339
- </dl>
4340
-
4341
-
4342
-
4343
-
4344
-
4345
-
4346
-
4347
-
4348
-
4349
-
4350
-
4351
-
4352
-
4353
-
4354
-
4355
- </dd>
4356
-
4357
-
4358
-
4359
- <hr>
4360
- <dt>
4361
- <h4 class="name" id="event:tokenExpired">tokenExpired</h4>
4362
-
4363
-
4364
- </dt>
4365
- <dd>
4366
-
4367
-
4368
- <div class="description">
4369
- Fired when token is expired.
4370
- </div>
4371
-
4372
-
4373
-
4374
-
4375
-
4376
- <h5>Type:
4377
- <span class="param-type">void</span>
4378
-
4379
-
4380
- </h5>
4381
-
4382
-
4383
-
4384
-
4385
-
4386
-
4387
- <dl class="details">
4388
-
4389
-
4390
-
4391
-
4392
-
4393
-
4394
-
4395
-
4396
-
4397
-
4398
-
4399
-
4400
-
4401
-
4402
-
4403
-
4404
-
4405
-
4406
-
4407
-
4408
-
4409
-
4410
-
4411
-
4412
-
4413
-
4414
-
4415
-
4416
-
4417
-
4418
-
4419
-
4420
-
4421
-
4422
-
4423
- </dl>
4424
-
4425
-
4426
-
4427
-
4428
-
4429
-
4430
-
4431
-
4432
-
4433
-
4434
-
4435
-
4436
-
4437
-
4438
-
4439
- </dd>
4440
-
4441
-
4442
-
4443
- <hr>
4444
- <dt>
4445
- <h4 class="name" id="event:typingEnded">typingEnded</h4>
4446
-
4447
-
4448
- </dt>
4449
- <dd>
4450
-
4451
-
4452
- <div class="description">
4453
- Fired when a Participant has stopped typing.
4454
- </div>
4455
-
4456
-
4457
-
4458
-
4459
-
4460
- <h5>Type:
4461
- <span class="param-type"><a href="Participant.html">Participant</a></span>
4462
-
4463
-
4464
- </h5>
4465
-
4466
-
4467
-
4468
-
4469
-
4470
-
4471
- <dl class="details">
4472
-
4473
-
4474
-
4475
-
4476
-
4477
-
4478
-
4479
-
4480
-
4481
-
4482
-
4483
-
4484
-
4485
-
4486
-
4487
-
4488
-
4489
-
4490
-
4491
-
4492
-
4493
-
4494
-
4495
-
4496
-
4497
-
4498
-
4499
-
4500
-
4501
-
4502
-
4503
-
4504
-
4505
-
4506
-
4507
- </dl>
4508
-
4509
-
4510
-
4511
-
4512
-
4513
-
4514
-
4515
-
4516
-
4517
-
4518
-
4519
-
4520
-
4521
-
4522
-
4523
- </dd>
4524
-
4525
-
4526
-
4527
- <hr>
4528
- <dt>
4529
- <h4 class="name" id="event:typingStarted">typingStarted</h4>
4530
-
4531
-
4532
- </dt>
4533
- <dd>
4534
-
4535
-
4536
- <div class="description">
4537
- Fired when a Participant has started typing.
4538
- </div>
4539
-
4540
-
4541
-
4542
-
4543
-
4544
- <h5>Type:
4545
- <span class="param-type"><a href="Participant.html">Participant</a></span>
4546
-
4547
-
4548
- </h5>
4549
-
4550
-
4551
-
4552
-
4553
-
4554
-
4555
- <dl class="details">
4556
-
4557
-
4558
-
4559
-
4560
-
4561
-
4562
-
4563
-
4564
-
4565
-
4566
-
4567
-
4568
-
4569
-
4570
-
4571
-
4572
-
4573
-
4574
-
4575
-
4576
-
4577
-
4578
-
4579
-
4580
-
4581
-
4582
-
4583
-
4584
-
4585
-
4586
-
4587
-
4588
-
4589
-
4590
-
4591
- </dl>
4592
-
4593
-
4594
-
4595
-
4596
-
4597
-
4598
-
4599
-
4600
-
4601
-
4602
-
4603
-
4604
-
4605
-
4606
-
4607
- </dd>
4608
-
4609
-
4610
-
4611
- <hr>
4612
- <dt>
4613
- <h4 class="name" id="event:userSubscribed">userSubscribed</h4>
4614
-
4615
-
4616
- </dt>
4617
- <dd>
4618
-
4619
-
4620
- <div class="description">
4621
- Fired when the Client is subscribed to a User.
4622
- </div>
4623
-
4624
-
4625
-
4626
-
4627
-
4628
- <h5>Type:
4629
- <span class="param-type"><a href="User.html">User</a></span>
4630
-
4631
-
4632
- </h5>
4633
-
4634
-
4635
-
4636
-
4637
-
4638
-
4639
- <dl class="details">
4640
-
4641
-
4642
-
4643
-
4644
-
4645
-
4646
-
4647
-
4648
-
4649
-
4650
-
4651
-
4652
-
4653
-
4654
-
4655
-
4656
-
4657
-
4658
-
4659
-
4660
-
4661
-
4662
-
4663
-
4664
-
4665
-
4666
-
4667
-
4668
-
4669
-
4670
-
4671
-
4672
-
4673
-
4674
-
4675
- </dl>
4676
-
4677
-
4678
-
4679
-
4680
-
4681
-
4682
-
4683
-
4684
-
4685
-
4686
-
4687
-
4688
-
4689
-
4690
-
4691
- </dd>
4692
-
4693
-
4694
-
4695
- <hr>
4696
- <dt>
4697
- <h4 class="name" id="event:userUnsubscribed">userUnsubscribed</h4>
4698
-
4699
-
4700
- </dt>
4701
- <dd>
4702
-
4703
-
4704
- <div class="description">
4705
- Fired when the Client is unsubscribed from a User.
4706
- </div>
4707
-
4708
-
4709
-
4710
-
4711
-
4712
- <h5>Type:
4713
- <span class="param-type"><a href="User.html">User</a></span>
4714
-
4715
-
4716
- </h5>
4717
-
4718
-
4719
-
4720
-
4721
-
4722
-
4723
- <dl class="details">
4724
-
4725
-
4726
-
4727
-
4728
-
4729
-
4730
-
4731
-
4732
-
4733
-
4734
-
4735
-
4736
-
4737
-
4738
-
4739
-
4740
-
4741
-
4742
-
4743
-
4744
-
4745
-
4746
-
4747
-
4748
-
4749
-
4750
-
4751
-
4752
-
4753
-
4754
-
4755
-
4756
-
4757
-
4758
-
4759
- </dl>
4760
-
4761
-
4762
-
4763
-
4764
-
4765
-
4766
-
4767
-
4768
-
4769
-
4770
-
4771
-
4772
-
4773
-
4774
-
4775
- </dd>
4776
-
4777
-
4778
-
4779
- <hr>
4780
- <dt>
4781
- <h4 class="name" id="event:userUpdated">userUpdated</h4>
4782
-
4783
-
4784
- </dt>
4785
- <dd>
4786
-
4787
-
4788
- <div class="description">
4789
- Fired when the User&apos;s properties or reachability status have been updated.
4790
- </div>
4791
-
4792
-
4793
-
4794
-
4795
-
4796
- <h5>Type:
4797
- <span class="param-type">Object</span>
4798
-
4799
-
4800
- </h5>
4801
-
4802
-
4803
-
4804
-
4805
-
4806
-
4807
- <dl class="details">
4808
-
4809
-
4810
- <h5 class="subsection-title">Properties:</h5>
4811
-
4812
- <dl>
4813
-
4814
- <table class="props table table-striped">
4815
- <thead>
4816
- <tr>
4817
-
4818
- <th>Name</th>
4819
-
4820
-
4821
- <th>Type</th>
4822
-
4823
-
4824
-
4825
-
4826
-
4827
- <th class="last">Description</th>
4828
- </tr>
4829
- </thead>
4830
-
4831
- <tbody>
4832
-
4833
-
4834
- <tr>
4835
-
4836
- <td class="name"><code>user</code></td>
4837
-
4838
-
4839
- <td class="type">
4840
-
4841
-
4842
- <span class="param-type"><a href="User.html">User</a></span>
4843
-
4844
-
4845
-
4846
-
4847
- </td>
4848
-
4849
-
4850
-
4851
-
4852
-
4853
- <td class="description last">Updated User</td>
4854
- </tr>
4855
-
4856
-
4857
-
4858
- <tr>
4859
-
4860
- <td class="name"><code>updateReasons</code></td>
4861
-
4862
-
4863
- <td class="type">
4864
-
4865
-
4866
- <span class="param-type">Array.&lt;<a href="User.html#UpdateReason">User#UpdateReason</a>&gt;</span>
4867
-
4868
-
4869
-
4870
-
4871
- </td>
4872
-
4873
-
4874
-
4875
-
4876
-
4877
- <td class="description last">Array of User&apos;s updated event reasons</td>
4878
- </tr>
4879
-
4880
-
4881
- </tbody>
4882
- </table>
4883
- </dl>
4884
-
4885
-
4886
-
4887
-
4888
-
4889
-
4890
-
4891
-
4892
-
4893
-
4894
-
4895
-
4896
-
4897
-
4898
-
4899
-
4900
-
4901
-
4902
-
4903
-
4904
-
4905
-
4906
-
4907
-
4908
-
4909
-
4910
-
4911
-
4912
-
4913
-
4914
-
4915
-
4916
-
4917
-
4918
-
4919
-
4920
- </dl>
4921
-
4922
-
4923
-
4924
-
4925
-
4926
-
4927
-
4928
-
4929
-
4930
-
4931
-
4932
-
4933
-
4934
-
4935
-
4936
- </dd>
4937
-
4938
- </dl>
4939
-
4940
- </article>
4941
-
4942
- </section>
4943
-
4944
-
4945
-
4946
-
4947
- </div>
4948
- </div>
4949
-
4950
- <div class="clearfix"></div>
4951
-
4952
-
4953
- <div class="col-md-3">
4954
- <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
4955
- </div>
4956
-
4957
-
4958
- </div>
4959
- </div>
4960
-
4961
-
4962
- <div class="modal fade" id="searchResults">
4963
- <div class="modal-dialog">
4964
- <div class="modal-content">
4965
- <div class="modal-header">
4966
- <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&#xD7;</span></button>
4967
- <h4 class="modal-title">Search results</h4>
4968
- </div>
4969
- <div class="modal-body"></div>
4970
- <div class="modal-footer">
4971
- <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
4972
- </div>
4973
- </div><!-- /.modal-content -->
4974
- </div><!-- /.modal-dialog -->
4975
- </div>
4976
-
4977
-
4978
- <footer>
4979
-
4980
-
4981
- <span class="jsdoc-message">
4982
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
4983
-
4984
- on 2021-06-28T16:25:18+00:00
4985
-
4986
- using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
4987
- </span>
4988
- </footer>
4989
-
4990
- <script src="scripts/docstrap.lib.js"></script>
4991
- <script src="scripts/toc.js"></script>
4992
-
4993
- <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
4994
-
4995
-
4996
- <script>
4997
- $( function () {
4998
- $( "[id*='$']" ).each( function () {
4999
- var $this = $( this );
5000
-
5001
- $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
5002
- } );
5003
-
5004
- $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
5005
- var $this = $( this );
5006
-
5007
- var example = $this.find( "code" );
5008
- exampleText = example.html();
5009
- var lang = /{@lang (.*?)}/.exec( exampleText );
5010
- if ( lang && lang[1] ) {
5011
- exampleText = exampleText.replace( lang[0], "" );
5012
- example.html( exampleText );
5013
- lang = lang[1];
5014
- } else {
5015
- var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
5016
- lang = langClassMatch ? langClassMatch[1] : "javascript";
5017
- }
5018
-
5019
- if ( lang ) {
5020
-
5021
- $this
5022
- .addClass( "sunlight-highlight-" + lang )
5023
- .addClass( "linenums" )
5024
- .html( example.html() );
5025
-
5026
- }
5027
- } );
5028
-
5029
- Sunlight.highlightAll( {
5030
- lineNumbers : false,
5031
- showMenu : true,
5032
- enableDoclinks : true
5033
- } );
5034
-
5035
- $.catchAnchorLinks( {
5036
- navbarOffset: 10
5037
- } );
5038
- $( "#toc" ).toc( {
5039
- anchorName : function ( i, heading, prefix ) {
5040
- return $( heading ).attr( "id" ) || ( prefix + i );
5041
- },
5042
- selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
5043
- showAndHide : false,
5044
- smoothScrolling: true
5045
- } );
5046
-
5047
- $( "#main span[id^='toc']" ).addClass( "toc-shim" );
5048
- $( '.dropdown-toggle' ).dropdown();
5049
-
5050
- $( "table" ).each( function () {
5051
- var $this = $( this );
5052
- $this.addClass('table');
5053
- } );
5054
-
5055
- } );
5056
- </script>
5057
-
5058
-
5059
-
5060
- <!--Navigation and Symbol Display-->
5061
-
5062
-
5063
- <!--Google Analytics-->
5064
-
5065
-
5066
-
5067
- <script type="text/javascript">
5068
- $(document).ready(function() {
5069
- SearcherDisplay.init();
5070
- });
5071
- </script>
5072
-
5073
-
5074
-
5075
- </body></html>