添加已读消息回执

Author: zhanq

android/src/io/jchat/android/Constant.java

@@ -133,4 +133,21 @@ public class Constant {
     public static final String JOIN_GROUP_TIME = "joinGroupTime";
     public static final String IS_SILENCE = "isSilence";
 
+    /*
+     * message receiptResult
+     * */
+    public static final String RECEIPT_RESULT = "receiptResult";
+    public static final String UN_RECEIPT_COUNT = "unReceiptCount";
+    public static final String UN_RECEIPT_M_TIME = "unReceiptMTime";
+
+    /**
+     * MessageSendingOptions
+     */
+    public static final String IS_RETAIN_OFFLINE = "isRetainOffline";
+    public static final String IS_SHOW_NOTIFICATION = "isShowNotification";
+    public static final String IS_CUSTOM_NOTIFICATION_ENABLED = "isCustomNotificationEnabled";
+    public static final String NOTIFICATION_TITLE = "notificationTitle";
+    public static final String NOTIFICATION_TEXT = "notificationText";
+    public static final String NEED_READ_RECEIPT = "needReadReceipt";
+
 }

android/src/io/jchat/android/JMessageModule.java

@@ -61,6 +61,7 @@
 import cn.jpush.im.android.api.event.GroupApprovedNotificationEvent;
 import cn.jpush.im.android.api.event.LoginStateChangeEvent;
 import cn.jpush.im.android.api.event.MessageEvent;
+import cn.jpush.im.android.api.event.MessageReceiptStatusChangeEvent;
 import cn.jpush.im.android.api.event.MessageRetractEvent;
 import cn.jpush.im.android.api.event.NotificationClickEvent;
 import cn.jpush.im.android.api.event.OfflineMessageEvent;
