com.tuisongbao.engine.chat.conversation

Class ChatConversation

java.lang.Object

com.github.nkzawa.emitter.Emitter

com.tuisongbao.engine.common.EventEmitter

com.tuisongbao.engine.chat.conversation.ChatConversation

public class ChatConversation
extends com.tuisongbao.engine.common.EventEmitter

会话类

• 直接在该对象上进行发送消息，获取消息，重置未读消息，删除会话等操作
• 绑定 EVENT_MESSAGE_NEW 事件可监听新消息
• 开启缓存时，所有的 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_MESSAGE_NEW 新消息事件，监听该事件，可以实时获取当前会话的新消息
java.lang.Object	extension 拓展项，用于挂载你需要的字段，比如会话相关联的群组的名称。

Constructor Summary

Constructors

Constructor and Description
ChatConversation(Engine engine)

Method Summary

Modifier and Type	Method and Description
void	delete(com.tuisongbao.engine.common.callback.EngineCallback<java.lang.String> callback) 删除会话
java.lang.String	getLastActiveAt()
ChatMessage	getLastMessage() 获取最后一条消息。
void	getMessages(java.lang.Long startMessageId, java.lang.Long endMessageId, int limit, com.tuisongbao.engine.common.callback.EngineCallback<java.util.List<ChatMessage>> callback) 获取会话的历史消息 messageId 是一个自增数，从 0 开始，数字越大表示消息越晚（新）。 startMessageId 和 endMessageId 都可选，参数取值说明，按照顺序依次为 (startMessageId, endMessageId, limit)： (null, null, 20) 获取最新的 20 条消息 (null, 40, 20) 如果最新的 messageId 是 50，返回 50 ～ 40；如果是 70, 返回 70 ~ 50 (40, null, 20) 获取 40 ~ 20 之间的消息 (40, 10, 30) 获取 40 ~ 10 之间的消息
java.lang.String	getTarget()
ChatType	getType()
int	getUnreadMessageCount()
void	incUnreadMessageCount()
void	resetUnread(com.tuisongbao.engine.common.callback.EngineCallback<java.lang.String> callback) 重置未读消息。 将未读消息数设置为 0。
ChatMessage	sendMessage(ChatMessageContent content, com.tuisongbao.engine.common.callback.EngineCallback<ChatMessage> callback, com.tuisongbao.engine.common.callback.ProgressCallback progressCallback) 在会话中发送消息
void	setLastActiveAt(java.lang.String lastActiveAt)
void	setLastMessage(ChatMessage lastMessage)
void	setTarget(java.lang.String target)
void	setType(ChatType type)
void	setUnreadMessageCount(int unreadMessageCount)
java.lang.String	toString()

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, wait, wait, wait

Field Detail

EVENT_MESSAGE_NEW

public static final transient java.lang.String EVENT_MESSAGE_NEW

新消息事件，监听该事件，可以实时获取当前会话的新消息

    conversation.bind(ChatConversation.EVENT_MESSAGE_NEW, new Emitter.Listener() {
        @Override
        public void call(final Object... args) {
            ChatMessage message = (ChatMessage)args[0];
            Log.i(TAG, "当前会话收到新消息 " + message);
        }
    });
 

See Also:

Constant Field Values

extension

public transient java.lang.Object extension

拓展项，用于挂载你需要的字段，比如会话相关联的群组的名称。

Constructor Detail

ChatConversation

public ChatConversation(Engine engine)

Method Detail

getType

public ChatType getType()

setType

public void setType(ChatType type)

getTarget

public java.lang.String getTarget()

setTarget

public void setTarget(java.lang.String target)

getUnreadMessageCount

public int getUnreadMessageCount()

setUnreadMessageCount

public void setUnreadMessageCount(int unreadMessageCount)

incUnreadMessageCount

public void incUnreadMessageCount()

getLastActiveAt

public java.lang.String getLastActiveAt()

setLastActiveAt

public void setLastActiveAt(java.lang.String lastActiveAt)

getLastMessage

public ChatMessage getLastMessage()

获取最后一条消息。

不是发送请求获取最后一条消息，是其本身的一个属性，表示获得该会话时，那一刻的最新的一条消息。

Returns:

最后一条消息

setLastMessage

public void setLastMessage(ChatMessage lastMessage)

resetUnread

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

重置未读消息。 将未读消息数设置为 0。

Parameters:

callback - 可选

delete

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

删除会话

Parameters:

callback - 可选

getMessages

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

获取会话的历史消息 messageId 是一个自增数，从 0 开始，数字越大表示消息越晚（新）。 startMessageId 和 endMessageId 都可选，参数取值说明，按照顺序依次为 (startMessageId, endMessageId, limit)：

• (null, null, 20) 获取最新的 20 条消息
• (null, 40, 20) 如果最新的 messageId 是 50，返回 50 ～ 40；如果是 70, 返回 70 ~ 50
• (40, null, 20) 获取 40 ~ 20 之间的消息
• (40, 10, 30) 获取 40 ~ 10 之间的消息

Parameters:

startMessageId - 起始 messageId

endMessageId - 结束的 messageId

limit - 必填，消息条数限制

callback - 处理方法

sendMessage

public ChatMessage sendMessage(ChatMessageContent content,
                               com.tuisongbao.engine.common.callback.EngineCallback<ChatMessage> callback,
                               com.tuisongbao.engine.common.callback.ProgressCallback progressCallback)

在会话中发送消息

Parameters:

content - 消息实体

callback - 结果处理方法

progressCallback - 进度处理方法

Returns:

ChatMessage 实例。当为发送图片时，会将缩略图的信息填入，方便开发者刷新页面。

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object