cn.jmessage.api.user

Class UserClient

java.lang.Object

cn.jmessage.api.common.BaseClient

cn.jmessage.api.user.UserClient

public class UserClient
extends BaseClient

Field Summary

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

_baseUrl, _gson, _httpClient

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
cn.jiguang.common.resp.ResponseWrapper	addBlackList(java.lang.String username, java.lang.String... users) Add Users to black list
cn.jiguang.common.resp.ResponseWrapper	addFriends(java.lang.String username, java.lang.String... users) Add friends to username
cn.jiguang.common.resp.ResponseWrapper	deleteFriends(java.lang.String username, java.lang.String... users) Delete friends
cn.jiguang.common.resp.ResponseWrapper	deleteUser(java.lang.String username)
cn.jiguang.common.resp.ResponseWrapper	forbidUser(java.lang.String username, boolean disable) Forbid or activate user
UserListResult	getAdminListByAppkey(int start, int count) Get admins by appkey
UserInfoResult[]	getBlackList(java.lang.String username) Get a user's all black list
UserInfoResult[]	getFriendsInfo(java.lang.String username) Get friends'info from user
UserGroupsResult	getGroupList(java.lang.String username) Get all groups of a user
UserInfoResult	getUserInfo(java.lang.String username)
UserListResult	getUserList(int start, int count) Get user list
UserStateListResult[]	getUsersState(java.lang.String... users) Get users' state
UserStateResult	getUserState(java.lang.String username) Get user state
cn.jiguang.common.resp.ResponseWrapper	registerAdmins(RegisterInfo payload)
cn.jiguang.common.resp.ResponseWrapper	registerUsers(RegisterPayload payload)
cn.jiguang.common.resp.ResponseWrapper	removeBlackList(java.lang.String username, java.lang.String... users)
cn.jiguang.common.resp.ResponseWrapper	setGroupShield(GroupShieldPayload payload, java.lang.String username) Set user's group message blocking
cn.jiguang.common.resp.ResponseWrapper	setNoDisturb(java.lang.String username, NoDisturbPayload payload) Set don't disturb service while receiving messages.
cn.jiguang.common.resp.ResponseWrapper	updateFriendsNote(java.lang.String username, FriendNote[] array) Update friends' note information.
cn.jiguang.common.resp.ResponseWrapper	updatePassword(java.lang.String username, java.lang.String password)
cn.jiguang.common.resp.ResponseWrapper	updateUserInfo(java.lang.String username, UserPayload payload)

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

UserClient

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

Create a User Client with default parameters.

Parameters:

appkey - The key of one application on JPush.

masterSecret - API access secret of the appKey.

UserClient

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

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

UserClient

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

Create a User Client with 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

registerUsers

public cn.jiguang.common.resp.ResponseWrapper registerUsers(RegisterPayload payload)
                                                     throws cn.jiguang.common.resp.APIConnectionException,
                                                            cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

registerAdmins

public cn.jiguang.common.resp.ResponseWrapper registerAdmins(RegisterInfo payload)
                                                      throws cn.jiguang.common.resp.APIConnectionException,
                                                             cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

getUserInfo

