cn.jmessage.api

Class JMessageClient

java.lang.Object

cn.jmessage.api.JMessageClient

public class JMessageClient
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
JMessageClient(java.lang.String appkey, java.lang.String masterSecret) Create a JMessage Client.
JMessageClient(java.lang.String appkey, java.lang.String masterSecret, cn.jiguang.common.connection.HttpProxy proxy) Create a JMessage Client with a proxy.
JMessageClient(java.lang.String appkey, java.lang.String masterSecret, cn.jiguang.common.connection.HttpProxy proxy, JMessageConfig config) Create a JMessage Client by custom Client configuration.
JMessageClient(java.lang.String appkey, java.lang.String masterSecret, int maxRetryTimes) Create a JMessage Client with custom maxRetryTimes.
JMessageClient(java.lang.String appkey, java.lang.String masterSecret, java.lang.String hostname) Create a JMessage Client with a custom hostname.

Method Summary

Modifier and Type	Method and Description
cn.jiguang.common.resp.ResponseWrapper	addBlackList(java.lang.String username, java.lang.String... users) Add Users to black list
cn.jiguang.common.resp.ResponseWrapper	addChatRoomMember(long roomId, Members members) Add members to chat room
cn.jiguang.common.resp.ResponseWrapper	addChatRoomMember(long roomId, java.lang.String... members) Add members to chat room
cn.jiguang.common.resp.ResponseWrapper	addCrossBlacklist(java.lang.String username, CrossBlacklist[] blacklists) Add blacklist whose users belong to another app to a given user.
cn.jiguang.common.resp.ResponseWrapper	addCrossFriends(java.lang.String username, CrossFriendPayload payload) Add users from cross app.
cn.jiguang.common.resp.ResponseWrapper	addFriends(java.lang.String username, java.lang.String... users) Add friends to username
cn.jiguang.common.resp.ResponseWrapper	addOrRemoveCrossGroupMember(long gid, CrossGroup[] groups) Add or remove group members from a given group id.
void	addOrRemoveMembers(long gid, java.lang.String[] addList, java.lang.String[] removeList) Add or remove members from a group
cn.jiguang.common.resp.ResponseWrapper	addSensitiveWords(java.util.Set<java.lang.String> words) Add sensitive words
cn.jiguang.common.resp.ResponseWrapper	addSensitiveWords(java.lang.String... words) Add sensitive words
void	changeGroupAdmin(long gid, java.lang.String appKey, java.lang.String username)
CreateChatRoomResult	createChatRoom(ChatRoomPayload payload) Create chat room
CreateGroupResult	createGroup(java.lang.String owner, java.lang.String gname, java.lang.String desc, java.lang.String avatar, int flag, java.lang.String... userlist)
cn.jiguang.common.resp.ResponseWrapper	deleteChatRoom(long roomId) Delete chat room by id
cn.jiguang.common.resp.ResponseWrapper	deleteCrossBlacklist(java.lang.String username, CrossBlacklist[] blacklists) Delete blacklist whose users belong to another app from a given user.
cn.jiguang.common.resp.ResponseWrapper	deleteCrossFriends(java.lang.String username, CrossFriendPayload payload) Delete cross app friends
cn.jiguang.common.resp.ResponseWrapper	deleteFriends(java.lang.String username, java.lang.String... users) Delete friends
void	deleteGroup(long gid)
cn.jiguang.common.resp.ResponseWrapper	deleteSensitiveWord(java.lang.String word) Delete sensitive word
void	deleteUser(java.lang.String username)
DownloadResult	downloadFile(java.lang.String mediaId) Download file with mediaId, will return DownloadResult which include url.
cn.jiguang.common.resp.ResponseWrapper	forbidUser(java.lang.String username, boolean disable) Forbid or activate user
UserListResult	getAdminListByAppkey(int start, int count) Get admins by appkey
ChatRoomListResult	getAppChatRoomInfo(int start, int count) Get application's chat room list
ChatRoomListResult	getBatchChatRoomInfo(long... roomIds) Get chat room information by room ids
UserInfoResult[]	getBlackList(java.lang.String username) Get a user's all black list
ChatRoomMemberList	getChatRoomMembers(long roomId, int start, int count) Get all member info of chat room
UserInfoResult[]	getCrossBlacklist(java.lang.String username) Get all users' info(contains appkey) of user's cross app blacklist
MemberListResult	getCrossGroupMembers(long gid) Get members' info from cross group
UserInfoResult[]	getFriendsInfo(java.lang.String username) Get all friends'info from a gived username
GroupInfoResult	getGroupInfo(long gid)
GroupListResult	getGroupListByAppkey(int start, int count)
UserGroupsResult	getGroupListByUser(java.lang.String username) Get all groups of a user
MemberListResult	getGroupMembers(long gid)
GroupStatListResult	getGroupStatistic(java.lang.String start, int duration) Get group statistic, time unit only supports DAY now.
MessageListResult	getMessageList(int count, java.lang.String begin_time, java.lang.String end_time) Get message list from history, messages will store 60 days.
MessageListResult	getMessageListByCursor(java.lang.String cursor)
MessageStatListResult	getMessageStatistic(java.lang.String timeUnit, java.lang.String start, int duration) Get message statistic.
SensitiveWordListResult	getSensitiveWordList(int start, int count) Get sensitive word list
SensitiveWordStatusResult	getSensitiveWordStatus() Get sensitive word status
ChatRoomListResult	getUserChatRoomInfo(java.lang.String username) Get user's whole chat room information
UserInfoResult	getUserInfo(java.lang.String username)
UserListResult	getUserList(int start, int count) Get user list
MessageListResult	getUserMessages(java.lang.String username, int count, java.lang.String begin_time, java.lang.String end_time) Get message list from user's record, messages will store 60 days.
MessageListResult	getUserMessagesByCursor(java.lang.String username, java.lang.String cursor) Get user's message list with cursor, the cursor will effective in 120 seconds.
UserStateListResult[]	getUsersState(java.lang.String... users) Get users' state
UserStateResult	getUserState(java.lang.String username)
UserStatListResult	getUserStatistic(java.lang.String startTime, int duration) Get user statistic, now time unit only supports DAY
java.lang.String	registerAdmins(java.lang.String username, java.lang.String password)
java.lang.String	registerUsers(RegisterInfo[] users)
cn.jiguang.common.resp.ResponseWrapper	removeBlacklist(java.lang.String username, java.lang.String... users)
cn.jiguang.common.resp.ResponseWrapper	removeChatRoomMembers(long roomId, Members members) remove members from chat room
cn.jiguang.common.resp.ResponseWrapper	removeChatRoomMembers(long roomId, java.lang.String... members) remove members from chat room
cn.jiguang.common.resp.ResponseWrapper	retractMessage(java.lang.String username, long msgId) retract message 消息撤回
SendMessageResult	sendGroupTextByAdmin(java.lang.String targetId, java.lang.String fromId, MessageBody body) Send group text message by admin
SendMessageResult	sendMessage(java.lang.Integer version, java.lang.String targetType, java.lang.String targetId, java.lang.String fromType, java.lang.String fromId, MessageType messageType, MessageBody messageBody) Send message
SendMessageResult	sendMessage(MessagePayload payload)
SendMessageResult	sendSingleTextByAdmin(java.lang.String targetId, java.lang.String fromId, MessageBody body) Send single text message by admin
cn.jiguang.common.resp.ResponseWrapper	setCrossNoDisturb(java.lang.String username, CrossNoDisturb[] array) Set cross app no disturb https://docs.jiguang.cn/jmessage/server/rest_api_im/#api_1
cn.jiguang.common.resp.ResponseWrapper	setGroupShield(GroupShieldPayload payload, java.lang.String username) Set user's group message blocking
void	setHttpClient(cn.jiguang.common.connection.IHttpClient httpClient)
cn.jiguang.common.resp.ResponseWrapper	setNoDisturb(java.lang.String username, NoDisturbPayload payload) Set don't disturb service while receiving messages.
cn.jiguang.common.resp.ResponseWrapper	updateChatRoomInfo(long roomId, java.lang.String ownerUsername, java.lang.String name, java.lang.String desc) Update chat room info
cn.jiguang.common.resp.ResponseWrapper	updateFriendsNote(java.lang.String username, FriendNote[] array) Update friends' note information.
void	updateGroupInfo(long gid, java.lang.String groupName, java.lang.String groupDesc, java.lang.String avatar)
cn.jiguang.common.resp.ResponseWrapper	updateSensitiveWord(java.lang.String newWord, java.lang.String oldWord) Update sensitive word
cn.jiguang.common.resp.ResponseWrapper	updateSensitiveWordStatus(int status) Update sensitive word status
void	updateUserInfo(java.lang.String username, java.lang.String nickname, java.lang.String birthday, java.lang.String signature, int gender, java.lang.String region, java.lang.String address, java.lang.String avatar)
void	updateUserInfo(java.lang.String username, UserPayload payload)
void	updateUserPassword(java.lang.String username, java.lang.String password)
cn.jiguang.common.resp.ResponseWrapper	updateUserSpeakStatus(long roomId, java.lang.String username, int flag) Update user speak status
UploadResult	uploadFile(java.lang.String path, java.lang.String fileType) Upload file, only support image file(jpg, bmp, gif, png) currently, file size should not larger than 8M.
MessageListResult	v2GetMessageList(int count, java.lang.String begin_time, java.lang.String end_time) Get message list from history, messages will store 60 days.
MessageListResult	v2GetMessageListByCursor(java.lang.String cursor)
MessageListResult	v2GetUserMessages(java.lang.String username, int count, java.lang.String begin_time, java.lang.String end_time) Get message list from user's record, messages will store 60 days.
MessageListResult	v2GetUserMessagesByCursor(java.lang.String username, java.lang.String cursor) Get user's message list with cursor, the cursor will effective in 120 seconds.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JMessageClient

