hyphenate_SDK3.0  3.5.6
hyphenatejavaIMSDK
Public Member Functions | List of all members
com.hyphenate.chat.EMChatRoomManager Class Reference
Collaboration diagram for com.hyphenate.chat.EMChatRoomManager:
Collaboration graph
[legend]

Public Member Functions

 EMChatRoomManager (EMClient client, EMAChatRoomManager manager)
 
void addChatRoomChangeListener (EMChatRoomChangeListener listener)
 
void removeChatRoomChangeListener (EMChatRoomChangeListener listener)
 
void removeChatRoomListener (EMChatRoomChangeListener listener)
 
void joinChatRoom (final String roomId, final EMValueCallBack< EMChatRoom > callback)
 
void leaveChatRoom (final String roomId)
 
EMPageResult< EMChatRoomfetchPublicChatRoomsFromServer (int pageNum, int pageSize) throws HyphenateException
 
EMCursorResult< EMChatRoomfetchPublicChatRoomsFromServer (int pageSize, String cursor) throws HyphenateException
 
void asyncFetchPublicChatRoomsFromServer (final int pageSize, final String cursor, final EMValueCallBack< EMCursorResult< EMChatRoom >> callback)
 
void asyncFetchPublicChatRoomsFromServer (final int pageNum, final int pageSize, final EMValueCallBack< EMPageResult< EMChatRoom >> callback)
 
EMChatRoom fetchChatRoomFromServer (String roomId) throws HyphenateException
 
EMChatRoom fetchChatRoomFromServer (String roomId, boolean fetchMembers) throws HyphenateException
 
void asyncFetchChatRoomFromServer (final String roomId, final EMValueCallBack< EMChatRoom > callback)
 
EMChatRoom getChatRoom (String roomId)
 
List< EMChatRoomgetAllChatRooms ()
 
EMChatRoom createChatRoom (String subject, String description, String welcomeMessage, int maxUserCount, List< String > members) throws HyphenateException
 
void asyncCreateChatRoom (final String subject, final String description, final String welcomeMessage, final int maxUserCount, final List< String > members, final EMValueCallBack< EMChatRoom > callBack)
 
void destroyChatRoom (String chatRoomId) throws HyphenateException
 
void asyncDestroyChatRoom (final String chatRoomId, final EMCallBack callBack)
 
EMChatRoom changeChatRoomSubject (String chatRoomId, String newSubject) throws HyphenateException
 
void asyncChangeChatRoomSubject (final String chatRoomId, final String newSubject, final EMValueCallBack< EMChatRoom > callBack)
 
EMChatRoom changeChatroomDescription (String chatRoomId, String newDescription) throws HyphenateException
 
void asyncChangeChatroomDescription (final String chatRoomId, final String newDescription, final EMValueCallBack< EMChatRoom > callBack)
 
EMCursorResult< String > fetchChatRoomMembers (String chatRoomId, String cursor, int pageSize) throws HyphenateException
 
void asyncFetchChatRoomMembers (final String chatRoomId, final String cursor, final int pageSize, final EMValueCallBack< EMCursorResult< String >> callBack)
 
EMChatRoom muteChatRoomMembers (String chatRoomId, List< String > muteMembers, long duration) throws HyphenateException
 
void asyncMuteChatRoomMembers (final String chatRoomId, final List< String > muteMembers, final long duration, final EMValueCallBack< EMChatRoom > callBack)
 
EMChatRoom unMuteChatRoomMembers (String chatRoomId, List< String > members) throws HyphenateException
 
void asyncUnMuteChatRoomMembers (final String chatRoomId, final List< String > members, final EMValueCallBack< EMChatRoom > callBack)
 
EMChatRoom changeOwner (String chatRoomId, String newOwner) throws HyphenateException
 
void asyncChangeOwner (final String chatRoomId, final String newOwner, final EMValueCallBack< EMChatRoom > callBack) throws HyphenateException
 
EMChatRoom addChatRoomAdmin (String chatRoomId, String admin) throws HyphenateException
 
void asyncAddChatRoomAdmin (final String chatRoomId, final String admin, final EMValueCallBack< EMChatRoom > callBack)
 
EMChatRoom removeChatRoomAdmin (String chatRoomId, String admin) throws HyphenateException
 
void asyncRemoveChatRoomAdmin (final String chatRoomId, final String admin, final EMValueCallBack< EMChatRoom > callBack)
 
