cn.jmessage.api.group

Class GroupClient

java.lang.Object

cn.jmessage.api.common.BaseClient

cn.jmessage.api.group.GroupClient

public class GroupClient
extends BaseClient

Field Summary

Fields inherited from class cn.jmessage.api.common.BaseClient

_baseUrl, _gson, _httpClient

Constructor Summary

Constructors

Constructor and Description
GroupClient(java.lang.String appkey, java.lang.String masterSecret) Create a Group Client with default parameters.
GroupClient(java.lang.String appkey, java.lang.String masterSecret, cn.jiguang.common.connection.HttpProxy proxy) Create a Group Client with a proxy.
GroupClient(java.lang.String appkey, java.lang.String masterSecret, cn.jiguang.common.connection.HttpProxy proxy, JMessageConfig config) Create a Group Client by custom config.

Method Summary

Methods

Modifier and Type	Method and Description
cn.jiguang.common.resp.ResponseWrapper	addOrRemoveMembers(long gid, Members add, Members remove)
cn.jiguang.common.resp.ResponseWrapper	changeGroupAdmin(long gid, java.lang.String appKey, java.lang.String username)
CreateGroupResult	createGroup(GroupPayload payload)
cn.jiguang.common.resp.ResponseWrapper	deleteGroup(long gid)
GroupInfoResult	getGroupInfo(long gid)
GroupListResult	getGroupListByAppkey(int start, int count)
MemberListResult	getGroupMembers(long gid)
cn.jiguang.common.resp.ResponseWrapper	updateGroupInfo(long gid, java.lang.String groupName, java.lang.String groupDesc, java.lang.String avatar)

Methods inherited from class cn.jmessage.api.common.BaseClient

setHttpClient

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupClient

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

Create a Group Client with default parameters.

Parameters:

appkey - The key of one application on JPush.

masterSecret - API access secret of the appKey.

GroupClient

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

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

GroupClient

public GroupClient(java.lang.String appkey,
           java.lang.String masterSecret,
           cn.jiguang.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.

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

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(GroupPayload payload)
                              throws cn.jiguang.common.resp.APIConnectionException,
                                     cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

addOrRemoveMembers

public cn.jiguang.common.resp.ResponseWrapper addOrRemoveMembers(long gid,
                                                        Members add,
                                                        Members remove)
                                                          throws cn.jiguang.common.resp.APIConnectionException,
                                                                 cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

deleteGroup

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