Merge pull request #143 from wicked-tc130/dev

update api docs

Author: wicked-tc130

document/API.md

@@ -108,6 +108,9 @@ import JMessage from 'jmessage-react-plugin';
     - [removeReceiveMessageListener](#addreceivemessagelistener)
     - [addReceiveChatRoomMsgListener](#addreceivechatroommsglistener)
     - [removeReceiveChatRoomMsgListener](#removereceivechatroommsglistener)
+  - [已读消息回执](#addReceiptMessageListener)
+    - [addReceiptMessageListener](#addReceiptMessageListener)
+    - [removeReceiptMessageListener](#removeReceiptMessageListener)
   - [离线消息](#addsyncofflinemessagelistener)
     - [addSyncOfflineMessageListener](#addsyncofflinemessagelistener)
     - [removeSyncOfflineMessageListener](#addsyncofflinemessagelistener)
@@ -1136,6 +1139,7 @@ JMessage.createSendMessage({type: 'single', username: 'username', appKey: 'appke
   - isCustomNotificationEnabled: 是否开启自定义接收方通知栏功能，设置为 `true` 后可设置下面的 `notificationTitle` 和 `notificationText`。默认未设置。
   - notificationTitle: 设置此条消息在接收方通知栏所展示通知的标题。
   - notificationText: 设置此条消息在接收方通知栏所展示通知的内容。
+  - needReadReceipt: 设置这条消息的发送是否需要对方发送已读回执 开启之后，对方收到消息后，如果调用了setMsgHaveRead()接口， 则作为消息发送方，会收到已读消息回执事件通知
 
 ### sendTextMessage
 
@@ -1753,6 +1757,25 @@ JMessage.resetUnreadMessageCount({ type: 'single', username: 'username', appKey:
 - groupId: 对象群组 id。当 `type` 为 'group' 时，`groupId` 为必填。
 - roomId: 对象聊天室 id。当 `type` 为 'chatRoom' 时，`roomId` 为必填。
 
+### setMsgHaveRead
+
+设置消息已读
+
+#### 示例
+
+```js
+JMessageModule.setMsgHaveRead(params,(result) => {
+        var code = result.code
+        var desc = result.description
+    }
+)
+```
+
+#### 参数说明
+- username: 用户的username。
+- appKey: 用户所属应用的appkey。
+- id: 本会话中指定local message id。为空时使用serverMessageId
+- serverMessageId: 本会话中指定server message id。不可为空
 
 ## 聊天室
 
@@ -2084,7 +2107,6 @@ var listener = ([message]) => {
 JMessage.addReceiveChatRoomMsgListene(listener) // 添加监听
 JMessage.removeReceiveChatRoomMsgListener(listener) // 移除监听(一般在 componentWillUnmount 中调用)
 ```
-
 ####  addSyncOfflineMessageListener
 
 同步离线消息事件监听。
@@ -2106,6 +2128,28 @@ JMessage.removeSyncOfflineMessageListener(listener) // 移除监听(一般在 co
   - conversation：离线消息所在的会话
   - messageArray：指定会话中的离线消息
 
+####  addReceiptMessageListener
+
+已读消息回执事件监听。
+
+##### 示例
+
+```javascript
+var listener = (result) => {
+  // 回调参数 result = {'receiptResult': {}}，返回已读消息回执结果}
+# 
+JMessage.addReceiptMessageListener(listener) // 添加监听
+JMessage.removeReceiptMessageListener(listener) // 移除监听(一般在 componentWillUnmount 中调用)
+```
+
+##### 回调参数
+
+- result
+  - receiptResult：已读消息回执结果
+      - serverMessageId：未回执数被改变的消息的serverMsgId
+      - unReceiptCount：未回执数被改变的消息的当前未发送已读回执的人数
+      - unReceiptMTime：获取未回执数被改变的消息的未回执人数变更时间
+      
 #### addSyncRoamingMessageListener
 
 同步漫游消息事件监听。