public JMessageClient(java.lang.String appkey,
                      java.lang.String masterSecret)

Create a JMessage Client.

Parameters:

appkey - The KEY of one application on JPush.

masterSecret - API access secret of the appKey.

JMessageClient

public JMessageClient(java.lang.String appkey,
                      java.lang.String masterSecret,
                      int maxRetryTimes)

Create a JMessage Client with custom maxRetryTimes.

Parameters:

appkey - The KEY of one application on JPush.

masterSecret - API access secret of the appKey.

maxRetryTimes - The max retry times.

JMessageClient

public JMessageClient(java.lang.String appkey,
                      java.lang.String masterSecret,
                      cn.jiguang.common.connection.HttpProxy proxy)

Create a JMessage Client with a proxy.

Parameters:

appkey - The KEY of one application on JPush.

masterSecret - API access secret of the appKey.

proxy - The proxy, if there is no proxy, should be null.

JMessageClient

public JMessageClient(java.lang.String appkey,
                      java.lang.String masterSecret,
                      java.lang.String hostname)

Create a JMessage Client with a custom hostname. If you are using JPush/JMessage privacy cloud, maybe this constructor is what you needed.

Parameters:

appkey - The KEY of one application on JPush.

masterSecret - API access secret of the appKey.

hostname - The custom hostname.

