io.agora.chat.ChatThreadManager类 参考

Public 成员函数
void	addChatThreadChangeListener (ChatThreadChangeListener listener)
void	removeChatThreadChangeListener (ChatThreadChangeListener listener)
void	createChatThread (String parentId, String messageId, String chatThreadName, ValueCallBack< ChatThread > callBack)
void	getChatThreadFromServer (String chatThreadId, ValueCallBack< ChatThread > callBack)
void	joinChatThread (String chatThreadId, ValueCallBack< ChatThread > callBack)
void	destroyChatThread (String chatThreadId, CallBack callBack)
void	leaveChatThread (String chatThreadId, CallBack callBack)
void	updateChatThreadName (String chatThreadId, String chatThreadName, CallBack callBack)
void	removeMemberFromChatThread (String chatThreadId, String member, CallBack callBack)
void	getChatThreadMembers (String chatThreadId, int limit, String cursor, ValueCallBack< CursorResult< String > > callBack)
void	getJoinedChatThreadsFromServer (int limit, String cursor, ValueCallBack< CursorResult< ChatThread > > callBack)
void	getJoinedChatThreadsFromServer (String parentId, int limit, String cursor, ValueCallBack< CursorResult< ChatThread > > callBack)
void	getChatThreadsFromServer (String parentId, int limit, String cursor, ValueCallBack< CursorResult< ChatThread > > callBack)
void	getChatThreadLatestMessage (List< String > chatThreadIds, ValueCallBack< Map< String, ChatMessage > > callBack)

详细描述

子区管理类，用于管理子区，包含子区创建和解散以及成员管理等操作。

成员函数说明

addChatThreadChangeListener()

void io.agora.chat.ChatThreadManager.addChatThreadChangeListener

(

ChatThreadChangeListener

listener

)

注册子区事件监听器，用于监听子区变化，如子区的创建和解散等。

你可以调用 removeChatThreadChangeListener(ChatThreadChangeListener) 移除不需要的监听器。

参数

listener

要注册的子区事件监听器。

createChatThread()

void io.agora.chat.ChatThreadManager.createChatThread	(	String	parentId,
		String	messageId,
		String	chatThreadName,
		ValueCallBack< ChatThread >	callBack
	)

创建子区。

子区所属群组的所有成员均可调用该方法。

子区创建成功后，会出现如下情况：

• 单设备登录时，子区所属群组的所有成员均会收到回调 ChatThreadChangeListener#onChatThreadCreated(ChatThreadEvent)。 你可通过设置 ChatThreadChangeListener 监听相关事件。
• 多端多设备登录时，各设备会收到事件回调 io.agora.MultiDeviceListener#onChatThreadEvent(int, String, List)。 该回调方法中第一个参数表示子区事件，例如，子区创建事件为 io.agora.MultiDeviceListener#THREAD_CREATE。 你可通过设置 io.agora.MultiDeviceListener 监听相关事件。

参数

parentId	父 ID，即群组 ID。
messageId	父消息 ID。
chatThreadName	要创建的子区的名称。长度不超过 64 个字符。
callBack	结果回调： 成功时回调 ValueCallBack#onSuccess(Object)，返回创建成功的子区对象； 失败时回调 ValueCallBack#onError(int, String)，返回错误信息。

destroyChatThread()

void io.agora.chat.ChatThreadManager.destroyChatThread	(	String	chatThreadId,
		CallBack	callBack
	)

解散子区。

只有子区所属群组的群主及管理员可调用该方法。

注解

• 单设备登录时，子区所属群组的所有成员均会收到 ChatThreadChangeListener#onChatThreadDestroyed(ChatThreadEvent) 回调。 你可通过设置 ChatThreadChangeListener 监听子区事件。
• 多端多设备登录时，设备会收到 io.agora.MultiDeviceListener#onChatThreadEvent(int, String, List) 回调。 该回调方法中，第一个参数为子区事件，例如，子区解散事件为 io.agora.MultiDeviceListener#THREAD_DESTROY。 你可通过设置 io.agora.MultiDeviceListener 监听子区事件。