@@ -82,6 +83,7 @@ public class JMessageModule extends ReactContextBaseJavaModule {
 
     private static final String TAG = "JMessageModule";
     private static final String RECEIVE_MSG_EVENT = "JMessage.ReceiveMsgEvent";
+    private static final String RECEIPT_MSG_EVENT = "JMessage.ReceiptMsgEvent";
     private static final String LOGIN_STATE_CHANGE_EVENT = "JMessage.LoginStateChanged"; //
     private static final String CLICK_NOTIFICATION_EVENT = "JMessage.ClickMessageNotification"; // 点击推送 Android Only
     private static final String SYNC_OFFLINE_EVENT = "JMessage.SyncOfflineMessage"; // 同步离线消息事件
@@ -377,17 +379,20 @@ public void sendMessage(ReadableMap map, final Callback success, final Callback
             if (map.hasKey(Constant.SENDING_OPTIONS)) {
                 MessageSendingOptions options = new MessageSendingOptions();
                 ReadableMap optionMap = map.getMap(Constant.SENDING_OPTIONS);
-                options.setShowNotification(optionMap.getBoolean("isShowNotification"));
-                options.setRetainOffline(optionMap.getBoolean("isRetainOffline"));
+                options.setShowNotification(optionMap.getBoolean(Constant.IS_SHOW_NOTIFICATION));
+                options.setRetainOffline(optionMap.getBoolean(Constant.IS_RETAIN_OFFLINE));
 
-                if (optionMap.hasKey("isCustomNotificationEnabled")) {
-                    options.setCustomNotificationEnabled(optionMap.getBoolean("isCustomNotificationEnabled"));
+                if (optionMap.hasKey(Constant.IS_CUSTOM_NOTIFICATION_ENABLED)) {
+                    options.setCustomNotificationEnabled(optionMap.getBoolean(Constant.IS_CUSTOM_NOTIFICATION_ENABLED));
                 }
-                if (optionMap.hasKey("notificationTitle")) {
-                    options.setNotificationTitle(optionMap.getString("notificationTitle"));
+                if (optionMap.hasKey(Constant.NOTIFICATION_TITLE)) {
+                    options.setNotificationTitle(optionMap.getString(Constant.NOTIFICATION_TITLE));
                 }
-                if (optionMap.hasKey("notificationText")) {
-                    options.setNotificationText(optionMap.getString("notificationText"));
+                if (optionMap.hasKey(Constant.NOTIFICATION_TEXT)) {
+                    options.setNotificationText(optionMap.getString(Constant.NOTIFICATION_TEXT));
+                }
+                if(optionMap.hasKey(Constant.NEED_READ_RECEIPT)){
+                    options.setNeedReadReceipt(optionMap.getBoolean(Constant.NEED_READ_RECEIPT));
                 }
                 JMessageClient.sendMessage(message, options);
             } else {
@@ -1517,17 +1522,20 @@ public void forwardMessage(ReadableMap map, final Callback success, final Callba
                 if (map.hasKey(Constant.SENDING_OPTIONS)) {
                     options = new MessageSendingOptions();
                     ReadableMap optionMap = map.getMap(Constant.SENDING_OPTIONS);
-                    options.setShowNotification(optionMap.getBoolean("isShowNotification"));
-                    options.setRetainOffline(optionMap.getBoolean("isRetainOffline"));
+                    options.setShowNotification(optionMap.getBoolean(Constant.IS_SHOW_NOTIFICATION));
+                    options.setRetainOffline(optionMap.getBoolean(Constant.IS_RETAIN_OFFLINE));
 
-                    if (optionMap.hasKey("isCustomNotificationEnabled")) {
-                        options.setCustomNotificationEnabled(optionMap.getBoolean("isCustomNotificationEnabled"));
+                    if (optionMap.hasKey(Constant.IS_CUSTOM_NOTIFICATION_ENABLED)) {
+                        options.setCustomNotificationEnabled(optionMap.getBoolean(Constant.IS_CUSTOM_NOTIFICATION_ENABLED));
+                    }
+                    if (optionMap.hasKey(Constant.NOTIFICATION_TITLE)) {
+                        options.setNotificationTitle(optionMap.getString(Constant.NOTIFICATION_TITLE));
                     }
-                    if (optionMap.hasKey("notificationTitle")) {
-                        options.setNotificationTitle(optionMap.getString("notificationTitle"));
+                    if (optionMap.hasKey(Constant.NOTIFICATION_TEXT)) {
+                        options.setNotificationText(optionMap.getString(Constant.NOTIFICATION_TEXT));
                     }
-                    if (optionMap.hasKey("notificationText")) {
-                        options.setNotificationText(optionMap.getString("notificationText"));
+                    if(optionMap.hasKey(Constant.NEED_READ_RECEIPT)){
+                        options.setNeedReadReceipt(optionMap.getBoolean(Constant.NEED_READ_RECEIPT));
                     }
                 }
                 ReadableMap target = map.getMap(Constant.TARGET);
@@ -2076,6 +2084,53 @@ public void gotResult(int status, String desc) {
         }
     }
 
+    @ReactMethod
+    public void setMsgHaveRead(ReadableMap map, final Callback callback) {
+        String userName = map.getString(Constant.USERNAME);
+        String appKey = map.getString(Constant.APP_KEY);
+        String msgId = map.getString(Constant.ID);
+        String serverMsgId = map.getString(Constant.SERVER_ID);
+        WritableMap callbackMap = Arguments.createMap();
+        if(TextUtils.isEmpty(userName)||
+                TextUtils.isEmpty(appKey)||
+                TextUtils.isEmpty(msgId)||
+                TextUtils.isEmpty(serverMsgId)){
+            callbackMap.putInt(Constant.CODE, ERR_CODE_CONVERSATION);
+            callbackMap.putString(Constant.DESCRIPTION, ERR_MSG_CONVERSATION);
+            callback.invoke(callbackMap);
+            return;
+        }
+        Conversation conversation = JMessageClient.getSingleConversation(userName, appKey);
+        if(conversation==null){
+            callbackMap.putInt(Constant.CODE, ERR_CODE_CONVERSATION);
+            callbackMap.putString(Constant.DESCRIPTION, ERR_MSG_CONVERSATION);
+            callback.invoke(callbackMap);
+            return;
+        }
+        //优先使用msgId获取conversation，获取不到再使用serverMsgId获取
+        Message message = conversation.getMessage(Integer.parseInt(msgId));
+        if(message==null){
+            message = conversation.getMessage(Long.parseLong(serverMsgId));
+        }
+        if (message == null){
+            callbackMap.putInt(Constant.CODE, ERR_CODE_MESSAGE);
+            callbackMap.putString(Constant.DESCRIPTION, ERR_MSG_MESSAGE);
+            callback.invoke(callbackMap);
+            return;
+        }
+        if (!message.haveRead()) {
+            message.setHaveRead(new BasicCallback() {
+                @Override
+                public void gotResult(int i, String s) {
+                    WritableMap map = Arguments.createMap();
+                    map.putInt(Constant.CODE, i);
+                    map.putString(Constant.DESCRIPTION, s);
+                    callback.invoke(map);
+                }
+            });
+        }
+    }
+
     public void onEvent(LoginStateChangeEvent event) {
         Logger.d(TAG, "登录状态改变事件：event = " + event.toString());
         WritableMap map = Arguments.createMap();
@@ -2091,6 +2146,23 @@ public void onEvent(MessageEvent event) {
                 .emit(RECEIVE_MSG_EVENT, ResultUtils.toJSObject(msg));
     }
 
+    /*
+    * 收到已读回执
+    * */
+    public void onEventMainThread(MessageReceiptStatusChangeEvent event) {
+        WritableMap map = Arguments.createMap();
+        Conversation conv = event.getConversation();
+        for (MessageReceiptStatusChangeEvent.MessageReceiptMeta meta : event.getMessageReceiptMetas()) {
+            WritableMap receiptMap = Arguments.createMap();
+            receiptMap.putString(Constant.SERVER_ID, String.valueOf(meta.getServerMsgId()));
+            receiptMap.putInt(Constant.UN_RECEIPT_COUNT, meta.getUnReceiptCnt());
+            receiptMap.putString(Constant.UN_RECEIPT_M_TIME, String.valueOf(meta.getUnReceiptMtime()));
+            map.putMap(Constant.RECEIPT_RESULT, receiptMap);
+        }
+        getReactApplicationContext().getJSModule(DeviceEventManagerModule.RCTDeviceEventEmitter.class)
+                .emit(RECEIPT_MSG_EVENT, map);
+    }
+
     /**
      * 漫游消息同步事件。
      *

android/src/io/jchat/android/utils/JMessageUtils.java

@@ -74,18 +74,21 @@ public void gotResult(int status, String desc) {
         if (map.hasKey(Constant.SENDING_OPTIONS)) {
             MessageSendingOptions options = new MessageSendingOptions();
             ReadableMap optionMap = map.getMap(Constant.SENDING_OPTIONS);
-            options.setShowNotification(optionMap.getBoolean("isShowNotification"));
-            options.setRetainOffline(optionMap.getBoolean("isRetainOffline"));
 
-            if (optionMap.hasKey("isCustomNotificationEnabled")) {
-                options.setCustomNotificationEnabled(
-                        optionMap.getBoolean("isCustomNotificationEnabled"));
+            options.setShowNotification(optionMap.getBoolean(Constant.IS_SHOW_NOTIFICATION));
+            options.setRetainOffline(optionMap.getBoolean(Constant.IS_RETAIN_OFFLINE));
+
+            if (optionMap.hasKey(Constant.IS_CUSTOM_NOTIFICATION_ENABLED)) {
+                options.setCustomNotificationEnabled(optionMap.getBoolean(Constant.IS_CUSTOM_NOTIFICATION_ENABLED));
+            }
+            if (optionMap.hasKey(Constant.NOTIFICATION_TITLE)) {
+                options.setNotificationTitle(optionMap.getString(Constant.NOTIFICATION_TITLE));
             }
-            if (optionMap.hasKey("notificationTitle")) {
-                options.setNotificationTitle(optionMap.getString("notificationTitle"));
+            if (optionMap.hasKey(Constant.NOTIFICATION_TEXT)) {
+                options.setNotificationText(optionMap.getString(Constant.NOTIFICATION_TEXT));
             }
-            if (optionMap.hasKey("notificationText")) {
-                options.setNotificationText(optionMap.getString("notificationText"));
+            if(optionMap.hasKey(Constant.NEED_READ_RECEIPT)){
+                options.setNeedReadReceipt(optionMap.getBoolean(Constant.NEED_READ_RECEIPT));
             }
             JMessageClient.sendMessage(msg, options);
         }

example/app/routes/Chat/index.js

@@ -200,6 +200,17 @@ export default class Chat extends Component {
 
       this.receiveMessageCallBack = (message) => {
 
+        console.log("收到消息"+JSON.stringify(message));
+        const readParams = {
+          // ...message,
+          username: message.from.username,
+          appKey: message.from.appKey,
+          id: message.id,
+          serverMessageId: message.serverMessageId
+        }
+        
+        JMessage.setMsgHaveRead(readParams,(result) => {})
+        
         if (this.conversation.type === 'single') {
           if (message.target.type === 'user') {
             if (message.from.username === this.conversation.username) {
@@ -225,6 +236,7 @@ export default class Chat extends Component {
         }
       }
       JMessage.addReceiveMessageListener(this.receiveMessageCallBack)
+      JMessage.addReceiptMessageListener((result)=>{})
     }
     AuroraIController.addMessageListDidLoadListener(this.messageListDidLoadCallback)
     // this.timer = setTimeout(() => {
@@ -406,6 +418,7 @@ export default class Chat extends Component {
       Alert.alert('send text', JSON.stringify(msg))
 
       msg.messageSendingOptions = {
+        needReadReceipt: true,
         isShowNotification:  true,
         isRetainOffline:  true,
         isCustomNotificationEnabled:  true,

index.js

@@ -8,6 +8,7 @@ const JMessageModule = NativeModules.JMessageModule;
 
 const listeners = {};
 const receiveMsgEvent = "JMessage.ReceiveMsgEvent"; // 接收到消息事件
+const receiptMsgEvent = "JMessage.ReceiptMsgEvent"; // 接收已读消息回执事件
 const loginStateChanged = "JMessage.LoginStateChanged"; // 
 const clickMessageNotificationEvent = "JMessage.ClickMessageNotification"; // 点击推送 Android Only
 const syncOfflineMessage = "JMessage.SyncOfflineMessage" // 同步离线消息事件
@@ -860,6 +861,20 @@ export default class JMessage {
         JMessageModule.setConversationExtras(params, success, error)
     }
 
+    /**
+     * 设置消息已读
+     * @param {object} params = {
+     *  'username': String 
+     *  'appKey': String
+     *  'id': String
+     *  'serverMessageId': String
+     * }
+     *  @param {function} result =  function ({'code': '错误码', 'description': '错误信息'}) {}
+     */
+    static setMsgHaveRead(params,result){
+        JMessageModule.setMsgHaveRead(params,result)
+    }
+
     /**
      * 
      * JMessage Events
@@ -893,6 +908,40 @@ export default class JMessage {
             listeners[listener] = null;
         }
 
+    /**
+     * 添加收到消息事件监听。
+     *
+     * @param {function} listener = function (result) {}  // 以参数形式返回消息对象。
+     * result = {
+     *      receiptResult = {
+     *          'serverMessageId': String
+     *          'unReceiptCount': int
+     *          'unReceiptMTime': String
+     *      },
+     *      receiptResult = {
+     *          'serverMessageId': String
+     *          'unReceiptCount': int
+     *          'unReceiptMTime': String
+     *      },
+     *      ...
+     * 
+     * }
+     */
+    static addReceiptMessageListener(listener) {
+        listeners[listener] = DeviceEventEmitter.addListener(receiptMsgEvent,
+            (result) => {
+                listener(result);
+            });
+    }
+
+    static removeReceiptMessageListener(listener) {
+            if (!listeners[listener]) {
+                return;
+            }
+            listeners[listener].remove();
+            listeners[listener] = null;
+        }    
+
     /**
      * 添加点击通知栏消息通知事件监听。
      * Note: Android only, (如果想要 iOS 端 实现相同的功能，需要同时集成 jpush-react-native)