JMessageClient

public JMessageClient(java.lang.String appkey,
                      java.lang.String masterSecret,
                      cn.jiguang.common.connection.HttpProxy proxy,
                      JMessageConfig config)

Create a JMessage Client by custom Client configuration. If you are using custom parameters, maybe this constructor is what you needed.

Parameters:

appkey - The KEY of one application on JPush.

masterSecret - API access secret of the appKey.

proxy - The proxy, if there is no proxy, should be null.

config - The client configuration. Can use JMessageConfig.getInstance() as default.

Method Detail

registerUsers

public java.lang.String registerUsers(RegisterInfo[] users)
                               throws cn.jiguang.common.resp.APIConnectionException,
                                      cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

registerAdmins

public java.lang.String registerAdmins(java.lang.String username,
                                       java.lang.String password)
                                throws cn.jiguang.common.resp.APIConnectionException,
                                       cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

getUserInfo

public UserInfoResult getUserInfo(java.lang.String username)
                           throws cn.jiguang.common.resp.APIConnectionException,
                                  cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

getUserState

public UserStateResult getUserState(java.lang.String username)
                             throws cn.jiguang.common.resp.APIConnectionException,
                                    cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

getUsersState

public UserStateListResult[] getUsersState(java.lang.String... users)
                                    throws cn.jiguang.common.resp.APIConnectionException,
                                           cn.jiguang.common.resp.APIRequestException

Get users' state

Parameters:

users - username of users

Returns:

UserStateListResult

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

updateUserPassword

public void updateUserPassword(java.lang.String username,
                               java.lang.String password)
                        throws cn.jiguang.common.resp.APIConnectionException,
                               cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

updateUserInfo

public void updateUserInfo(java.lang.String username,
                           java.lang.String nickname,
                           java.lang.String birthday,
                           java.lang.String signature,
                           int gender,
                           java.lang.String region,
                           java.lang.String address,
                           java.lang.String avatar)
                    throws cn.jiguang.common.resp.APIConnectionException,
                           cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

updateUserInfo

public void updateUserInfo(java.lang.String username,
                           UserPayload payload)
                    throws cn.jiguang.common.resp.APIConnectionException,
                           cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

getUserList

public UserListResult getUserList(int start,
                                  int count)
                           throws cn.jiguang.common.resp.APIConnectionException,
                                  cn.jiguang.common.resp.APIRequestException

Get user list

Parameters:

start - The start index of the list

count - The number that how many you want to get from list

Returns:

User info list

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

getAdminListByAppkey

public UserListResult getAdminListByAppkey(int start,
                                           int count)
                                    throws cn.jiguang.common.resp.APIConnectionException,
                                           cn.jiguang.common.resp.APIRequestException

Get admins by appkey

Parameters:

start - The start index of the list

count - The number that how many you want to get from list

Returns:

admin user info list

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

getBlackList

public UserInfoResult[] getBlackList(java.lang.String username)
                              throws cn.jiguang.common.resp.APIConnectionException,
                                     cn.jiguang.common.resp.APIRequestException

Get a user's all black list

Parameters:

username - The owner of the black list

Returns:

user info list

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

addBlackList

public cn.jiguang.common.resp.ResponseWrapper addBlackList(java.lang.String username,
                                                           java.lang.String... users)
                                                    throws cn.jiguang.common.resp.APIConnectionException,
                                                           cn.jiguang.common.resp.APIRequestException