参数

chatThreadId	子区 ID。
callBack	结果回调： 成功时回调 CallBack#onSuccess()； 失败时回调 CallBack#onError(int, String)，返回错误信息。

getChatThreadFromServer()

void io.agora.chat.ChatThreadManager.getChatThreadFromServer	(	String	chatThreadId,
		ValueCallBack< ChatThread >	callBack
	)

从服务器获取子区详情。

参数

chatThreadId	子区 ID。
callBack	结果回调： 成功时回调 ValueCallBack#onSuccess(Object)，返回子区详情； 失败时回调 ValueCallBack#onError(int, String)，返回错误信息。

getChatThreadLatestMessage()

void io.agora.chat.ChatThreadManager.getChatThreadLatestMessage	(	List< String >	chatThreadIds,
		ValueCallBack< Map< String, ChatMessage > >	callBack
	)

从服务器批量获取指定子区中的最新一条消息。

参数

chatThreadIds	要查询的子区 ID 列表，每次最多可传 20 个子区。
callBack	结果回调： 成功时回调 ValueCallBack#onSuccess(Object)，返回一个 Map 集合，键为子区 ID，值是对应子区最新消息；

• 失败时回调 ValueCallBack#onError(int, String)，返回错误信息。

getChatThreadMembers()

void io.agora.chat.ChatThreadManager.getChatThreadMembers	(	String	chatThreadId,
		int	limit,
		String	cursor,
		ValueCallBack< CursorResult< String > >	callBack
	)

分页获取子区成员。

子区所属群组的所有成员均可调用该方法。

参数

chatThreadId	子区 ID。
limit	每页期望返回的成员数。取值范围为 [1,50]。
cursor	开始获取数据的游标位置，首次调用方法时传 null 或空字符串，按成员加入子区时间的正序获取数据。
callBack	结果回调： 成功时回调 ValueCallBack#onSuccess(Object)，返回获取结果 CursorResult，包含成员列表以及用于下次获取数据的游标； 失败时回调 ValueCallBack#onError(int, String)，返回错误信息。

getChatThreadsFromServer()

void io.agora.chat.ChatThreadManager.getChatThreadsFromServer	(	String	parentId,
		int	limit,
		String	cursor,
		ValueCallBack< CursorResult< ChatThread > >	callBack
	)

分页从服务器端获取指定群组的子区列表。

参数

parentId	父 ID，即群组 ID。
limit	每页期望返回的子区数。取值范围为 [1,50]。
cursor	开始取数据的游标位置。首次获取数据时传 null 或空字符串，按子区创建时间的倒序获取数据。
callBack	结果回调： 成功时回调 ValueCallBack#onSuccess(Object)，返回获取结果 CursorResult，包含子区列表和下次查询的游标。 失败时回调 ValueCallBack#onError(int, String)，返回错误信息。

getJoinedChatThreadsFromServer() [1/2]

void io.agora.chat.ChatThreadManager.getJoinedChatThreadsFromServer	(	int	limit,
		String	cursor,
		ValueCallBack< CursorResult< ChatThread > >	callBack
	)

分页从服务器获取当前用户加入的子区列表。

参数

limit	每页期望返回的子区数。取值范围为 [1,50]。
cursor	开始获取数据的游标位置。首次调用方法时传 null 或空字符串，按用户加入子区时间的倒序获取数据。
callBack	结果回调： 成功时回调 ValueCallBack#onSuccess(Object)，返回分页获取结果 CursorResult，包含子区列表以及用于下次获取数据的游标； 失败时回调 ValueCallBack#onError(int, String)，返回错误信息。

getJoinedChatThreadsFromServer() [2/2]

void io.agora.chat.ChatThreadManager.getJoinedChatThreadsFromServer	(	String	parentId,
		int	limit,
		String	cursor,
		ValueCallBack< CursorResult< ChatThread > >	callBack
	)

分页从服务器获取当前用户加入指定群组的子区列表。

参数

