35 Message metadata

README.md

@@ -101,16 +101,19 @@ Returns `true` if the client is successfully connected to Amio Chat server.
 ### getSessionId()
 It returns session ID of the client connected to Amio Chat server. It return `null` if the connection was not successful. 
 
-### messages.send(content)
+### messages.send(content, metadata)
 Sends a message.
 
 Parameters:
 - **content** - Message content. See [Amio documentation](https://docs.amio.io/v1.0/reference#messages-send-message) for details about the format.
+- **metadata** - Optional. Add [metadata](https://docs.amio.io/v1.0/reference#messages-metadata) to the message. Metadata has to be an object and can carry whatever data needed to be sent along with the message.
 
 ```js
 amioChat.messages.send({
   type: 'text',
   payload: 'Hello world'
+}, {
+  any: "arbitrary data"
 })
 .then(() => {
   console.log('Message sent successfully')
@@ -121,16 +124,18 @@ amioChat.messages.send({
 ```
 
 ### messages.sendText(text)
-Sends a text message. This is just a handy shortcut for `messages.send({type: 'text', payload: '...'})`
+Sends a text message. This is just a handy shortcut for `messages.send({type: 'text', payload: '...'}, metadata)`
 
 Parameters:
 - **text** - The content of the text message.
+- **metadata** - Optional. Add [metadata](https://docs.amio.io/v1.0/reference#messages-metadata) to the message. Metadata has to be an object and can carry whatever data needed to be sent along with the message.
 
-### messages.sendImage(url)
+### messages.sendImage(url, metadata)
 Sends an image message. This is just a handy shortcut for `messages.send({type: 'image', payload: '...'})`
 
 Parameters:
 - **url** - The URL of the image.
+- **metadata** - Optional. Add [metadata](https://docs.amio.io/v1.0/reference#messages-metadata) to the message. Metadata has to be an object and can carry whatever data needed to be sent along with the message.
 
 ### messages.list(nextCursor, max)
 Loads messages from message history. Can be called multiple times to move further back in history.
@@ -155,6 +160,9 @@ Response format:
       "content": {
         "type": "text",
         "payload": "World"
+      },
+      "metadata": {
+        "any": "arbitrary data"
       }
     },
     { 
@@ -259,6 +267,9 @@ Parameters:
     "type": "{{MESSAGE TYPE}}",
     "payload": "{{MESSAGE PAYLOAD}}"
   },
+  "metadata": {
+    "any": "arbitrary data"
+  },
   "sent": "{{SENT_TIMESTAMP}}",
   "delivered": "{{DELIVERED_TIMESTAMP}}",
   "read": "{{READ_TIMESTAMP}}"
@@ -285,6 +296,9 @@ Parameters:
     "type": "{{MESSAGE TYPE}}",
     "payload": "{{MESSAGE PAYLOAD}}"
   },
+  "metadata": {
+    "any": "arbitrary data"
+  },
   "sent": "{{SENT_TIMESTAMP}}",
   "delivered": "{{DELIVERED_TIMESTAMP}}",
   "read": "{{READ_TIMESTAMP}}"

package.json

@@ -1,6 +1,6 @@
 {
   "name": "amio-chat-sdk-web",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Amio Chat JavaScript SDK for custom webchat implementation. https://amio.io",
   "main": "lib/amio-chat-sdk-web.js",
   "module": "src/amio-chat-client.js",

src/messages.js

@@ -6,41 +6,50 @@ import {
 
 class Messages {
 
-  send(content) {
+  send(content, metadata = null) {
     return new Promise((resolve, reject) => {
       if(typeof content !== 'object' || content === null) {
         reject('Content is not an object (did you want to use messages.sendText() instead?).')
         return
       }
 
+      if(metadata && typeof metadata !== 'object') {
+        reject('Metadata must be an object.')
+        return
+      }
+
       const data = {
         content: content
       }
 
+      if(metadata) {
+        data.metadata = metadata
+      }
+
       connection.emit(SOCKET_MESSAGE_CLIENT, data)
         .then(resolve)
         .catch(reject)
     })
   }
 
-  sendText(text) {
+  sendText(text, metadata = null) {
     const content = {
       type: 'text',
       payload: text
     }
 
-    return this.send(content)
+    return this.send(content, metadata)
   }
 
-  sendImage(url) {
+  sendImage(url, metadata = null) {
     const content = {
       type: 'image',
       payload: {
         url: url
       }
     }
 
-    return this.send(content)
+    return this.send(content, metadata)
   }
 
   list(nextCursor, max = 10) {