Add Users to black list

Parameters:

username - The owner of the black list

users - The users that will add to black list

Returns:

add users to black list

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

removeBlacklist

public cn.jiguang.common.resp.ResponseWrapper removeBlacklist(java.lang.String username,
                                                              java.lang.String... users)
                                                       throws cn.jiguang.common.resp.APIConnectionException,
                                                              cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

getGroupListByUser

public UserGroupsResult getGroupListByUser(java.lang.String username)
                                    throws cn.jiguang.common.resp.APIConnectionException,
                                           cn.jiguang.common.resp.APIRequestException

Get all groups of a user

Parameters:

username - Necessary

Returns:

Group info list

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

deleteUser

public void deleteUser(java.lang.String username)
                throws cn.jiguang.common.resp.APIConnectionException,
                       cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

setNoDisturb

public cn.jiguang.common.resp.ResponseWrapper setNoDisturb(java.lang.String username,
                                                           NoDisturbPayload payload)
                                                    throws cn.jiguang.common.resp.APIConnectionException,
                                                           cn.jiguang.common.resp.APIRequestException

Set don't disturb service while receiving messages. You can Add or remove single conversation or group conversation

Parameters:

username - Necessary

payload - NoDisturbPayload

Returns:

No content

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

addFriends

public cn.jiguang.common.resp.ResponseWrapper addFriends(java.lang.String username,
                                                         java.lang.String... users)
                                                  throws cn.jiguang.common.resp.APIConnectionException,
                                                         cn.jiguang.common.resp.APIRequestException

Add friends to username

Parameters:

username - Necessary

users - username to be add

Returns:

No content

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

deleteFriends

public cn.jiguang.common.resp.ResponseWrapper deleteFriends(java.lang.String username,
                                                            java.lang.String... users)
                                                     throws cn.jiguang.common.resp.APIConnectionException,
                                                            cn.jiguang.common.resp.APIRequestException

Delete friends

Parameters:

username - Friends you want to delete to

users - username to be delete

Returns:

No content

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

updateFriendsNote

public cn.jiguang.common.resp.ResponseWrapper updateFriendsNote(java.lang.String username,
                                                                FriendNote[] array)
                                                         throws cn.jiguang.common.resp.APIConnectionException,
                                                                cn.jiguang.common.resp.APIRequestException

Update friends' note information. The size is limit to 500.

Parameters:

username - Necessary

array - FriendNote array

Returns:

No content

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

getFriendsInfo

public UserInfoResult[] getFriendsInfo(java.lang.String username)
                                throws cn.jiguang.common.resp.APIConnectionException,
                                       cn.jiguang.common.resp.APIRequestException

Get all friends'info from a gived username

Parameters:

username - Necessary

Returns:

UserList

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

setGroupShield

public cn.jiguang.common.resp.ResponseWrapper setGroupShield(GroupShieldPayload payload,
                                                             java.lang.String username)
                                                      throws cn.jiguang.common.resp.APIConnectionException,
                                                             cn.jiguang.common.resp.APIRequestException

Set user's group message blocking

Parameters:

payload - GroupShieldPayload

username - Necessary

Returns:

No content

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

forbidUser

public cn.jiguang.common.resp.ResponseWrapper forbidUser(java.lang.String username,
                                                         boolean disable)
                                                  throws cn.jiguang.common.resp.APIConnectionException,
                                                         cn.jiguang.common.resp.APIRequestException

Forbid or activate user

Parameters:

username - username

disable - true means forbid, false means activate

Returns:

No content

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

getGroupInfo

public GroupInfoResult getGroupInfo(long gid)
                             throws cn.jiguang.common.resp.APIConnectionException,
                                    cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

getGroupMembers

public MemberListResult getGroupMembers(long gid)
                                 throws cn.jiguang.common.resp.APIConnectionException,
                                        cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

getGroupListByAppkey

public GroupListResult getGroupListByAppkey(int start,
                                            int count)
                                     throws cn.jiguang.common.resp.APIConnectionException,
                                            cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

createGroup

public CreateGroupResult createGroup(java.lang.String owner,
                                     java.lang.String gname,
                                     java.lang.String desc,
                                     java.lang.String avatar,
                                     int flag,
                                     java.lang.String... userlist)
                              throws cn.jiguang.common.resp.APIConnectionException,
                                     cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

addOrRemoveMembers

public void addOrRemoveMembers(long gid,
                               java.lang.String[] addList,
                               java.lang.String[] removeList)
                        throws cn.jiguang.common.resp.APIConnectionException,
                               cn.jiguang.common.resp.APIRequestException

Add or remove members from a group

Parameters:

gid - The group id

addList - If this parameter is null then send remove request

removeList - If this parameter is null then send add request

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

deleteGroup

