cn.jmessage.api

类 JMessageClient

java.lang.Object

cn.jmessage.api.JMessageClient

public class JMessageClient
extends Object

构造器概要

构造器

构造器和说明
JMessageClient(String appkey, String masterSecret) Create a JMessage Client.
JMessageClient(String appkey, String masterSecret, cn.jiguang.common.connection.HttpProxy proxy) Create a JMessage Client with a proxy.
JMessageClient(String appkey, String masterSecret, cn.jiguang.common.connection.HttpProxy proxy, JMessageConfig config) Create a JMessage Client by custom Client configuration.
JMessageClient(String appkey, String masterSecret, int maxRetryTimes) Create a JMessage Client with custom maxRetryTimes.
JMessageClient(String appkey, String masterSecret, String hostname) Create a JMessage Client with a custom hostname.

方法概要

限定符和类型	方法和说明
cn.jiguang.common.resp.ResponseWrapper	addBlackList(String username, String... users) Add Users to black list
cn.jiguang.common.resp.ResponseWrapper	addCrossBlacklist(String username, CrossBlacklist[] blacklists) Add blacklist whose users belong to another app to a given user.
cn.jiguang.common.resp.ResponseWrapper	addFriends(String username, 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, String[] addList, String[] removeList) Add or remove members from a group
CreateGroupResult	createGroup(String owner, String gname, String desc, String... userlist)
cn.jiguang.common.resp.ResponseWrapper	deleteCrossBlacklist(String username, CrossBlacklist[] blacklists) Delete blacklist whose users belong to another app from a given user.
cn.jiguang.common.resp.ResponseWrapper	deleteFriends(String username, String... users) Delete friends
void	deleteGroup(long gid)
void	deleteUser(String username)
DownloadResult	downloadFile(String mediaId) Download file with mediaId, will return DownloadResult which include url.
UserListResult	getAdminListByAppkey(int start, int count) Get admins by appkey
UserInfoResult[]	getBlackList(String username) Get a user's all black list
UserInfoResult[]	getCrossBlacklist(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(String username) Get all friends'info from a gived username
GroupInfoResult	getGroupInfo(long gid)
GroupListResult	getGroupListByAppkey(int start, int count)
UserGroupsResult	getGroupListByUser(String username) Get all groups of a user
MemberListResult	getGroupMembers(long gid)
MessageListResult	getMessageList(int count, String begin_time, String end_time) Get message list from history, messages will store 60 days.
MessageListResult	getMessageListByCursor(String cursor)
UserInfoResult	getUserInfo(String username)
UserListResult	getUserList(int start, int count) Get user list
MessageListResult	getUserMessages(String username, int count, String begin_time, String end_time) Get message list from user's record, messages will store 60 days.
MessageListResult	getUserMessagesByCursor(String username, String cursor) Get user's message list with cursor, the cursor will effective in 120 seconds.
UserStateResult	getUserState(String username)
String	registerAdmins(String username, String password)
String	registerUsers(RegisterInfo[] users)
cn.jiguang.common.resp.ResponseWrapper	removeBlacklist(String username, String... users)
SendMessageResult	sendGroupTextByAdmin(String targetId, String fromId, MessageBody body) Send group text message by admin
SendMessageResult	sendMessage(Integer version, String targetType, String targetId, String fromType, String fromId, MessageType messageType, MessageBody messageBody) Send message
SendMessageResult	sendMessage(MessagePayload payload)
SendMessageResult	sendSingleTextByAdmin(String targetId, String fromId, MessageBody body) Send single text message by admin
cn.jiguang.common.resp.ResponseWrapper	setCrossNoDisturb(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	setNoDisturb(String username, NoDisturbPayload payload) Set don't disturb service while receiving messages.
cn.jiguang.common.resp.ResponseWrapper	updateFriendsNote(String username, FriendNote[] array) Update friends' note information.
void	updateGroupInfo(long gid, String groupName, String groupDesc)
void	updateUserInfo(String username, String nickname, String birthday, String signature, int gender, String region, String address)
void	updateUserPassword(String username, String password)
UploadResult	uploadFile(String path) Upload file, only support image file(jpg, bmp, gif, png) currently, file size should not larger than 8M.

从类继承的方法 java.lang.Object

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

构造器详细资料

JMessageClient

public JMessageClient(String appkey,
                      String masterSecret)

Create a JMessage Client.

参数:

appkey - The KEY of one application on JPush.

masterSecret - API access secret of the appKey.

JMessageClient

public JMessageClient(String appkey,
                      String masterSecret,
                      int maxRetryTimes)

Create a JMessage Client with custom maxRetryTimes.

参数:

appkey - The KEY of one application on JPush.

masterSecret - API access secret of the appKey.

maxRetryTimes - The max retry times.

JMessageClient

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

Create a JMessage Client with a proxy.

参数:

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(String appkey,
                      String masterSecret,
                      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.

参数:

appkey - The KEY of one application on JPush.

masterSecret - API access secret of the appKey.

hostname - The custom hostname.

JMessageClient

public JMessageClient(String appkey,
                      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.

参数:

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.

方法详细资料

registerUsers

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

抛出:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

registerAdmins

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

抛出:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

getUserInfo

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

抛出:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

getUserState

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

抛出:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

updateUserPassword

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

抛出:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

updateUserInfo

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

抛出:

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

参数:

start - The start index of the list

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

返回:

User info list

抛出:

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

参数:

start - The start index of the list

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

返回:

admin user info list

抛出:

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

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

getBlackList

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

Get a user's all black list

参数:

username - The owner of the black list

返回:

user info list

抛出:

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

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

addBlackList

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

Add Users to black list

参数:

username - The owner of the black list

users - The users that will add to black list

返回:

add users to black list

抛出:

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

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

removeBlacklist

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

抛出:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

getGroupListByUser

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

Get all groups of a user

参数:

username - Necessary

返回:

Group info list

抛出:

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

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

deleteUser

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

抛出:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

getGroupInfo

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

抛出:

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

抛出:

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

抛出:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

createGroup

public CreateGroupResult createGroup(String owner,
                                     String gname,
                                     String desc,
                                     String... userlist)
                              throws cn.jiguang.common.resp.APIConnectionException,
                                     cn.jiguang.common.resp.APIRequestException

抛出:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

addOrRemoveMembers

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

Add or remove members from a group

参数:

gid - The group id

addList - If this parameter is null then send remove request

removeList - If this parameter is null then send add request

抛出:

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

抛出:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

updateGroupInfo

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

抛出:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

sendMessage

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

Send message

参数:

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

返回:

return msg_id

抛出:

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

抛出:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

downloadFile

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

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

参数:

mediaId - Necessary

返回:

DownloadResult

抛出:

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

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

uploadFile

public UploadResult uploadFile(String path)
                        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.

参数:

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

返回:

UploadResult

抛出:

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

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

sendSingleTextByAdmin

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

Send single text message by admin

参数:

targetId - target user's id

fromId - sender's id

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

返回:

return msg_id

抛出:

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

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

sendGroupTextByAdmin

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

Send group text message by admin

参数:

targetId - target user's id

fromId - sender's id

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

返回:

return msg_id

抛出:

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

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

getMessageList

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

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

参数:

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'

返回:

MessageListResult

抛出:

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

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

getMessageListByCursor

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

抛出:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

getUserMessages

public MessageListResult getUserMessages(String username,
                                         int count,
                                         String begin_time,
                                         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.

参数:

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'

返回:

MessageListResult

抛出:

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

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

getUserMessagesByCursor

public MessageListResult getUserMessagesByCursor(String username,
                                                 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.

参数:

username - Necessary parameter.

cursor - First request will return cursor

返回:

MessageListResult

抛出:

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

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

setNoDisturb

public cn.jiguang.common.resp.ResponseWrapper setNoDisturb(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

参数:

username - Necessary

payload - NoDisturbPayload

返回:

No content

抛出:

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

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

addFriends

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

Add friends to username

参数:

username - Necessary

users - username to be add

返回:

No content

抛出:

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

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

deleteFriends

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

Delete friends

参数:

username - Friends you want to delete to

users - username to be delete

返回:

No content

抛出:

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

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

updateFriendsNote

public cn.jiguang.common.resp.ResponseWrapper updateFriendsNote(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.

参数:

username - Necessary

array - FriendNote array

返回:

No content

抛出:

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

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

getFriendsInfo

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

Get all friends'info from a gived username

参数:

username - Necessary

返回:

UserList

抛出:

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.

参数:

gid - Necessary, target group id.

groups - Necessary

返回:

No content

抛出:

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

参数:

gid - Necessary, target group id

返回:

Member info array

抛出:

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

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

addCrossBlacklist

public cn.jiguang.common.resp.ResponseWrapper addCrossBlacklist(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.

参数:

username - The owner of the blacklist

blacklists - CrossBlacklist array

返回:

No Content

抛出:

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

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

deleteCrossBlacklist

public cn.jiguang.common.resp.ResponseWrapper deleteCrossBlacklist(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.

参数:

username - The owner of the blacklist

blacklists - CrossBlacklist array

返回:

No content

抛出:

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

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

getCrossBlacklist

public UserInfoResult[] getCrossBlacklist(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

参数:

username - Necessary, the owner of blacklist

返回:

UserInfo array

抛出:

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

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

setCrossNoDisturb

public cn.jiguang.common.resp.ResponseWrapper setCrossNoDisturb(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

参数:

username - Necessary

array - CrossNoDisturb array

返回:

No content

抛出:

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

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