com.hyphenate.chat.EMChatRoomManager类 参考

com.hyphenate.chat.EMChatRoomManager 的协作图:

Public 成员函数
	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< EMChatRoom >	fetchPublicChatRoomsFromServer (int pageNum, int pageSize) throws HyphenateException
EMCursorResult< EMChatRoom >	fetchPublicChatRoomsFromServer (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< EMChatRoom >	getAllChatRooms ()
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)

成员函数说明

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

为聊天室添加管理员，需要拥有者权限

参数

chatRoomId
admin

返回

异常

HyphenateException

void com.hyphenate.chat.EMChatRoomManager.addChatRoomChangeListener

(

EMChatRoomChangeListener

listener

)

注册聊天室事件监听

参数

listener

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

为聊天室添加管理员，需要拥有者权限

参数

chatRoomId
admin
callBack

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

添加成员到黑名单，禁止成员继续加入聊天室，需要拥有者或者管理员权限

参数

chatRoomId
members
callBack

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

修改群描述信息，需要owner权，同步方法

参数

chatRoomId
newDescription

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

修改聊天室标题，需要owner权，同步方法

参数

chatRoomId
newSubject

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

转移聊天室的所有权

参数

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
	)

创建聊天室，聊天室最大人数上限10000。异步方法

参数

subject	名称
description	描述
welcomeMessage	邀请成员加入聊天室的消息
maxUserCount	允许加入聊天室的最大成员数
members	邀请加入聊天室的成员列表
callBack	程序回调函数，onSuccess会包含该聊天室

void com.hyphenate.chat.EMChatRoomManager.asyncDestroyChatRoom	(	final String	chatRoomId,
		final EMCallBack	callBack
	)

销毁聊天室，需要owner权，同步方法

参数

chatRoomId
callBack

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

从服务器获取聊天室公告内容

参数

chatRoomId	聊天室id
callBack	回调
callBack

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

获取群组黑名单列表，分页显示，需要拥有者或者管理员权限

参数

chatRoomId
pageNum
pageSize
callBack

void com.hyphenate.chat.EMChatRoomManager.asyncFetchChatRoomFromServer	(	final String	roomId,
		final EMValueCallBack< EMChatRoom >	callback
	)

从服务器获取聊天室详情 耗时操作

参数

roomId
callback

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

获取聊天室成员列表

参数

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
	)

获取聊天室的禁言列表，需要拥有者或者管理员权限

参数

chatRoomId
pageNum
pageSize
callBack

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

翻页从服务器获取聊天室 耗时操作

参数

pageSize	一次取多少条
cursor	从这个游标位置开始取
callback

弃用:

use asyncFetchPublicChatRoomsFromServer(final int pageNum, final int pageSize, final EMValueCallBack<EMPageResult<EMChatRoom>> callback)

void com.hyphenate.chat.EMChatRoomManager.asyncFetchPublicChatRoomsFromServer	(	final int	pageNum,
		final int	pageSize,
		final EMValueCallBack< EMPageResult< EMChatRoom >>	callback
	)

翻页从服务器获取聊天室 耗时操作

参数

pageNum	当前要拉取的页数，从1开始
pageSize	当前要拉取页的数量
callback

void com.hyphenate.chat.EMChatRoomManager.asyncMuteChatRoomMembers	(	final String	chatRoomId,
		final List< String >	muteMembers,
		final long	duration,
		final EMValueCallBack< EMChatRoom >	callBack
	)

禁止聊天室成员发言，需要聊天室拥有者或者管理员权限

参数

chatRoomId
muteMembers	需要禁言的群组成员
duration	禁言持续时间，单位是毫秒
callBack

void com.hyphenate.chat.EMChatRoomManager.asyncRemoveChatRoomAdmin	(	final String	chatRoomId,
		final String	admin,
		final EMValueCallBack< EMChatRoom >	callBack
	)

删除聊天室管理员，需要拥有着权限

参数

chatRoomId
admin
callBack

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

删除聊天室成员，需要拥有者或者管理员权限

参数

chatRoomId
members
callBack

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

将成员从黑名单种移除，需要拥有者或者管理员权限

参数

chatRoomId
members
callBack

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

取消禁言，需要聊天室拥有者或者管理员权限，异步方法

参数

chatRoomId
members
callBack

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

异步更新聊天室公告

参数

chatRoomId	聊天室id
announcement	公告内容
callBack	回调
callBack

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

添加成员到黑名单，禁止成员继续加入聊天室，需要拥有者或者管理员权限

参数

chatRoomId
members

返回

异常

HyphenateException

EMChatRoom com.hyphenate.chat.EMChatRoomManager.changeChatroomDescription	(	String	chatRoomId,
		String	newDescription
	)		throws HyphenateException

修改群描述信息，需要owner权，同步方法

参数

chatRoomId
newDescription

返回

异常

HyphenateException

EMChatRoom com.hyphenate.chat.EMChatRoomManager.changeChatRoomSubject	(	String	chatRoomId,
		String	newSubject
	)		throws HyphenateException

修改聊天室标题，需要owner权，同步方法

参数

chatRoomId
newSubject

返回

异常

HyphenateException

EMChatRoom com.hyphenate.chat.EMChatRoomManager.changeOwner	(	String	chatRoomId,
		String	newOwner
	)		throws HyphenateException

转移聊天室的所有权，需要聊天室拥有者权限

参数

chatRoomId
newOwner

返回

异常

HyphenateException

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

创建聊天室，聊天室最大人数上限10000

参数

