@twilio/conversations 2.1.0-rc.8 → 3.0.0-canary.13

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 (69) hide show
  1. package/README.md +8 -4
  2. package/builds/browser.js +2730 -1984
  3. package/builds/browser.js.map +1 -1
  4. package/builds/lib.d.ts +516 -307
  5. package/builds/lib.js +2730 -1984
  6. package/builds/lib.js.map +1 -1
  7. package/builds/twilio-conversations.js +5347 -4949
  8. package/builds/twilio-conversations.min.js +1 -16
  9. package/dist/aggregated-delivery-receipt.js.map +1 -1
  10. package/dist/client.js +429 -284
  11. package/dist/client.js.map +1 -1
  12. package/dist/command-executor.js.map +1 -1
  13. package/dist/configuration.js +2 -2
  14. package/dist/configuration.js.map +1 -1
  15. package/dist/conversation.js +405 -369
  16. package/dist/conversation.js.map +1 -1
  17. package/dist/data/conversations.js +10 -11
  18. package/dist/data/conversations.js.map +1 -1
  19. package/dist/data/messages.js +46 -26
  20. package/dist/data/messages.js.map +1 -1
  21. package/dist/data/participants.js +19 -10
  22. package/dist/data/participants.js.map +1 -1
  23. package/dist/data/users.js +2 -2
  24. package/dist/data/users.js.map +1 -1
  25. package/dist/detailed-delivery-receipt.js.map +1 -1
  26. package/dist/index.js +6 -4
  27. package/dist/index.js.map +1 -1
  28. package/dist/interfaces/attributes.js.map +1 -1
  29. package/dist/interfaces/notification-types.js.map +1 -1
  30. package/dist/logger.js +2 -4
  31. package/dist/logger.js.map +1 -1
  32. package/dist/media.js +36 -25
  33. package/dist/media.js.map +1 -1
  34. package/dist/message-builder.js +24 -18
  35. package/dist/message-builder.js.map +1 -1
  36. package/dist/message.js +60 -29
  37. package/dist/message.js.map +1 -1
  38. package/dist/node_modules/tslib/tslib.es6.js +1 -1
  39. package/dist/node_modules/tslib/tslib.es6.js.map +1 -1
  40. package/dist/packages/conversations/package.json.js +1 -1
  41. package/dist/participant.js +2 -2
  42. package/dist/participant.js.map +1 -1
  43. package/dist/push-notification.js.map +1 -1
  44. package/dist/rest-paginator.js.map +1 -1
  45. package/dist/services/network.js.map +1 -1
  46. package/dist/services/typing-indicator.js +1 -1
  47. package/dist/services/typing-indicator.js.map +1 -1
  48. package/dist/unsent-message.js +13 -3
  49. package/dist/unsent-message.js.map +1 -1
  50. package/dist/user.js +1 -1
  51. package/dist/user.js.map +1 -1
  52. package/dist/util/deferred.js.map +1 -1
  53. package/dist/util/index.js.map +1 -1
  54. package/docs/assets/js/search.js +1 -1
  55. package/docs/classes/Client.html +205 -39
  56. package/docs/classes/Conversation.html +103 -51
  57. package/docs/classes/Media.html +2 -28
  58. package/docs/classes/Message.html +94 -39
  59. package/docs/classes/MessageBuilder.html +31 -8
  60. package/docs/classes/PushNotification.html +1 -1
  61. package/docs/classes/UnsentMessage.html +2 -2
  62. package/docs/index.html +20 -27
  63. package/docs/interfaces/ConversationLimits.html +12 -12
  64. package/docs/interfaces/ConversationState.html +2 -2
  65. package/docs/interfaces/ConversationUpdatedEventArgs.html +3001 -0
  66. package/docs/interfaces/PushNotificationData.html +48 -0
  67. package/docs/modules.html +19 -26
  68. package/package.json +24 -20
  69. package/CHANGELOG.md +0 -404
package/README.md CHANGED
@@ -21,10 +21,14 @@ const { Client } = require('@twilio/conversations');
21
21
  const client = new Client(token);
22
22
  // Before you use the client, subscribe to the `'stateChanged'` event and wait
23
23
  // for the `'initialized'` state to be reported.
24
- client.on('stateChanged', (state) => {
24
+ client.on('stateChanged', ({ state, error }) => {
25
25
  if (state === 'initialized') {
26
26
  // Use the client
27
27
  }
28
+
29
+ if (error) {
30
+ // Handle error
31
+ }
28
32
  }
29
33
  ```
30
34
 
@@ -34,7 +38,7 @@ import { Client } from '@twilio/conversations';
34
38
  const client = new Client(token);
35
39
  // Before you use the client, subscribe to the `'stateChanged'` event and wait
36
40
  // for the `'initialized'` state to be reported.
37
- client.on('stateChanged', (state) => {
41
+ client.on('stateChanged', ({ state, error }) => {
38
42
  if (state === 'initialized') {
39
43
  // Use the client
40
44
  }
@@ -46,7 +50,7 @@ client.on('stateChanged', (state) => {
46
50
  Releases of `twilio-conversations.js` are hosted on a CDN, and you can include these
47
51
  directly in your web app using a `<script>` tag.
48
52
  ```html
49
- <script src="https://media.twiliocdn.com/sdk/js/conversations/v2.0/twilio-conversations.min.js"></script>
53
+ <script src="https://media.twiliocdn.com/sdk/js/conversations/v3.0/twilio-conversations.min.js"></script>
50
54
  ```
51
55
  Using this method, `twilio-conversations.js` will set a browser global `Twilio.Conversations` through which you can use the client:
52
56
  ```
@@ -64,7 +68,7 @@ number. While less flexible it is significantly more secure, which is required b
64
68
  To consume securely use the following script snippet format:
65
69
 
66
70
  ```html
67
- <script src="https://media.twiliocdn.com/sdk/js/conversations/releases/2.0.1/twilio-conversations.min.js"
71
+ <script src="https://media.twiliocdn.com/sdk/js/conversations/releases/3.0.0/twilio-conversations.min.js"
68
72
  integrity="sha256-<HASH FROM THE CHANGELOGS PAGE>"
69
73
  crossorigin="anonymous"></script>
70
74
  ```