v2.0.0

openimsdk · Feb 25, 2022 · 4ab0f17 · 4ab0f17
1 parent f0741db
commit 4ab0f17
Show file tree

Hide file tree

Showing 11 changed files with 869 additions and 1,699 deletions.
diff --git a/OpenIM-SDK/build.gradle b/OpenIM-SDK/build.gradle
@@ -33,7 +33,7 @@ dependencies {
     androidTestImplementation 'androidx.test.ext:junit:1.1.2'
     androidTestImplementation 'androidx.test.espresso:espresso-core:3.3.0'
 
-    implementation 'io.openim:client-sdk:2.0.3@aar'
+    implementation 'io.openim:client-sdk:2.0.4@aar'
     implementation 'com.alibaba:fastjson:1.1.72.android'
 //    implementation 'com.google.code.gson:gson:2.8.7'
 }
diff --git a/OpenIM-SDK/src/main/java/io/openim/android/sdk/OpenIMClient.java b/OpenIM-SDK/src/main/java/io/openim/android/sdk/OpenIMClient.java
@@ -50,10 +50,12 @@ public static OpenIMClient getInstance() {
      * 需要将文件自行拷贝到dbPath目录下，如果此时文件路径为 apath+"/sound/a.mp3"，则参数path的值为：/sound/a.mp3。
      * 如果选择的全路径方法，路径为你文件的实际路径不需要再拷贝。
      *
-     * @param apiUrl     SDK的API接口地址。如：http:xxx:10000
-     * @param wsUrl      SDK的web socket地址。如： ws:xxx:17778
-     * @param storageDir 数据存储目录路径
-     * @param listener   SDK初始化监听
+     * @param apiUrl        SDK的API接口地址。如：http:xxx:10000
+     * @param wsUrl         SDK的web socket地址。如： ws:xxx:17778
+     * @param storageDir    数据存储目录路径
+     * @param logLevel      日志等级，如：6
+     * @param objectStorage 图片上传配置 如：cos
+     * @param listener      SDK初始化监听
      * @return boolean   true成功; false失败
      */
     public boolean initSDK(String apiUrl, String wsUrl, String storageDir, int logLevel, String objectStorage, OnConnListener listener) {

diff --git a/OpenIM-SDK/src/main/java/io/openim/android/sdk/listener/OnMsgSendCallback.java b/OpenIM-SDK/src/main/java/io/openim/android/sdk/listener/OnMsgSendCallback.java
@@ -1,10 +1,12 @@
 package io.openim.android.sdk.listener;
 
 
+import io.openim.android.sdk.models.Message;
+
 /**
  * 消息发送监听
  */
-public interface OnMsgSendCallback extends OnBase<String> {
+public interface OnMsgSendCallback extends OnBase<Message> {
     /**
      * 发送失败
      */
@@ -18,5 +20,5 @@ public interface OnMsgSendCallback extends OnBase<String> {
     /**
      * 发送成功
      */
-    void onSuccess(String s);
+    void onSuccess(Message s);
 }
diff --git a/OpenIM-SDK/src/main/java/io/openim/android/sdk/listener/_MsgSendProgressListener.java b/OpenIM-SDK/src/main/java/io/openim/android/sdk/listener/_MsgSendProgressListener.java
@@ -1,5 +1,6 @@
 package io.openim.android.sdk.listener;
 
+import io.openim.android.sdk.models.Message;
 import io.openim.android.sdk.utils.CommonUtil;
 
 final public class _MsgSendProgressListener implements open_im_sdk_callback.SendMsgCallBack {
@@ -26,7 +27,7 @@ public void onProgress(long l) {
     @Override
     public void onSuccess(String s) {
         if (null != base) {
-            CommonUtil.returnSuccess(base, s);
+            CommonUtil.returnObject(base, Message.class, s);
         }
     }
 }
diff --git a/OpenIM-SDK/src/main/java/io/openim/android/sdk/manager/ConversationManager.java b/OpenIM-SDK/src/main/java/io/openim/android/sdk/manager/ConversationManager.java
@@ -4,9 +4,9 @@
 import java.util.List;
 
 import io.openim.android.sdk.listener.BaseImpl;
-import io.openim.android.sdk.listener._ConversationListener;
 import io.openim.android.sdk.listener.OnBase;
 import io.openim.android.sdk.listener.OnConversationListener;
+import io.openim.android.sdk.listener._ConversationListener;
 import io.openim.android.sdk.models.ConversationInfo;
 import io.openim.android.sdk.models.NotDisturbInfo;
 import io.openim.android.sdk.utils.JsonUtil;
@@ -42,7 +42,9 @@ public void getAllConversationList(OnBase<List<ConversationInfo>> base) {
     /**
      * 获取会话记录
      *
-     * @param base callback List<{@link ConversationInfo}>
+     * @param base   callback List<{@link ConversationInfo}>
+     * @param offset 偏移量，每次开始的index值
+     * @param count  数量，每次获取的数量总数
      */
     public void getConversationListSplit(OnBase<List<ConversationInfo>> base, long offset, long count) {
         Open_im_sdk.getConversationListSplit(BaseImpl.arrayBase(base, ConversationInfo.class), ParamsUtil.buildOperationID(), offset, count);

diff --git a/OpenIM-SDK/src/main/java/io/openim/android/sdk/manager/FriendshipManager.java b/OpenIM-SDK/src/main/java/io/openim/android/sdk/manager/FriendshipManager.java
@@ -86,7 +86,7 @@ public void getFriendList(OnBase<List<UserInfo>> base) {
      * 修改好友资料
      *
      * @param uid    用户id
-     * @param remark 备注
+     * @param remark 备注名
      * @param base   callback String
      */
     public void setFriendRemark(OnBase<String> base, String uid, String remark) {
@@ -127,7 +127,6 @@ public void removeBlacklist(OnBase<String> base, String uid) {
 
     /**
      * 根据用户id检查好友关系
-     * flag == 1 是好友
      *
      * @param uidList 用户ID列表
      * @param base    callback List<{@link UserInfo}>
@@ -149,8 +148,9 @@ public void deleteFriend(OnBase<String> base, String uid) {
     /**
      * 拒绝好友申请
      *
-     * @param uid  用户ID
-     * @param base callback String
+     * @param uid       用户ID
+     * @param handleMsg 处理信息
+     * @param base      callback String
      */
     public void refuseFriendApplication(OnBase<String> base, String uid, String handleMsg) {
         Map<String, Object> params = new ArrayMap<>();
@@ -162,8 +162,9 @@ public void refuseFriendApplication(OnBase<String> base, String uid, String hand
     /**
      * 接受好友请求
      *
-     * @param uid  用户ID
-     * @param base callback String
+     * @param uid       用户ID
+     * @param handleMsg 处理信息
+     * @param base      callback String
      */
     public void acceptFriendApplication(OnBase<String> base, String uid, String handleMsg) {
         Map<String, Object> params = new ArrayMap<>();

diff --git a/OpenIM-SDK/src/main/java/io/openim/android/sdk/manager/GroupManager.java b/OpenIM-SDK/src/main/java/io/openim/android/sdk/manager/GroupManager.java
@@ -34,7 +34,7 @@ public void setOnGroupListener(OnGroupListener listener) {
      * 邀请进群
      *
      * @param groupId 群组ID
-     * @param uidList 被要用的用户id列表
+     * @param uidList 被邀请的用户id列表
      * @param reason  邀请说明
      * @param base    callback List<{@link GroupInviteResult}>>
      */
@@ -46,7 +46,7 @@ public void inviteUserToGroup(OnBase<List<GroupInviteResult>> base, String group
      * 踢出群
      *
      * @param groupId 群组ID
-     * @param uidList 被要踢出群的用户id列表
+     * @param uidList 被踢出群的用户id列表
      * @param reason  说明
      * @param base    callback List<{@link GroupInviteResult}>>
      */
@@ -59,7 +59,7 @@ public void kickGroupMember(OnBase<List<GroupInviteResult>> base, String groupId
      * 批量获取群成员信息
      *
      * @param groupId 群组ID
-     * @param uidList 群成员ID
+     * @param uidList 群成员ID集合
      * @param base    callback List<{@link GroupMembersInfo}>
      **/
     public void getGroupMembersInfo(OnBase<List<GroupMembersInfo>> base, String groupId, List<String> uidList) {
@@ -70,7 +70,9 @@ public void getGroupMembersInfo(OnBase<List<GroupMembersInfo>> base, String grou
      * 获取群成员
      *
      * @param groupId 群组ID
-     * @param filter  过滤成员
+     * @param filter  过滤成员 1普通成员, 2群主，3管理员，0所有
+     * @param offset  偏移量
+     * @param count   每页数量
      */
     public void getGroupMemberList(OnBase<GroupMembersInfo> base, String groupId, int filter, int offset, int count) {
         Open_im_sdk.getGroupMemberList(BaseImpl.objectBase(base, GroupMembersInfo.class), ParamsUtil.buildOperationID(), groupId, filter, offset, count);
@@ -90,12 +92,14 @@ public void getJoinedGroupList(OnBase<List<GroupInfo>> base) {
      * 创建群
      *
      * @param groupName    群名称
+     * @param faceURL      群icon
      * @param notification 群公告
      * @param introduction 群简介
-     * @param faceURL      群icon
+     * @param groupType
+     * @param ex           其他信息
      * @param list         List<{@link GroupMemberRole}> 创建群是选择的成员. setRole：0:普通成员 2:管理员；1：群主
      */
-    public void createGroup(OnBase<GroupInfo> base, String groupName, String notification, String introduction, String faceURL, int groupType, String ex, List<GroupMemberRole> list) {
+    public void createGroup(OnBase<GroupInfo> base, String groupName, String faceURL, String notification, String introduction, int groupType, String ex, List<GroupMemberRole> list) {
         Map<String, Object> map = new ArrayMap<>();
         map.put("groupName", groupName);
         map.put("notification", notification);
@@ -111,12 +115,13 @@ public void createGroup(OnBase<GroupInfo> base, String groupName, String notific
      *
      * @param groupID      群ID
      * @param groupName    群名称
+     * @param faceURL      群icon
      * @param notification 群公告
      * @param introduction 群简介
-     * @param faceURL      群icon
+     * @param ex           其他信息
      * @param base         callback String
      */
-    public void setGroupInfo(OnBase<String> base, String groupID, String groupName, String notification, String introduction, String faceURL, String ex) {
+    public void setGroupInfo(OnBase<String> base, String groupID, String groupName, String faceURL, String notification, String introduction, String ex) {
         Map<String, Object> map = new ArrayMap<>();
         map.put("groupName", groupName);
         map.put("notification", notification);
@@ -162,7 +167,7 @@ public void quitGroup(OnBase<String> base, String gid) {
      * 转让群主
      *
      * @param gid  群组ID
-     * @param uid  被转让的用户ID
+     * @param uid  新拥有者（群主）id
      * @param base callback String
      */
     public void transferGroupOwner(OnBase<String> base, String gid, String uid) {
@@ -190,6 +195,8 @@ public void getSendGroupApplicationList(OnBase<GroupApplicationInfo> base) {
     /**
      * 接受入群申请
      *
+     * @param gid       群ID
+     * @param uid       申请入群的用户ID
      * @param handleMsg 说明
      * @param base      callback String
      */
@@ -201,6 +208,8 @@ public void acceptGroupApplication(OnBase<String> base, String gid, String uid,
     /**
      * 拒绝入群申请
      *
+     * @param gid       群ID
+     * @param uid       申请入群的用户ID
      * @param handleMsg 说明
      * @param base      callback String
      */

diff --git a/OpenIM-SDK/src/main/java/io/openim/android/sdk/manager/MessageManager.java b/OpenIM-SDK/src/main/java/io/openim/android/sdk/manager/MessageManager.java
@@ -270,11 +270,11 @@ public Message createMergerMessage(List<Message> messageList, String title, List
     /**
      * 创建转发消息
      *
-     * @param messageList 消息列表
+     * @param message 消息体
      * @return {@link Message}
      */
-    public Message createForwardMessage(List<Message> messageList) {
-        return parse(Open_im_sdk.createForwardMessage(ParamsUtil.buildOperationID(), JsonUtil.toString(messageList)));
+    public Message createForwardMessage(Message message) {
+        return parse(Open_im_sdk.createForwardMessage(ParamsUtil.buildOperationID(), JsonUtil.toString(message)));
     }
 
     /**

diff --git a/OpenIM-SDK/src/main/java/io/openim/android/sdk/models/NotDisturbInfo.java b/OpenIM-SDK/src/main/java/io/openim/android/sdk/models/NotDisturbInfo.java
@@ -8,7 +8,7 @@ public class NotDisturbInfo {
     private String conversationId;
     /*
      * 免打扰状态
-     * 1:屏蔽消息; 2:接收消息但不提示; 3:正常
+     * 1:屏蔽消息; 2:接收消息但不提示; 0:正常
      * */
     private int result;
 

diff --git a/README.md b/README.md
@@ -17,4 +17,5 @@
 # OpenIM
 -keep class io.openim.**{*;}
 -keep class open_im_sdk.**{*;}
+-keep class open_im_sdk_callback.**{*;}
 ```