@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
@@ -1,1934 +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: Message</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: Message</h1>
57
- <section>
58
-
59
- <header>
60
-
61
- <h2>
62
- Message
63
- </h2>
64
-
65
- <div class="class-description">A Message represents a Message in a Conversation.</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>author</code></td>
123
-
124
-
125
- <td class="type">
126
-
127
-
128
- <span class="param-type">String</span>
129
-
130
-
131
-
132
-
133
- </td>
134
-
135
-
136
-
137
-
138
-
139
- <td class="description last">The name of the user that sent Message</td>
140
- </tr>
141
-
142
-
143
-
144
- <tr>
145
-
146
- <td class="name"><code>subject</code></td>
147
-
148
-
149
- <td class="type">
150
-
151
-
152
- <span class="param-type">String</span>
153
- |
154
-
155
- <span class="param-type">null</span>
156
-
157
-
158
-
159
-
160
- </td>
161
-
162
-
163
-
164
-
165
-
166
- <td class="description last">Message subject. Used only in email conversations</td>
167
- </tr>
168
-
169
-
170
-
171
- <tr>
172
-
173
- <td class="name"><code>body</code></td>
174
-
175
-
176
- <td class="type">
177
-
178
-
179
- <span class="param-type">String</span>
180
-
181
-
182
-
183
-
184
- </td>
185
-
186
-
187
-
188
-
189
-
190
- <td class="description last">The body of the Message. Is null if Message is Media Message</td>
191
- </tr>
192
-
193
-
194
-
195
- <tr>
196
-
197
- <td class="name"><code>attributes</code></td>
198
-
199
-
200
- <td class="type">
201
-
202
-
203
- <span class="param-type">any</span>
204
-
205
-
206
-
207
-
208
- </td>
209
-
210
-
211
-
212
-
213
-
214
- <td class="description last">Message custom attributes</td>
215
- </tr>
216
-
217
-
218
-
219
- <tr>
220
-
221
- <td class="name"><code>conversation</code></td>
222
-
223
-
224
- <td class="type">
225
-
226
-
227
- <span class="param-type"><a href="Conversation.html">Conversation</a></span>
228
-
229
-
230
-
231
-
232
- </td>
233
-
234
-
235
-
236
-
237
-
238
- <td class="description last">Conversation Message belongs to</td>
239
- </tr>
240
-
241
-
242
-
243
- <tr>
244
-
245
- <td class="name"><code>dateCreated</code></td>
246
-
247
-
248
- <td class="type">
249
-
250
-
251
- <span class="param-type">Date</span>
252
-
253
-
254
-
255
-
256
- </td>
257
-
258
-
259
-
260
-
261
-
262
- <td class="description last">When Message was created</td>
263
- </tr>
264
-
265
-
266
-
267
- <tr>
268
-
269
- <td class="name"><code>dateUpdated</code></td>
270
-
271
-
272
- <td class="type">
273
-
274
-
275
- <span class="param-type">Date</span>
276
-
277
-
278
-
279
-
280
- </td>
281
-
282
-
283
-
284
-
285
-
286
- <td class="description last">When Message was updated</td>
287
- </tr>
288
-
289
-
290
-
291
- <tr>
292
-
293
- <td class="name"><code>index</code></td>
294
-
295
-
296
- <td class="type">
297
-
298
-
299
- <span class="param-type">Number</span>
300
-
301
-
302
-
303
-
304
- </td>
305
-
306
-
307
-
308
-
309
-
310
- <td class="description last">Index of Message in the Conversation&apos;s messages list
311
- By design of the conversations system the message indices may have arbitrary gaps between them,
312
- that does not necessarily mean they were deleted or otherwise modified - just that
313
- messages may have non-contiguous indices even if they are sent immediately one after another.
314
-
315
- Trying to use indices for some calculations is going to be unreliable.
316
-
317
- To calculate the number of unread messages it is better to use the read horizon API.
318
- See <a href="Conversation.html#getUnreadMessagesCount">Conversation#getUnreadMessagesCount</a> for details.</td>
319
- </tr>
320
-
321
-
322
-
323
- <tr>
324
-
325
- <td class="name"><code>lastUpdatedBy</code></td>
326
-
327
-
328
- <td class="type">
329
-
330
-
331
- <span class="param-type">String</span>
332
-
333
-
334
-
335
-
336
- </td>
337
-
338
-
339
-
340
-
341
-
342
- <td class="description last">Identity of the last user that updated Message</td>
343
- </tr>
344
-
345
-
346
-
347
- <tr>
348
-
349
- <td class="name"><code>media</code></td>
350
-
351
-
352
- <td class="type">
353
-
354
-
355
- <span class="param-type"><a href="Media.html">Media</a></span>
356
-
357
-
358
-
359
-
360
- </td>
361
-
362
-
363
-
364
-
365
-
366
- <td class="description last">Contains Media information (if present)</td>
367
- </tr>
368
-
369
-
370
-
371
- <tr>
372
-
373
- <td class="name"><code>participantSid</code></td>
374
-
375
-
376
- <td class="type">
377
-
378
-
379
- <span class="param-type">String</span>
380
-
381
-
382
-
383
-
384
- </td>
385
-
386
-
387
-
388
-
389
-
390
- <td class="description last">Authoring Participant&apos;s server-assigned unique identifier</td>
391
- </tr>
392
-
393
-
394
-
395
- <tr>
396
-
397
- <td class="name"><code>sid</code></td>
398
-
399
-
400
- <td class="type">
401
-
402
-
403
- <span class="param-type">String</span>
404
-
405
-
406
-
407
-
408
- </td>
409
-
410
-
411
-
412
-
413
-
414
- <td class="description last">The server-assigned unique identifier for Message</td>
415
- </tr>
416
-
417
-
418
-
419
- <tr>
420
-
421
- <td class="name"><code>type</code></td>
422
-
423
-
424
- <td class="type">
425
-
426
-
427
- <span class="param-type">&apos;text&apos;</span>
428
- |
429
-
430
- <span class="param-type">&apos;media&apos;</span>
431
-
432
-
433
-
434
-
435
- </td>
436
-
437
-
438
-
439
-
440
-
441
- <td class="description last">Type of message: &apos;text&apos; or &apos;media&apos;</td>
442
- </tr>
443
-
444
-
445
-
446
- <tr>
447
-
448
- <td class="name"><code>aggregatedDeliveryReceipt</code></td>
449
-
450
-
451
- <td class="type">
452
-
453
-
454
- <span class="param-type"><a href="AggregatedDeliveryReceipt.html">AggregatedDeliveryReceipt</a></span>
455
- |
456
-
457
- <span class="param-type">null</span>
458
-
459
-
460
-
461
-
462
- </td>
463
-
464
-
465
-
466
-
467
-
468
- <td class="description last">Aggregated information about
469
- Message delivery statuses across all <a href="Participant.html">Participant</a>s of a <a href="Conversation.html">Conversation</a>.</td>
470
- </tr>
471
-
472
-
473
- </tbody>
474
- </table>
475
- </dl>
476
-
477
-
478
-
479
-
480
-
481
-
482
-
483
-
484
-
485
-
486
-
487
-
488
-
489
-
490
-
491
-
492
-
493
-
494
-
495
-
496
-
497
-
498
-
499
-
500
-
501
-
502
-
503
-
504
-
505
-
506
-
507
-
508
-
509
-
510
-
511
-
512
- </dl>
513
-
514
-
515
-
516
-
517
-
518
- <h5>Fires:</h5>
519
- <ul>
520
- <li><a href="Message.html#event:updated">Message#event:updated</a></li>
521
- </ul>
522
-
523
-
524
-
525
-
526
-
527
-
528
-
529
-
530
-
531
-
532
-
533
- </dd>
534
-
535
-
536
- </div>
537
-
538
-
539
-
540
-
541
-
542
-
543
-
544
-
545
-
546
-
547
-
548
-
549
- <h3 class="subsection-title">Members</h3>
550
-
551
- <dl>
552
-
553
- <hr>
554
- <dt class="name" id="attachedMedia">
555
- <h4 id="attachedMedia"><span class="type-signature"></span>attachedMedia<span class="type-signature"></span></h4>
556
-
557
-
558
- </dt>
559
- <dd>
560
-
561
- <div class="description">
562
- Return all media attachments, except email body/history attachments, without temporary urls.
563
- </div>
564
-
565
-
566
-
567
-
568
-
569
- <dl class="details">
570
-
571
-
572
-
573
-
574
-
575
-
576
-
577
-
578
-
579
-
580
-
581
-
582
-
583
-
584
-
585
-
586
-
587
-
588
-
589
-
590
-
591
-
592
-
593
-
594
-
595
-
596
-
597
-
598
-
599
-
600
-
601
-
602
-
603
-
604
-
605
- </dl>
606
-
607
-
608
-
609
- </dd>
610
-
611
-
612
-
613
- <hr>
614
- <dt class="name" id="media">
615
- <h4 id="media"><span class="type-signature"></span>media<span class="type-signature"></span></h4>
616
-
617
-
618
- </dt>
619
- <dd>
620
-
621
- <div class="description">
622
- One of the attached media.
623
- </div>
624
-
625
-
626
-
627
-
628
-
629
- <dl class="details">
630
-
631
-
632
-
633
-
634
-
635
-
636
-
637
-
638
-
639
-
640
-
641
-
642
-
643
-
644
-
645
-
646
-
647
- <dt class="important tag-deprecated method-doc-label method-doc-details-label">Deprecated:</dt>
648
-
649
- <dd>
650
- <ul class="dummy">
651
- <li>Use attachedMedia instead. Note that the latter is now an array.</li>
652
- </ul>
653
- </dd>
654
-
655
-
656
-
657
-
658
-
659
-
660
-
661
-
662
-
663
-
664
-
665
-
666
-
667
-
668
-
669
-
670
-
671
-
672
-
673
-
674
- </dl>
675
-
676
-
677
-
678
- </dd>
679
-
680
- </dl>
681
-
682
-
683
-
684
- <h3 class="subsection-title">Methods</h3>
685
-
686
- <dl>
687
-
688
- <hr>
689
- <dt>
690
- <h4 class="name" id="attachTemporaryUrlsFor"><span class="type-signature"></span>attachTemporaryUrlsFor(contentSet)</h4>
691
-
692
-
693
- </dt>
694
- <dd>
695
-
696
-
697
- <div class="description">
698
- Get content URLs for all media attachments in the given set using single operation.
699
- </div>
700
-
701
-
702
-
703
-
704
-
705
-
706
-
707
-
708
- <h5>Parameters:</h5>
709
-
710
-
711
- <table class="params table table-striped">
712
- <thead>
713
- <tr>
714
-
715
- <th>Name</th>
716
-
717
-
718
- <th>Type</th>
719
-
720
-
721
-
722
-
723
-
724
- <th class="last">Description</th>
725
- </tr>
726
- </thead>
727
-
728
- <tbody>
729
-
730
-
731
- <tr>
732
-
733
- <td class="name"><code>contentSet</code></td>
734
-
735
-
736
- <td class="type">
737
-
738
- </td>
739
-
740
-
741
-
742
-
743
-
744
- <td class="description last">Set of media attachments to query for content URL.</td>
745
- </tr>
746
-
747
-
748
- </tbody>
749
- </table>
750
-
751
-
752
-
753
-
754
- <dl class="details">
755
-
756
-
757
-
758
-
759
-
760
-
761
-
762
-
763
-
764
-
765
-
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
- </dl>
791
-
792
-
793
-
794
-
795
-
796
-
797
-
798
-
799
-
800
-
801
-
802
-
803
-
804
-
805
-
806
- </dd>
807
-
808
-
809
-
810
- <hr>
811
- <dt>
812
- <h4 class="name" id="getDetailedDeliveryReceipts"><span class="type-signature"></span>getDetailedDeliveryReceipts()</h4>
813
-
814
-
815
- </dt>
816
- <dd>
817
-
818
-
819
- <div class="description">
820
- Get delivery receipts of the message
821
- </div>
822
-
823
-
824
-
825
-
826
-
827
-
828
-
829
-
830
-
831
-
832
- <dl class="details">
833
-
834
-
835
-
836
-
837
-
838
-
839
-
840
-
841
-
842
-
843
-
844
-
845
-
846
-
847
-
848
-
849
-
850
-
851
-
852
-
853
-
854
-
855
-
856
-
857
-
858
-
859
-
860
-
861
-
862
-
863
-
864
-
865
-
866
-
867
-
868
- </dl>
869
-
870
-
871
-
872
-
873
-
874
-
875
-
876
-
877
-
878
-
879
-
880
-
881
-
882
- <h5>Returns:</h5>
883
-
884
-
885
-
886
-
887
- <dl>
888
- <dt>
889
- Type
890
- </dt>
891
- <dd>
892
-
893
- <span class="param-type">Promise.&lt;Array.&lt;<a href="DetailedDeliveryReceipt.html">DetailedDeliveryReceipt</a>&gt;&gt;</span>
894
-
895
-
896
-
897
- </dd>
898
- </dl>
899
-
900
-
901
-
902
-
903
-
904
- </dd>
905
-
906
-
907
-
908
- <hr>
909
- <dt>
910
- <h4 class="name" id="getMediaByCategory"><span class="type-signature"></span>getMediaByCategory(categories)</h4>
911
-
912
-
913
- </dt>
914
- <dd>
915
-
916
-
917
- <div class="description">
918
- Return a (possibly empty) array of media matching a specific set of categories.
919
- Allowed categories are &apos;media&apos;, &apos;body&apos; and &apos;history&apos;.
920
- </div>
921
-
922
-
923
-
924
-
925
-
926
-
927
-
928
-
929
- <h5>Parameters:</h5>
930
-
931
-
932
- <table class="params table table-striped">
933
- <thead>
934
- <tr>
935
-
936
- <th>Name</th>
937
-
938
-
939
- <th>Type</th>
940
-
941
-
942
-
943
-
944
-
945
- <th class="last">Description</th>
946
- </tr>
947
- </thead>
948
-
949
- <tbody>
950
-
951
-
952
- <tr>
953
-
954
- <td class="name"><code>categories</code></td>
955
-
956
-
957
- <td class="type">
958
-
959
- </td>
960
-
961
-
962
-
963
-
964
-
965
- <td class="description last">Array of categories to match.</td>
966
- </tr>
967
-
968
-
969
- </tbody>
970
- </table>
971
-
972
-
973
-
974
-
975
- <dl class="details">
976
-
977
-
978
-
979
-
980
-
981
-
982
-
983
-
984
-
985
-
986
-
987
-
988
-
989
-
990
-
991
-
992
-
993
-
994
-
995
-
996
-
997
-
998
-
999
-
1000
-
1001
-
1002
-
1003
-
1004
-
1005
-
1006
-
1007
-
1008
-
1009
-
1010
-
1011
- </dl>
1012
-
1013
-
1014
-
1015
-
1016
-
1017
-
1018
-
1019
-
1020
-
1021
-
1022
-
1023
-
1024
-
1025
- <h5>Returns:</h5>
1026
-
1027
-
1028
- <div class="param-desc">
1029
- Array of media descriptors matching given categories.
1030
- </div>
1031
-
1032
-
1033
-
1034
-
1035
-
1036
-
1037
-
1038
- </dd>
1039
-
1040
-
1041
-
1042
- <hr>
1043
- <dt>
1044
- <h4 class="name" id="getParticipant"><span class="type-signature"></span>getParticipant()</h4>
1045
-
1046
-
1047
- </dt>
1048
- <dd>
1049
-
1050
-
1051
- <div class="description">
1052
- Get Participant who is author of the Message
1053
- </div>
1054
-
1055
-
1056
-
1057
-
1058
-
1059
-
1060
-
1061
-
1062
-
1063
-
1064
- <dl class="details">
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
-
1098
-
1099
-
1100
- </dl>
1101
-
1102
-
1103
-
1104
-
1105
-
1106
-
1107
-
1108
-
1109
-
1110
-
1111
-
1112
-
1113
-
1114
- <h5>Returns:</h5>
1115
-
1116
-
1117
-
1118
-
1119
- <dl>
1120
- <dt>
1121
- Type
1122
- </dt>
1123
- <dd>
1124
-
1125
- <span class="param-type">Promise.&lt;<a href="Participant.html">Participant</a>&gt;</span>
1126
-
1127
-
1128
-
1129
- </dd>
1130
- </dl>
1131
-
1132
-
1133
-
1134
-
1135
-
1136
- </dd>
1137
-
1138
-
1139
-
1140
- <hr>
1141
- <dt>
1142
- <h4 class="name" id="remove"><span class="type-signature"></span>remove()</h4>
1143
-
1144
-
1145
- </dt>
1146
- <dd>
1147
-
1148
-
1149
- <div class="description">
1150
- Remove the Message.
1151
- </div>
1152
-
1153
-
1154
-
1155
-
1156
-
1157
-
1158
-
1159
-
1160
-
1161
-
1162
- <dl class="details">
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
-
1196
-
1197
-
1198
- </dl>
1199
-
1200
-
1201
-
1202
-
1203
-
1204
-
1205
-
1206
-
1207
-
1208
-
1209
-
1210
-
1211
-
1212
- <h5>Returns:</h5>
1213
-
1214
-
1215
-
1216
-
1217
- <dl>
1218
- <dt>
1219
- Type
1220
- </dt>
1221
- <dd>
1222
-
1223
- <span class="param-type">Promise.&lt;<a href="Message.html">Message</a>&gt;</span>
1224
-
1225
-
1226
-
1227
- </dd>
1228
- </dl>
1229
-
1230
-
1231
-
1232
-
1233
-
1234
- </dd>
1235
-
1236
-
1237
-
1238
- <hr>
1239
- <dt>
1240
- <h4 class="name" id="updateAttributes"><span class="type-signature"></span>updateAttributes(attributes)</h4>
1241
-
1242
-
1243
- </dt>
1244
- <dd>
1245
-
1246
-
1247
- <div class="description">
1248
- Edit message attributes.
1249
- </div>
1250
-
1251
-
1252
-
1253
-
1254
-
1255
-
1256
-
1257
-
1258
- <h5>Parameters:</h5>
1259
-
1260
-
1261
- <table class="params table table-striped">
1262
- <thead>
1263
- <tr>
1264
-
1265
- <th>Name</th>
1266
-
1267
-
1268
- <th>Type</th>
1269
-
1270
-
1271
-
1272
-
1273
-
1274
- <th class="last">Description</th>
1275
- </tr>
1276
- </thead>
1277
-
1278
- <tbody>
1279
-
1280
-
1281
- <tr>
1282
-
1283
- <td class="name"><code>attributes</code></td>
1284
-
1285
-
1286
- <td class="type">
1287
-
1288
-
1289
- <span class="param-type">any</span>
1290
-
1291
-
1292
-
1293
-
1294
- </td>
1295
-
1296
-
1297
-
1298
-
1299
-
1300
- <td class="description last">new attributes for Message.</td>
1301
- </tr>
1302
-
1303
-
1304
- </tbody>
1305
- </table>
1306
-
1307
-
1308
-
1309
-
1310
- <dl class="details">
1311
-
1312
-
1313
-
1314
-
1315
-
1316
-
1317
-
1318
-
1319
-
1320
-
1321
-
1322
-
1323
-
1324
-
1325
-
1326
-
1327
-
1328
-
1329
-
1330
-
1331
-
1332
-
1333
-
1334
-
1335
-
1336
-
1337
-
1338
-
1339
-
1340
-
1341
-
1342
-
1343
-
1344
-
1345
-
1346
- </dl>
1347
-
1348
-
1349
-
1350
-
1351
-
1352
-
1353
-
1354
-
1355
-
1356
-
1357
-
1358
-
1359
-
1360
- <h5>Returns:</h5>
1361
-
1362
-
1363
-
1364
-
1365
- <dl>
1366
- <dt>
1367
- Type
1368
- </dt>
1369
- <dd>
1370
-
1371
- <span class="param-type">Promise.&lt;<a href="Message.html">Message</a>&gt;</span>
1372
-
1373
-
1374
-
1375
- </dd>
1376
- </dl>
1377
-
1378
-
1379
-
1380
-
1381
-
1382
- </dd>
1383
-
1384
-
1385
-
1386
- <hr>
1387
- <dt>
1388
- <h4 class="name" id="updateBody"><span class="type-signature"></span>updateBody(body)</h4>
1389
-
1390
-
1391
- </dt>
1392
- <dd>
1393
-
1394
-
1395
- <div class="description">
1396
- Edit message body.
1397
- </div>
1398
-
1399
-
1400
-
1401
-
1402
-
1403
-
1404
-
1405
-
1406
- <h5>Parameters:</h5>
1407
-
1408
-
1409
- <table class="params table table-striped">
1410
- <thead>
1411
- <tr>
1412
-
1413
- <th>Name</th>
1414
-
1415
-
1416
- <th>Type</th>
1417
-
1418
-
1419
-
1420
-
1421
-
1422
- <th class="last">Description</th>
1423
- </tr>
1424
- </thead>
1425
-
1426
- <tbody>
1427
-
1428
-
1429
- <tr>
1430
-
1431
- <td class="name"><code>body</code></td>
1432
-
1433
-
1434
- <td class="type">
1435
-
1436
-
1437
- <span class="param-type">String</span>
1438
-
1439
-
1440
-
1441
-
1442
- </td>
1443
-
1444
-
1445
-
1446
-
1447
-
1448
- <td class="description last">new body of Message.</td>
1449
- </tr>
1450
-
1451
-
1452
- </tbody>
1453
- </table>
1454
-
1455
-
1456
-
1457
-
1458
- <dl class="details">
1459
-
1460
-
1461
-
1462
-
1463
-
1464
-
1465
-
1466
-
1467
-
1468
-
1469
-
1470
-
1471
-
1472
-
1473
-
1474
-
1475
-
1476
-
1477
-
1478
-
1479
-
1480
-
1481
-
1482
-
1483
-
1484
-
1485
-
1486
-
1487
-
1488
-
1489
-
1490
-
1491
-
1492
-
1493
-
1494
- </dl>
1495
-
1496
-
1497
-
1498
-
1499
-
1500
-
1501
-
1502
-
1503
-
1504
-
1505
-
1506
-
1507
-
1508
- <h5>Returns:</h5>
1509
-
1510
-
1511
-
1512
-
1513
- <dl>
1514
- <dt>
1515
- Type
1516
- </dt>
1517
- <dd>
1518
-
1519
- <span class="param-type">Promise.&lt;<a href="Message.html">Message</a>&gt;</span>
1520
-
1521
-
1522
-
1523
- </dd>
1524
- </dl>
1525
-
1526
-
1527
-
1528
-
1529
-
1530
- </dd>
1531
-
1532
- </dl>
1533
-
1534
-
1535
-
1536
- <h3 class="subsection-title">Type Definitions</h3>
1537
-
1538
- <dl>
1539
-
1540
- <hr>
1541
- <dt class="name" id="UpdateReason">
1542
- <h4 id="UpdateReason">UpdateReason</h4>
1543
-
1544
-
1545
- </dt>
1546
- <dd>
1547
-
1548
- <div class="description">
1549
- The update reason for <code>updated</code> event emitted on Message
1550
- </div>
1551
-
1552
-
1553
-
1554
- <h5>Type:</h5>
1555
- <ul>
1556
- <li>
1557
-
1558
- <span class="param-type">&apos;body&apos;</span>
1559
- |
1560
-
1561
- <span class="param-type">&apos;lastUpdatedBy&apos;</span>
1562
- |
1563
-
1564
- <span class="param-type">&apos;dateCreated&apos;</span>
1565
- |
1566
-
1567
- <span class="param-type">&apos;dateUpdated&apos;</span>
1568
- |
1569
-
1570
- <span class="param-type">&apos;attributes&apos;</span>
1571
- |
1572
-
1573
- <span class="param-type">&apos;author&apos;</span>
1574
- |
1575
-
1576
- <span class="param-type">&apos;deliveryReceipt&apos;</span>
1577
- |
1578
-
1579
- <span class="param-type">&apos;subject&apos;</span>
1580
-
1581
-
1582
-
1583
- </li>
1584
- </ul>
1585
-
1586
-
1587
-
1588
- <dl class="details">
1589
-
1590
-
1591
-
1592
-
1593
-
1594
-
1595
-
1596
-
1597
-
1598
-
1599
-
1600
-
1601
-
1602
-
1603
-
1604
-
1605
-
1606
-
1607
-
1608
-
1609
-
1610
-
1611
-
1612
-
1613
-
1614
-
1615
-
1616
-
1617
-
1618
-
1619
-
1620
-
1621
-
1622
-
1623
-
1624
- </dl>
1625
-
1626
-
1627
-
1628
- </dd>
1629
-
1630
- </dl>
1631
-
1632
-
1633
-
1634
- <h3 class="subsection-title">Events</h3>
1635
-
1636
- <dl>
1637
-
1638
- <hr>
1639
- <dt>
1640
- <h4 class="name" id="event:updated">updated</h4>
1641
-
1642
-
1643
- </dt>
1644
- <dd>
1645
-
1646
-
1647
- <div class="description">
1648
- Fired when the Message&apos;s properties or body has been updated.
1649
- </div>
1650
-
1651
-
1652
-
1653
-
1654
-
1655
- <h5>Type:
1656
- <span class="param-type">Object</span>
1657
-
1658
-
1659
- </h5>
1660
-
1661
-
1662
-
1663
-
1664
-
1665
-
1666
- <dl class="details">
1667
-
1668
-
1669
- <h5 class="subsection-title">Properties:</h5>
1670
-
1671
- <dl>
1672
-
1673
- <table class="props table table-striped">
1674
- <thead>
1675
- <tr>
1676
-
1677
- <th>Name</th>
1678
-
1679
-
1680
- <th>Type</th>
1681
-
1682
-
1683
-
1684
-
1685
-
1686
- <th class="last">Description</th>
1687
- </tr>
1688
- </thead>
1689
-
1690
- <tbody>
1691
-
1692
-
1693
- <tr>
1694
-
1695
- <td class="name"><code>message</code></td>
1696
-
1697
-
1698
- <td class="type">
1699
-
1700
-
1701
- <span class="param-type"><a href="Message.html">Message</a></span>
1702
-
1703
-
1704
-
1705
-
1706
- </td>
1707
-
1708
-
1709
-
1710
-
1711
-
1712
- <td class="description last">Updated Message</td>
1713
- </tr>
1714
-
1715
-
1716
-
1717
- <tr>
1718
-
1719
- <td class="name"><code>updateReasons</code></td>
1720
-
1721
-
1722
- <td class="type">
1723
-
1724
-
1725
- <span class="param-type">Array.&lt;<a href="Message.html#UpdateReason">Message#UpdateReason</a>&gt;</span>
1726
-
1727
-
1728
-
1729
-
1730
- </td>
1731
-
1732
-
1733
-
1734
-
1735
-
1736
- <td class="description last">Array of Message&apos;s updated event reasons</td>
1737
- </tr>
1738
-
1739
-
1740
- </tbody>
1741
- </table>
1742
- </dl>
1743
-
1744
-
1745
-
1746
-
1747
-
1748
-
1749
-
1750
-
1751
-
1752
-
1753
-
1754
-
1755
-
1756
-
1757
-
1758
-
1759
-
1760
-
1761
-
1762
-
1763
-
1764
-
1765
-
1766
-
1767
-
1768
-
1769
-
1770
-
1771
-
1772
-
1773
-
1774
-
1775
-
1776
-
1777
-
1778
-
1779
- </dl>
1780
-
1781
-
1782
-
1783
-
1784
-
1785
-
1786
-
1787
-
1788
-
1789
-
1790
-
1791
-
1792
-
1793
-
1794
-
1795
- </dd>
1796
-
1797
- </dl>
1798
-
1799
- </article>
1800
-
1801
- </section>
1802
-
1803
-
1804
-
1805
-
1806
- </div>
1807
- </div>
1808
-
1809
- <div class="clearfix"></div>
1810
-
1811
-
1812
- <div class="col-md-3">
1813
- <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
1814
- </div>
1815
-
1816
-
1817
- </div>
1818
- </div>
1819
-
1820
-
1821
- <div class="modal fade" id="searchResults">
1822
- <div class="modal-dialog">
1823
- <div class="modal-content">
1824
- <div class="modal-header">
1825
- <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&#xD7;</span></button>
1826
- <h4 class="modal-title">Search results</h4>
1827
- </div>
1828
- <div class="modal-body"></div>
1829
- <div class="modal-footer">
1830
- <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
1831
- </div>
1832
- </div><!-- /.modal-content -->
1833
- </div><!-- /.modal-dialog -->
1834
- </div>
1835
-
1836
-
1837
- <footer>
1838
-
1839
-
1840
- <span class="jsdoc-message">
1841
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
1842
-
1843
- on 2021-06-30T16:21:28+00:00
1844
-
1845
- using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
1846
- </span>
1847
- </footer>
1848
-
1849
- <script src="scripts/docstrap.lib.js"></script>
1850
- <script src="scripts/toc.js"></script>
1851
-
1852
- <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
1853
-
1854
-
1855
- <script>
1856
- $( function () {
1857
- $( "[id*='$']" ).each( function () {
1858
- var $this = $( this );
1859
-
1860
- $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
1861
- } );
1862
-
1863
- $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
1864
- var $this = $( this );
1865
-
1866
- var example = $this.find( "code" );
1867
- exampleText = example.html();
1868
- var lang = /{@lang (.*?)}/.exec( exampleText );
1869
- if ( lang && lang[1] ) {
1870
- exampleText = exampleText.replace( lang[0], "" );
1871
- example.html( exampleText );
1872
- lang = lang[1];
1873
- } else {
1874
- var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
1875
- lang = langClassMatch ? langClassMatch[1] : "javascript";
1876
- }
1877
-
1878
- if ( lang ) {
1879
-
1880
- $this
1881
- .addClass( "sunlight-highlight-" + lang )
1882
- .addClass( "linenums" )
1883
- .html( example.html() );
1884
-
1885
- }
1886
- } );
1887
-
1888
- Sunlight.highlightAll( {
1889
- lineNumbers : false,
1890
- showMenu : true,
1891
- enableDoclinks : true
1892
- } );
1893
-
1894
- $.catchAnchorLinks( {
1895
- navbarOffset: 10
1896
- } );
1897
- $( "#toc" ).toc( {
1898
- anchorName : function ( i, heading, prefix ) {
1899
- return $( heading ).attr( "id" ) || ( prefix + i );
1900
- },
1901
- selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
1902
- showAndHide : false,
1903
- smoothScrolling: true
1904
- } );
1905
-
1906
- $( "#main span[id^='toc']" ).addClass( "toc-shim" );
1907
- $( '.dropdown-toggle' ).dropdown();
1908
-
1909
- $( "table" ).each( function () {
1910
- var $this = $( this );
1911
- $this.addClass('table');
1912
- } );
1913
-
1914
- } );
1915
- </script>
1916
-
1917
-
1918
-
1919
- <!--Navigation and Symbol Display-->
1920
-
1921
-
1922
- <!--Google Analytics-->
1923
-
1924
-
1925
-
1926
- <script type="text/javascript">
1927
- $(document).ready(function() {
1928
- SearcherDisplay.init();
1929
- });
1930
- </script>
1931
-
1932
-
1933
-
1934
- </body></html>