subject	名称
description	描述
welcomeMessage	邀请成员加入聊天室的消息
maxUserCount	允许加入聊天室的最大成员数
members	邀请加入聊天室的成员列表

返回

EMChatRoom 聊天室

异常

HyphenateException

void com.hyphenate.chat.EMChatRoomManager.destroyChatRoom

(

String

chatRoomId

)

throws HyphenateException

销毁聊天室，需要owner权，同步方法

参数

chatRoomId

异常

HyphenateException

String com.hyphenate.chat.EMChatRoomManager.fetchChatRoomAnnouncement

(

String

chatRoomId

)

throws HyphenateException

从服务器获取聊天室公告内容

参数

chatRoomId

聊天室id

返回

异常

HyphenateException

List<String> com.hyphenate.chat.EMChatRoomManager.fetchChatRoomBlackList	(	String	chatRoomId,
		int	pageNum,
		int	pageSize
	)		throws HyphenateException

获取群组黑名单列表，分页显示，需要拥有者或者管理员权限

参数

chatRoomId
pageNum
pageSize

返回

异常

HyphenateException

EMChatRoom com.hyphenate.chat.EMChatRoomManager.fetchChatRoomFromServer

(

String

roomId

)

throws HyphenateException

从服务器获取聊天室详情，默认不取成员列表 耗时操作

参数

roomId

返回

EMChatRoom

异常

HyphenateException

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

从服务器获取聊天室详情，如果需要取成员列表，默认最多取200个成员，超出部分，请调用EMChatRoomManager#fetchChatRoomMembers(String, String, int) 耗时操作

参数

roomId	聊天室id
fetchMembers	是否需要获取聊天室成员

返回

EMChatRoom

异常

HyphenateException

EMCursorResult<String> com.hyphenate.chat.EMChatRoomManager.fetchChatRoomMembers	(	String	chatRoomId,
		String	cursor,
		int	pageSize
	)		throws HyphenateException

获取聊天室成员列表， 获取最后一页成员列表时，EMCursorResult.getCursor()返回一个空字符串.

参数

chatRoomId
cursor
pageSize

返回

异常

HyphenateException

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

获取聊天室的禁言列表，需要拥有者或者管理员权限

参数

chatRoomId
pageNum
pageSize

返回

Map.entry.key 是禁言的成员id，Map.entry.value是禁言动作失效的时间，单位是毫秒

异常

HyphenateException

EMPageResult<EMChatRoom> com.hyphenate.chat.EMChatRoomManager.fetchPublicChatRoomsFromServer	(	int	pageNum,
		int	pageSize
	)		throws HyphenateException

分页从服务器获取聊天室 耗时操作

参数

pageNum	当前要拉取的页数，从1开始
pageSize	当前要拉取页的数量

返回

分页获取结果 EMPageResult

异常

HyphenateException

EMCursorResult<EMChatRoom> com.hyphenate.chat.EMChatRoomManager.fetchPublicChatRoomsFromServer	(	int	pageSize,
		String	cursor
	)		throws HyphenateException

翻页从服务器获取聊天室，在获取最后一页时，EMCursorResult.getCursor()返回一个空字符串。 耗时操作

参数

pageSize	一次取多少条
cursor	从这个游标位置开始取

返回

分页获取结果 EMCursorResult

异常

HyphenateException

弃用:

use fetchPublicChatRoomsFromServer(int pageNum, int pageSize)

List<EMChatRoom> com.hyphenate.chat.EMChatRoomManager.getAllChatRooms

(

)

获取当前内存的聊天室

返回

EMChatRoom com.hyphenate.chat.EMChatRoomManager.getChatRoom

(

String

roomId

)

从内存中获取聊天室 非耗时操作

参数

roomId

返回

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

加入聊天室,异步方法

参数

roomId
callback

void com.hyphenate.chat.EMChatRoomManager.leaveChatRoom

(

final String

roomId

)

离开聊天室,异步方法

参数

roomId

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

禁止聊天室成员发言，需要聊天室拥有者或者管理员权限

参数

chatRoomId
muteMembers	禁言的用户列表
duration	禁言的时间，单位是毫秒

返回

异常

HyphenateException

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

删除聊天室管理员，需要拥有者权限

参数

chatRoomId
admin

返回

异常

HyphenateException

void com.hyphenate.chat.EMChatRoomManager.removeChatRoomChangeListener

(

EMChatRoomChangeListener

listener

)

移除聊天室事件监听

参数

listener

弃用:

使用 EMChatRoomManager#removeChatRoomListener(EMChatRoomChangeListener) 替代

void com.hyphenate.chat.EMChatRoomManager.removeChatRoomListener

(

EMChatRoomChangeListener

listener

)

移除聊天室事件监听

参数

listener

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

删除聊天室成员，需要拥有者或者管理员权限

参数

chatRoomId
members

返回

异常

HyphenateException

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

将成员从黑名单种移除，需要拥有者或者管理员权限

参数

chatRoomId
members

返回

异常

HyphenateException

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

取消禁言，需要聊天室拥有者或者管理员权限

参数

chatRoomId
members

返回

异常

HyphenateException

void com.hyphenate.chat.EMChatRoomManager.updateChatRoomAnnouncement	(	String	chatRoomId,
		String	announcement
	)		throws HyphenateException

更新聊天室公告

参数

chatRoomId	聊天室id
announcement	公告内容

异常

HyphenateException

---

该类的文档由以下文件生成:

• hyphenatechatsdk/src/com/hyphenate/chat/EMChatRoomManager.java