Public 成员函数
abstract void	AddRoomAdmin (string roomId, string memberId, CallBack handle=null)

abstract void	BlockRoomMembers (string roomId, List< string > members, CallBack handle=null)

abstract void	ChangeRoomOwner (string roomId, string newOwner, CallBack handle=null)

abstract void	ChangeRoomDescription (string roomId, string newDescription, CallBack handle=null)

abstract void	ChangeRoomName (string roomId, string newName, CallBack handle=null)

abstract void	CreateRoom (string name, string descriptions=null, string welcomeMsg=null, int maxUserCount=300, List< string > members=null, ValueCallBack< Room > handle=null)

abstract void	DestroyRoom (string roomId, CallBack handle=null)

abstract void	FetchPublicRoomsFromServer (int pageNum=1, int pageSize=200, ValueCallBack< PageResult< Room > > handle=null)

abstract void	FetchRoomAnnouncement (string roomId, ValueCallBack< string > handle=null)

abstract void	FetchRoomBlockList (string roomId, int pageNum=1, int pageSize=200, ValueCallBack< List< string > > handle=null)

abstract void	FetchRoomInfoFromServer (string roomId, ValueCallBack< Room > handle=null)

abstract void	FetchRoomMembers (string roomId, string cursor="", int pageSize=200, ValueCallBack< CursorResult< string > > handle=null)

abstract void	FetchRoomMuteList (string roomId, int pageSize=200, int pageNum=1, ValueCallBack< List< string > > handle=null)

abstract void	JoinRoom (string roomId, ValueCallBack< Room > handle=null)

abstract void	LeaveRoom (string roomId, CallBack handle=null)

abstract void	MuteRoomMembers (string roomId, List< string > members, CallBack handle=null)

abstract void	RemoveRoomAdmin (string roomId, string adminId, CallBack handle=null)

abstract void	DeleteRoomMembers (string roomId, List< string > members, CallBack handle=null)

abstract void	UnBlockRoomMembers (string roomId, List< string > members, CallBack handle=null)

abstract void	UnMuteRoomMembers (string roomId, List< string > members, CallBack handle=null)

abstract void	UpdateRoomAnnouncement (string roomId, string announcement, CallBack handle=null)

abstract void	MuteAllRoomMembers (string roomId, ValueCallBack< Room > handle=null)

abstract void	UnMuteAllRoomMembers (string roomId, ValueCallBack< Room > handle=null)

abstract void	AddWhiteListMembers (string roomId, List< string > members, CallBack handle=null)

abstract void	RemoveWhiteListMembers (string roomId, List< string > members, CallBack handle=null)

void	AddRoomManagerDelegate (IRoomManagerDelegate roomManagerDelegate)

void	RemoveRoomManagerDelegate (IRoomManagerDelegate roomManagerDelegate)

详细描述

聊天管理器抽象类。

成员函数说明

◆ AddRoomAdmin()

abstract void ChatSDK.IRoomManager.AddRoomAdmin	(	string	roomId,
		string	memberId,
		CallBack	handle = `null`
	)

pure virtual

添加聊天室管理员。

仅聊天室所有者可调用此方法。

异步方法。

参数

chatRoomId	聊天室 ID。
memberId	要添加的管理员的 ID。
handle	操作结果回调，详见 `CallBack`。

◆ BlockRoomMembers()

abstract void ChatSDK.IRoomManager.BlockRoomMembers	(	string	roomId,
		List< string >	members,
		CallBack	handle = `null`
	)

pure virtual

将成员添加到聊天室黑名单。

仅聊天室所有者和管理员可调用此方法。

注意

成员加入黑名单的同时，将被服务器移出聊天室。
可通过 IRoomManagerDelegate#OnRemovedFromRoom( String, String, String) 回调通知。
加入黑名单的成员禁止再次加入到聊天室。

异步方法。

参数

roomId	聊天室 ID。
members	要加入黑名单的成员列表。
handle	操作结果回调，详见 `CallBack`。

◆ ChangeRoomOwner()

abstract void ChatSDK.IRoomManager.ChangeRoomOwner	(	string	roomId,
		string	newOwner,
		CallBack	handle = `null`
	)

pure virtual

转让聊天室的所有权。

仅聊天室所有者可调用此方法。

异步方法。

参数

roomId	聊天室 ID。
newOwner	新的聊天室所有者 ID。
handle	操作结果回调，详见 `CallBack`。

◆ ChangeRoomDescription()

