io.agora.chat.ChatThreadManager Class Reference

Public Member Functions
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)

Detailed Description

The message thread manager that defines how to manage message threads, including message thread creation, destruction, and member management.

Member Function Documentation

addChatThreadChangeListener()

void io.agora.chat.ChatThreadManager.addChatThreadChangeListener

(

ChatThreadChangeListener

listener

)

Adds the message thread event listener, which listens for message thread changes, such as the message thread creation and destruction.

You can call removeChatThreadChangeListener(ChatThreadChangeListener) to remove an unnecessary message thread event listener.

Parameters

listener

The message thread event listener to add.

createChatThread()

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

Creates a message thread.

Each member of the chat group where the message thread belongs can call this method.

Upon the creation of a message thread, the following will occur:

• In a single-device login scenario, each member of the group to which the message thread belongs will receive the ChatThreadChangeListener#onChatThreadCreated(ChatThreadEvent) callback. You can listen for message thread events by setting ChatThreadChangeListener.
• In a multi-device login scenario, the devices will receive the io.agora.MultiDeviceListener#onChatThreadEvent(int, String, List) callback. In this callback method, the first parameter indicates a message thread event, for example, io.agora.MultiDeviceListener#THREAD_CREATE for a message thread creation event. You can listen for message thread events by setting io.agora.MultiDeviceListener.

Parameters

parentId	The parent ID, which is the group ID.
messageId	The ID of the parent message.
chatThreadName	The name of the new message thread. It can contain a maximum of 64 characters.
callBack	The result callback: If success, ValueCallBack#onSuccess(Object) is triggered to return the new message thread object; If a failure occurs, ValueCallBack#onError(int, String) is triggered to return an error.

destroyChatThread()

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

Destroys the message thread.

Only the owner or admins of the group where the message thread belongs can call this method.

Note

• In a single-device login scenario, each member of the group to which the message thread belongs will receive the ChatThreadChangeListener#onChatThreadDestroyed(ChatThreadEvent) callback. You can listen for message thread events by setting ChatThreadChangeListener.
• In a multi-device login scenario, The devices will receive the io.agora.MultiDeviceListener#onChatThreadEvent(int, String, List) callback. In this callback method, the first parameter indicates a message thread event, for example, io.agora.MultiDeviceListener#THREAD_DESTROY for a message thread destruction event. You can listen for message thread events by setting io.agora.MultiDeviceListener.

Parameters

chatThreadId	The message thread ID.
callBack	The result callback: If success, CallBack#onSuccess() is triggered. If a failure occurs, CallBack#onError(int, String) is triggered to return an error.

getChatThreadFromServer()

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

Gets the details of the message thread from the server.

Parameters

chatThreadId	The message thread ID.
callBack	The result callback: If success, ValueCallBack#onSuccess(Object) is triggered to return the message thread details; If a failure occurs, ValueCallBack#onError(int, String) is triggered to return an error.

getChatThreadLatestMessage()

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

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

Parameters

chatThreadIds	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.

getChatThreadMembers()

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

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.

Parameters

chatThreadId	The message thread ID.
limit	The number of members that you expect to get on each page. The value range is [1,50].
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.
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.

getChatThreadsFromServer()

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

Use the pagination to get the list of message threads in the specified group.

This method gets data from the server.

Parameters

parentId	The parent ID, which is the group ID.
limit	The number of message threads that you expect to get on each page. The value range is [1,50].
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 reverse chronological order of when message threads are created.
callBack	The result callback: If success, ValueCallBack#onSuccess(Object) is triggered to return the result CursorResult, including the message thread list and the cursor for the next query. If a failure occurs, ValueCallBack#onError(int, String) is triggered to return an error.

getJoinedChatThreadsFromServer() [1/2]

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

Uses the pagination to get the list of message threads that the current user has joined.

This method gets data from the server.

Parameters

