cn.jmessage.api.chatroom

Class ChatRoomClient

java.lang.Object

cn.jmessage.api.common.BaseClient

cn.jmessage.api.chatroom.ChatRoomClient

public class ChatRoomClient
extends BaseClient

Field Summary

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

_baseUrl, _gson, _httpClient

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
cn.jiguang.common.resp.ResponseWrapper	addChatRoomMember(long roomId, Members members) Add members to chat room
cn.jiguang.common.resp.ResponseWrapper	addChatRoomMember(long roomId, java.lang.String... members) Add members to chat room
CreateChatRoomResult	createChatRoom(ChatRoomPayload payload) Create chat room
cn.jiguang.common.resp.ResponseWrapper	deleteChatRoom(long roomId) Delete chat room by id
ChatRoomListResult	getAppChatRoomInfo(int start, int count) Get application's chat room list
ChatRoomListResult	getBatchChatRoomInfo(long... roomIds) Get chat room information by room ids
ChatRoomMemberList	getChatRoomMembers(long roomId, int start, int count) Get all member info of chat room
ChatRoomListResult	getUserChatRoomInfo(java.lang.String username) Get user's whole chat room information
cn.jiguang.common.resp.ResponseWrapper	removeChatRoomMembers(long roomId, Members members) remove members from chat room
cn.jiguang.common.resp.ResponseWrapper	removeChatRoomMembers(long roomId, java.lang.String... members) remove members from chat room
cn.jiguang.common.resp.ResponseWrapper	updateChatRoomInfo(long roomId, java.lang.String ownerUsername, java.lang.String name, java.lang.String desc) Update chat room info
cn.jiguang.common.resp.ResponseWrapper	updateUserSpeakStatus(long roomId, java.lang.String username, int flag) Update user speak status

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

ChatRoomClient

public ChatRoomClient(java.lang.String appKey,
              java.lang.String masterSecret)

ChatRoomClient

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

ChatRoomClient

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

createChatRoom

public CreateChatRoomResult createChatRoom(ChatRoomPayload payload)
                                    throws cn.jiguang.common.resp.APIConnectionException,
                                           cn.jiguang.common.resp.APIRequestException

Create chat room

Parameters:

payload - ChatRoomPayload

Returns:

result contains room id

Throws:

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

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

getBatchChatRoomInfo

public ChatRoomListResult getBatchChatRoomInfo(long... roomIds)
                                        throws cn.jiguang.common.resp.APIConnectionException,
                                               cn.jiguang.common.resp.APIRequestException

Get chat room information by room ids

Parameters:

roomIds - Array of room id

Returns:

ChatRoomListResult

Throws:

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

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

getUserChatRoomInfo

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

Get user's whole chat room information

Parameters:

username - required

Returns:

ChatRoomListResult

Throws:

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

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

getAppChatRoomInfo

public ChatRoomListResult getAppChatRoomInfo(int start,
                                    int count)
                                      throws cn.jiguang.common.resp.APIConnectionException,
                                             cn.jiguang.common.resp.APIRequestException

Get application's chat room list

Parameters:

start - start index

count - list count

Returns:

ChatRoomListResult

Throws:

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

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

updateChatRoomInfo

public cn.jiguang.common.resp.ResponseWrapper updateChatRoomInfo(long roomId,
                                                        java.lang.String ownerUsername,
                                                        java.lang.String name,
                                                        java.lang.String desc)
                                                          throws cn.jiguang.common.resp.APIConnectionException,
                                                                 cn.jiguang.common.resp.APIRequestException

Update chat room info

Parameters:

roomId - room id

ownerUsername - owner username

name - new chat room name

desc - chat room description

Returns:

No content

Throws:

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

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

deleteChatRoom

public cn.jiguang.common.resp.ResponseWrapper deleteChatRoom(long roomId)
                                                      throws cn.jiguang.common.resp.APIConnectionException,
                                                             cn.jiguang.common.resp.APIRequestException

Delete chat room by id

Parameters:

roomId - room id

Returns:

No content

Throws:

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

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

updateUserSpeakStatus

public cn.jiguang.common.resp.ResponseWrapper updateUserSpeakStatus(long roomId,
                                                           java.lang.String username,
                                                           int flag)
                                                             throws cn.jiguang.common.resp.APIConnectionException,
                                                                    cn.jiguang.common.resp.APIRequestException

Update user speak status

Parameters:

roomId - chat room id

username - user to be modified

flag - 0 means allow to speak, 1 means forbid to speak in chat room

Returns:

No content

Throws:

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

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

getChatRoomMembers

public ChatRoomMemberList getChatRoomMembers(long roomId,
                                    int start,
                                    int count)
                                      throws cn.jiguang.common.resp.APIConnectionException,
                                             cn.jiguang.common.resp.APIRequestException

Get all member info of chat room

Parameters:

roomId - chat room id

start - start index

count - member count

Returns:

ChatRoomMemberList

Throws:

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

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

addChatRoomMember

public cn.jiguang.common.resp.ResponseWrapper addChatRoomMember(long roomId,
                                                       java.lang.String... members)
                                                         throws cn.jiguang.common.resp.APIConnectionException,
                                                                cn.jiguang.common.resp.APIRequestException

Add members to chat room

Parameters:

roomId - chat room id

members - username array

Returns:

No content

Throws:

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

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

addChatRoomMember

public cn.jiguang.common.resp.ResponseWrapper addChatRoomMember(long roomId,
                                                       Members members)
                                                         throws cn.jiguang.common.resp.APIConnectionException,
                                                                cn.jiguang.common.resp.APIRequestException

Add members to chat room

Parameters:

roomId - chat room id

members - Members

Returns:

No content

Throws:

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

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

removeChatRoomMembers

public cn.jiguang.common.resp.ResponseWrapper removeChatRoomMembers(long roomId,
                                                           java.lang.String... members)
                                                             throws cn.jiguang.common.resp.APIConnectionException,
                                                                    cn.jiguang.common.resp.APIRequestException

remove members from chat room

Parameters:

roomId - chat room id

members - username array

Returns:

No content

Throws:

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

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

removeChatRoomMembers

public cn.jiguang.common.resp.ResponseWrapper removeChatRoomMembers(long roomId,
                                                           Members members)
                                                             throws cn.jiguang.common.resp.APIConnectionException,
                                                                    cn.jiguang.common.resp.APIRequestException

remove members from chat room

Parameters:

roomId - chat room id

members - Members

Returns:

No content

Throws:

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

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