public void deleteGroup(long gid)
                 throws cn.jiguang.common.resp.APIConnectionException,
                        cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

updateGroupInfo

public void updateGroupInfo(long gid,
                            java.lang.String groupName,
                            java.lang.String groupDesc,
                            java.lang.String avatar)
                     throws cn.jiguang.common.resp.APIConnectionException,
                            cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

changeGroupAdmin

public void changeGroupAdmin(long gid,
                             java.lang.String appKey,
                             java.lang.String username)
                      throws cn.jiguang.common.resp.APIConnectionException,
                             cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

sendMessage

public SendMessageResult sendMessage(java.lang.Integer version,
                                     java.lang.String targetType,
                                     java.lang.String targetId,
                                     java.lang.String fromType,
                                     java.lang.String fromId,
                                     MessageType messageType,
                                     MessageBody messageBody)
                              throws cn.jiguang.common.resp.APIConnectionException,
                                     cn.jiguang.common.resp.APIRequestException

Send message

Parameters:

version - Current version is 1

targetType - Group or single

targetId - The message receiver

fromType - Only support admin now

fromId - Sender

messageType - MessageType: text, image or custom

messageBody - A MessageBodyResult instance

Returns:

return msg_id

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

sendMessage

public SendMessageResult sendMessage(MessagePayload payload)
                              throws cn.jiguang.common.resp.APIConnectionException,
                                     cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

sendSingleTextByAdmin

public SendMessageResult sendSingleTextByAdmin(java.lang.String targetId,
                                               java.lang.String fromId,
                                               MessageBody body)
                                        throws cn.jiguang.common.resp.APIConnectionException,
                                               cn.jiguang.common.resp.APIRequestException

Send single text message by admin

Parameters:

targetId - target user's id

fromId - sender's id

body - message body, include text and extra(if needed).

Returns:

return msg_id

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

sendGroupTextByAdmin

public SendMessageResult sendGroupTextByAdmin(java.lang.String targetId,
                                              java.lang.String fromId,
                                              MessageBody body)
                                       throws cn.jiguang.common.resp.APIConnectionException,
                                              cn.jiguang.common.resp.APIRequestException

Send group text message by admin

Parameters:

targetId - target user's id

fromId - sender's id

body - message body, include text and extra(if needed).

Returns:

return msg_id

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

getMessageList

public MessageListResult getMessageList(int count,
                                        java.lang.String begin_time,
                                        java.lang.String end_time)
                                 throws cn.jiguang.common.resp.APIConnectionException,
                                        cn.jiguang.common.resp.APIRequestException

Get message list from history, messages will store 60 days.

Parameters:

count - Necessary parameter. The count of the message list.

begin_time - Necessary parameter. The format must follow by 'yyyy-MM-dd HH:mm:ss'

end_time - Necessary parameter. The format must follow by 'yyyy-MM-dd HH:mm:ss'

Returns:

MessageListResult

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

getMessageListByCursor

public MessageListResult getMessageListByCursor(java.lang.String cursor)
                                         throws cn.jiguang.common.resp.APIConnectionException,
                                                cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

getUserMessages

public MessageListResult getUserMessages(java.lang.String username,
                                         int count,
                                         java.lang.String begin_time,
                                         java.lang.String end_time)
                                  throws cn.jiguang.common.resp.APIConnectionException,
                                         cn.jiguang.common.resp.APIRequestException

Get message list from user's record, messages will store 60 days.

Parameters:

username - Necessary parameter.

count - Necessary parameter. The count of the message list.

begin_time - Optional parameter. The format must follow by 'yyyy-MM-dd HH:mm:ss'

end_time - Optional parameter. The format must follow by 'yyyy-MM-dd HH:mm:ss'

Returns:

MessageListResult

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

getUserMessagesByCursor

public MessageListResult getUserMessagesByCursor(java.lang.String username,
                                                 java.lang.String cursor)
                                          throws cn.jiguang.common.resp.APIConnectionException,
                                                 cn.jiguang.common.resp.APIRequestException

Get user's message list with cursor, the cursor will effective in 120 seconds. And will return same count of messages as first request.

Parameters:

username - Necessary parameter.

cursor - First request will return cursor

Returns:

MessageListResult

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

retractMessage

public cn.jiguang.common.resp.ResponseWrapper retractMessage(java.lang.String username,
                                                             long msgId)
                                                      throws cn.jiguang.common.resp.APIConnectionException,
                                                             cn.jiguang.common.resp.APIRequestException

retract message 消息撤回

Parameters:

username - 用户名

msgId - message id

Returns:

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:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

downloadFile

public DownloadResult downloadFile(java.lang.String mediaId)
                            throws cn.jiguang.common.resp.APIConnectionException,
                                   cn.jiguang.common.resp.APIRequestException

Download file with mediaId, will return DownloadResult which include url.

Parameters:

mediaId - Necessary

Returns:

DownloadResult

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

uploadFile