Map< String, Long > fetchChatRoomMuteList (String chatRoomId, int pageNum, int pageSize) throws HyphenateException
 
void asyncFetchChatRoomMuteList (final String chatRoomId, final int pageNum, final int pageSize, final EMValueCallBack< Map< String, Long >> callBack)
 
EMChatRoom removeChatRoomMembers (String chatRoomId, List< String > members) throws HyphenateException
 
void asyncRemoveChatRoomMembers (final String chatRoomId, final List< String > members, final EMValueCallBack< EMChatRoom > callBack)
 
EMChatRoom blockChatroomMembers (String chatRoomId, List< String > members) throws HyphenateException
 
void asyncBlockChatroomMembers (final String chatRoomId, final List< String > members, final EMValueCallBack< EMChatRoom > callBack)
 
EMChatRoom unblockChatRoomMembers (String chatRoomId, List< String > members) throws HyphenateException
 
void asyncUnBlockChatRoomMembers (final String chatRoomId, final List< String > members, final EMValueCallBack< EMChatRoom > callBack)
 
List< String > fetchChatRoomBlackList (String chatRoomId, int pageNum, int pageSize) throws HyphenateException
 
void asyncFetchChatRoomBlackList (final String chatRoomId, final int pageNum, final int pageSize, final EMValueCallBack< List< String >> callBack)
 
void updateChatRoomAnnouncement (String chatRoomId, String announcement) throws HyphenateException
 
void asyncUpdateChatRoomAnnouncement (final String chatRoomId, final String announcement, final EMCallBack callBack)
 
String fetchChatRoomAnnouncement (String chatRoomId) throws HyphenateException
 
void asyncFetchChatRoomAnnouncement (final String chatRoomId, final EMValueCallBack< String > callBack)
 

Member Function Documentation

EMChatRoom com.hyphenate.chat.EMChatRoomManager.addChatRoomAdmin ( String  chatRoomId,
String  admin 
) throws HyphenateException

add chat room administrator, need owner's authority to access.

Parameters
chatRoomId
admin
Returns
Exceptions
HyphenateException
void com.hyphenate.chat.EMChatRoomManager.addChatRoomChangeListener ( EMChatRoomChangeListener  listener)

register chat room change listener

Parameters
listener
void com.hyphenate.chat.EMChatRoomManager.asyncAddChatRoomAdmin ( final String  chatRoomId,
final String  admin,
final EMValueCallBack< EMChatRoom callBack 
)

add chat room administrator, need owner's authority to access.

Parameters
chatRoomId
admin
callBack
void com.hyphenate.chat.EMChatRoomManager.asyncBlockChatroomMembers ( final String  chatRoomId,
final List< String >  members,
final EMValueCallBack< EMChatRoom callBack 
)

add members to chat room's black list, need owner or administrator's authority to access.

Parameters
chatRoomId
members
callBack
void com.hyphenate.chat.EMChatRoomManager.asyncChangeChatroomDescription ( final String  chatRoomId,
final String  newDescription,
final EMValueCallBack< EMChatRoom callBack 
)

change chat room description, owner‘s authority is required, asynchronous method

Parameters
chatRoomId
newDescription
callBack
void com.hyphenate.chat.EMChatRoomManager.asyncChangeChatRoomSubject ( final String  chatRoomId,
final String  newSubject,
final EMValueCallBack< EMChatRoom callBack 
)

change chat room subject, owner‘s authority is required, asynchronous method

Parameters
chatRoomId
newSubject
void com.hyphenate.chat.EMChatRoomManager.asyncChangeOwner ( final String  chatRoomId,
final String  newOwner,
final EMValueCallBack< EMChatRoom callBack 
) throws HyphenateException

transfer chat room ownership to others, need owner's authority to access.

Parameters
chatRoomId
newOwner
callBack
void com.hyphenate.chat.EMChatRoomManager.asyncCreateChatRoom ( final String  subject,
final String  description,
final String  welcomeMessage,
final int  maxUserCount,
final List< String >  members,
final EMValueCallBack< EMChatRoom callBack 
)

create chat room, maximum number of 10,000

Parameters
subjectsubject
descriptiondescription
welcomeMessagewelcome message to invite member join the chat room
maxUserCountmax allowed member limit
membersmembers to join
void com.hyphenate.chat.EMChatRoomManager.asyncDestroyChatRoom ( final String  chatRoomId,
final EMCallBack  callBack 
)

