cn.jmessage.api.group

类 GroupClient

java.lang.Object

cn.jmessage.api.common.BaseClient

cn.jmessage.api.group.GroupClient

public class GroupClient
extends BaseClient

字段概要

从类继承的字段 cn.jmessage.api.common.BaseClient

_baseUrl, _httpClient

构造器概要

构造器

构造器和说明
GroupClient(String appkey, String masterSecret) Create a Group Client with default parameters.
GroupClient(String appkey, String masterSecret, cn.jpush.api.common.connection.HttpProxy proxy) Create a Group Client with a proxy.
GroupClient(String appkey, String masterSecret, cn.jpush.api.common.connection.HttpProxy proxy, JMessageConfig config) Create a Group Client by custom config.

方法概要

方法

限定符和类型	方法和说明
cn.jpush.api.common.resp.ResponseWrapper	addOrRemoveMembers(long gid, Members add, Members remove)
CreateGroupResult	createGroup(GroupPayload payload)
cn.jpush.api.common.resp.ResponseWrapper	deleteGroup(long gid)
GroupInfoResult	getGroupInfo(long gid)
GroupListResult	getGroupListByAppkey(int start, int count)
MemberListResult	getGroupMembers(long gid)
cn.jpush.api.common.resp.ResponseWrapper	updateGroupInfo(long gid, String groupName, String groupDesc)

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

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

构造器详细资料

GroupClient

public GroupClient(String appkey,
           String masterSecret)

Create a Group Client with default parameters.

参数:

appkey - The key of one application on JPush.

masterSecret - API access secret of the appKey.

GroupClient

public GroupClient(String appkey,
           String masterSecret,
           cn.jpush.api.common.connection.HttpProxy proxy)

Create a Group 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.

GroupClient

public GroupClient(String appkey,
           String masterSecret,
           cn.jpush.api.common.connection.HttpProxy proxy,
           JMessageConfig config)

Create a Group Client by custom config. If you are using JMessage privacy cloud or 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.

方法详细资料

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(GroupPayload payload)
                              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 cn.jpush.api.common.resp.ResponseWrapper addOrRemoveMembers(long gid,
                                                          Members add,
                                                          Members remove)
                                                            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 cn.jpush.api.common.resp.ResponseWrapper 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 cn.jpush.api.common.resp.ResponseWrapper 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