cn.jmessage.api.crossapp

类 CrossAppClient

java.lang.Object

cn.jmessage.api.common.BaseClient

cn.jmessage.api.crossapp.CrossAppClient

public class CrossAppClient
extends BaseClient

字段概要

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

_baseUrl, _gson, _httpClient

构造器概要

构造器

构造器和说明
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

方法概要

限定符和类型	方法和说明
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

从类继承的方法 cn.jmessage.api.common.BaseClient

setHttpClient

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

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

构造器详细资料

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

参数:

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.

方法详细资料

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.

参数:

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(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.

参数:

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(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.

参数:

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(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

参数:

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(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

参数:

username - Necessary

array - CrossNoDisturb array

返回:

No content

抛出:

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.

参数:

username - Necessary

payload - CrossFriendPayload

返回:

No content

抛出:

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

参数:

username - Necessary

payload - CrossFriendPayload

返回:

No content

抛出:

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

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