public UserInfoResult getUserInfo(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

updateUserInfo

public cn.jiguang.common.resp.ResponseWrapper updateUserInfo(java.lang.String username,
                                                    UserPayload payload)
                                                      throws cn.jiguang.common.resp.APIConnectionException,
                                                             cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

getUserState

public UserStateResult getUserState(java.lang.String username)
                             throws cn.jiguang.common.resp.APIConnectionException,
                                    cn.jiguang.common.resp.APIRequestException

Get user state

Parameters:

username - Necessary

Returns:

user state info, include login and online message.

Throws:

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

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

getUsersState

public UserStateListResult[] getUsersState(java.lang.String... users)
                                    throws cn.jiguang.common.resp.APIConnectionException,
                                           cn.jiguang.common.resp.APIRequestException

Get users' state

Parameters:

users - username of users

Returns:

UserStateListResult

Throws:

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

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

updatePassword

public cn.jiguang.common.resp.ResponseWrapper updatePassword(java.lang.String username,
                                                    java.lang.String password)
                                                      throws cn.jiguang.common.resp.APIConnectionException,
                                                             cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

deleteUser

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

getBlackList

public UserInfoResult[] getBlackList(java.lang.String username)
                              throws cn.jiguang.common.resp.APIConnectionException,
                                     cn.jiguang.common.resp.APIRequestException

Get a user's all black list

Parameters:

username - The owner of the black list

Returns:

UserList

Throws:

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

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

addBlackList

public cn.jiguang.common.resp.ResponseWrapper addBlackList(java.lang.String username,
                                                  java.lang.String... users)
                                                    throws cn.jiguang.common.resp.APIConnectionException,
                                                           cn.jiguang.common.resp.APIRequestException

Add Users to black list

Parameters:

username - The owner of the black list

users - The users that will add to black list

Returns:

add users to black list

Throws:

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

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

removeBlackList

public cn.jiguang.common.resp.ResponseWrapper removeBlackList(java.lang.String username,
                                                     java.lang.String... users)
                                                       throws cn.jiguang.common.resp.APIConnectionException,
                                                              cn.jiguang.common.resp.APIRequestException

Throws:

cn.jiguang.common.resp.APIConnectionException

cn.jiguang.common.resp.APIRequestException

getUserList

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

Get user list

Parameters:

start - The start index of the list

count - The number that how many you want to get from list

Returns:

User info list

Throws:

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

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

getAdminListByAppkey

public UserListResult getAdminListByAppkey(int start,
                                  int count)
                                    throws cn.jiguang.common.resp.APIConnectionException,
                                           cn.jiguang.common.resp.APIRequestException

Get admins by appkey

Parameters:

start - The start index of the list

count - The number that how many you want to get from list

Returns:

admin user info list

Throws:

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

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

setNoDisturb

public cn.jiguang.common.resp.ResponseWrapper setNoDisturb(java.lang.String username,
                                                  NoDisturbPayload payload)
                                                    throws cn.jiguang.common.resp.APIConnectionException,
                                                           cn.jiguang.common.resp.APIRequestException

Set don't disturb service while receiving messages. You can Add or remove single conversation or group conversation

Parameters:

username - Necessary

payload - NoDisturbPayload

Returns:

No content

Throws:

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

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

getGroupList

public UserGroupsResult getGroupList(java.lang.String username)
                              throws cn.jiguang.common.resp.APIConnectionException,
                                     cn.jiguang.common.resp.APIRequestException

Get all groups of a user

Parameters:

username - Necessary

Returns:

Group info list

Throws:

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

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

addFriends

public cn.jiguang.common.resp.ResponseWrapper addFriends(java.lang.String username,
                                                java.lang.String... users)
                                                  throws cn.jiguang.common.resp.APIConnectionException,
                                                         cn.jiguang.common.resp.APIRequestException

Add friends to username

Parameters:

username - Necessary

users - username to be add

Returns:

No content

Throws:

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

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

deleteFriends

public cn.jiguang.common.resp.ResponseWrapper deleteFriends(java.lang.String username,
                                                   java.lang.String... users)
                                                     throws cn.jiguang.common.resp.APIConnectionException,
                                                            cn.jiguang.common.resp.APIRequestException

Delete friends

Parameters:

username - Friends you want to delete to

users - username to be delete

Returns:

No content

Throws:

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

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

updateFriendsNote

public cn.jiguang.common.resp.ResponseWrapper updateFriendsNote(java.lang.String username,
                                                       FriendNote[] array)
                                                         throws cn.jiguang.common.resp.APIConnectionException,
                                                                cn.jiguang.common.resp.APIRequestException

Update friends' note information. The size is limit to 500.

Parameters:

username - Necessary

array - FriendNote array

Returns:

No content

Throws:

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

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

getFriendsInfo

public UserInfoResult[] getFriendsInfo(java.lang.String username)
                                throws cn.jiguang.common.resp.APIConnectionException,
                                       cn.jiguang.common.resp.APIRequestException

Get friends'info from user

Parameters:

username - Necessary

Returns:

UserList

Throws:

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

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

setGroupShield

public cn.jiguang.common.resp.ResponseWrapper setGroupShield(GroupShieldPayload payload,
                                                    java.lang.String username)
                                                      throws cn.jiguang.common.resp.APIConnectionException,
                                                             cn.jiguang.common.resp.APIRequestException

Set user's group message blocking

Parameters:

payload - GroupShieldPayload

username - Necessary

Returns:

No content

Throws:

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

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

forbidUser

public cn.jiguang.common.resp.ResponseWrapper forbidUser(java.lang.String username,
                                                boolean disable)
                                                  throws cn.jiguang.common.resp.APIConnectionException,
                                                         cn.jiguang.common.resp.APIRequestException

Forbid or activate user

Parameters:

username - username

disable - true means forbid, false means activate

Returns:

No content

Throws:

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

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