abstract void ChatSDK.IRoomManager.ChangeRoomDescription	(	string	roomId,
		string	newDescription,
		CallBack	handle = `null`
	)

pure virtual

修改聊天室描述信息。

仅聊天室所有者可调用此方法。

异步方法。

参数

roomId	聊天室 ID。
newDescription	新的聊天室描述。
handle	操作结果回调，详见 `CallBack`。

◆ ChangeRoomName()

abstract void ChatSDK.IRoomManager.ChangeRoomName	(	string	roomId,
		string	newName,
		CallBack	handle = `null`
	)

pure virtual

修改聊天室名称。

仅聊天室所有者可调用此方法。

异步方法。

参数

roomId	聊天室 ID。
newName	聊天室新名称。
handle	操作结果回调，详见 `CallBack`。

◆ CreateRoom()

abstract void ChatSDK.IRoomManager.CreateRoom	(	string	name,
		string	descriptions = `null`,
		string	welcomeMsg = `null`,
		int	maxUserCount = `300`,
		List< string >	members = `null`,
		ValueCallBack< Room >	handle = `null`
	)

pure virtual

创建聊天室。

异步方法。

参数

name	聊天室名称。
description	聊天室描述。
welcomeMsg	邀请成员加入聊天室的消息。
maxUserCount	允许加入聊天室的最大成员数。
members	邀请加入聊天室的成员列表。
handle	操作结果回调，详见 `CallBack`。

◆ DestroyRoom()

abstract void ChatSDK.IRoomManager.DestroyRoom	(	string	roomId,
		CallBack	handle = `null`
	)

pure virtual

销毁聊天室。

仅聊天室所有者可调用此方法。

异步方法。

参数

roomId	聊天室 ID。
handle	操作结果回调，详见 `CallBack`。

◆ FetchPublicRoomsFromServer()

abstract void ChatSDK.IRoomManager.FetchPublicRoomsFromServer	(	int	pageNum = `1`,
		int	pageSize = `200`,
		ValueCallBack< PageResult< Room > >	handle = `null`
	)

pure virtual

以分页方式从服务器获取聊天室。

对于数据量未知且很大的情况，你可以设置 pageNum 和 pageSize 分页获取数据。

异步方法。

参数

pageNum	当前页数，从 1 开始。
pageSize	每页期望返回的记录数。如当前在最后一页，返回的数量小于该参数的值。
handle	操作结果回调，详见 `CallBack`。

◆ FetchRoomAnnouncement()

abstract void ChatSDK.IRoomManager.FetchRoomAnnouncement	(	string	roomId,
		ValueCallBack< string >	handle = `null`
	)

pure virtual

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

异步方法。

参数

roomId	聊天室 ID。
handle	操作结果回调，详见 `CallBack`。

◆ FetchRoomBlockList()

abstract void ChatSDK.IRoomManager.FetchRoomBlockList	(	string	roomId,
		int	pageNum = `1`,
		int	pageSize = `200`,
		ValueCallBack< List< string > >	handle = `null`
	)

pure virtual

以分页的形式获取聊天室黑名单列表。

对于数据量未知且很大的情况，你可以设置 pageSize 和 cursor 分页获取数据。

仅聊天室所有者或管理员可调用此方法。

异步方法。

参数

roomId	聊天室 ID。
pageNum	当前页码，从 1 开始。
pageSize	每页期望返回的黑名单上的用户数。如果当前在最后一页，返回的数量小于该参数的值。
handle	操作结果回调，详见 `CallBack`。

◆ FetchRoomInfoFromServer()

abstract void ChatSDK.IRoomManager.FetchRoomInfoFromServer	(	string	roomId,
		ValueCallBack< Room >	handle = `null`
	)

pure virtual

从服务器获取聊天室详情，默认不取成员列表。

异步方法。

参数

roomId	聊天室 ID。
handle	操作结果回调，返回聊天室信息或错误描述，详见 `ValueCallBack`。

◆ FetchRoomMembers()

abstract void ChatSDK.IRoomManager.FetchRoomMembers	(	string	roomId,
		string	cursor = `""`,
		int	pageSize = `200`,
		ValueCallBack< CursorResult< string > >	handle = `null`
	)

pure virtual

以分页方式获取聊天室成员列表。

对于数据量未知且很大的情况，你可以设置 pageSize 和 cursor 分页获取数据。

异步方法。

参数

