com.tuisongbao.engine.chat.conversation

Class ChatConversationManager

java.lang.Object

com.github.nkzawa.emitter.Emitter

com.tuisongbao.engine.common.EventEmitter

com.tuisongbao.engine.common.BaseManager

com.tuisongbao.engine.chat.conversation.ChatConversationManager

public final class ChatConversationManager
extends com.tuisongbao.engine.common.BaseManager

ChatConversation 的管理类

• 每个 Engine 只有一个该实例。
• 所有的API调用会根据缓存数据适当从服务器获取最新的数据，减少流量。

Nested Class Summary

Nested classes/interfaces inherited from class com.github.nkzawa.emitter.Emitter

com.github.nkzawa.emitter.Emitter.Listener

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EVENT_CONVERSATION_NEW 新会话事件，该事件触发时表示有新的会话生成，建议开发者调用 getList(ChatType, String, EngineCallback) 或者 getLocalList() 刷新 UI。

Constructor Summary

Constructors

Constructor and Description
ChatConversationManager(Engine engine)

Method Summary

Modifier and Type	Method and Description
void	clearCache() 清除所有缓存的会话，包括相关消息
void	delete(ChatType chatType, java.lang.String target, com.tuisongbao.engine.common.callback.EngineCallback<java.lang.String> callback) 删除会话
ChatConversation	find(java.lang.String target) 查找会话，不发送请求，只从缓存中查找，不存在时返回 null。获取最新的数据请使用 getList(ChatType, String, EngineCallback)。
void	getList(ChatType chatType, java.lang.String target, com.tuisongbao.engine.common.callback.EngineCallback<java.util.List<ChatConversation>> callback) 获取会话列表
java.util.List<ChatConversation>	getLocalList() 获取缓存的会话列表
void	getMessages(ChatType chatType, java.lang.String target, java.lang.Long startMessageId, java.lang.Long endMessageId, int limit, com.tuisongbao.engine.common.callback.EngineCallback<java.util.List<ChatMessage>> callback) 获取某个会话的历史消息。startMessageId 和 endMessageId 都可选，都为null时表示获取最新的limit条消息
ChatConversation	loadOne(java.lang.String target, ChatType type) 获取本地会话，不发送请求，只从缓存中查找，不存在时会创建一个新会话。
void	resetUnread(ChatType chatType, java.lang.String target, com.tuisongbao.engine.common.callback.EngineCallback<java.lang.String> callback) 重置未读消息数

Methods inherited from class com.tuisongbao.engine.common.BaseManager

send

Methods inherited from class com.tuisongbao.engine.common.EventEmitter

bind, bindOnce, trigger, unbind, unbind

Methods inherited from class com.github.nkzawa.emitter.Emitter

emit, hasListeners, listeners, off, off, off, on, once

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EVENT_CONVERSATION_NEW

public static final transient java.lang.String EVENT_CONVERSATION_NEW

新会话事件，该事件触发时表示有新的会话生成，建议开发者调用 getList(ChatType, String, EngineCallback) 或者 getLocalList() 刷新 UI。

See Also:

Constant Field Values

Constructor Detail

ChatConversationManager

public ChatConversationManager(Engine engine)

Method Detail

find

public ChatConversation find(java.lang.String target)

查找会话，不发送请求，只从缓存中查找，不存在时返回 null。获取最新的数据请使用 getList(ChatType, String, EngineCallback)。

Parameters:

target - 必填，userId 或 groupId，表示与谁的会话

Returns:

缓存的会话

loadOne

public ChatConversation loadOne(java.lang.String target,
                                ChatType type)

获取本地会话，不发送请求，只从缓存中查找，不存在时会创建一个新会话。

Parameters:

target - 必填，userId 或 groupId，表示与谁的会话

type - 聊天类型

Returns:

缓存的会话或者新会话

getLocalList

public java.util.List<ChatConversation> getLocalList()

获取缓存的会话列表

建议当收到 EVENT_CONVERSATION_NEW 时，调用该方法获取当前最新的会话列表，节省流量。

Returns:

按 ChatConversation.lastActiveAt 逆序排列的会话列表

getList

public void getList(ChatType chatType,
                    java.lang.String target,
                    com.tuisongbao.engine.common.callback.EngineCallback<java.util.List<ChatConversation>> callback)

获取会话列表

Parameters:

chatType - ChatType.SingleChat（单聊） 或 ChatType.GroupChat （群聊）

target - 可选，userId 或 groupId;表示与谁的会话，为 null 时表示获取该用户的所有会话

callback - 结果通知函数

resetUnread

public void resetUnread(ChatType chatType,
                        java.lang.String target,
                        com.tuisongbao.engine.common.callback.EngineCallback<java.lang.String> callback)

重置未读消息数

Parameters:

chatType - ChatType.SingleChat（单聊） 或 ChatType.GroupChat （群聊）

target - 必填，userId 或 groupId

delete

public void delete(ChatType chatType,
                   java.lang.String target,
                   com.tuisongbao.engine.common.callback.EngineCallback<java.lang.String> callback)

删除会话

Parameters:

chatType - ChatType.SingleChat（单聊） 或 ChatType.GroupChat （群聊）

target - 必填，userId 或 groupId

callback - 结果通知函数

getMessages

public void getMessages(ChatType chatType,
                        java.lang.String target,
                        java.lang.Long startMessageId,
                        java.lang.Long endMessageId,
                        int limit,
                        com.tuisongbao.engine.common.callback.EngineCallback<java.util.List<ChatMessage>> callback)

获取某个会话的历史消息。startMessageId 和 endMessageId 都可选，都为null时表示获取最新的limit条消息

Parameters:

chatType - ChatType.SingleChat（单聊） 或 ChatType.GroupChat （群聊）

target - 必填，userId 或 groupId

startMessageId - 起始 messageId

endMessageId - 结束的 messageId

limit - 消息条数限制

callback - 结果通知函数

clearCache

public void clearCache()

清除所有缓存的会话，包括相关消息