public UploadResult uploadFile(java.lang.String path,
                               java.lang.String fileType)
                        throws cn.jiguang.common.resp.APIConnectionException,
                               cn.jiguang.common.resp.APIRequestException

Upload file, only support image file(jpg, bmp, gif, png) currently, file size should not larger than 8M.

Parameters:

path - Necessary, the native path of the file you want to upload

fileType - Current support type: image, file, voice

Returns:

UploadResult

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

addOrRemoveCrossGroupMember

public cn.jiguang.common.resp.ResponseWrapper addOrRemoveCrossGroupMember(long gid,
                                                                          CrossGroup[] groups)
                                                                   throws cn.jiguang.common.resp.APIConnectionException,
                                                                          cn.jiguang.common.resp.APIRequestException

Add or remove group members from a given group id.

Parameters:

gid - Necessary, target group id.

groups - Necessary

Returns:

No content

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

getCrossGroupMembers

public MemberListResult getCrossGroupMembers(long gid)
                                      throws cn.jiguang.common.resp.APIConnectionException,
                                             cn.jiguang.common.resp.APIRequestException

Get members' info from cross group

Parameters:

gid - Necessary, target group id

Returns:

Member info array

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

addCrossBlacklist

public cn.jiguang.common.resp.ResponseWrapper addCrossBlacklist(java.lang.String username,
                                                                CrossBlacklist[] blacklists)
                                                         throws cn.jiguang.common.resp.APIConnectionException,
                                                                cn.jiguang.common.resp.APIRequestException

Add blacklist whose users belong to another app to a given user.

Parameters:

username - The owner of the blacklist

blacklists - CrossBlacklist array

Returns:

No Content

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

deleteCrossBlacklist

public cn.jiguang.common.resp.ResponseWrapper deleteCrossBlacklist(java.lang.String username,
                                                                   CrossBlacklist[] blacklists)
                                                            throws cn.jiguang.common.resp.APIConnectionException,
                                                                   cn.jiguang.common.resp.APIRequestException

Delete blacklist whose users belong to another app from a given user.

Parameters:

username - The owner of the blacklist

blacklists - CrossBlacklist array

Returns:

No content

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

getCrossBlacklist

public UserInfoResult[] getCrossBlacklist(java.lang.String username)
                                   throws cn.jiguang.common.resp.APIConnectionException,
                                          cn.jiguang.common.resp.APIRequestException

Get all users' info(contains appkey) of user's cross app blacklist

Parameters:

username - Necessary, the owner of blacklist

Returns:

UserInfo array

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

setCrossNoDisturb

public cn.jiguang.common.resp.ResponseWrapper setCrossNoDisturb(java.lang.String username,
                                                                CrossNoDisturb[] array)
                                                         throws cn.jiguang.common.resp.APIConnectionException,
                                                                cn.jiguang.common.resp.APIRequestException

Set cross app no disturb https://docs.jiguang.cn/jmessage/server/rest_api_im/#api_1

Parameters:

username - Necessary

array - CrossNoDisturb array

Returns:

No content

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

addCrossFriends

public cn.jiguang.common.resp.ResponseWrapper addCrossFriends(java.lang.String username,
                                                              CrossFriendPayload payload)
                                                       throws cn.jiguang.common.resp.APIConnectionException,
                                                              cn.jiguang.common.resp.APIRequestException

Add users from cross app.

Parameters:

username - Necessary

payload - CrossFriendPayload

Returns:

No content

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

deleteCrossFriends

public cn.jiguang.common.resp.ResponseWrapper deleteCrossFriends(java.lang.String username,
                                                                 CrossFriendPayload payload)
                                                          throws cn.jiguang.common.resp.APIConnectionException,
                                                                 cn.jiguang.common.resp.APIRequestException

Delete cross app friends

Parameters:

username - Necessary

payload - CrossFriendPayload

Returns:

No content

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

addSensitiveWords

public cn.jiguang.common.resp.ResponseWrapper addSensitiveWords(java.lang.String... words)
                                                         throws cn.jiguang.common.resp.APIConnectionException,
                                                                cn.jiguang.common.resp.APIRequestException

Add sensitive words

Parameters:

words - String array

Returns:

No content

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

addSensitiveWords

public cn.jiguang.common.resp.ResponseWrapper addSensitiveWords(java.util.Set<java.lang.String> words)
                                                         throws cn.jiguang.common.resp.APIConnectionException,
                                                                cn.jiguang.common.resp.APIRequestException

Add sensitive words

Parameters:

words - String Set

Returns:

No content

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

updateSensitiveWord

public cn.jiguang.common.resp.ResponseWrapper updateSensitiveWord(java.lang.String newWord,
                                                                  java.lang.String oldWord)
                                                           throws cn.jiguang.common.resp.APIConnectionException,
                                                                  cn.jiguang.common.resp.APIRequestException

Update sensitive word