roomId	聊天室 ID。
cursor	从该游标位置开始取数据。首次调用 `cursor` 传空值，SDK 按照用户加入聊天室时间的倒序获取数据，即从最新数据开始获取。服务器返回的数据中包含 `cursor` 字段，该字段保存在本地，下次调用接口时，可以将更新的 `cursor` 传入作为开始获取数据的位置。
pageSize	每页期望返回的成员数。如果当前为最后一页，返回的数据量小于该参数的值；
handle	操作结果回调，成功则返回聊天室成员列表，失败则返回错误描述，详见 `ValueCallBack`。

◆ FetchRoomMuteList()

abstract void ChatSDK.IRoomManager.FetchRoomMuteList	(	string	roomId,
		int	pageSize = `200`,
		int	pageNum = `1`,
		ValueCallBack< List< string > >	handle = `null`
	)

pure virtual

以分页方式获取聊天室禁言列表。

对于数据量未知且很大的情况，你可以设置 pageSize 和 cursor 分页获取数据。

仅聊天室所有者和管理员可调用此方法。

异步方法。

参数

roomId	聊天室 ID。
pageNum	当前页码，从 1 开始。
pageSize	每页返回的禁言成员数。如果当前为最后一页，返回的数量小于该参数的值。
handle	操作结果回调，成功则返回聊天室禁言列表，失败返回错误描述，详见 `ValueCallBack`。

◆ JoinRoom()

abstract void ChatSDK.IRoomManager.JoinRoom	(	string	roomId,
		ValueCallBack< Room >	handle = `null`
	)

pure virtual

加入聊天室。

退出聊天室调用 LeaveRoom(String, CallBack)。

异步方法。

参数

roomId	聊天室 ID。
handle	操作结果回调，成功则返回加入的聊天室对象，失败则返回错误信息，详见 `ValueCallBack`。

◆ LeaveRoom()

abstract void ChatSDK.IRoomManager.LeaveRoom	(	string	roomId,
		CallBack	handle = `null`
	)

pure virtual

离开聊天室。

利用 JoinRoom(String, ValueCallBack) 加入聊天室后，离开时调用此方法。

异步方法。

参数

roomId	聊天室 ID。
handle	操作结果回调，详见 `CallBack`。

◆ MuteRoomMembers()

abstract void ChatSDK.IRoomManager.MuteRoomMembers	(	string	roomId,
		List< string >	members,
		CallBack	handle = `null`
	)

pure virtual

禁止聊天室成员发言。

仅聊天室所有者和管理员可调用此方法。

异步方法。

参数

roomId	聊天室 ID。
members	要禁言的用户列表。
handle	操作结果回调，详见 `CallBack`。

◆ RemoveRoomAdmin()

abstract void ChatSDK.IRoomManager.RemoveRoomAdmin	(	string	roomId,
		string	adminId,
		CallBack	handle = `null`
	)

pure virtual

移除聊天室管理员权限。

仅聊天室所有者可调用此方法。

异步方法。

参数

roomId	聊天室 ID。
adminId	要移除管理员权限的 ID。
handle	操作结果回调，详见 `CallBack`。

◆ DeleteRoomMembers()

abstract void ChatSDK.IRoomManager.DeleteRoomMembers	(	string	roomId,
		List< string >	members,
		CallBack	handle = `null`
	)

pure virtual

将成员移出聊天室。

仅聊天室所有者和管理员可调用此方法。

异步方法。

参数

roomId	聊天室 ID。
members	要移出聊天室的用户列表。
handle	操作结果回调，详见 `CallBack`。

◆ UnBlockRoomMembers()

abstract void ChatSDK.IRoomManager.UnBlockRoomMembers	(	string	roomId,
		List< string >	members,
		CallBack	handle = `null`
	)

pure virtual

从聊天室黑名单中移除成员。

仅聊天室所有者或管理员可调用此方法。

异步方法。

参数

roomId	聊天室 ID。
members	要移除黑名单的成员列表。
handle	操作结果回调，详见 `CallBack`。

◆ UnMuteRoomMembers()

abstract void ChatSDK.IRoomManager.UnMuteRoomMembers	(	string	roomId,
		List< string >	members,
		CallBack	handle = `null`
	)

pure virtual

解除禁言。

仅聊天室所有者和管理员可调用此方法。

异步方法。

参数

roomId	聊天室 ID。
members	要解除禁言的用户列表。
handle	操作结果回调，详见 `CallBack`。

◆ UpdateRoomAnnouncement()

