agora_chat_SDK 1.0.6
agora java chat SDK
|
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) |
子区管理类,用于管理子区,包含子区创建和解散以及成员管理等操作。
void io.agora.chat.ChatThreadManager.addChatThreadChangeListener | ( | ChatThreadChangeListener | listener | ) |
注册子区事件监听器,用于监听子区变化,如子区的创建和解散等。
你可以调用 removeChatThreadChangeListener(ChatThreadChangeListener) 移除不需要的监听器。
listener | 要注册的子区事件监听器。 |
void io.agora.chat.ChatThreadManager.createChatThread | ( | String | parentId, |
String | messageId, | ||
String | chatThreadName, | ||
ValueCallBack< ChatThread > | callBack | ||
) |
创建子区。
子区所属群组的所有成员均可调用该方法。
子区创建成功后,会出现如下情况:
parentId | 父 ID,即群组 ID。 |
messageId | 父消息 ID。 |
chatThreadName | 要创建的子区的名称。长度不超过 64 个字符。 |
callBack | 结果回调:
|
void io.agora.chat.ChatThreadManager.destroyChatThread | ( | String | chatThreadId, |
CallBack | callBack | ||
) |
解散子区。
只有子区所属群组的群主及管理员可调用该方法。
注意
chatThreadId | 子区 ID。 |
callBack | 结果回调:
|
void io.agora.chat.ChatThreadManager.getChatThreadFromServer | ( | String | chatThreadId, |
ValueCallBack< ChatThread > | callBack | ||
) |
从服务器获取子区详情。
chatThreadId | 子区 ID。 |
callBack | 结果回调:
|
void io.agora.chat.ChatThreadManager.getChatThreadLatestMessage | ( | List< String > | chatThreadIds, |
ValueCallBack< Map< String, ChatMessage > > | callBack | ||
) |
从服务器批量获取指定子区中的最新一条消息。
chatThreadIds | 要查询的子区 ID 列表,每次最多可传 20 个子区。 |
callBack | 结果回调:
|
Gets the last reply in the specified message threads from the server.
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:
|
void io.agora.chat.ChatThreadManager.getChatThreadMembers | ( | String | chatThreadId, |
int | limit, | ||
String | cursor, | ||
ValueCallBack< CursorResult< String > > | callBack | ||
) |
分页获取子区成员。
子区所属群组的所有成员均可调用该方法。
chatThreadId | 子区 ID。 |
limit | 每页期望返回的成员数。取值范围为 [1,50]。 |
cursor | 开始获取数据的游标位置,首次调用方法时传 null 或空字符串,按成员加入子区时间的正序获取数据。 |
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.
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:
|
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 | 结果回调:
|
void io.agora.chat.ChatThreadManager.getJoinedChatThreadsFromServer | ( | int | limit, |
String | cursor, | ||
ValueCallBack< CursorResult< ChatThread > > | callBack | ||
) |
分页从服务器获取当前用户加入的子区列表。
limit | 每页期望返回的子区数。取值范围为 [1,50]。 |
cursor | 开始获取数据的游标位置。首次调用方法时传 null 或空字符串,按用户加入子区时间的倒序获取数据。 |
callBack | 结果回调:
|
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 | 结果回调:
|
void io.agora.chat.ChatThreadManager.joinChatThread | ( | String | chatThreadId, |
ValueCallBack< ChatThread > | callBack | ||
) |
加入子区。
子区所属群组的所有成员均可调用该方法。
多端多设备登录时,注意以下几点:
chatThreadId | 子区 ID。 |
callBack | 结果回调:
|
void io.agora.chat.ChatThreadManager.leaveChatThread | ( | String | chatThreadId, |
CallBack | callBack | ||
) |
退出子区。
子区中的所有成员均可调用该方法。
多设备登录情况下,注意以下几点:
chatThreadId | 要退出的子区的 ID。 |
callBack | 结果回调:
|
void io.agora.chat.ChatThreadManager.removeChatThreadChangeListener | ( | ChatThreadChangeListener | listener | ) |
移除子区事件监听器。
在利用 addChatThreadChangeListener(ChatThreadChangeListener) 注册子区事件监听器后调用此方法。
listener | 要移除的子区事件监听器。 |
void io.agora.chat.ChatThreadManager.removeMemberFromChatThread | ( | String | chatThreadId, |
String | member, | ||
CallBack | callBack | ||
) |
移除子区成员。
只有子区所属群主、群管理员及子区创建者可调用该方法。
被移出的成员会收到 ChatThreadChangeListener#onChatThreadUserRemoved(ChatThreadEvent) 回调。
你可通过设置 ChatThreadChangeListener 监听子区事件。
chatThreadId | 子区 ID。 |
member | 被移出子区的成员的用户 ID。 |
callBack | 结果回调。
|
void io.agora.chat.ChatThreadManager.updateChatThreadName | ( | String | chatThreadId, |
String | chatThreadName, | ||
CallBack | callBack | ||
) |
修改子区名称。
只有子区所属群主、群管理员及子区创建者可调用该方法。
子区所属群组的成员会收到 ChatThreadChangeListener#onChatThreadUpdated(ChatThreadEvent) 回调。
你可通过设置 ChatThreadChangeListener 监听子区事件。
chatThreadId | 子区 ID。 |
chatThreadName | 子区的新名称。长度不超过 64 个字符。 |
callBack | 结果回调:
|