destroy chat room, owner‘s authority is required, asynchronous method

Parameters
chatRoomId
callBack
void com.hyphenate.chat.EMChatRoomManager.asyncFetchChatRoomAnnouncement ( final String  chatRoomId,
final EMValueCallBack< String >  callBack 
)

get the chatroom announcement from server

Parameters
chatRoomIdchatroom id
callBackcallback
callBack
void com.hyphenate.chat.EMChatRoomManager.asyncFetchChatRoomBlackList ( final String  chatRoomId,
final int  pageNum,
final int  pageSize,
final EMValueCallBack< List< String >>  callBack 
)

fetch chat room black list members in pages, need owner or administrator's authority to access.

Parameters
chatRoomId
pageNum
pageSize
callBack
void com.hyphenate.chat.EMChatRoomManager.asyncFetchChatRoomFromServer ( final String  roomId,
final EMValueCallBack< EMChatRoom callback 
)

fetch the chat room by room id

Parameters
roomId
callback
void com.hyphenate.chat.EMChatRoomManager.asyncFetchChatRoomMembers ( final String  chatRoomId,
final String  cursor,
final int  pageSize,
final EMValueCallBack< EMCursorResult< String >>  callBack 
)

fetch chat room member list, asynchronous method

Parameters
chatRoomId
cursor
pageSize
callBack
void com.hyphenate.chat.EMChatRoomManager.asyncFetchChatRoomMuteList ( final String  chatRoomId,
final int  pageNum,
final int  pageSize,
final EMValueCallBack< Map< String, Long >>  callBack 
)

fetch mute list, which contains mute members and mute time, need owner or administrator's authority to access.

Parameters
chatRoomId
pageNum
pageSize
callBack
void com.hyphenate.chat.EMChatRoomManager.asyncFetchPublicChatRoomsFromServer ( final int  pageSize,
final String  cursor,
final EMValueCallBack< EMCursorResult< EMChatRoom >>  callback 
)

fetch the chatroom in page synchronoulsy this is a time consuming ooperation