abstract void ChatSDK.IRoomManager.UpdateRoomAnnouncement	(	string	roomId,
		string	announcement,
		CallBack	handle = `null`
	)

pure virtual

更新聊天室公告。

仅聊天室所有者和管理员可调用此方法。

异步方法。

参数

roomId	聊天室 ID。
announcement	公告内容。
handle	操作结果回调，详见 `CallBack`。

◆ MuteAllRoomMembers()

abstract void ChatSDK.IRoomManager.MuteAllRoomMembers	(	string	roomId,
		ValueCallBack< Room >	handle = `null`
	)

pure virtual

设置全员禁言。

仅聊天室所有者和管理员可调用此方法。

聊天室拥有者、管理员及加入白名单的用户不受影响。

异步方法。

参数

roomId	聊天室 ID。
handle	结果回调，成功时回调 `ValueCallBack#onSuccess(Object)`，失败时回调 `ValueCallBack#onError(int, String)`。

◆ UnMuteAllRoomMembers()

abstract void ChatSDK.IRoomManager.UnMuteAllRoomMembers	(	string	roomId,
		ValueCallBack< Room >	handle = `null`
	)

pure virtual

解除所有成员的禁言状态。仅聊天室所有者和管理员可调用此方法。

异步方法。

参数

roomId	聊天室 ID。
handle	结果回调，成功时回调 `ValueCallBack#onSuccess(Object)`，失败时回调 `ValueCallBack#onError(int, String)`。

◆ AddWhiteListMembers()

abstract void ChatSDK.IRoomManager.AddWhiteListMembers	(	string	roomId,
		List< string >	members,
		CallBack	handle = `null`
	)

pure virtual

将成员添加到白名单。

仅聊天室所有者或管理员可调用此方法。

聊天室所有者或者管理员执行 MuteAllMembers 时，加入白名单的成员不受影响。

异步方法。

参数

roomId	聊天室 ID。
members	加入白名单的成员列表。
handle	结果回调，成功时回调 `ValueCallBack#onSuccess(Object)`，失败时回调 `ValueCallBack#onError(int, String)`。

◆ RemoveWhiteListMembers()

abstract void ChatSDK.IRoomManager.RemoveWhiteListMembers	(	string	roomId,
		List< string >	members,
		CallBack	handle = `null`
	)

pure virtual

将成员从白名单移除。

仅聊天室所有者和管理员可调用此方法。

成员从白名单移除后，将受到 MuteAllMembers 功能的影响。

异步方法。

参数

roomId	聊天室 ID。
members	移除白名单的用户列表。
handle	结果回调，成功时回调 `ValueCallBack#onSuccess(Object)`，失败时回调 `ValueCallBack#onError(int, String)`。

◆ AddRoomManagerDelegate()

void ChatSDK.IRoomManager.AddRoomManagerDelegate ( IRoomManagerDelegate roomManagerDelegate )

注册聊天室监听器。

参数

roomManagerDelegate 要注册的聊天室监听器，继承自 IRoomManagerDelegate。

◆ RemoveRoomManagerDelegate()

void ChatSDK.IRoomManager.RemoveRoomManagerDelegate ( IRoomManagerDelegate roomManagerDelegate )

移除聊天室监听器。

参数

roomManagerDelegate 要移除的聊天室监听器，继承自 IRoomManagerDelegate。

Public 成员函数

详细描述

成员函数说明

◆ AddRoomAdmin()

◆ BlockRoomMembers()

◆ ChangeRoomOwner()

◆ ChangeRoomDescription()

◆ ChangeRoomName()

◆ CreateRoom()

◆ DestroyRoom()

◆ FetchPublicRoomsFromServer()

◆ FetchRoomAnnouncement()

◆ FetchRoomBlockList()

◆ FetchRoomInfoFromServer()

◆ FetchRoomMembers()

◆ FetchRoomMuteList()

◆ JoinRoom()

◆ LeaveRoom()

◆ MuteRoomMembers()

◆ RemoveRoomAdmin()

◆ DeleteRoomMembers()

◆ UnBlockRoomMembers()

◆ UnMuteRoomMembers()

◆ UpdateRoomAnnouncement()

◆ MuteAllRoomMembers()

◆ UnMuteAllRoomMembers()

◆ AddWhiteListMembers()

◆ RemoveWhiteListMembers()

◆ AddRoomManagerDelegate()

◆ RemoveRoomManagerDelegate()