limit	The number of message threads that you expect to get on each page. The value range is [1,50].
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 reverse chronological order of when the user joins the message threads.
callBack	The result callback: If success, ValueCallBack#onSuccess(Object) is triggered to return the result CursorResult, including the message thread list and the cursor for the next query. If a failure occurs, ValueCallBack#onError(int, String) is triggered to return an error.

getJoinedChatThreadsFromServer() [2/2]

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

Use the pagination to get the list of message threads that the current user has joined in the specified group.

This method gets data from the server.

Parameters

parentId	The parent ID, which is the group ID.
limit	The number of message threads that you expect to get on each page. The value range is [1,50].
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 reverse chronological order of when the user joins the message threads.
callBack	The result callback: If success, ValueCallBack#onSuccess(Object) is triggered to return the result CursorResult, including the message thread list and the cursor for the next query. If a failure occurs, ValueCallBack#onError(int, String) is triggered to return an error.

joinChatThread()

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

Joins a message thread.

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

In a multi-device login scenario, note the following:

• The devices will receive the io.agora.MultiDeviceListener#onChatThreadEvent(int, String, List) callback.
• In this callback method, the first parameter indicates a message thread event, for example, io.agora.MultiDeviceListener#THREAD_JOIN for a message thread join event.
• You can listen for message thread events by setting io.agora.MultiDeviceListener.

Parameters

chatThreadId	The message thread ID.
callBack	The result callback: If success, ValueCallBack#onSuccess(Object) is triggered to return the message thread details ChatThread which do not include the member count. If a failure occurs, ValueCallBack#onError(int, String) is triggered to return an error. If you join a message thread repeatedly, the SDK will return an error with the error code io.agora.Error#USER_ALREADY_EXIST.

leaveChatThread()

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

Leaves a message thread.

Each member in the message thread can call this method.

In a multi-device login scenario, note the following:

• The devices will receive the io.agora.MultiDeviceListener#onChatThreadEvent(int, String, List) callback.
• In this callback method, the first parameter indicates a message thread event, for example, io.agora.MultiDeviceListener#THREAD_LEAVE for a message thread leaving event.
• You can listen for message thread events by setting io.agora.MultiDeviceListener.

Parameters

chatThreadId	The ID of the message thread that the current user wants to leave.
callBack	The result callback: If success, CallBack#onSuccess() is triggered; If a failure occurs, CallBack#onError(int, String) is triggered to return an error.

removeChatThreadChangeListener()

void io.agora.chat.ChatThreadManager.removeChatThreadChangeListener

(

ChatThreadChangeListener

listener

)

Removes the message thread event listener.

After a message thread event listener is added with addChatThreadChangeListener(ChatThreadChangeListener), you can call this method to remove it when it is not required.

Parameters

listener

The message thread event listener to remove.

removeMemberFromChatThread()

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

Removes a member from the message thread.

Only the owner or admins of the group where the message thread belongs and the message thread creator can call this method.

The removed member will receive the ChatThreadChangeListener#onChatThreadUserRemoved(ChatThreadEvent) callback.

You can listen for message thread events by setting ChatThreadChangeListener.

Parameters

chatThreadId	The message thread ID.
member	The user ID of the member to be removed from the message thread.
callBack	The result callback. If success, CallBack#onSuccess() is triggered. If a failure occurs, CallBack#onError(int, String) is triggered to return an error.

updateChatThreadName()

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

Changes the name of the message thread.

Only the owner or admins of the group where the message thread belongs and the message thread creator can call this method.

Each member of the group to which the message thread belongs will receive the ChatThreadChangeListener#onChatThreadUpdated(ChatThreadEvent) callback.

You can listen for message thread events by setting ChatThreadChangeListener.

Parameters

chatThreadId	The message thread ID.
chatThreadName	The new message thread name. It can contain a maximum of 64 characters.
callBack	The result callback: If success, CallBack#onSuccess() is triggered. If a failure occurs, CallBack#onError(int, String) is triggered to return an error.

---

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

• io/agora/chat/ChatThreadManager.java