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.jpush.api.common.connection.HttpProxy proxy) Create a JMessage Client with a proxy.
JMessageClient(String appkey, String masterSecret, cn.jpush.api.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.

方法概要

方法

限定符和类型	方法和说明
void	addOrRemoveMembers(long gid, String[] addList, String[] removeList)
CreateGroupResult	createGroup(String owner, String gname, String desc, String... userlist)
void	deleteGroup(long gid)
void	deleteUser(String username)
GroupInfoResult	getGroupInfo(long gid)
GroupListResult	getGroupListByAppkey(int start, int count)
UserGroupsResult	getGroupListByUser(String username)
MemberListResult	getGroupMembers(long gid)
UserInfoResult	getUserInfo(String username)
UserListResult	getUserList(int start, int count)
String	registerAdmins(String username, String password)
String	registerUsers(RegisterInfo[] users)
SendMessageResult	sendGroupTextByAdmin(String targetId, String fromId, MessageBody body)
SendMessageResult	sendMessage(Integer version, String targetType, String targetId, String fromType, String fromId, String messageType, MessageBody messageBody)
SendMessageResult	sendSingleTextByAdmin(String targetId, String fromId, MessageBody body)
void	updateGroupInfo(long gid, String groupName, String groupDesc)
void	updateUserInfo(String username, String nickname, String birthday, String signature, int gender, String region, String address, String avatar)
void	updateUserPassword(String username, String password)

从类继承的方法 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.jpush.api.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.jpush.api.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.jpush.api.common.resp.APIConnectionException,
                            cn.jpush.api.common.resp.APIRequestException

抛出:

cn.jpush.api.common.resp.APIConnectionException

cn.jpush.api.common.resp.APIRequestException

registerAdmins

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

抛出:

cn.jpush.api.common.resp.APIConnectionException

cn.jpush.api.common.resp.APIRequestException

getUserInfo

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

抛出:

cn.jpush.api.common.resp.APIConnectionException

cn.jpush.api.common.resp.APIRequestException

updateUserPassword

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

抛出:

cn.jpush.api.common.resp.APIConnectionException

cn.jpush.api.common.resp.APIRequestException

updateUserInfo

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

抛出:

cn.jpush.api.common.resp.APIConnectionException

cn.jpush.api.common.resp.APIRequestException

getUserList

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

抛出:

cn.jpush.api.common.resp.APIConnectionException

cn.jpush.api.common.resp.APIRequestException

getGroupListByUser

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

抛出:

cn.jpush.api.common.resp.APIConnectionException

cn.jpush.api.common.resp.APIRequestException

deleteUser

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

抛出:

cn.jpush.api.common.resp.APIConnectionException

cn.jpush.api.common.resp.APIRequestException

getGroupInfo

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

抛出:

cn.jpush.api.common.resp.APIConnectionException

cn.jpush.api.common.resp.APIRequestException

getGroupMembers

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

抛出:

cn.jpush.api.common.resp.APIConnectionException

cn.jpush.api.common.resp.APIRequestException

getGroupListByAppkey

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

抛出:

cn.jpush.api.common.resp.APIConnectionException

cn.jpush.api.common.resp.APIRequestException

createGroup

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

抛出:

cn.jpush.api.common.resp.APIConnectionException

cn.jpush.api.common.resp.APIRequestException

addOrRemoveMembers

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

抛出:

cn.jpush.api.common.resp.APIConnectionException

cn.jpush.api.common.resp.APIRequestException

deleteGroup

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

抛出:

cn.jpush.api.common.resp.APIConnectionException

cn.jpush.api.common.resp.APIRequestException

updateGroupInfo

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

抛出:

cn.jpush.api.common.resp.APIConnectionException

cn.jpush.api.common.resp.APIRequestException

sendMessage

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

抛出:

cn.jpush.api.common.resp.APIConnectionException

cn.jpush.api.common.resp.APIRequestException

sendSingleTextByAdmin

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

抛出:

cn.jpush.api.common.resp.APIConnectionException

cn.jpush.api.common.resp.APIRequestException

sendGroupTextByAdmin

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

抛出:

cn.jpush.api.common.resp.APIConnectionException

cn.jpush.api.common.resp.APIRequestException