AgoraChat.ChatThreadManager类 参考

类 AgoraChat.ChatThreadManager 继承关系图:

Public 成员函数
void	CreateThread (string threadName, string msgId, string groupId, ValueCallBack< ChatThread > callback=null)
void	JoinThread (string threadId, ValueCallBack< ChatThread > callback=null)
void	LeaveThread (string threadId, CallBack callback=null)
void	DestroyThread (string threadId, CallBack callback=null)
void	RemoveThreadMember (string threadId, string userId, CallBack callback=null)
void	ChangeThreadName (string threadId, string newName, CallBack callback=null)
void	FetchThreadMembers (string threadId, string cursor=null, int pageSize=20, ValueCallBack< CursorResult< string > > callback=null)
void	FetchThreadListOfGroup (string groupId, bool joined, string cursor=null, int pageSize=20, ValueCallBack< CursorResult< ChatThread > > callback=null)
void	FetchMineJoinedThreadList (string cursor=null, int pageSize=20, ValueCallBack< CursorResult< ChatThread > > callback=null)
void	GetThreadDetail (string threadId, ValueCallBack< ChatThread > callback=null)
void	GetLastMessageAccordingThreads (List< string > threadIds, ValueCallBack< Dictionary< string, Message > > callback=null)
void	AddThreadManagerDelegate (IChatThreadManagerDelegate threadManagerDelegate)
void	RemoveThreadManagerDelegate (IChatThreadManagerDelegate threadManagerDelegate)

成员函数说明

CreateThread()

void AgoraChat.ChatThreadManager.CreateThread	(	string	threadName,
		string	msgId,
		string	groupId,
		ValueCallBack< ChatThread >	callback = null
	)

创建子区。

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

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

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

参数

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

JoinThread()

void AgoraChat.ChatThreadManager.JoinThread	(	string	threadId,
		ValueCallBack< ChatThread >	callback = null
	)

加入子区。

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

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

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

参数

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

LeaveThread()

void AgoraChat.ChatThreadManager.LeaveThread	(	string	threadId,
		CallBack	callback = null
	)

退出子区。

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

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

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

参数

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

DestroyThread()

void AgoraChat.ChatThreadManager.DestroyThread	(	string	threadId,
		CallBack	callback = null
	)

解散子区。

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

注意

• 多端多设备登录时，设备会收到 IMultiDeviceDelegate#onThreadMultiDevicesEvent(MultiDevicesOperation, String, List) 回调。 该回调方法中，第一个参数为子区事件，例如，子区解散事件为 MultiDevicesOperation#THREAD_DESTROY。 你可通过设置 IMultiDeviceDelegate 监听子区事件。

参数

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

RemoveThreadMember()

void AgoraChat.ChatThreadManager.RemoveThreadMember	(	string	threadId,
		string	userId,
		CallBack	callback = null
	)

移除子区成员。

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

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

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

参数

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

ChangeThreadName()

void AgoraChat.ChatThreadManager.ChangeThreadName	(	string	threadId,
		string	newName,
		CallBack	callback = null
	)

修改子区名称。

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

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

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

参数

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

FetchThreadMembers()

void AgoraChat.ChatThreadManager.FetchThreadMembers	(	string	threadId,
		string	cursor = null,
		int	pageSize = 20,
		ValueCallBack< CursorResult< string > >	callback = null
	)

分页获取子区成员。

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

参数

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

Gets a list of members in the message thread with pagination.

Each member of the group to which the message thread belongs can call this method.

参数

threadId	The message thread ID.
cursor	The position from which to start getting data. At the first method call, if you set cursor to null or an empty string, the SDK will get data in the chronological order of when members join the message thread.
pageSize	The number of members that you expect to get on each page. The value range is [1,50].
callBack	The result callback: If success, ValueCallBack#onSuccess(Object) is triggered to return the result CursorResult, including the message thread member list and the cursor for the next query. If a failure occurs, ValueCallBack#onError(int, String) is triggered to return an error.

FetchThreadListOfGroup()

void AgoraChat.ChatThreadManager.FetchThreadListOfGroup	(	string	groupId,
		bool	joined,
		string	cursor = null,
		int	pageSize = 20,
		ValueCallBack< CursorResult< ChatThread > >	callback = null
	)

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

参数

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

FetchMineJoinedThreadList()

void AgoraChat.ChatThreadManager.FetchMineJoinedThreadList	(	string	cursor = null,
		int	pageSize = 20,
		ValueCallBack< CursorResult< ChatThread > >	callback = null
	)

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

参数

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

GetThreadDetail()

void AgoraChat.ChatThreadManager.GetThreadDetail	(	string	threadId,
		ValueCallBack< ChatThread >	callback = null
	)

从服务器获取子区详情。

参数

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

GetLastMessageAccordingThreads()

void AgoraChat.ChatThreadManager.GetLastMessageAccordingThreads	(	List< string >	threadIds,
		ValueCallBack< Dictionary< string, Message > >	callback = null
	)

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

参数

threadIds	要查询的子区 ID 列表，每次最多可传 20 个子区。
callback	结果回调： 成功时回调 ValueCallBack#onSuccess(Object)，返回一个 Map 集合，键为子区 ID，值是对应子区最新消息； 失败时回调 ValueCallBack#onError(int, String)，返回错误信息。

Gets the last reply in the specified message threads from the server.

参数

threadIds	The list of message thread IDs to query. You can pass a maximum of 20 message thread IDs each time.
callback	The result callback: If success, ValueCallBack#onSuccess(Object) is triggered to return a Map collection that contains key-value pairs where the key is the message thread ID and the value is the last threaded reply. If a failure occurs, ValueCallBack#onError(int, String) is triggered to return an error.

AddThreadManagerDelegate()

void AgoraChat.ChatThreadManager.AddThreadManagerDelegate

(

IChatThreadManagerDelegate

threadManagerDelegate

)

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

你可以调用 RemoveThreadManagerDelegate 移除不需要的监听器。

参数

threadManagerDelegate

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

RemoveThreadManagerDelegate()

void AgoraChat.ChatThreadManager.RemoveThreadManagerDelegate

(

IChatThreadManagerDelegate

threadManagerDelegate

)

移除子区事件监听器。

在利用 AddThreadManagerDelegate 注册子区事件监听器后调用此方法。

参数

listener

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