docs: add code comments (#68)

src/main/java/io/github/doocs/im/core/Account.java

@@ -8,13 +8,21 @@ import io.github.doocs.im.util.HttpUtil;
 import java.io.IOException;
 
 /**
+ * 帐号管理
+ *
  * @author hyh
  * @since 2021/07/29 14:52
  */
 public class Account {
+    /**
+     * 帐号管理服务名
+     */
     private static final String SERVICE_NAME = "im_open_login_svc";
     private static final String SERVICE_NAME_OPEN_IM = "openim";
 
+    /**
+     * 帐号管理相关命令字
+     */
     private static final String ACCOUNT_IMPORT_COMMAND = "account_import";
     private static final String MULTI_ACCOUNT_IMPORT_COMMAND = "multiaccount_import";
     private static final String ACCOUNT_DELETE_COMMAND = "account_delete";
@@ -28,31 +36,73 @@ public class Account {
         this.imClient = imClient;
     }
 
+    /**
+     * 导入单个帐号
+     *
+     * @param accountImportRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public AccountImportResult accountImport(AccountImportRequest accountImportRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, ACCOUNT_IMPORT_COMMAND);
         return HttpUtil.post(url, accountImportRequest, AccountImportResult.class, imClient.getConfig());
     }
 
+    /**
+     * 导入多个帐号
+     *
+     * @param multiAccountImportRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public MultiAccountImportResult multiAccountImport(MultiAccountImportRequest multiAccountImportRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, MULTI_ACCOUNT_IMPORT_COMMAND);
         return HttpUtil.post(url, multiAccountImportRequest, MultiAccountImportResult.class, imClient.getConfig());
     }
 
+    /**
+     * 删除帐号
+     *
+     * @param accountDeleteRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public AccountDeleteResult accountDelete(AccountDeleteRequest accountDeleteRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, ACCOUNT_DELETE_COMMAND);
         return HttpUtil.post(url, accountDeleteRequest, AccountDeleteResult.class, imClient.getConfig());
     }
 
+    /**
+     * 查询帐号
+     *
+     * @param accountCheckRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public AccountCheckResult accountCheck(AccountCheckRequest accountCheckRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, ACCOUNT_CHECK_COMMAND);
         return HttpUtil.post(url, accountCheckRequest, AccountCheckResult.class, imClient.getConfig());
     }
 
+    /**
+     * 失效帐号登录状态
+     *
+     * @param kickRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public KickResult kick(KickRequest kickRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, KICK_COMMAND);
         return HttpUtil.post(url, kickRequest, KickResult.class, imClient.getConfig());
     }
 
+    /**
+     * 查询帐号在线状态
+     *
+     * @param queryOnlineStatusRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public QueryOnlineStatusResult queryOnlineStatus(QueryOnlineStatusRequest queryOnlineStatusRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME_OPEN_IM, QUERY_ONLINE_STATUS_COMMAND);
         return HttpUtil.post(url, queryOnlineStatusRequest, QueryOnlineStatusResult.class, imClient.getConfig());

src/main/java/io/github/doocs/im/core/Member.java

@@ -8,12 +8,20 @@ import io.github.doocs.im.util.HttpUtil;
 import java.io.IOException;
 
 /**
+ * 全员推送
+ *
  * @author bingo
  * @since 2021/7/31 16:19
  */
 public class Member {
+    /**
+     * 全员推送服务名
+     */
     private static final String SERVICE_NAME = "all_member_push";
 
+    /**
+     * 全员推送相关命令字
+     */
     private static final String IM_PUSH_COMMAND = "im_push";
     private static final String IM_SET_ATTR_NAME_COMMAND = "im_set_attr_name";
     private static final String IM_GET_ATTR_NAME_COMMAND = "im_get_attr_name";
@@ -31,51 +39,121 @@ public class Member {
         this.imClient = imClient;
     }
 
+    /**
+     * 全员推送
+     *
+     * @param imPushRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public ImPushResult imPush(ImPushRequest imPushRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, IM_PUSH_COMMAND);
         return HttpUtil.post(url, imPushRequest, ImPushResult.class, imClient.getConfig());
     }
 
+    /**
+     * 设置应用属性名称
+     *
+     * @param imSetAttrNameRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public ImSetAttrNameResult imSetAttrName(ImSetAttrNameRequest imSetAttrNameRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, IM_SET_ATTR_NAME_COMMAND);
         return HttpUtil.post(url, imSetAttrNameRequest, ImSetAttrNameResult.class, imClient.getConfig());
     }
 
+    /**
+     * 获取应用属性名称
+     *
+     * @param imGetAttrNameRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public ImGetAttrNameResult imGetAttrName(ImGetAttrNameRequest imGetAttrNameRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, IM_GET_ATTR_NAME_COMMAND);
         return HttpUtil.post(url, imGetAttrNameRequest, ImGetAttrNameResult.class, imClient.getConfig());
     }
 
+    /**
+     * 获取用户属性
+     *
+     * @param imGetAttrRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public ImGetAttrResult imGetAttr(ImGetAttrRequest imGetAttrRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, IM_GET_ATTR_COMMAND);
         return HttpUtil.post(url, imGetAttrRequest, ImGetAttrResult.class, imClient.getConfig());
     }
 
+    /**
+     * 设置用户属性
+     *
+     * @param imSetAttrRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public ImSetAttrResult imSetAttr(ImSetAttrRequest imSetAttrRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, IM_SET_ATTR_COMMAND);
         return HttpUtil.post(url, imSetAttrRequest, ImSetAttrResult.class, imClient.getConfig());
     }
 
+    /**
+     * 删除用户属性
+     *
+     * @param imRemoveAttrRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public ImRemoveAttrResult imRemoveAttr(ImRemoveAttrRequest imRemoveAttrRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, IM_REMOVE_ATTR_COMMAND);
         return HttpUtil.post(url, imRemoveAttrRequest, ImRemoveAttrResult.class, imClient.getConfig());
     }
 
+    /**
+     * 获取用户标签
+     *
+     * @param imGetTagRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public ImGetTagResult imGetTag(ImGetTagRequest imGetTagRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, IM_GET_TAG_COMMAND);
         return HttpUtil.post(url, imGetTagRequest, ImGetTagResult.class, imClient.getConfig());
     }
 
+    /**
+     * 添加用户标签
+     *
+     * @param imAddTagRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public ImAddTagResult imAddTag(ImAddTagRequest imAddTagRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, IM_ADD_TAG_COMMAND);
         return HttpUtil.post(url, imAddTagRequest, ImAddTagResult.class, imClient.getConfig());
     }
 
+    /**
+     * 删除用户标签
+     *
+     * @param imRemoveTagRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public ImRemoveTagResult imRemoveTag(ImRemoveTagRequest imRemoveTagRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, IM_REMOVE_TAG_COMMAND);
         return HttpUtil.post(url, imRemoveTagRequest, ImRemoveTagResult.class, imClient.getConfig());
     }
 
+    /**
+     * 删除用户所有标签
+     *
+     * @param imRemoveAllTagsRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public ImRemoveAllTagsResult imRemoveAllTags(ImRemoveAllTagsRequest imRemoveAllTagsRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, IM_REMOVE_ALL_TAGS_COMMAND);
         return HttpUtil.post(url, imRemoveAllTagsRequest, ImRemoveAllTagsResult.class, imClient.getConfig());

src/main/java/io/github/doocs/im/core/Message.java

@@ -8,12 +8,20 @@ import io.github.doocs.im.util.HttpUtil;
 import java.io.IOException;
 
 /**
+ * 单聊消息
+ *
  * @author hyh
  * @since 2021/07/29 10:28
  */
 public class Message {
+    /**
+     * 单聊消息服务名
+     */
     private static final String SERVICE_NAME = "openim";
 
+    /**
+     * 单聊消息相关命令字
+     */
     private static final String SEND_MSG_COMMAND = "sendmsg";
     private static final String IMPORT_MSG_COMMAND = "importmsg";
     private static final String BATCH_SEND_MSG_COMMAND = "batchsendmsg";
@@ -28,36 +36,85 @@ public class Message {
         this.imClient = imClient;
     }
 
+    /**
+     * 单发单聊消息
+     *
+     * @param sendMsgRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public SendMsgResult sendMsg(SendMsgRequest sendMsgRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, SEND_MSG_COMMAND);
         return HttpUtil.post(url, sendMsgRequest, SendMsgResult.class, imClient.getConfig());
     }
 
+    /**
+     * 批量发单聊消息
+     *
+     * @param batchSendMsgRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public BatchSendMsgResult batchSendMsg(BatchSendMsgRequest batchSendMsgRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, BATCH_SEND_MSG_COMMAND);
         return HttpUtil.post(url, batchSendMsgRequest, BatchSendMsgResult.class, imClient.getConfig());
     }
 
+    /**
+     * 导入单聊消息
+     *
+     * @param importMsgRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public ImportMsgResult importMsg(ImportMsgRequest importMsgRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, IMPORT_MSG_COMMAND);
         return HttpUtil.post(url, importMsgRequest, ImportMsgResult.class, imClient.getConfig());
     }
 
+    /**
+     * 查询单聊消息
+     *
+     * @param adminGetRoamMsgRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public AdminRoamMsgResult getRoamMsg(AdminGetRoamMsgRequest adminGetRoamMsgRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, ADMIN_GET_ROAM_MSG_COMMAND);
         return HttpUtil.post(url, adminGetRoamMsgRequest, AdminRoamMsgResult.class, imClient.getConfig());
     }
 
+    /**
+     * 撤回单聊消息
+     *
+     * @param adminMsgWithdrawRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public AdminMsgWithdrawResult msgWithdraw(AdminMsgWithdrawRequest adminMsgWithdrawRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, ADMIN_MSG_WITHDRAW_COMMAND);
         return HttpUtil.post(url, adminMsgWithdrawRequest, AdminMsgWithdrawResult.class, imClient.getConfig());
     }
 
+    /**
+     * 设置单聊消息已读
+     *
+     * @param adminSetMsgReadRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public AdminSetMsgReadResult setMsgRead(AdminSetMsgReadRequest adminSetMsgReadRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, ADMIN_SET_MSG_READ_COMMAND);
         return HttpUtil.post(url, adminSetMsgReadRequest, AdminSetMsgReadResult.class, imClient.getConfig());
     }
 
+    /**
+     * 查询单聊未读消息计数
+     *
+     * @param getC2cUnreadMsgRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public C2cUnreadMsgNumResult getC2cUnreadMsgNum(GetC2cUnreadMsgRequest getC2cUnreadMsgRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, GET_C2C_UNREAD_MSG_NUM_COMMAND);
         return HttpUtil.post(url, getC2cUnreadMsgRequest, C2cUnreadMsgNumResult.class, imClient.getConfig());

src/main/java/io/github/doocs/im/core/Operation.java

@@ -8,14 +8,22 @@ import io.github.doocs.im.util.HttpUtil;
 import java.io.IOException;
 
 /**
+ * 运营管理、全局禁言管理
+ *
  * @author xy
  * @since 2021/07/31 11:17
  */
 public class Operation {
+    /**
+     * 运营管理、全局禁言管理服务名
+     */
     private static final String SERVICE_NAME_OPEN_CONFIG = "openconfigsvr";
     private static final String SERVICE_NAME_OPEN_MSG = "open_msg_svc";
     private static final String SERVICE_NAME_CONFIG = "ConfigSvc";
 
+    /**
+     * 运营管理、全局禁言管理相关命令字
+     */
     private static final String SET_NO_SPEAKING_COMMAND = "setnospeaking";
     private static final String GET_NO_SPEAKING_COMMAND = "getnospeaking";
     private static final String GET_APP_INFO_COMMAND = "getappinfo";
@@ -29,26 +37,61 @@ public class Operation {
         this.imClient = imClient;
     }
 
+    /**
+     * 设置全局禁言
+     *
+     * @param setNoSpeakingRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public SetNoSpeakingResult setNoSpeaking(SetNoSpeakingRequest setNoSpeakingRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME_OPEN_CONFIG, SET_NO_SPEAKING_COMMAND);
         return HttpUtil.post(url, setNoSpeakingRequest, SetNoSpeakingResult.class, imClient.getConfig());
     }
 
+    /**
+     * 查询全局禁言
+     *
+     * @param getNoSpeakingRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public GetNoSpeakingResult getNoSpeaking(GetNoSpeakingRequest getNoSpeakingRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME_OPEN_CONFIG, GET_NO_SPEAKING_COMMAND);
         return HttpUtil.post(url, getNoSpeakingRequest, GetNoSpeakingResult.class, imClient.getConfig());
     }
 
+    /**
+     * 拉取运营数据
+     *
+     * @param getAppInfoRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public GetAppInfoResult getAppInfo(GetAppInfoRequest getAppInfoRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME_OPEN_CONFIG, GET_APP_INFO_COMMAND);
         return HttpUtil.post(url, getAppInfoRequest, GetAppInfoResult.class, imClient.getConfig());
     }
 
+    /**
+     * 下载最近消息记录
+     *
+     * @param getHistoryRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public GetHistoryResult getHistory(GetHistoryRequest getHistoryRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME_OPEN_MSG, GET_HISTORY_COMMAND);
         return HttpUtil.post(url, getHistoryRequest, GetHistoryResult.class, imClient.getConfig());
     }
 
+    /**
+     * 获取服务器 IP 地址
+     *
+     * @param getIpListRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public GetIpListResult getIpList(GetIpListRequest getIpListRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME_CONFIG, GET_IP_LIST_COMMAND);
         return HttpUtil.post(url, getIpListRequest, GetIpListResult.class, imClient.getConfig());

src/main/java/io/github/doocs/im/core/Profile.java

@@ -10,12 +10,20 @@ import io.github.doocs.im.util.HttpUtil;
 import java.io.IOException;
 
 /**
+ * 资料管理
+ *
  * @author hyh
  * @since 2021/07/29 15:11
  */
 public class Profile {
+    /**
+     * 资料管理服务名
+     */
     private static final String SERVICE_NAME = "profile";
 
+    /**
+     * 资料管理相关命令字
+     */
     private static final String PORTRAIT_SET_COMMAND = "portrait_set";
     private static final String PORTRAIT_GET_COMMAND = "portrait_get";
 
@@ -25,11 +33,25 @@ public class Profile {
         this.imClient = imClient;
     }
 
+    /**
+     * 设置资料
+     *
+     * @param portraitSetRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public PortraitSetResult portraitSet(PortraitSetRequest portraitSetRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, PORTRAIT_SET_COMMAND);
         return HttpUtil.post(url, portraitSetRequest, PortraitSetResult.class, imClient.getConfig());
     }
 
+    /**
+     * 拉取资料
+     *
+     * @param portraitGetRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public PortraitGetResult portraitGet(PortraitGetRequest portraitGetRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, PORTRAIT_GET_COMMAND);
         return HttpUtil.post(url, portraitGetRequest, PortraitGetResult.class, imClient.getConfig());

src/main/java/io/github/doocs/im/core/RecentContact.java

@@ -10,12 +10,20 @@ import io.github.doocs.im.util.HttpUtil;
 import java.io.IOException;
 
 /**
+ * 最近联系人
+ *
  * @author bingo
  * @since 2021/10/11 10:25
  */
 public class RecentContact {
+    /**
+     * 最近联系人服务名
+     */
     private static final String SERVICE_NAME = "recentcontact";
 
+    /**
+     * 最近联系人相关命令字
+     */
     private static final String GET_RECENT_CONTACT_LIST = "get_list";
     private static final String DELETE_RECENT_CONTACT = "delete";
 
@@ -25,11 +33,25 @@ public class RecentContact {
         this.imClient = imClient;
     }
 
+    /**
+     * 拉取会话列表
+     *
+     * @param recentContactListRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public GetRecentContactListResult recentContactList(GetRecentContactListRequest recentContactListRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, GET_RECENT_CONTACT_LIST);
         return HttpUtil.post(url, recentContactListRequest, GetRecentContactListResult.class, imClient.getConfig());
     }
 
+    /**
+     * 删除单个会话
+     *
+     * @param deleteRecentContactRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public DeleteRecentContactResult deleteRecentContact(DeleteRecentContactRequest deleteRecentContactRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, DELETE_RECENT_CONTACT);
         return HttpUtil.post(url, deleteRecentContactRequest, DeleteRecentContactResult.class, imClient.getConfig());

src/main/java/io/github/doocs/im/core/Sns.java

@@ -12,8 +12,14 @@ import java.io.IOException;
  * @since 2021/07/29 15:11
  */
 public class Sns {
+    /**
+     * 关系链管理服务名
+     */
     private static final String SERVICE_NAME = "sns";
 
+    /**
+     * 关系链管理相关命令字
+     */
     private static final String FRIEND_ADD_COMMAND = "friend_add";
     private static final String FRIEND_IMPORT_COMMAND = "friend_import";
     private static final String FRIEND_UPDATE_COMMAND = "friend_update";
@@ -36,76 +42,181 @@ public class Sns {
         this.imClient = imClient;
     }
 
+    /**
+     * 添加好友
+     *
+     * @param friendAddRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public FriendAddResult friendAdd(FriendAddRequest friendAddRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, FRIEND_ADD_COMMAND);
         return HttpUtil.post(url, friendAddRequest, FriendAddResult.class, imClient.getConfig());
     }
 
+    /**
+     * 导入好友
+     *
+     * @param friendImportRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public FriendImportResult friendImport(FriendImportRequest friendImportRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, FRIEND_IMPORT_COMMAND);
         return HttpUtil.post(url, friendImportRequest, FriendImportResult.class, imClient.getConfig());
     }
 
+    /**
+     * 更新好友
+     *
+     * @param friendUpdateRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public FriendUpdateResult friendUpdate(FriendUpdateRequest friendUpdateRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, FRIEND_UPDATE_COMMAND);
         return HttpUtil.post(url, friendUpdateRequest, FriendUpdateResult.class, imClient.getConfig());
     }
 
+    /**
+     * 删除好友
+     *
+     * @param friendDeleteRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public FriendDeleteResult friendDelete(FriendDeleteRequest friendDeleteRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, FRIEND_DELETE_COMMAND);
         return HttpUtil.post(url, friendDeleteRequest, FriendDeleteResult.class, imClient.getConfig());
     }
 
+    /**
+     * 删除所有好友
+     *
+     * @param friendDeleteAllRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public FriendDeleteAllResult friendDeleteAll(FriendDeleteAllRequest friendDeleteAllRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, FRIEND_DELETE_ALL_COMMAND);
         return HttpUtil.post(url, friendDeleteAllRequest, FriendDeleteAllResult.class, imClient.getConfig());
     }
 
+    /**
+     * 校验好友
+     *
+     * @param friendCheckRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public FriendCheckResult friendCheck(FriendCheckRequest friendCheckRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, FRIEND_CHECK_COMMAND);
         return HttpUtil.post(url, friendCheckRequest, FriendCheckResult.class, imClient.getConfig());
     }
 
+    /**
+     * 拉取好友
+     *
+     * @param friendGetRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public FriendGetResult friendGet(FriendGetRequest friendGetRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, FRIEND_GET_COMMAND);
         return HttpUtil.post(url, friendGetRequest, FriendGetResult.class, imClient.getConfig());
     }
 
+    /**
+     * 拉取指定好友
+     *
+     * @param friendGetListRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public FriendGetListResult friendGetList(FriendGetListRequest friendGetListRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, FRIEND_GET_LIST_COMMAND);
         return HttpUtil.post(url, friendGetListRequest, FriendGetListResult.class, imClient.getConfig());
     }
 
+    /**
+     * 添加黑名单
+     *
+     * @param blackListAddRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public BlackListAddResult blackListAdd(BlackListAddRequest blackListAddRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, BLACK_LIST_ADD_COMMAND);
         return HttpUtil.post(url, blackListAddRequest, BlackListAddResult.class, imClient.getConfig());
     }
 
+    /**
+     * 删除黑名单
+     *
+     * @param blackListDeleteRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public BlackListDeleteResult blackListDelete(BlackListDeleteRequest blackListDeleteRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, BLACK_LIST_DELETE_COMMAND);
         return HttpUtil.post(url, blackListDeleteRequest, BlackListDeleteResult.class, imClient.getConfig());
     }
 
+    /**
+     * 拉取黑名单
+     *
+     * @param blackListGetRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public BlackListGetResult blackListGet(BlackListGetRequest blackListGetRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, BLACK_LIST_GET_COMMAND);
         return HttpUtil.post(url, blackListGetRequest, BlackListGetResult.class, imClient.getConfig());
     }
 
+    /**
+     * 校验黑名单
+     *
+     * @param blackListCheckRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public BlackListCheckResult blackListCheck(BlackListCheckRequest blackListCheckRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, BLACK_LIST_CHECK_COMMAND);
         return HttpUtil.post(url, blackListCheckRequest, BlackListCheckResult.class, imClient.getConfig());
     }
 
+    /**
+     * 添加分组
+     *
+     * @param groupAddRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public GroupAddResult groupAdd(GroupAddRequest groupAddRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, GROUP_ADD_COMMAND);
         return HttpUtil.post(url, groupAddRequest, GroupAddResult.class, imClient.getConfig());
     }
 
+    /**
+     * 删除分组
+     *
+     * @param groupDeleteRequest 请求参数
+     * @return 结果
+     * @throws IOException 异常
+     */
     public GroupDeleteResult groupDelete(GroupDeleteRequest groupDeleteRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, GROUP_DELETE_COMMAND);
         return HttpUtil.post(url, groupDeleteRequest, GroupDeleteResult.class, imClient.getConfig());
     }
 
+    /**
+     * 拉取分组 结果
+     *
+     * @param groupGetRequest 请求参数
+     * @return
+     * @throws IOException 异常
+     */
     public GroupGetResult groupGet(GroupGetRequest groupGetRequest) throws IOException {
         String url = imClient.getUrl(SERVICE_NAME, GROUP_GET_COMMAND);
         return HttpUtil.post(url, groupGetRequest, GroupGetResult.class, imClient.getConfig());