@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,948 +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: AggregatedDeliveryReceipt</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: AggregatedDeliveryReceipt</h1>
57
- <section>
58
-
59
- <header>
60
-
61
- <h2>
62
- AggregatedDeliveryReceipt
63
- </h2>
64
-
65
- <div class="class-description">Contains aggregated information about a <a href="Message.html">Message</a>&apos;s delivery statuses across all <a href="Participant.html">Participant</a>s
66
- of a <a href="Conversation.html">Conversation</a>.
67
-
68
- At any moment during delivering message to a <a href="Participant.html">Participant</a> the message can have zero or more of following
69
- delivery statuses:
70
-
71
- <ul><li>
72
- Message considered as <b>sent</b> to a participant, if the nearest upstream carrier accepted the message.
73
- </li><li>
74
- Message considered as <b>delivered</b> to a participant, if Twilio has received confirmation of message
75
- delivery from the upstream carrier, and, where available, the destination handset.
76
- </li><li>
77
- Message considered as <b>undelivered</b> to a participant, if Twilio has received a delivery receipt
78
- indicating that the message was not delivered. This can happen for many reasons including carrier content
79
- filtering and the availability of the destination handset.
80
- </li><li>
81
- Message considered as <b>read</b> by a participant, if the message has been delivered and opened by the
82
- recipient in the conversation. The recipient must have enabled read receipts.
83
- </li><li>
84
- Message considered as <b>failed</b> to be delivered to a participant if the message could not be sent.
85
- This can happen for various reasons including queue overflows, account suspensions and media
86
- errors (in the case of MMS for instance).
87
- </li></ul>
88
-
89
- <a href="AggregatedDeliveryReceipt.html">AggregatedDeliveryReceipt</a> class contains aggregated value <a href="AggregatedDeliveryReceipt.html#DeliveryAmount">AggregatedDeliveryReceipt#DeliveryAmount</a> for each delivery status.</div>
90
-
91
-
92
- </header>
93
-
94
-
95
- <article>
96
- <div class="container-overview">
97
-
98
-
99
- <hr>
100
- <dt>
101
-
102
-
103
-
104
- </dt>
105
- <dd>
106
-
107
-
108
-
109
-
110
-
111
-
112
-
113
-
114
-
115
-
116
-
117
- <dl class="details">
118
-
119
-
120
- <h5 class="subsection-title">Properties:</h5>
121
-
122
- <dl>
123
-
124
- <table class="props table table-striped">
125
- <thead>
126
- <tr>
127
-
128
- <th>Name</th>
129
-
130
-
131
- <th>Type</th>
132
-
133
-
134
-
135
-
136
-
137
- <th class="last">Description</th>
138
- </tr>
139
- </thead>
140
-
141
- <tbody>
142
-
143
-
144
- <tr>
145
-
146
- <td class="name"><code>total</code></td>
147
-
148
-
149
- <td class="type">
150
-
151
-
152
- <span class="param-type">number</span>
153
-
154
-
155
-
156
-
157
- </td>
158
-
159
-
160
-
161
-
162
-
163
- <td class="description last">Maximum number of delivery events expected for the message</td>
164
- </tr>
165
-
166
-
167
-
168
- <tr>
169
-
170
- <td class="name"><code>sent</code></td>
171
-
172
-
173
- <td class="type">
174
-
175
-
176
- <span class="param-type"><a href="AggregatedDeliveryReceipt.html#DeliveryAmount">AggregatedDeliveryReceipt#DeliveryAmount</a></span>
177
-
178
-
179
-
180
-
181
- </td>
182
-
183
-
184
-
185
-
186
-
187
- <td class="description last">Amount of participants that have <b>sent</b> delivery status for the message.</td>
188
- </tr>
189
-
190
-
191
-
192
- <tr>
193
-
194
- <td class="name"><code>delivered</code></td>
195
-
196
-
197
- <td class="type">
198
-
199
-
200
- <span class="param-type"><a href="AggregatedDeliveryReceipt.html#DeliveryAmount">AggregatedDeliveryReceipt#DeliveryAmount</a></span>
201
-
202
-
203
-
204
-
205
- </td>
206
-
207
-
208
-
209
-
210
-
211
- <td class="description last">Amount of participants that have <b>delivered</b> delivery status
212
- for the message.</td>
213
- </tr>
214
-
215
-
216
-
217
- <tr>
218
-
219
- <td class="name"><code>read</code></td>
220
-
221
-
222
- <td class="type">
223
-
224
-
225
- <span class="param-type"><a href="AggregatedDeliveryReceipt.html#DeliveryAmount">AggregatedDeliveryReceipt#DeliveryAmount</a></span>
226
-
227
-
228
-
229
-
230
- </td>
231
-
232
-
233
-
234
-
235
-
236
- <td class="description last">Amount of participants that have <b>read</b> delivery status for the message.</td>
237
- </tr>
238
-
239
-
240
-
241
- <tr>
242
-
243
- <td class="name"><code>undelivered</code></td>
244
-
245
-
246
- <td class="type">
247
-
248
-
249
- <span class="param-type"><a href="AggregatedDeliveryReceipt.html#DeliveryAmount">AggregatedDeliveryReceipt#DeliveryAmount</a></span>
250
-
251
-
252
-
253
-
254
- </td>
255
-
256
-
257
-
258
-
259
-
260
- <td class="description last">Amount of participants that have <b>undelivered</b> delivery status
261
- for the message.</td>
262
- </tr>
263
-
264
-
265
-
266
- <tr>
267
-
268
- <td class="name"><code>failed</code></td>
269
-
270
-
271
- <td class="type">
272
-
273
-
274
- <span class="param-type"><a href="AggregatedDeliveryReceipt.html#DeliveryAmount">AggregatedDeliveryReceipt#DeliveryAmount</a></span>
275
-
276
-
277
-
278
-
279
- </td>
280
-
281
-
282
-
283
-
284
-
285
- <td class="description last">Amount of participants that have <b>failed</b> delivery status for the message.</td>
286
- </tr>
287
-
288
-
289
- </tbody>
290
- </table>
291
- </dl>
292
-
293
-
294
-
295
-
296
-
297
-
298
-
299
-
300
-
301
-
302
-
303
-
304
-
305
-
306
-
307
-
308
-
309
-
310
-
311
-
312
-
313
-
314
-
315
-
316
-
317
-
318
-
319
-
320
-
321
-
322
-
323
-
324
-
325
-
326
-
327
-
328
- </dl>
329
-
330
-
331
-
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
-
343
-
344
- </dd>
345
-
346
-
347
- </div>
348
-
349
-
350
-
351
-
352
-
353
-
354
-
355
-
356
-
357
-
358
-
359
-
360
- <h3 class="subsection-title">Members</h3>
361
-
362
- <dl>
363
-
364
- <hr>
365
- <dt class="name" id="delivered">
366
- <h4 id="delivered"><span class="type-signature"></span>delivered<span class="type-signature"></span></h4>
367
-
368
-
369
- </dt>
370
- <dd>
371
-
372
- <div class="description">
373
- Message considered as <b>delivered</b> to a participant, if Twilio has received confirmation of message
374
- delivery from the upstream carrier, and, where available, the destination handset.
375
- </div>
376
-
377
-
378
-
379
-
380
-
381
- <dl class="details">
382
-
383
-
384
-
385
-
386
-
387
-
388
-
389
-
390
-
391
-
392
-
393
-
394
-
395
-
396
-
397
-
398
-
399
-
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
-
411
-
412
-
413
-
414
-
415
-
416
-
417
- </dl>
418
-
419
-
420
-
421
- </dd>
422
-
423
-
424
-
425
- <hr>
426
- <dt class="name" id="failed">
427
- <h4 id="failed"><span class="type-signature"></span>failed<span class="type-signature"></span></h4>
428
-
429
-
430
- </dt>
431
- <dd>
432
-
433
- <div class="description">
434
- Message considered as <b>failed</b> to be delivered to a participant if the message could not be sent.
435
- This can happen for various reasons including queue overflows, account suspensions and media
436
- errors (in the case of MMS for instance). Twilio does not charge you for failed messages.
437
- </div>
438
-
439
-
440
-
441
-
442
-
443
- <dl class="details">
444
-
445
-
446
-
447
-
448
-
449
-
450
-
451
-
452
-
453
-
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
- </dl>
480
-
481
-
482
-
483
- </dd>
484
-
485
-
486
-
487
- <hr>
488
- <dt class="name" id="read">
489
- <h4 id="read"><span class="type-signature"></span>read<span class="type-signature"></span></h4>
490
-
491
-
492
- </dt>
493
- <dd>
494
-
495
- <div class="description">
496
- Message considered as <b>read</b> by a participant, if the message has been delivered and opened by the
497
- recipient in the conversation. The recipient must have enabled read receipts.
498
- </div>
499
-
500
-
501
-
502
-
503
-
504
- <dl class="details">
505
-
506
-
507
-
508
-
509
-
510
-
511
-
512
-
513
-
514
-
515
-
516
-
517
-
518
-
519
-
520
-
521
-
522
-
523
-
524
-
525
-
526
-
527
-
528
-
529
-
530
-
531
-
532
-
533
-
534
-
535
-
536
-
537
-
538
-
539
-
540
- </dl>
541
-
542
-
543
-
544
- </dd>
545
-
546
-
547
-
548
- <hr>
549
- <dt class="name" id="sent">
550
- <h4 id="sent"><span class="type-signature"></span>sent<span class="type-signature"></span></h4>
551
-
552
-
553
- </dt>
554
- <dd>
555
-
556
- <div class="description">
557
- Message considered as <b>sent</b> to a participant, if the nearest upstream carrier accepted the message.
558
- </div>
559
-
560
-
561
-
562
-
563
-
564
- <dl class="details">
565
-
566
-
567
-
568
-
569
-
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
- </dl>
601
-
602
-
603
-
604
- </dd>
605
-
606
-
607
-
608
- <hr>
609
- <dt class="name" id="total">
610
- <h4 id="total"><span class="type-signature"></span>total<span class="type-signature"></span></h4>
611
-
612
-
613
- </dt>
614
- <dd>
615
-
616
-
617
-
618
-
619
-
620
- <dl class="details">
621
-
622
-
623
-
624
-
625
-
626
-
627
-
628
-
629
-
630
-
631
-
632
-
633
-
634
-
635
-
636
-
637
-
638
-
639
-
640
-
641
-
642
-
643
-
644
-
645
-
646
-
647
-
648
-
649
-
650
-
651
-
652
-
653
-
654
-
655
-
656
- </dl>
657
-
658
-
659
-
660
- </dd>
661
-
662
-
663
-
664
- <hr>
665
- <dt class="name" id="undelivered">
666
- <h4 id="undelivered"><span class="type-signature"></span>undelivered<span class="type-signature"></span></h4>
667
-
668
-
669
- </dt>
670
- <dd>
671
-
672
- <div class="description">
673
- Message considered as <b>undelivered</b> to a participant, if Twilio has received a delivery receipt
674
- indicating that the message was not delivered. This can happen for many reasons including carrier content
675
- filtering and the availability of the destination handset.
676
- </div>
677
-
678
-
679
-
680
-
681
-
682
- <dl class="details">
683
-
684
-
685
-
686
-
687
-
688
-
689
-
690
-
691
-
692
-
693
-
694
-
695
-
696
-
697
-
698
-
699
-
700
-
701
-
702
-
703
-
704
-
705
-
706
-
707
-
708
-
709
-
710
-
711
-
712
-
713
-
714
-
715
-
716
-
717
-
718
- </dl>
719
-
720
-
721
-
722
- </dd>
723
-
724
- </dl>
725
-
726
-
727
-
728
-
729
-
730
- <h3 class="subsection-title">Type Definitions</h3>
731
-
732
- <dl>
733
-
734
- <hr>
735
- <dt class="name" id="DeliveryAmount">
736
- <h4 id="DeliveryAmount">DeliveryAmount</h4>
737
-
738
-
739
- </dt>
740
- <dd>
741
-
742
- <div class="description">
743
- Signifies amount of participants which have the status for the message.
744
- </div>
745
-
746
-
747
-
748
- <h5>Type:</h5>
749
- <ul>
750
- <li>
751
-
752
- <span class="param-type">&apos;none&apos;</span>
753
- |
754
-
755
- <span class="param-type">&apos;some&apos;</span>
756
- |
757
-
758
- <span class="param-type">&apos;all&apos;</span>
759
-
760
-
761
-
762
- </li>
763
- </ul>
764
-
765
-
766
-
767
- <dl class="details">
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
-
802
-
803
- </dl>
804
-
805
-
806
-
807
- </dd>
808
-
809
- </dl>
810
-
811
-
812
-
813
- </article>
814
-
815
- </section>
816
-
817
-
818
-
819
-
820
- </div>
821
- </div>
822
-
823
- <div class="clearfix"></div>
824
-
825
-
826
- <div class="col-md-3">
827
- <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div>
828
- </div>
829
-
830
-
831
- </div>
832
- </div>
833
-
834
-
835
- <div class="modal fade" id="searchResults">
836
- <div class="modal-dialog">
837
- <div class="modal-content">
838
- <div class="modal-header">
839
- <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">&#xD7;</span></button>
840
- <h4 class="modal-title">Search results</h4>
841
- </div>
842
- <div class="modal-body"></div>
843
- <div class="modal-footer">
844
- <button type="button" class="btn btn-default" data-dismiss="modal">Close</button>
845
- </div>
846
- </div><!-- /.modal-content -->
847
- </div><!-- /.modal-dialog -->
848
- </div>
849
-
850
-
851
- <footer>
852
-
853
-
854
- <span class="jsdoc-message">
855
- Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
856
-
857
- on 2021-06-28T16:25:18+00:00
858
-
859
- using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
860
- </span>
861
- </footer>
862
-
863
- <script src="scripts/docstrap.lib.js"></script>
864
- <script src="scripts/toc.js"></script>
865
-
866
- <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script>
867
-
868
-
869
- <script>
870
- $( function () {
871
- $( "[id*='$']" ).each( function () {
872
- var $this = $( this );
873
-
874
- $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) );
875
- } );
876
-
877
- $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () {
878
- var $this = $( this );
879
-
880
- var example = $this.find( "code" );
881
- exampleText = example.html();
882
- var lang = /{@lang (.*?)}/.exec( exampleText );
883
- if ( lang && lang[1] ) {
884
- exampleText = exampleText.replace( lang[0], "" );
885
- example.html( exampleText );
886
- lang = lang[1];
887
- } else {
888
- var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/);
889
- lang = langClassMatch ? langClassMatch[1] : "javascript";
890
- }
891
-
892
- if ( lang ) {
893
-
894
- $this
895
- .addClass( "sunlight-highlight-" + lang )
896
- .addClass( "linenums" )
897
- .html( example.html() );
898
-
899
- }
900
- } );
901
-
902
- Sunlight.highlightAll( {
903
- lineNumbers : false,
904
- showMenu : true,
905
- enableDoclinks : true
906
- } );
907
-
908
- $.catchAnchorLinks( {
909
- navbarOffset: 10
910
- } );
911
- $( "#toc" ).toc( {
912
- anchorName : function ( i, heading, prefix ) {
913
- return $( heading ).attr( "id" ) || ( prefix + i );
914
- },
915
- selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4",
916
- showAndHide : false,
917
- smoothScrolling: true
918
- } );
919
-
920
- $( "#main span[id^='toc']" ).addClass( "toc-shim" );
921
- $( '.dropdown-toggle' ).dropdown();
922
-
923
- $( "table" ).each( function () {
924
- var $this = $( this );
925
- $this.addClass('table');
926
- } );
927
-
928
- } );
929
- </script>
930
-
931
-
932
-
933
- <!--Navigation and Symbol Display-->
934
-
935
-
936
- <!--Google Analytics-->
937
-
938
-
939
-
940
- <script type="text/javascript">
941
- $(document).ready(function() {
942
- SearcherDisplay.init();
943
- });
944
- </script>
945
-
946
-
947
-
948
- </body></html>