Parameters:

newWord - new word

oldWord - old word

Returns:

No content

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

deleteSensitiveWord

public cn.jiguang.common.resp.ResponseWrapper deleteSensitiveWord(java.lang.String word)
                                                           throws cn.jiguang.common.resp.APIConnectionException,
                                                                  cn.jiguang.common.resp.APIRequestException

Delete sensitive word

Parameters:

word - word to be deleted

Returns:

No content

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

getSensitiveWordList

public SensitiveWordListResult getSensitiveWordList(int start,
                                                    int count)
                                             throws cn.jiguang.common.resp.APIConnectionException,
                                                    cn.jiguang.common.resp.APIRequestException

Get sensitive word list

Parameters:

start - the begin of the list

count - the count of the list

Returns:

SensitiveWordListResult

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

updateSensitiveWordStatus

public cn.jiguang.common.resp.ResponseWrapper updateSensitiveWordStatus(int status)
                                                                 throws cn.jiguang.common.resp.APIConnectionException,
                                                                        cn.jiguang.common.resp.APIRequestException

Update sensitive word status

Parameters:

status - 1 represent turn on filtering, 0 represent turn off.

Returns:

No content

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

getSensitiveWordStatus

public SensitiveWordStatusResult getSensitiveWordStatus()
                                                 throws cn.jiguang.common.resp.APIConnectionException,
                                                        cn.jiguang.common.resp.APIRequestException

Get sensitive word status

Returns:

status of sensitive word

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

createChatRoom

public CreateChatRoomResult createChatRoom(ChatRoomPayload payload)
                                    throws cn.jiguang.common.resp.APIConnectionException,
                                           cn.jiguang.common.resp.APIRequestException

Create chat room

Parameters:

payload - ChatRoomPayload

Returns:

result contains room id

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

getBatchChatRoomInfo

public ChatRoomListResult getBatchChatRoomInfo(long... roomIds)
                                        throws cn.jiguang.common.resp.APIConnectionException,
                                               cn.jiguang.common.resp.APIRequestException

Get chat room information by room ids

Parameters:

roomIds - Array of room id

Returns:

ChatRoomListResult

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

getUserChatRoomInfo

public ChatRoomListResult getUserChatRoomInfo(java.lang.String username)
                                       throws cn.jiguang.common.resp.APIConnectionException,
                                              cn.jiguang.common.resp.APIRequestException

Get user's whole chat room information

Parameters:

username - required

Returns:

ChatRoomListResult

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

getAppChatRoomInfo

public ChatRoomListResult getAppChatRoomInfo(int start,
                                             int count)
                                      throws cn.jiguang.common.resp.APIConnectionException,
                                             cn.jiguang.common.resp.APIRequestException

Get application's chat room list

Parameters:

start - start index

count - list count

Returns:

ChatRoomListResult

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

updateChatRoomInfo

public cn.jiguang.common.resp.ResponseWrapper updateChatRoomInfo(long roomId,
                                                                 java.lang.String ownerUsername,
                                                                 java.lang.String name,
                                                                 java.lang.String desc)
                                                          throws cn.jiguang.common.resp.APIConnectionException,
                                                                 cn.jiguang.common.resp.APIRequestException

Update chat room info

Parameters:

roomId - room id

ownerUsername - owner username

name - new chat room name

desc - chat room description

Returns:

No content

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

deleteChatRoom

public cn.jiguang.common.resp.ResponseWrapper deleteChatRoom(long roomId)
                                                      throws cn.jiguang.common.resp.APIConnectionException,
                                                             cn.jiguang.common.resp.APIRequestException

Delete chat room by id

Parameters:

roomId - room id

Returns:

No content

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

updateUserSpeakStatus

public cn.jiguang.common.resp.ResponseWrapper updateUserSpeakStatus(long roomId,
                                                                    java.lang.String username,
                                                                    int flag)
                                                             throws cn.jiguang.common.resp.APIConnectionException,
                                                                    cn.jiguang.common.resp.APIRequestException

Update user speak status

Parameters:

roomId - chat room id

username - user to be modified

flag - 0 means allow to speak, 1 means forbid to speak in chat room

Returns:

No content

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

getChatRoomMembers

public ChatRoomMemberList getChatRoomMembers(long roomId,
                                             int start,
                                             int count)
                                      throws cn.jiguang.common.resp.APIConnectionException,
                                             cn.jiguang.common.resp.APIRequestException

Get all member info of chat room

Parameters:

roomId - chat room id

start - start index

count - member count

Returns:

ChatRoomMemberList

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

addChatRoomMember

public cn.jiguang.common.resp.ResponseWrapper addChatRoomMember(long roomId,
                                                                java.lang.String... members)
                                                         throws cn.jiguang.common.resp.APIConnectionException,
                                                                cn.jiguang.common.resp.APIRequestException

Add members to chat room

Parameters:

roomId - chat room id