parentId	父 ID，即群组 ID。
limit	每页期望返回的子区数。取值范围为 [1,50]。
cursor	开始取数据的游标位置。首次调用方法时传 null 或空字符串，按用户加入子区时间的倒序获取数据。
callBack	结果回调： 成功时回调 ValueCallBack#onSuccess(Object)，返回获取结果 CursorResult，包含子区列表以及下次查询的游标。

• 失败时回调 ValueCallBack#onError(int, String)，返回错误信息。

joinChatThread()

void io.agora.chat.ChatThreadManager.joinChatThread	(	String	chatThreadId,
		ValueCallBack< ChatThread >	callBack
	)

加入子区。

子区所属群组的所有成员均可调用该方法。

多端多设备登录时，注意以下几点：

• 设备会收到 io.agora.MultiDeviceListener#onChatThreadEvent(int, String, List) 回调。
• 该回调方法中，第一个参数表示子区事件，例如，加入子区事件为 io.agora.MultiDeviceListener#THREAD_JOIN。
• 可通过设置 io.agora.MultiDeviceListener 监听相关事件。

参数

chatThreadId	子区 ID。
callBack	结果回调： 成功时回调 ValueCallBack#onSuccess(Object)，返回子区详情 ChatThread，详情中不含成员数量； 失败时回调 ValueCallBack#onError(int, String)，返回错误信息。 重复加入会报错，错误码为 io.agora.Error#USER_ALREADY_EXIST。

leaveChatThread()

void io.agora.chat.ChatThreadManager.leaveChatThread	(	String	chatThreadId,
		CallBack	callBack
	)

退出子区。

子区中的所有成员均可调用该方法。

多设备登录情况下，注意以下几点：

• 各设备会收到 io.agora.MultiDeviceListener#onChatThreadEvent(int, String, List) 回调。
• 该回调方法中第一个参数表示事件，退出子区事件为 io.agora.MultiDeviceListener#THREAD_LEAVE。
• 你可通过设置 io.agora.MultiDeviceListener 监听相关事件；

参数

chatThreadId	要退出的子区的 ID。
callBack	结果回调： 成功时回调 CallBack#onSuccess()； 失败时回调 CallBack#onError(int, String)，返回错误信息。

removeChatThreadChangeListener()

void io.agora.chat.ChatThreadManager.removeChatThreadChangeListener

(

ChatThreadChangeListener

listener

)

移除子区事件监听器。

在利用 addChatThreadChangeListener(ChatThreadChangeListener) 注册子区事件监听器后调用此方法。

参数

listener

要移除的子区事件监听器。

removeMemberFromChatThread()

void io.agora.chat.ChatThreadManager.removeMemberFromChatThread	(	String	chatThreadId,
		String	member,
		CallBack	callBack
	)

移除子区成员。

只有子区所属群主、群管理员及子区创建者可调用该方法。

被移出的成员会收到 ChatThreadChangeListener#onChatThreadUserRemoved(ChatThreadEvent) 回调。

你可通过设置 ChatThreadChangeListener 监听子区事件。

参数

chatThreadId	子区 ID。
member	被移出子区的成员的用户 ID。
callBack	结果回调。 成功时回调 CallBack#onSuccess()； 失败时回调 CallBack#onError(int, String)，返回错误信息。

updateChatThreadName()

void io.agora.chat.ChatThreadManager.updateChatThreadName	(	String	chatThreadId,
		String	chatThreadName,
		CallBack	callBack
	)

修改子区名称。

只有子区所属群主、群管理员及子区创建者可调用该方法。

子区所属群组的成员会收到 ChatThreadChangeListener#onChatThreadUpdated(ChatThreadEvent) 回调。

你可通过设置 ChatThreadChangeListener 监听子区事件。

参数

chatThreadId	子区 ID。
chatThreadName	子区的新名称。长度不超过 64 个字符。
callBack	结果回调： 成功时回调 CallBack#onSuccess()； 失败时回调 CallBack#onError(int, String)，返回错误信息。

---

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

• io/agora/chat/ChatThreadManager.java