cn.jmessage.api.crossapp

Class CrossAppClient

java.lang.Object

cn.jmessage.api.common.BaseClient

cn.jmessage.api.crossapp.CrossAppClient

public class CrossAppClient
extends BaseClient

Field Summary

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

_baseUrl, _gson, _httpClient

Constructor Summary

Constructors

Constructor and Description
CrossAppClient(java.lang.String appkey, java.lang.String masterSecret)
CrossAppClient(java.lang.String appKey, java.lang.String masterSecret, cn.jiguang.common.connection.HttpProxy proxy)
CrossAppClient(java.lang.String appKey, java.lang.String masterSecret, cn.jiguang.common.connection.HttpProxy proxy, JMessageConfig config) Create a JMessage Base Client

Method Summary

Modifier and Type	Method and Description
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	addOrRemoveCrossGroupMembers(long gid, CrossGroup[] groups) Add or remove group members from a given group 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
UserInfoResult[]	getCrossBlacklist(java.lang.String username) Get all user's info(contains appkey) of user's cross app blacklist
MemberListResult	getCrossGroupMembers(long gid) Get members' info from cross group
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

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

CrossAppClient

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

CrossAppClient

public CrossAppClient(java.lang.String appKey,
                      java.lang.String masterSecret,
                      cn.jiguang.common.connection.HttpProxy proxy)

CrossAppClient

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

Create a JMessage Base Client

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

addOrRemoveCrossGroupMembers

public cn.jiguang.common.resp.ResponseWrapper addOrRemoveCrossGroupMembers(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 user's 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