members - username array

Returns:

No content

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

addChatRoomMember

public cn.jiguang.common.resp.ResponseWrapper addChatRoomMember(long roomId,
                                                                Members members)
                                                         throws cn.jiguang.common.resp.APIConnectionException,
                                                                cn.jiguang.common.resp.APIRequestException

Add members to chat room

Parameters:

roomId - chat room id

members - Members

Returns:

No content

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

removeChatRoomMembers

public cn.jiguang.common.resp.ResponseWrapper removeChatRoomMembers(long roomId,
                                                                    java.lang.String... members)
                                                             throws cn.jiguang.common.resp.APIConnectionException,
                                                                    cn.jiguang.common.resp.APIRequestException

remove members from chat room

Parameters:

roomId - chat room id

members - username array

Returns:

No content

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

removeChatRoomMembers

public cn.jiguang.common.resp.ResponseWrapper removeChatRoomMembers(long roomId,
                                                                    Members members)
                                                             throws cn.jiguang.common.resp.APIConnectionException,
                                                                    cn.jiguang.common.resp.APIRequestException

remove members from chat room

Parameters:

roomId - chat room id

members - Members

Returns:

No content

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

v2GetMessageList

public MessageListResult v2GetMessageList(int count,
                                          java.lang.String begin_time,
                                          java.lang.String end_time)
                                   throws cn.jiguang.common.resp.APIConnectionException,
                                          cn.jiguang.common.resp.APIRequestException

Get message list from history, messages will store 60 days.

Parameters:

count - Necessary parameter. The count of the message list.

begin_time - Necessary parameter. The format must follow by 'yyyy-MM-dd HH:mm:ss'

end_time - Necessary parameter. The format must follow by 'yyyy-MM-dd HH:mm:ss'

Returns:

MessageListResult

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

v2GetMessageListByCursor

public MessageListResult v2GetMessageListByCursor(java.lang.String cursor)
                                           throws cn.jiguang.common.resp.APIConnectionException,
                                                  cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

v2GetUserMessages

public MessageListResult v2GetUserMessages(java.lang.String username,
                                           int count,
                                           java.lang.String begin_time,
                                           java.lang.String end_time)
                                    throws cn.jiguang.common.resp.APIConnectionException,
                                           cn.jiguang.common.resp.APIRequestException

Get message list from user's record, messages will store 60 days.

Parameters:

username - Necessary parameter.

count - Necessary parameter. The count of the message list.

begin_time - Optional parameter. The format must follow by 'yyyy-MM-dd HH:mm:ss'

end_time - Optional parameter. The format must follow by 'yyyy-MM-dd HH:mm:ss'

Returns:

MessageListResult

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

v2GetUserMessagesByCursor

public MessageListResult v2GetUserMessagesByCursor(java.lang.String username,
                                                   java.lang.String cursor)
                                            throws cn.jiguang.common.resp.APIConnectionException,
                                                   cn.jiguang.common.resp.APIRequestException

Get user's message list with cursor, the cursor will effective in 120 seconds. And will return same count of messages as first request.

Parameters:

username - Necessary parameter.

cursor - First request will return cursor

Returns:

MessageListResult

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

getUserStatistic

public UserStatListResult getUserStatistic(java.lang.String startTime,
                                           int duration)
                                    throws cn.jiguang.common.resp.APIConnectionException,
                                           cn.jiguang.common.resp.APIRequestException

Get user statistic, now time unit only supports DAY

Parameters:

startTime - start time, format: yyyy-MM-dd

duration - 0-60

Returns:

UserStatListResult

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

getMessageStatistic

public MessageStatListResult getMessageStatistic(java.lang.String timeUnit,
                                                 java.lang.String start,
                                                 int duration)
                                          throws cn.jiguang.common.resp.APIConnectionException,
                                                 cn.jiguang.common.resp.APIRequestException

Get message statistic. Detail instructions please refer to https://docs.jiguang.cn/jmessage/server/rest_api_im_report_v2/#_6

Parameters:

timeUnit - MUST be one of HOUR, DAY, MONTH

start - start time, when timeUnit is HOUR, format: yyyy-MM-dd HH,

duration - depends on timeUnit, the duration has limit

Returns:

MessageStatListResult

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

getGroupStatistic

public GroupStatListResult getGroupStatistic(java.lang.String start,
                                             int duration)
                                      throws cn.jiguang.common.resp.APIConnectionException,
                                             cn.jiguang.common.resp.APIRequestException

Get group statistic, time unit only supports DAY now.

Parameters:

start - Format: yyyy-MM-dd

duration - duration must between 0 and 60

Returns:

GroupStatListResult

Throws:

cn.jiguang.common.resp.APIConnectionException - connect exception

cn.jiguang.common.resp.APIRequestException - request exception

setHttpClient

public void setHttpClient(cn.jiguang.common.connection.IHttpClient httpClient)