com.tuisongbao.engine.chat

Class ChatManager

java.lang.Object

com.github.nkzawa.emitter.Emitter

com.tuisongbao.engine.common.EventEmitter

com.tuisongbao.engine.common.BaseManager

com.tuisongbao.engine.chat.ChatManager

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

Chat 管理类

推送宝 Engine 中，Chat 模块的管理类。 可通过调用 Engine.getChatManager() 获得该实例。 创建并管理 ChatGroupManager, ChatMessageManager 和 ChatConversationManager。 通过该类 login(String) 和 logout(EngineCallback)。 在用户已登录的情况下，使用 #bind(String, Listener) 方法可以获取以下事件的回调通知：

• EVENT_LOGIN_SUCCEEDED
• EVENT_LOGIN_FAILED
• EVENT_MESSAGE_NEW
• EVENT_PRESENCE_CHANGED

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_LOGIN_FAILED 登录失败时会触发该事件，事件回调接收一个参数，类型为 ResponseError
static java.lang.String	EVENT_LOGIN_SUCCEEDED 登录成功时会触发该事件，包括自动登录 login(String) 成功时也会触发该事件，事件回调接收一个参数，类型为 ChatUser
static java.lang.String	EVENT_MESSAGE_NEW 有新消息时触发该事件，事件回调接收一个参数，类型为 ChatMessage
static java.lang.String	EVENT_PRESENCE_CHANGED 用户上下线通知的提醒，事件回调接收一个参数，类型为 ChatUserPresence

Constructor Summary

Constructors

Constructor and Description
ChatManager(Engine engine)

Method Summary

Modifier and Type	Method and Description
void	clearCache() 清除所有缓存数据
void	disableCache() 关闭缓存，默认是开启状态
void	enableCache() 开启缓存，默认是开启状态
ChatUser	getChatUser() 获取当前用户
ChatConversationManager	getConversationManager() 获取 ChatConversation 的管理类，同一个 ChatManager 上返回的是同一个引用
ChatGroupManager	getGroupManager() 获取 ChatGroup 的管理类，同一个 ChatManager 上返回的是同一个引用
com.tuisongbao.engine.chat.message.ChatMessageManager	getMessageManager()
boolean	hasLogin()
boolean	isCacheEnabled()
void	login(java.lang.String userData) 登录聊天系统
void	logout(com.tuisongbao.engine.common.callback.EngineCallback<java.lang.String> callback) 退出登录，并解绑所有挂载在 ChatManager 上的事件处理方法。
void	onLoginFailed(com.tuisongbao.engine.common.entity.ResponseError error)
void	onLoginSuccess(ChatUser user)
boolean	send(com.tuisongbao.engine.common.event.BaseEvent event, com.tuisongbao.engine.common.event.BaseEventHandler handler) 如果发送 Event 不成功，会一直尝试。切换用户之后 login(String)，会将所有还未发送成功的 Event 清空。

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_MESSAGE_NEW

public static final java.lang.String EVENT_MESSAGE_NEW

有新消息时触发该事件，事件回调接收一个参数，类型为 ChatMessage

See Also:

Constant Field Values

EVENT_PRESENCE_CHANGED

public static final java.lang.String EVENT_PRESENCE_CHANGED

用户上下线通知的提醒，事件回调接收一个参数，类型为 ChatUserPresence

See Also:

Constant Field Values

EVENT_LOGIN_SUCCEEDED

public static final java.lang.String EVENT_LOGIN_SUCCEEDED

登录成功时会触发该事件，包括自动登录 login(String) 成功时也会触发该事件，事件回调接收一个参数，类型为 ChatUser

See Also:

Constant Field Values

EVENT_LOGIN_FAILED

public static final java.lang.String EVENT_LOGIN_FAILED

登录失败时会触发该事件，事件回调接收一个参数，类型为 ResponseError

See Also:

Constant Field Values

Constructor Detail

ChatManager

public ChatManager(Engine engine)

Method Detail

getChatUser

public ChatUser getChatUser()

获取当前用户

Returns:

当前用户；如果用户没有登录成功，返回 null

login

public void login(java.lang.String userData)

登录聊天系统

登录过程中，会根据 EngineOptions 中提供的 EngineOptions.mAuthEndPoint 进行鉴权。 需通过绑定 EVENT_LOGIN_SUCCEEDED 和 EVENT_LOGIN_FAILED 事件获取登录结果。

Parameters:

userData - 用户的唯一标识

logout

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

退出登录，并解绑所有挂载在 ChatManager 上的事件处理方法。

Parameters:

callback - 处理方法

enableCache

public void enableCache()

开启缓存，默认是开启状态

disableCache

public void disableCache()

关闭缓存，默认是开启状态

isCacheEnabled

public boolean isCacheEnabled()

clearCache

public void clearCache()

清除所有缓存数据

hasLogin

public boolean hasLogin()

onLoginFailed

public void onLoginFailed(com.tuisongbao.engine.common.entity.ResponseError error)

getConversationManager

public ChatConversationManager getConversationManager()

获取 ChatConversation 的管理类，同一个 ChatManager 上返回的是同一个引用

Returns:

ChatConversationManager 实例

getGroupManager

public ChatGroupManager getGroupManager()

获取 ChatGroup 的管理类，同一个 ChatManager 上返回的是同一个引用

Returns:

ChatGroupManager 实例

getMessageManager

public com.tuisongbao.engine.chat.message.ChatMessageManager getMessageManager()

send

public boolean send(com.tuisongbao.engine.common.event.BaseEvent event,
                    com.tuisongbao.engine.common.event.BaseEventHandler handler)

如果发送 Event 不成功，会一直尝试。切换用户之后 login(String)，会将所有还未发送成功的 Event 清空。

Overrides:

send in class com.tuisongbao.engine.common.BaseManager

Parameters:

event - event

handler - 处理方法

Returns:

是否发送成功

onLoginSuccess

public void onLoginSuccess(ChatUser user)