修改sdk clientId -> userId

增加封禁用户方法

im-sdk/src/main/java/com/wecloud/im/sdk/ResourcePathConstants.java

@@ -122,6 +122,11 @@ public class ResourcePathConstants {
     public static final String USER_RELATION_REQUEST = "/api/imClient/getClientRelation";
 
     /**
+     * 封禁用户
+     */
+    public static final String BANNED_USER_REQUEST = "/api/imClient/bannedUser";
+
+    /**
      * 删除好友请求
      */
     public static final String UNFRIEND_REQUEST = "/api/friend/sdk/unfriends";

im-sdk/src/main/java/com/wecloud/im/sdk/WecloudIm.java

@@ -35,7 +35,7 @@ public interface WecloudIm {
      * @Return
      * @return
      */
-    ImClient registerClient(String userId, String headPortrait, String nickname);
+    ImClient registerUser(String userId, String headPortrait, String nickname);
 
     /**
      * 获取用户token
@@ -60,6 +60,16 @@ public interface WecloudIm {
     Boolean modifyUser(String userId, String nickname, String headPortrait);
 
     /**
+     * 封禁用户
+     * @Author luozh
+     * @Date 2022年05月16日 02:57:55
+     * @param userId 用户id
+     * @param minute 封禁时长，单位为分钟，最大值为 43200 分钟。
+     * @Return
+     */
+    Boolean bannedUser(String userId, Integer minute);
+
+    /**
      * 获取好友请求列表
      * @Author luozh
      * @Date 2022年04月21日 04:50:57

im-sdk/src/main/java/com/wecloud/im/sdk/WecloudImClient.java

@@ -6,11 +6,12 @@ import java.util.List;
 import cn.hutool.core.bean.BeanUtil;
 import cn.hutool.core.lang.Assert;
 
-import com.wecloud.im.sdk.internal.WecloudImClientOperation;
 import com.wecloud.im.sdk.internal.WecloudImContactsOperation;
 import com.wecloud.im.sdk.internal.WecloudImConversationOperation;
 import com.wecloud.im.sdk.internal.WecloudImGroupOperation;
 import com.wecloud.im.sdk.internal.WecloudImMessageOperation;
+import com.wecloud.im.sdk.internal.WecloudImUserOperation;
+import com.wecloud.im.sdk.model.BannedUserRequest;
 import com.wecloud.im.sdk.model.Blacklist;
 import com.wecloud.im.sdk.model.ChatRoomMember;
 import com.wecloud.im.sdk.model.ClientLoginRequest;
@@ -76,7 +77,7 @@ public class WecloudImClient implements WecloudIm {
     private String appSecret;
 
     /* The miscellaneous IM operations */
-    private WecloudImClientOperation imClientOperation;
+    private WecloudImUserOperation imUserOperation;
 
     private WecloudImConversationOperation imConversationOperation;
 
@@ -94,20 +95,20 @@ public class WecloudImClient implements WecloudIm {
     }
 
     @Override
-    public ImClient registerClient(String userId, String headPortrait, String nickname) {
+    public ImClient registerUser(String userId, String headPortrait, String nickname) {
         RegisterClientRequest registerClientRequest =
                 RegisterClientRequest.builder()
                         .userId(userId).headPortrait(headPortrait)
                         .nickname(nickname)
                         .build();
-        return imClientOperation.registerClient(registerClientRequest);
+        return imUserOperation.registerClient(registerClientRequest);
     }
 
     @Override
     public Token getToken(String userId, Integer deviceType) {
-        ClientLoginRequest clientLoginRequest = ClientLoginRequest.builder().clientId(userId).deviceType(deviceType).build();
+        ClientLoginRequest clientLoginRequest = ClientLoginRequest.builder().userId(userId).deviceType(deviceType).build();
 
-        return imClientOperation.getToken(clientLoginRequest);
+        return imUserOperation.getToken(clientLoginRequest);
     }
 
     @Override
@@ -115,7 +116,13 @@ public class WecloudImClient implements WecloudIm {
         ModifyUserRequest modifyUserRequest =
                 ModifyUserRequest.builder().userId(userId).nickname(nickname).headPortrait(headPortrait).build();
 
-        return imClientOperation.modifyUser(modifyUserRequest);
+        return imUserOperation.modifyUser(modifyUserRequest);
+    }
+
+    @Override
+    public Boolean bannedUser(String userId, Integer minute) {
+        BannedUserRequest bannedUserRequest = BannedUserRequest.builder().userId(userId).minute(minute).build();
+        return imUserOperation.bannedUser(bannedUserRequest);
     }
 
     @Override
@@ -135,15 +142,15 @@ public class WecloudImClient implements WecloudIm {
     @Override
     public ClientRelation userRelation(String userId, String friendId) {
         UserRelationRequest userRelationRequest =
-                UserRelationRequest.builder().clientId(userId).friendClientId(friendId).build();
-        return imClientOperation.userRelation(userRelationRequest);
+                UserRelationRequest.builder().userId(userId).friendUserId(friendId).build();
+        return imUserOperation.userRelation(userRelationRequest);
     }
 
     @Override
     public List<ClientRelation> usersRelation(String userId, String friendIds) {
         UsersRelationRequest userRelationRequest =
-                UsersRelationRequest.builder().clientId(userId).friendClientIds(friendIds).build();
-        return imClientOperation.usersRelation(userRelationRequest);
+                UsersRelationRequest.builder().userId(userId).friendUserIds(friendIds).build();
+        return imUserOperation.usersRelation(userRelationRequest);
     }
 
     @Override
@@ -174,7 +181,7 @@ public class WecloudImClient implements WecloudIm {
     @Override
     public List<ChatRoomMember> listChatRoomMember(Long chatRoomId) {
         ListChatRoomMemberRequest request = ListChatRoomMemberRequest.builder().chatRoomId(chatRoomId).build();
-        return imClientOperation.listChatRoomMember(request);
+        return imUserOperation.listChatRoomMember(request);
     }
 
     @Override
@@ -270,7 +277,7 @@ public class WecloudImClient implements WecloudIm {
     public Boolean groupSetting(GroupSettingParam param) {
         GroupSettingRequest groupSettingRequest =
                 GroupSettingRequest.builder()
-                        .operatorClientId(param.getOperatorClientId())
+                        .operatorUserId(param.getOperatorUserId())
                         .groupId(param.getGroupId())
                         .type(param.getType())
                         .on(param.getOn())
@@ -294,7 +301,7 @@ public class WecloudImClient implements WecloudIm {
     }
 
     private void initOperations() {
-        this.imClientOperation = new WecloudImClientOperation(apiDomain, appKey, appSecret);
+        this.imUserOperation = new WecloudImUserOperation(apiDomain, appKey, appSecret);
         this.imConversationOperation = new WecloudImConversationOperation(apiDomain, appKey, appSecret);
         this.imMessageOperation = new WecloudImMessageOperation(apiDomain, appKey, appSecret);
         this.imGroupOperation = new WecloudImGroupOperation(apiDomain, appKey, appSecret);

im-sdk/src/main/java/com/wecloud/im/sdk/internal/WecloudImGroupOperation.java

@@ -179,7 +179,7 @@ public class WecloudImGroupOperation extends WecloudImOperation {
         Boolean on = groupSettingRequest.getOn();
         String name = groupSettingRequest.getName();
         String headPortrait = groupSettingRequest.getHeadPortrait();
-        String operatorClientId = groupSettingRequest.getOperatorClientId();
+        String operatorClientId = groupSettingRequest.getOperatorUserId();
         assertParameterNotBlank(groupId, "groupId");
         assertParameterNotNull(type, "type");
         assertParameterNotBlank(operatorClientId, "operatorClientId");

im-sdk/src/main/java/com/wecloud/im/sdk/internal/WecloudImClientOperation.java → im-sdk/src/main/java/com/wecloud/im/sdk/internal/WecloudImUserOperation.java

@@ -10,6 +10,7 @@ import com.alibaba.fastjson.JSON;
 import com.alibaba.fastjson.TypeReference;
 import com.wecloud.im.sdk.common.HttpMethod;
 import com.wecloud.im.sdk.common.RequestMessage;
+import com.wecloud.im.sdk.model.BannedUserRequest;
 import com.wecloud.im.sdk.model.ChatRoomMember;
 import com.wecloud.im.sdk.model.ClientLoginRequest;
 import com.wecloud.im.sdk.model.ClientRelation;
@@ -21,6 +22,7 @@ import com.wecloud.im.sdk.model.Token;
 import com.wecloud.im.sdk.model.UserRelationRequest;
 import com.wecloud.im.sdk.model.UsersRelationRequest;
 
+import static com.wecloud.im.sdk.ResourcePathConstants.BANNED_USER_REQUEST;
 import static com.wecloud.im.sdk.ResourcePathConstants.GET_TOKEN_URL;
 import static com.wecloud.im.sdk.ResourcePathConstants.LIST_CHAT_ROOM_MEMBER_REQUEST;
 import static com.wecloud.im.sdk.ResourcePathConstants.MODIFY_USER_URL;
@@ -35,9 +37,9 @@ import static com.wecloud.im.sdk.utils.CodingUtils.assertParameterNotNull;
  * @Date 2022年04月13日 15:26
  * @Version 1.0
  */
-public class WecloudImClientOperation extends WecloudImOperation {
+public class WecloudImUserOperation extends WecloudImOperation {
 
-    public WecloudImClientOperation(URL apiDomain, String appKey, String appSecret) {
+    public WecloudImUserOperation(URL apiDomain, String appKey, String appSecret) {
         super(apiDomain, appKey, appSecret);
     }
 
@@ -75,15 +77,15 @@ public class WecloudImClientOperation extends WecloudImOperation {
      * @Return
      */
     public Token getToken(ClientLoginRequest clientLoginRequest) {
-        String clientId = clientLoginRequest.getClientId();
+        String userId = clientLoginRequest.getUserId();
         Integer deviceType = clientLoginRequest.getDeviceType();
         // 参数校验
-        assertParameterNotNull(clientId, "userId");
+        assertParameterNotNull(userId, "userId");
         assertParameterNotNull(deviceType, "deviceType");
         // 校验通过 构建参数
         Map<String, String> param = new HashMap<>();
         param.put("deviceType", clientLoginRequest.getDeviceType() + "");
-        param.put("clientId", clientLoginRequest.getClientId() + "");
+        param.put("clientId", clientLoginRequest.getUserId() + "");
 
         // 发送请求
         RequestMessage request = new WecloudRequestMessageBuilder().setEndpoint(GET_TOKEN_URL)
@@ -158,8 +160,8 @@ public class WecloudImClientOperation extends WecloudImOperation {
      * @Return
      */
     public ClientRelation userRelation(UserRelationRequest userRelationRequest) {
-        String clientId = userRelationRequest.getClientId();
-        String friendClientId = userRelationRequest.getFriendClientId();
+        String clientId = userRelationRequest.getUserId();
+        String friendClientId = userRelationRequest.getFriendUserId();
         assertParameterNotBlank(clientId, "userId");
         assertParameterNotBlank(friendClientId, "friendUserId");
 
@@ -179,4 +181,23 @@ public class WecloudImClientOperation extends WecloudImOperation {
     public List<ClientRelation> usersRelation(UsersRelationRequest userRelationRequest) {
         return null;
     }
+
+    public Boolean bannedUser(BannedUserRequest bannedUserRequest) {
+
+        String userId = bannedUserRequest.getUserId();
+        Integer minute = bannedUserRequest.getMinute();
+        assertParameterNotBlank(userId, "userId");
+
+        Map<String, String> param = new HashMap<>();
+        param.put("clientId", userId);
+        param.put("minute", minute.toString());
+        // 发送请求
+        RequestMessage request = new WecloudRequestMessageBuilder().setEndpoint(BANNED_USER_REQUEST)
+                .setMethod(HttpMethod.POST).setParameters(param)
+                .setOriginalRequest(bannedUserRequest).build();
+
+        Object result = doOperation(request);
+        Boolean flag = JSON.parseObject(JSON.toJSONString(result), Boolean.class);
+        return flag;
+    }
 }

im-sdk/src/main/java/com/wecloud/im/sdk/model/BannedUserRequest.java

+package com.wecloud.im.sdk.model;
+
+import lombok.Builder;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+
+/**
+ * 封禁用户请求
+ * @Author luozh
+ * @Date 2022年05月16日 14:59
+ * @Version 1.0
+ */
+@EqualsAndHashCode(callSuper = true)
+@Data
+@Builder
+public class BannedUserRequest extends WebServiceRequest {
+
+    /**
+     * 用户id
+     */
+    private String userId;
+
+    /**
+     * 封禁时长，单位为分钟，最大值为 43200 分钟。
+     */
+    private Integer minute;
+}

im-sdk/src/main/java/com/wecloud/im/sdk/model/ClientLoginRequest.java

@@ -18,7 +18,7 @@ public class ClientLoginRequest extends WebServiceRequest {
     /**
      * 用户id
      */
-    private String clientId;
+    private String userId;
 
     /**
      * 设备类型 1:ios; 2:android; 3:web; 4:win; 5:mac

im-sdk/src/main/java/com/wecloud/im/sdk/model/GroupSettingParam.java

@@ -13,7 +13,7 @@ import com.wecloud.im.sdk.enums.GroupChatSettingTypeEnum;
 @Data
 public class GroupSettingParam {
 
-    private String operatorClientId;
+    private String operatorUserId;
 
     /**
      * 设置类型 FORBID_ADD_FRIEND  禁止群成员互加好友

im-sdk/src/main/java/com/wecloud/im/sdk/model/GroupSettingRequest.java

@@ -20,7 +20,7 @@ public class GroupSettingRequest extends WebServiceRequest {
     /**
      * 操作人id
      */
-    private String operatorClientId;
+    private String operatorUserId;
 
     /**
      * 设置类型 FORBID_ADD_FRIEND  禁止群成员互加好友

im-sdk/src/main/java/com/wecloud/im/sdk/model/UserRelationRequest.java

@@ -18,10 +18,10 @@ public class UserRelationRequest extends WebServiceRequest {
     /**
      * 客户端id
      */
-    private String clientId;
+    private String userId;
 
     /**
      * 好友客户端id
      */
-    private String friendClientId;
+    private String friendUserId;
 }

im-sdk/src/main/java/com/wecloud/im/sdk/model/UsersRelationRequest.java

@@ -18,10 +18,10 @@ public class UsersRelationRequest extends WebServiceRequest {
     /**
      * 客户端id
      */
-    private String clientId;
+    private String userId;
 
     /**
      * 好友客户端id
      */
-    private String friendClientIds;
+    private String friendUserIds;
 }

im-sdk/src/main/java/com/wecloud/im/sdk/sample/RegisterClientSample.java

@@ -21,7 +21,7 @@ public class RegisterClientSample {
         String userId = "20220413001";
         String headPortrait = "";
         String nickname = "luo_test1";
-        ImClient imClient = im.registerClient(userId, headPortrait, nickname);
+        ImClient imClient = im.registerUser(userId, headPortrait, nickname);
         System.out.println("\tregister client result=" + JSONObject.toJSONString(imClient));
     }
 }