package cn.jmessage.api;
import cn.jiguang.common.connection.HttpProxy;
import cn.jiguang.common.connection.IHttpClient;
import cn.jiguang.common.resp.APIConnectionException;
import cn.jiguang.common.resp.APIRequestException;
import cn.jiguang.common.resp.ResponseWrapper;
import cn.jmessage.api.chatroom.ChatRoomClient;
import cn.jmessage.api.chatroom.ChatRoomListResult;
import cn.jmessage.api.chatroom.ChatRoomMemberList;
import cn.jmessage.api.chatroom.CreateChatRoomResult;
import cn.jmessage.api.common.model.chatroom.ChatRoomPayload;
import cn.jmessage.api.common.model.group.GroupPayload;
import cn.jmessage.api.common.model.group.GroupShieldPayload;
import cn.jmessage.api.crossapp.CrossAppClient;
import cn.jmessage.api.common.JMessageConfig;
import cn.jmessage.api.common.model.*;
import cn.jmessage.api.common.model.cross.CrossBlacklist;
import cn.jmessage.api.common.model.cross.CrossFriendPayload;
import cn.jmessage.api.common.model.cross.CrossGroup;
import cn.jmessage.api.common.model.cross.CrossNoDisturb;
import cn.jmessage.api.common.model.friend.FriendNote;
import cn.jmessage.api.common.model.message.MessageBody;
import cn.jmessage.api.common.model.message.MessagePayload;
import cn.jmessage.api.group.CreateGroupResult;
import cn.jmessage.api.group.GroupClient;
import cn.jmessage.api.group.GroupInfoResult;
import cn.jmessage.api.group.GroupListResult;
import cn.jmessage.api.group.MemberListResult;
import cn.jmessage.api.message.MessageClient;
import cn.jmessage.api.message.MessageListResult;
import cn.jmessage.api.message.MessageType;
import cn.jmessage.api.message.SendMessageResult;
import cn.jmessage.api.reportv2.GroupStatListResult;
import cn.jmessage.api.reportv2.MessageStatListResult;
import cn.jmessage.api.reportv2.ReportClient;
import cn.jmessage.api.reportv2.UserStatListResult;
import cn.jmessage.api.resource.DownloadResult;
import cn.jmessage.api.resource.ResourceClient;
import cn.jmessage.api.resource.UploadResult;
import cn.jmessage.api.sensitiveword.SensitiveWordClient;
import cn.jmessage.api.sensitiveword.SensitiveWordListResult;
import cn.jmessage.api.sensitiveword.SensitiveWordStatusResult;
import cn.jmessage.api.user.*;
import java.util.Set;
public class JMessageClient {
private final UserClient _userClient;
private final GroupClient _groupClient;
private final MessageClient _messageClient;
private final ResourceClient _resourceClient;
private final CrossAppClient _crossAppClient;
private final SensitiveWordClient _sensitiveWordClient;
private final ChatRoomClient _chatRoomClient;
private final ReportClient _reportClient;
private final int _sendVersion;
/**
* Create a JMessage Client.
*
* @param appkey The KEY of one application on JPush.
* @param masterSecret API access secret of the appKey.
*/
public JMessageClient(String appkey, String masterSecret) {
this(appkey, masterSecret, null, JMessageConfig.getInstance());
}
/**
* Create a JMessage Client with custom maxRetryTimes.
*
* @param appkey The KEY of one application on JPush.
* @param masterSecret API access secret of the appKey.
* @param maxRetryTimes The max retry times.
*/
public JMessageClient(String appkey, String masterSecret, int maxRetryTimes) {
this(appkey, masterSecret, null, JMessageConfig.getInstance().setMaxRetryTimes(maxRetryTimes));
}
/**
* Create a JMessage Client with a proxy.
*
* @param appkey The KEY of one application on JPush.
* @param masterSecret API access secret of the appKey.
* @param proxy The proxy, if there is no proxy, should be null.
*/
public JMessageClient(String appkey, String masterSecret, HttpProxy proxy) {
this(appkey, masterSecret, proxy, JMessageConfig.getInstance());
}
/**
* Create a JMessage Client with a custom hostname.
* If you are using JPush/JMessage privacy cloud, maybe this constructor is what you needed.
*
* @param appkey The KEY of one application on JPush.
* @param masterSecret API access secret of the appKey.
* @param hostname The custom hostname.
*/
public JMessageClient(String appkey, String masterSecret, String hostname) {
this(appkey, masterSecret, null, JMessageConfig.getInstance().setApiHostName(hostname));
}
/**
* Create a JMessage Client by custom Client configuration.
* If you are using custom parameters, maybe this constructor is what you needed.
*
* @param appkey The KEY of one application on JPush.
* @param masterSecret API access secret of the appKey.
* @param proxy The proxy, if there is no proxy, should be null.
* @param config The client configuration. Can use JMessageConfig.getInstance() as default.
*/
public JMessageClient(String appkey, String masterSecret, HttpProxy proxy, JMessageConfig config) {
_userClient = new UserClient(appkey, masterSecret, proxy, config);
_groupClient = new GroupClient(appkey, masterSecret, proxy, config);
_messageClient = new MessageClient(appkey, masterSecret, proxy, config);
_crossAppClient = new CrossAppClient(appkey, masterSecret, proxy, config);
_resourceClient = new ResourceClient(appkey, masterSecret, proxy, config);
_sensitiveWordClient = new SensitiveWordClient(appkey, masterSecret, proxy, config);
_chatRoomClient = new ChatRoomClient(appkey, masterSecret, proxy, config);
_reportClient = new ReportClient(appkey, masterSecret, proxy, config);
_sendVersion = (Integer) config.get(JMessageConfig.SEND_VERSION);
}
// ------------------------------- User API
public String registerUsers(RegisterInfo[] users)
throws APIConnectionException, APIRequestException {
RegisterPayload payload = RegisterPayload.newBuilder()
.addUsers(users)
.build();
return _userClient.registerUsers(payload).responseContent;
}
public String registerAdmins(String username, String password)
throws APIConnectionException, APIRequestException {
RegisterInfo payload = RegisterInfo.newBuilder()
.setUsername(username)
.setPassword(password)
.build();
return _userClient.registerAdmins(payload).responseContent;
}
public UserInfoResult getUserInfo(String username)
throws APIConnectionException, APIRequestException {
return _userClient.getUserInfo(username);
}
public UserStateResult getUserState(String username)
throws APIConnectionException, APIRequestException {
return _userClient.getUserState(username);
}
/**
* Get users' state
* @param users username of users
* @return {@link UserStateListResult}
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public UserStateListResult[] getUsersState(String...users)
throws APIConnectionException, APIRequestException {
return _userClient.getUsersState(users);
}
public void updateUserPassword(String username, String password)
throws APIConnectionException, APIRequestException {
_userClient.updatePassword(username, password);
}
public void updateUserInfo(String username, String nickname, String birthday, String signature, int gender,
String region, String address, String avatar)
throws APIConnectionException, APIRequestException {
UserPayload payload = UserPayload.newBuilder()
.setNickname(nickname)
.setBirthday(birthday)
.setSignature(signature)
.setGender(gender)
.setRegion(region)
.setAddress(address)
.setAvatar(avatar)
.build();
_userClient.updateUserInfo(username, payload);
}
public void updateUserInfo(String username, UserPayload payload)
throws APIConnectionException, APIRequestException {
_userClient.updateUserInfo(username, payload);
}
/**
* Get user list
* @param start The start index of the list
* @param count The number that how many you want to get from list
* @return User info list
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public UserListResult getUserList(int start, int count)
throws APIConnectionException, APIRequestException {
return _userClient.getUserList(start, count);
}
/**
* Get admins by appkey
* @param start The start index of the list
* @param count The number that how many you want to get from list
* @return admin user info list
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public UserListResult getAdminListByAppkey(int start, int count)
throws APIConnectionException, APIRequestException {
return _userClient.getAdminListByAppkey(start, count);
}
/**
* Get a user's all black list
* @param username The owner of the black list
* @return user info list
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public UserInfoResult[] getBlackList(String username)
throws APIConnectionException, APIRequestException {
return _userClient.getBlackList(username);
}
/**
* Add Users to black list
* @param username The owner of the black list
* @param users The users that will add to black list
* @return add users to black list
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public ResponseWrapper addBlackList(String username, String...users)
throws APIConnectionException, APIRequestException {
return _userClient.addBlackList(username, users);
}
public ResponseWrapper removeBlacklist(String username, String...users)
throws APIConnectionException, APIRequestException {
return _userClient.removeBlackList(username, users);
}
/**
* Get all groups of a user
* @param username Necessary
* @return Group info list
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public UserGroupsResult getGroupListByUser(String username)
throws APIConnectionException, APIRequestException {
return _userClient.getGroupList(username);
}
public void deleteUser(String username)
throws APIConnectionException, APIRequestException {
_userClient.deleteUser(username);
}
/**
* Set don't disturb service while receiving messages.
* You can Add or remove single conversation or group conversation
* @param username Necessary
* @param payload NoDisturbPayload
* @return No content
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public ResponseWrapper setNoDisturb(String username, NoDisturbPayload payload)
throws APIConnectionException, APIRequestException {
return _userClient.setNoDisturb(username, payload);
}
/**
* Add friends to username
* @param username Necessary
* @param users username to be add
* @return No content
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public ResponseWrapper addFriends(String username, String...users)
throws APIConnectionException, APIRequestException {
return _userClient.addFriends(username, users);
}
/**
* Delete friends
* @param username Friends you want to delete to
* @param users username to be delete
* @return No content
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public ResponseWrapper deleteFriends(String username, String...users)
throws APIConnectionException, APIRequestException {
return _userClient.deleteFriends(username, users);
}
/**
* Update friends' note information. The size is limit to 500.
* @param username Necessary
* @param array FriendNote array
* @return No content
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public ResponseWrapper updateFriendsNote(String username, FriendNote[] array)
throws APIConnectionException, APIRequestException {
return _userClient.updateFriendsNote(username, array);
}
/**
* Get all friends'info from a gived username
* @param username Necessary
* @return UserList
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public UserInfoResult[] getFriendsInfo(String username)
throws APIConnectionException, APIRequestException {
return _userClient.getFriendsInfo(username);
}
/**
* Set user's group message blocking
* @param payload GroupShieldPayload
* @param username Necessary
* @return No content
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public ResponseWrapper setGroupShield(GroupShieldPayload payload, String username)
throws APIConnectionException, APIRequestException {
return _userClient.setGroupShield(payload, username);
}
/**
* Forbid or activate user
* @param username username
* @param disable true means forbid, false means activate
* @return No content
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public ResponseWrapper forbidUser(String username, boolean disable)
throws APIConnectionException, APIRequestException {
return _userClient.forbidUser(username, disable);
}
// ------------------------------- Group API
public GroupInfoResult getGroupInfo(long gid)
throws APIConnectionException, APIRequestException {
return _groupClient.getGroupInfo(gid);
}
public MemberListResult getGroupMembers(long gid)
throws APIConnectionException, APIRequestException {
return _groupClient.getGroupMembers(gid);
}
public GroupListResult getGroupListByAppkey(int start, int count)
throws APIConnectionException, APIRequestException {
return _groupClient.getGroupListByAppkey(start, count);
}
public CreateGroupResult createGroup(String owner, String gname, String desc, String avatar, int flag, String... userlist)
throws APIConnectionException, APIRequestException {
Members members = Members.newBuilder().addMember(userlist).build();
GroupPayload payload = GroupPayload.newBuilder()
.setOwner(owner)
.setName(gname)
.setDesc(desc)
.setMembers(members)
.setAvatar(avatar)
.setFlag(flag)
.build();
return _groupClient.createGroup(payload);
}
/**
* Add or remove members from a group
* @param gid The group id
* @param addList If this parameter is null then send remove request
* @param removeList If this parameter is null then send add request
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public void addOrRemoveMembers(long gid, String[] addList, String[] removeList)
throws APIConnectionException, APIRequestException {
Members add = Members.newBuilder()
.addMember(addList)
.build();
Members remove = Members.newBuilder()
.addMember(removeList)
.build();
_groupClient.addOrRemoveMembers(gid, add, remove);
}
public void deleteGroup(long gid)
throws APIConnectionException, APIRequestException {
_groupClient.deleteGroup(gid);
}
public void updateGroupInfo(long gid, String groupName, String groupDesc, String avatar)
throws APIConnectionException, APIRequestException {
_groupClient.updateGroupInfo(gid, groupName, groupDesc, avatar);
}
public void changeGroupAdmin(long gid, String appKey, String username)
throws APIConnectionException, APIRequestException {
_groupClient.changeGroupAdmin(gid,appKey,username);
}
// ------------------------------- Message API
/**
* Send message
* @param version Current version is 1
* @param targetType Group or single
* @param targetId The message receiver
* @param fromType Only support admin now
* @param fromId Sender
* @param messageType MessageType: text, image or custom
* @param messageBody A MessageBodyResult instance
* @return return msg_id
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public SendMessageResult sendMessage(Integer version, String targetType, String targetId,
String fromType, String fromId, MessageType messageType, MessageBody messageBody)
throws APIConnectionException, APIRequestException {
MessagePayload payload = MessagePayload.newBuilder()
.setVersion(version)
.setTargetType(targetType)
.setTargetId(targetId)
.setFromType(fromType)
.setFromId(fromId)
.setMessageType(messageType)
.setMessageBody(messageBody)
.build();
return _messageClient.sendMessage(payload);
}
public SendMessageResult sendMessage(MessagePayload payload)
throws APIConnectionException, APIRequestException {
return _messageClient.sendMessage(payload);
}
/**
* Send single text message by admin
* @param targetId target user's id
* @param fromId sender's id
* @param body message body, include text and extra(if needed).
* @return return msg_id
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public SendMessageResult sendSingleTextByAdmin(String targetId, String fromId, MessageBody body)
throws APIConnectionException, APIRequestException {
return sendMessage(_sendVersion, "single", targetId, "admin",fromId, MessageType.TEXT, body);
}
/**
* Send group text message by admin
* @param targetId target user's id
* @param fromId sender's id
* @param body message body, include text and extra(if needed).
* @return return msg_id
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public SendMessageResult sendGroupTextByAdmin(String targetId, String fromId, MessageBody body)
throws APIConnectionException, APIRequestException {
return sendMessage(_sendVersion, "group", targetId, "admin",fromId, MessageType.TEXT, body);
}
/**
* Get message list from history, messages will store 60 days.
* @param count Necessary parameter. The count of the message list.
* @param begin_time Necessary parameter. The format must follow by 'yyyy-MM-dd HH:mm:ss'
* @param end_time Necessary parameter. The format must follow by 'yyyy-MM-dd HH:mm:ss'
* @return MessageListResult
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public MessageListResult getMessageList(int count, String begin_time, String end_time)
throws APIConnectionException, APIRequestException {
return _messageClient.getMessageList(count, begin_time, end_time);
}
public MessageListResult getMessageListByCursor(String cursor)
throws APIConnectionException, APIRequestException {
return _messageClient.getMessageListByCursor(cursor);
}
/**
* Get message list from user's record, messages will store 60 days.
* @param username Necessary parameter.
* @param count Necessary parameter. The count of the message list.
* @param begin_time Optional parameter. The format must follow by 'yyyy-MM-dd HH:mm:ss'
* @param end_time Optional parameter. The format must follow by 'yyyy-MM-dd HH:mm:ss'
* @return MessageListResult
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public MessageListResult getUserMessages(String username, int count, String begin_time, String end_time)
throws APIConnectionException, APIRequestException {
return _messageClient.getUserMessages(username, count, begin_time, end_time);
}
/**
* Get user's message list with cursor, the cursor will effective in 120 seconds.
* And will return same count of messages as first request.
* @param username Necessary parameter.
* @param cursor First request will return cursor
* @return MessageListResult
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public MessageListResult getUserMessagesByCursor(String username, String cursor)
throws APIConnectionException, APIRequestException {
return _messageClient.getUserMessagesByCursor(username, cursor);
}
/**
* retract message
* 消息撤回
* @param username 用户名
* @param msgId message id
* @return No Content， Error Code：
* 855001 out of retract message time, the effective time is within 3 minutes after sending message
* 855003 the retract message is not exist
* 855004 the message had been retracted
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public ResponseWrapper retractMessage(String username, long msgId)
throws APIConnectionException, APIRequestException {
return _messageClient.retractMessage(username, msgId);
}
// ------------------------------- Resource API
/**
* Download file with mediaId, will return DownloadResult which include url.
* @param mediaId Necessary
* @return DownloadResult
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public DownloadResult downloadFile(String mediaId)
throws APIConnectionException, APIRequestException {
return _resourceClient.downloadFile(mediaId);
}
/**
* Upload file, only support image file(jpg, bmp, gif, png) currently,
* file size should not larger than 8M.
* @param path Necessary, the native path of the file you want to upload
* @param fileType Current support type: image, file, voice
* @return UploadResult
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public UploadResult uploadFile(String path, String fileType)
throws APIConnectionException, APIRequestException {
return _resourceClient.uploadFile(path, fileType);
}
// ------------------------------- Cross APP API
/**
* Add or remove group members from a given group id.
* @param gid Necessary, target group id.
* @param groups Necessary
* @return No content
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public ResponseWrapper addOrRemoveCrossGroupMember(long gid, CrossGroup[] groups)
throws APIConnectionException, APIRequestException {
return _crossAppClient.addOrRemoveCrossGroupMembers(gid, groups);
}
/**
* Get members' info from cross group
* @param gid Necessary, target group id
* @return Member info array
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public MemberListResult getCrossGroupMembers(long gid)
throws APIConnectionException, APIRequestException {
return _crossAppClient.getCrossGroupMembers(gid);
}
/**
* Add blacklist whose users belong to another app to a given user.
* @param username The owner of the blacklist
* @param blacklists CrossBlacklist array
* @return No Content
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public ResponseWrapper addCrossBlacklist(String username, CrossBlacklist[] blacklists)
throws APIConnectionException, APIRequestException {
return _crossAppClient.addCrossBlacklist(username, blacklists);
}
/**
* Delete blacklist whose users belong to another app from a given user.
* @param username The owner of the blacklist
* @param blacklists CrossBlacklist array
* @return No content
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public ResponseWrapper deleteCrossBlacklist(String username, CrossBlacklist[] blacklists)
throws APIConnectionException, APIRequestException {
return _crossAppClient.deleteCrossBlacklist(username, blacklists);
}
/**
* Get all users' info(contains appkey) of user's cross app blacklist
* @param username Necessary, the owner of blacklist
* @return UserInfo array
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public UserInfoResult[] getCrossBlacklist(String username)
throws APIConnectionException, APIRequestException {
return _crossAppClient.getCrossBlacklist(username);
}
/**
* Set cross app no disturb
* https://docs.jiguang.cn/jmessage/server/rest_api_im/#api_1
* @param username Necessary
* @param array CrossNoDisturb array
* @return No content
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public ResponseWrapper setCrossNoDisturb(String username, CrossNoDisturb[] array)
throws APIConnectionException, APIRequestException {
return _crossAppClient.setCrossNoDisturb(username, array);
}
/**
* Add users from cross app.
* @param username Necessary
* @param payload CrossFriendPayload
* @return No content
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public ResponseWrapper addCrossFriends(String username, CrossFriendPayload payload)
throws APIConnectionException, APIRequestException {
return _crossAppClient.addCrossFriends(username, payload);
}
/**
* Delete cross app friends
* @param username Necessary
* @param payload CrossFriendPayload
* @return No content
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public ResponseWrapper deleteCrossFriends(String username, CrossFriendPayload payload)
throws APIConnectionException, APIRequestException {
return _crossAppClient.deleteCrossFriends(username, payload);
}
// ------------------------------- Sensitive Word API
/**
* Add sensitive words
* @param words String array
* @return No content
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public ResponseWrapper addSensitiveWords(String...words) throws APIConnectionException, APIRequestException {
return _sensitiveWordClient.addSensitiveWords(words);
}
/**
* Add sensitive words
* @param words String Set
* @return No content
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public ResponseWrapper addSensitiveWords(Set<String> words) throws APIConnectionException, APIRequestException {
return _sensitiveWordClient.addSensitiveWords(words);
}
/**
* Update sensitive word
* @param newWord new word
* @param oldWord old word
* @return No content
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public ResponseWrapper updateSensitiveWord(String newWord, String oldWord)
throws APIConnectionException, APIRequestException {
return _sensitiveWordClient.updateSensitiveWord(newWord, oldWord);
}
/**
* Delete sensitive word
* @param word word to be deleted
* @return No content
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public ResponseWrapper deleteSensitiveWord(String word) throws APIConnectionException, APIRequestException {
return _sensitiveWordClient.deleteSensitiveWord(word);
}
/**
* Get sensitive word list
* @param start the begin of the list
* @param count the count of the list
* @return SensitiveWordListResult
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public SensitiveWordListResult getSensitiveWordList(int start, int count)
throws APIConnectionException, APIRequestException {
return _sensitiveWordClient.getSensitiveWordList(start, count);
}
/**
* Update sensitive word status
* @param status 1 represent turn on filtering, 0 represent turn off.
* @return No content
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public ResponseWrapper updateSensitiveWordStatus(int status) throws APIConnectionException, APIRequestException {
return _sensitiveWordClient.updateSensitiveWordStatus(status);
}
/**
* Get sensitive word status
* @return status of sensitive word
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public SensitiveWordStatusResult getSensitiveWordStatus() throws APIConnectionException, APIRequestException {
return _sensitiveWordClient.getSensitiveWordStatus();
}
// ========================= Chat room API ==============================
/**
* Create chat room
*
* @param payload {@link ChatRoomPayload}
* @return result contains room id
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public CreateChatRoomResult createChatRoom(ChatRoomPayload payload) throws APIConnectionException, APIRequestException {
return _chatRoomClient.createChatRoom(payload);
}
/**
* Get chat room information by room ids
*
* @param roomIds Array of room id
* @return {@link ChatRoomListResult}
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public ChatRoomListResult getBatchChatRoomInfo(long... roomIds) throws APIConnectionException, APIRequestException {
return _chatRoomClient.getBatchChatRoomInfo(roomIds);
}
/**
* Get user's whole chat room information
*
* @param username required
* @return {@link ChatRoomListResult}
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public ChatRoomListResult getUserChatRoomInfo(String username) throws APIConnectionException, APIRequestException {
return _chatRoomClient.getUserChatRoomInfo(username);
}
/**
* Get application's chat room list
*
* @param start start index
* @param count list count
* @return {@link ChatRoomListResult}
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public ChatRoomListResult getAppChatRoomInfo(int start, int count)
throws APIConnectionException, APIRequestException {
return _chatRoomClient.getAppChatRoomInfo(start, count);
}
/**
* Update chat room info
*
* @param roomId room id
* @param ownerUsername owner username
* @param name new chat room name
* @param desc chat room description
* @return No content
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public ResponseWrapper updateChatRoomInfo(long roomId, String ownerUsername, String name, String desc)
throws APIConnectionException, APIRequestException {
return _chatRoomClient.updateChatRoomInfo(roomId, ownerUsername, name, desc);
}
/**
* Delete chat room by id
*
* @param roomId room id
* @return No content
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public ResponseWrapper deleteChatRoom(long roomId) throws APIConnectionException, APIRequestException {
return _chatRoomClient.deleteChatRoom(roomId);
}
/**
* Update user speak status
*
* @param roomId chat room id
* @param username user to be modified
* @param flag 0 means allow to speak, 1 means forbid to speak in chat room
* @return No content
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public ResponseWrapper updateUserSpeakStatus(long roomId, String username, int flag)
throws APIConnectionException, APIRequestException {
return _chatRoomClient.updateUserSpeakStatus(roomId, username, flag);
}
/**
* Get all member info of chat room
*
* @param roomId chat room id
* @param start start index
* @param count member count
* @return {@link ChatRoomMemberList}
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public ChatRoomMemberList getChatRoomMembers(long roomId, int start, int count)
throws APIConnectionException, APIRequestException {
return _chatRoomClient.getChatRoomMembers(roomId, start, count);
}
/**
* Add members to chat room
*
* @param roomId chat room id
* @param members username array
* @return No content
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public ResponseWrapper addChatRoomMember(long roomId, String... members)
throws APIConnectionException, APIRequestException {
return _chatRoomClient.addChatRoomMember(roomId, members);
}
/**
* Add members to chat room
*
* @param roomId chat room id
* @param members {@link Members}
* @return No content
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public ResponseWrapper addChatRoomMember(long roomId, Members members)
throws APIConnectionException, APIRequestException {
return _chatRoomClient.addChatRoomMember(roomId, members);
}
/**
* remove members from chat room
*
* @param roomId chat room id
* @param members username array
* @return No content
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public ResponseWrapper removeChatRoomMembers(long roomId, String... members)
throws APIConnectionException, APIRequestException {
return _chatRoomClient.removeChatRoomMembers(roomId, members);
}
/**
* remove members from chat room
*
* @param roomId chat room id
* @param members {@link Members}
* @return No content
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public ResponseWrapper removeChatRoomMembers(long roomId, Members members)
throws APIConnectionException, APIRequestException {
return _chatRoomClient.removeChatRoomMembers(roomId, members);
}
// =========================== Report API ==============================
/**
* Get message list from history, messages will store 60 days.
* @param count Necessary parameter. The count of the message list.
* @param begin_time Necessary parameter. The format must follow by 'yyyy-MM-dd HH:mm:ss'
* @param end_time Necessary parameter. The format must follow by 'yyyy-MM-dd HH:mm:ss'
* @return MessageListResult
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public MessageListResult v2GetMessageList(int count, String begin_time, String end_time)
throws APIConnectionException, APIRequestException {
return _reportClient.v2GetMessageList(count, begin_time, end_time);
}
public MessageListResult v2GetMessageListByCursor(String cursor)
throws APIConnectionException, APIRequestException {
return _reportClient.v2GetMessageListByCursor(cursor);
}
/**
* Get message list from user's record, messages will store 60 days.
* @param username Necessary parameter.
* @param count Necessary parameter. The count of the message list.
* @param begin_time Optional parameter. The format must follow by 'yyyy-MM-dd HH:mm:ss'
* @param end_time Optional parameter. The format must follow by 'yyyy-MM-dd HH:mm:ss'
* @return MessageListResult
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public MessageListResult v2GetUserMessages(String username, int count, String begin_time, String end_time)
throws APIConnectionException, APIRequestException {
return _reportClient.v2GetUserMessages(username, count, begin_time, end_time);
}
/**
* Get user's message list with cursor, the cursor will effective in 120 seconds.
* And will return same count of messages as first request.
* @param username Necessary parameter.
* @param cursor First request will return cursor
* @return MessageListResult
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public MessageListResult v2GetUserMessagesByCursor(String username, String cursor)
throws APIConnectionException, APIRequestException {
return _reportClient.v2GetUserMessagesByCursor(username, cursor);
}
// ============================ Report v2 VIP Only ====================
/**
* Get user statistic, now time unit only supports DAY
* @param startTime start time, format: yyyy-MM-dd
* @param duration 0-60
* @return {@link UserStatListResult}
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public UserStatListResult getUserStatistic(String startTime, int duration)
throws APIConnectionException, APIRequestException {
return _reportClient.getUserStatistic(startTime, duration);
}
/**
* Get message statistic. Detail instructions please refer to https://docs.jiguang.cn/jmessage/server/rest_api_im_report_v2/#_6
* @param timeUnit MUST be one of HOUR, DAY, MONTH
* @param start start time, when timeUnit is HOUR, format: yyyy-MM-dd HH,
* @param duration depends on timeUnit, the duration has limit
* @return {@link MessageStatListResult}
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public MessageStatListResult getMessageStatistic(String timeUnit, String start, int duration)
throws APIConnectionException, APIRequestException {
return _reportClient.getMessageStatistic(timeUnit, start, duration);
}
/**
* Get group statistic, time unit only supports DAY now.
* @param start Format: yyyy-MM-dd
* @param duration duration must between 0 and 60
* @return {@link GroupStatListResult}
* @throws APIConnectionException connect exception
* @throws APIRequestException request exception
*/
public GroupStatListResult getGroupStatistic(String start, int duration)
throws APIConnectionException, APIRequestException {
return _reportClient.getGroupStatistic(start, duration);
}
public void setHttpClient(IHttpClient httpClient) {
this._userClient.setHttpClient(httpClient);
this._sensitiveWordClient.setHttpClient(httpClient);
this._groupClient.setHttpClient(httpClient);
this._messageClient.setHttpClient(httpClient);
this._resourceClient.setHttpClient(httpClient);
this._crossAppClient.setHttpClient(httpClient);
this._chatRoomClient.setHttpClient(httpClient);
this._reportClient.setHttpClient(httpClient);
}
}