Parameters
pageSizehow many chat room to get
cursorcursor position
callback
Deprecated:
use asyncFetchPublicChatRoomsFromServer(final int pageNum, final int pageSize, final EMValueCallBack&#60;EMPageResult&#60;EMChatRoom&#62;&#62; callback)
void com.hyphenate.chat.EMChatRoomManager.asyncFetchPublicChatRoomsFromServer ( final int  pageNum,
final int  pageSize,
final EMValueCallBack< EMPageResult< EMChatRoom >>  callback 
)

fetch the chatroom in page asynchronously this is a time consuming operation

Parameters
pageNum–page number, start from 1
pageSize– size of page
callback
void com.hyphenate.chat.EMChatRoomManager.asyncMuteChatRoomMembers ( final String  chatRoomId,
final List< String >  muteMembers,
final long  duration,
final EMValueCallBack< EMChatRoom callBack 
)

Stop members post message for some time, entry value is mute duration, need owner or administrator's authority to access.

Parameters
chatRoomId
muteMembersmute group members
durationmute duration, in milli-seconds
callBack
void com.hyphenate.chat.EMChatRoomManager.asyncRemoveChatRoomAdmin ( final String  chatRoomId,
final String  admin,
final EMValueCallBack< EMChatRoom callBack 
)

remove chat room administrator, need owner's authority to access.

Parameters
chatRoomId
admin
callBack
void com.hyphenate.chat.EMChatRoomManager.asyncRemoveChatRoomMembers ( final String  chatRoomId,
final List< String >  members,
final EMValueCallBack< EMChatRoom callBack 
)

remove chat room members, need owner or administrator's authority to access.

Parameters
chatRoomId
members
callBack
void com.hyphenate.chat.EMChatRoomManager.asyncUnBlockChatRoomMembers ( final String  chatRoomId,
final List< String >  members,
final EMValueCallBack< EMChatRoom callBack 
)

remove members from chat room's black list, need owner or administrator's authority to access.

Parameters
chatRoomId
members
callBack
void com.hyphenate.chat.EMChatRoomManager.asyncUnMuteChatRoomMembers ( final String  chatRoomId,
final List< String >  members,
final EMValueCallBack< EMChatRoom callBack 
)

cancel mute chat room member, need owner or administrator's authority to access.

Parameters
chatRoomId
members
callBack
void com.hyphenate.chat.EMChatRoomManager.asyncUpdateChatRoomAnnouncement ( final String  chatRoomId,
final String  announcement,
final EMCallBack  callBack 
)

async update chat room announcement

Parameters
chatRoomIdchat room id
announcementannouncement content
callBackcallback
callBack
EMChatRoom com.hyphenate.chat.EMChatRoomManager.blockChatroomMembers ( String  chatRoomId,
List< String >  members 
) throws HyphenateException

add members to chat room's black list, need owner or administrator's authority to access.

Parameters
chatRoomId
members
Returns
Exceptions
HyphenateException
EMChatRoom com.hyphenate.chat.EMChatRoomManager.changeChatroomDescription ( String  chatRoomId,
String  newDescription 
) throws HyphenateException

change chat room description, owner‘s authority is required, synchronized operation

Parameters
chatRoomId
newDescription
Returns
Exceptions
HyphenateException
EMChatRoom com.hyphenate.chat.EMChatRoomManager.changeChatRoomSubject ( String  chatRoomId,
String  newSubject 
) throws HyphenateException

change chat room subject, owner‘s authority is required, synchronized operation

Parameters
chatRoomId
newSubject
Returns
Exceptions
HyphenateException
EMChatRoom com.hyphenate.chat.EMChatRoomManager.changeOwner ( String  chatRoomId,
String  newOwner 
) throws HyphenateException

transfer chat room ownership to others, need owner's authority to access.

Parameters
chatRoomId
newOwner
Returns
Exceptions
HyphenateException
EMChatRoom com.hyphenate.chat.EMChatRoomManager.createChatRoom ( String  subject,
String  description,
String  welcomeMessage,
int  maxUserCount,
List< String >  members 
) throws HyphenateException

create chat room, maximum number of 10,000

Parameters
subjectsubject
descriptiondescription
welcomeMessagewelcome message to invite member join the chat room
maxUserCountmax allowed member limit
membersinvite members to join
Returns
EMChatRoom
Exceptions
HyphenateException
void com.hyphenate.chat.EMChatRoomManager.destroyChatRoom ( String  chatRoomId) throws HyphenateException

destroy chat room, owner‘s authority is required, synchronized operation

Parameters
chatRoomId
Exceptions
HyphenateException
String com.hyphenate.chat.EMChatRoomManager.fetchChatRoomAnnouncement ( String  chatRoomId) throws HyphenateException

get the chatroom announcement from server

Parameters
chatRoomIdchatroom id
Returns
Exceptions
HyphenateException
List<String> com.hyphenate.chat.EMChatRoomManager.fetchChatRoomBlackList ( String  chatRoomId,
int  pageNum,
int  pageSize 
) throws HyphenateException

fetch chat room black list members in pages, need owner or administrator's authority to access.

Parameters
chatRoomId
pageNum
pageSize
Returns
Exceptions
HyphenateException
EMChatRoom com.hyphenate.chat.EMChatRoomManager.fetchChatRoomFromServer ( String  roomId) throws HyphenateException

fetch the chat room by room id, default behaviour is not fetch

Parameters
roomId
Returns
EMChatRoom
Exceptions
HyphenateException
EMChatRoom com.hyphenate.chat.EMChatRoomManager.fetchChatRoomFromServer ( String  roomId,
boolean  fetchMembers 
) throws HyphenateException

fetch the chat room by room id. If fetchMembers is true, default maximum of fetched member count is 200, to continue fetch members, call EMChatRoomManager#fetchChatRoomMembers(String, String, int)

Parameters
roomIdchat room id
fetchMembersWhether you need to get chat room members
Returns
EMChatRoom
Exceptions
HyphenateException
EMCursorResult<String> com.hyphenate.chat.EMChatRoomManager.fetchChatRoomMembers ( String  chatRoomId,
String  cursor,
int  pageSize 
) throws HyphenateException

fetch chat room member list, synchronized operation, for the last page, EMCursorResult.getCursor() return empty string.

Parameters
chatRoomId
cursor
pageSize
Returns
Exceptions
HyphenateException
Map<String, Long> com.hyphenate.chat.EMChatRoomManager.fetchChatRoomMuteList ( String  chatRoomId,
int  pageNum,
int  pageSize 
) throws HyphenateException

fetch mute list, which contains mute members and mute time, need owner or administrator's authority to access.

Parameters
chatRoomId
pageNum
pageSize
Returns
Map.entry.key is username of mute action, Map.entry.value is expired time of banning post action, in milli-seconds
Exceptions
HyphenateException
EMPageResult<EMChatRoom> com.hyphenate.chat.EMChatRoomManager.fetchPublicChatRoomsFromServer ( int  pageNum,
int  pageSize 
) throws HyphenateException

fetch the chatroom in page synchronoulsy this is a time consuming ooperation

Parameters
pageNum–page number, start from 1
pageSize– size of page
Returns
fetch result, EMPageResult
Exceptions
HyphenateException
EMCursorResult<EMChatRoom> com.hyphenate.chat.EMChatRoomManager.fetchPublicChatRoomsFromServer ( int  pageSize,
String  cursor 
) throws HyphenateException

fetch the chat rooms in page synchronously, when fetch the last page, EMCursorResult.getCursor() return an empty string. this is a time consuming operation

Parameters
pageSizehow many chat room to get
cursorcursor position
Returns
fetch result EMCursorResult
Exceptions
HyphenateException
Deprecated:
use fetchPublicChatRoomsFromServer(int pageNum, int pageSize)
List<EMChatRoom> com.hyphenate.chat.EMChatRoomManager.getAllChatRooms ( )

get all chat rooms in the cache

Returns
EMChatRoom com.hyphenate.chat.EMChatRoomManager.getChatRoom ( String  roomId)

get the chat room in the cache

Parameters
roomId
Returns
void com.hyphenate.chat.EMChatRoomManager.joinChatRoom ( final String  roomId,
final EMValueCallBack< EMChatRoom callback 
)

join the chat room asynchronously

Parameters
roomIdchat room id to join
callbackcallback for success or fail
void com.hyphenate.chat.EMChatRoomManager.leaveChatRoom ( final String  roomId)

leave the chat room asynchronously

Parameters
roomId
EMChatRoom com.hyphenate.chat.EMChatRoomManager.muteChatRoomMembers ( String  chatRoomId,
List< String >  muteMembers,
long  duration 
) throws HyphenateException

Stop members post messages for some time, entry value is mute duration, need owner or administrator's authority to access.

Parameters
chatRoomId
muteMembersmute member list
durationmute duration
Returns
Exceptions
HyphenateException
EMChatRoom com.hyphenate.chat.EMChatRoomManager.removeChatRoomAdmin ( String  chatRoomId,
String  admin 
) throws HyphenateException

remove chat room administrator, need owner's authority to access.

Parameters
chatRoomId
admin
Returns
Exceptions
HyphenateException
void com.hyphenate.chat.EMChatRoomManager.removeChatRoomChangeListener ( EMChatRoomChangeListener  listener)

remove chat room change listener

Parameters
listener
Deprecated:
use EMChatRoomManager#removeChatRoomListener(EMChatRoomChangeListener) instead
void com.hyphenate.chat.EMChatRoomManager.removeChatRoomListener ( EMChatRoomChangeListener  listener)

remove chat room change listener

Parameters
listener
EMChatRoom com.hyphenate.chat.EMChatRoomManager.removeChatRoomMembers ( String  chatRoomId,
List< String >  members 
) throws HyphenateException

remove chat room members, need owner or administrator's authority to access.

Parameters
chatRoomId
members
Returns
Exceptions
HyphenateException
EMChatRoom com.hyphenate.chat.EMChatRoomManager.unblockChatRoomMembers ( String  chatRoomId,
List< String >  members 
) throws HyphenateException

remove members from chat room's black list, need owner or administrator's authority to access.

Parameters
chatRoomId
members
Returns
Exceptions
HyphenateException
EMChatRoom com.hyphenate.chat.EMChatRoomManager.unMuteChatRoomMembers ( String  chatRoomId,
List< String >  members 
) throws HyphenateException

unmute chat room members, need owner or administrator's authority to access.

Parameters
chatRoomId
members
Returns
Exceptions
HyphenateException
void com.hyphenate.chat.EMChatRoomManager.updateChatRoomAnnouncement ( String  chatRoomId,
String  announcement 
) throws HyphenateException

update chat room announcement

Parameters
chatRoomIdchat room id
announcementannouncement content
Exceptions
HyphenateException

The documentation for this class was generated from the following file: