com.im.imlogic

类 LVIMSDK

java.lang.Object

com.im.imlogic.LVIMSDK

public final class LVIMSDK
extends java.lang.Object

Created by pangbingxin on 2018/8/6.

嵌套类概要

嵌套类

限定符和类型	类和说明
static interface	LVIMSDK.RequestDebugTokenListener 获取测试环境

方法概要

限定符和类型	方法和说明
int	createChatRoom(java.lang.String rid, java.lang.Object context, IMBridger.IMSendMessageListener listener) 创建房间
int	deleteLocalGroupHistoryMessage(java.lang.String sessionid) 删除本地群组历史消息记录
int	deleteLocalPrivateHistoryMessage(java.lang.String sessionid) 删除本地私信历史消息记录
java.lang.String	getAppID() 获取应用ID
java.lang.String	getAppKEY() 获取应用KEY
android.app.Application	getApplication() 获取应用实例
java.lang.String	getCacheDataBasePath() 获取数据库路径
java.lang.String	getCacheMediaFileName(boolean fremote, int mftype, java.lang.String fid, java.lang.String tid, java.lang.String fsuffix) 获取本地随机缓存媒体文件名
com.im.imlogic.IMConfig	getConfig() 获取config
com.im.imlogic.IMRoomState	getCurrentRoomState() 获取当前房间状态
java.lang.String	getDeviceID() 获取设备ID
java.lang.String	getLogPath() 获取日志路径
java.lang.String	getUserID() 获取用户ID
int	initWithAppId(android.app.Application app, java.lang.String appId, java.lang.String appSecret) 设置应用的appId和appSecret,成功返回0，app参数为null返回-1，appId或appSecret错误返回-2
boolean	isAppUserLoginSucceed() 是否已经登录IM
boolean	isAuthed() 检测是否已经认证成功
boolean	isChatroomEnabled() 检测房间是否已启用
boolean	isConnected() 检测是否已经连接成功
boolean	isDebugMode() 检测是否是调试模式
boolean	isGroupEnabled() 检测群组是否已启用
static int	isHttpMessageEnabled() 是否启用了http消息
boolean	isPrivateEnabled() 检测私信是否已启用
int	joinChatRoom(java.lang.String rid, java.lang.Object context, IMBridger.IMSendMessageListener listener) 加入房间
int	leaveChatRoom(java.lang.String rid, java.lang.Object context, IMBridger.IMSendMessageListener listener) 离开房间
int	login(java.lang.String uid, java.lang.String country) 登录IM
int	logout(long waitFinishTimeout)
int	queryLocalGroupHistoryMessage(java.lang.String sessionid, long dbid, int limit, boolean desc, java.util.List<IMMsg> msgs) 查询本地群组消息历史记录
int	queryLocalPrivateHistoryMessage(java.lang.String sessionid, long dbid, int limit, boolean desc, java.util.List<IMMsg> msgs) 查询本地私信消息历史记录
int	queryRemoteSessionList(int pageIndex, int pageSize, IMBridger.IMQueryRemoteSessionListListener listener) 从远程接口拉取历史会话列表
int	queryRemoteSessionMessage(java.lang.String tuid, long smsgid, long sequence, int size, IMBridger.IMQueryRemoteSessionMessageListener listener) 从远程拉取某个会话的历史消息
int	querySessionMessage(java.lang.String targetID, long smsgid, long sequence, int size, IMBridger.IMQuerySessionMessageListener listener) 拉取某个会话的历史消息
void	release() 释放销毁
void	requestDebugToken(LVIMSDK.RequestDebugTokenListener listener) 请求IM的token 此方法仅在debug模式下有效。
int	sendHttpMessage(java.lang.String url, java.lang.String method, java.util.Map<java.lang.String,java.lang.String> params, java.util.Map<java.lang.String,java.lang.String> headers, int sendtmo, int recvtmo, java.lang.Object context, IMBridger.IMSendMessageListener listener) 发送HTTP消息
int	sendMessage(IMMsg msg, java.lang.Object context, IMBridger.IMSendMessageListener listener) 发送消息
void	setAppDeviceID(java.lang.String appDeviceID) 设置应用的设备ID
void	setAppXAID(java.lang.String appXAID) 设置应用AID
void	setChatroomEnableState(boolean isEnable) 设置房间状态
void	setChatroomReceiveMessageListener(IMBridger.IMReceiveMessageListener listener) 设置房间消息监听器
void	setDebugEnableState(boolean isEnable) 设置调试状态
void	setEventListener(IMBridger.IMModuleEventListener listener) 设置事件回调监听器
void	setGlobalReceiveMessageListener(IMBridger.IMReceiveMessageListener listener) 设置全局消息监听器
void	setGroupEnableState(boolean isEnable) 设置群组可用状态
void	setHost(java.lang.String hostUrl) 设置服务器域名
void	setIMAppIDKey(android.app.Application app, java.lang.String appID, java.lang.String appKey) 已过时。
void	setIMToken(java.lang.String uid, java.lang.String imToken) 设置IM的验证token
void	setLogVisibleState(boolean isVisible) 设置日志是否可见
void	setPrivateEnableState(boolean isEnable) 设置私信可用状态
void	setReportListener(IMBridger.IMReportListener listener) 设置回报监听器
void	setUnReadMsgNumber(int size) 设置未读消息数量
void	setUploadLogFilterListener(IMBridger.IMUploadLogFilterListener listener) 设置日志上传监听器
static LVIMSDK	sharedInstance() 获取IM SDK对外功能类的单例对象。
int	start() 启动工作线程，执行更新token和派发消息等工作
int	stop(int timeout) 停止

从类继承的方法 java.lang.Object

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

方法详细资料

setHost

public void setHost(java.lang.String hostUrl)

设置服务器域名

参数:

hostUrl - 服务器域名

initWithAppId

public int initWithAppId(android.app.Application app,
                         java.lang.String appId,
                         java.lang.String appSecret)

设置应用的appId和appSecret,成功返回0，app参数为null返回-1，appId或appSecret错误返回-2

参数:

app - 应用实例对象Application，不能传null

appId - 后台申请的appId

appSecret - 后台申请的appSecret

setAppXAID

public void setAppXAID(java.lang.String appXAID)

设置应用AID

参数:

appXAID - 应用AID

setAppDeviceID

public void setAppDeviceID(java.lang.String appDeviceID)

设置应用的设备ID

参数:

appDeviceID - 应用的设备ID

sharedInstance

public static LVIMSDK sharedInstance()

获取IM SDK对外功能类的单例对象。

返回:

IM SDK主要接口单例对象

setIMAppIDKey

@Deprecated
public void setIMAppIDKey(android.app.Application app,
                                      java.lang.String appID,
                                      java.lang.String appKey)

已过时。

设置appId和appKey，已过时，请使用新方法@initWithAppId

参数:

app - 应用实例对象Application

appID - 应用的appId，后台获取。

appKey - 应用的appKey，后台获取。

setIMToken

public void setIMToken(java.lang.String uid,
                       java.lang.String imToken)

设置IM的验证token

参数:

uid - 当前登录IM的userId

imToken - IM服务器的验证token

isAppUserLoginSucceed

public boolean isAppUserLoginSucceed()

是否已经登录IM

返回:

true为已登录

requestDebugToken

public void requestDebugToken(LVIMSDK.RequestDebugTokenListener listener)

请求IM的token 此方法仅在debug模式下有效。实际中请用自己服务端的接口获取IM的token。

参数:

listener - 回调监听

getAppID

public java.lang.String getAppID()

获取应用ID

返回:

getAppKEY

public java.lang.String getAppKEY()

获取应用KEY

返回:

isConnected

public boolean isConnected()

检测是否已经连接成功

返回:

true为成功

isAuthed

public boolean isAuthed()

检测是否已经认证成功

返回:

true为成功

isDebugMode

public boolean isDebugMode()

检测是否是调试模式

setUnReadMsgNumber

public void setUnReadMsgNumber(int size)

设置未读消息数量

参数:

size - 未读消息数量

setDebugEnableState

public void setDebugEnableState(boolean isEnable)

设置调试状态

参数:

isEnable - true为调试，false为正式

setLogVisibleState

public void setLogVisibleState(boolean isVisible)

设置日志是否可见

参数:

isVisible - 是否可见

isChatroomEnabled

public boolean isChatroomEnabled()

检测房间是否已启用

setChatroomEnableState

public void setChatroomEnableState(boolean isEnable)

设置房间状态

参数:

isEnable - 是否可用

isPrivateEnabled

public boolean isPrivateEnabled()

检测私信是否已启用

返回:

true为启用

setPrivateEnableState

public void setPrivateEnableState(boolean isEnable)

设置私信可用状态

参数:

isEnable - 是否可用

isGroupEnabled

public boolean isGroupEnabled()

检测群组是否已启用

返回:

true为启用

setGroupEnableState

public void setGroupEnableState(boolean isEnable)

设置群组可用状态

参数:

isEnable - 是否可用

getApplication

public android.app.Application getApplication()

获取应用实例

返回:

true为启用

getConfig

public com.im.imlogic.IMConfig getConfig()

获取config

返回:

初始化的配置

getUserID

public java.lang.String getUserID()

获取用户ID

getDeviceID

public java.lang.String getDeviceID()

获取设备ID

getLogPath

public java.lang.String getLogPath()

获取日志路径

getCacheDataBasePath

public java.lang.String getCacheDataBasePath()

获取数据库路径

getCacheMediaFileName

public java.lang.String getCacheMediaFileName(boolean fremote,
                                              int mftype,
                                              java.lang.String fid,
                                              java.lang.String tid,
                                              java.lang.String fsuffix)

获取本地随机缓存媒体文件名

参数:

fremote - 是否是下载资源

mftype - 媒体类型

fid - 发送者ID

tid - 接收者ID

fsuffix - 文件后缀

querySessionMessage

public int querySessionMessage(java.lang.String targetID,
                               long smsgid,
                               long sequence,
                               int size,
                               IMBridger.IMQuerySessionMessageListener listener)

拉取某个会话的历史消息

参数:

targetID - 目标ID(群组ID/用户ID)

smsgid - 本地最后一条消息的服务端消息ID

sequence - 本地最后一条数据的服务端消息序列

size - 要获取的条数

listener - 结果监听

返回:

成功返回0, 否则返回非0

setEventListener

public void setEventListener(IMBridger.IMModuleEventListener listener)

设置事件回调监听器

参数:

listener - 监听器

setGlobalReceiveMessageListener

public void setGlobalReceiveMessageListener(IMBridger.IMReceiveMessageListener listener)

设置全局消息监听器

参数:

listener - 监听器

setChatroomReceiveMessageListener

public void setChatroomReceiveMessageListener(IMBridger.IMReceiveMessageListener listener)

设置房间消息监听器

参数:

listener - 监听器

setUploadLogFilterListener

public void setUploadLogFilterListener(IMBridger.IMUploadLogFilterListener listener)

设置日志上传监听器

参数:

listener - 监听器

setReportListener

public void setReportListener(IMBridger.IMReportListener listener)

设置回报监听器

参数:

listener - 监听器

release

public void release()

释放销毁

start

public int start()

启动工作线程，执行更新token和派发消息等工作

返回:

成功返回0, 否则返回非0

stop

public int stop(int timeout)

停止

参数:

timeout - 等待超时毫秒数

返回:

成功返回0, 超时返回1, 其它值均为错误

login

public int login(java.lang.String uid,
                 java.lang.String country)

登录IM

参数:

uid - 用户ID

country - 用户所属国家码

返回:

成功返回0, 否则返回非0

logout

public int logout(long waitFinishTimeout)

参数:

waitFinishTimeout - 等待退出完成超时毫秒数(默认1000)

返回:

登出

sendMessage

public int sendMessage(IMMsg msg,
                       java.lang.Object context,
                       IMBridger.IMSendMessageListener listener)

发送消息

参数:

msg - 消息对象

context - 自定义上下文

listener - 自定义回调监听器

返回:

成功返回0, 否则返回非0

createChatRoom

public int createChatRoom(java.lang.String rid,
                          java.lang.Object context,
                          IMBridger.IMSendMessageListener listener)

创建房间

参数:

rid - 房间ID

context - 自定义上下文

listener - 自定义回调

返回:

成功返回0, 否则返回非0

joinChatRoom

public int joinChatRoom(java.lang.String rid,
                        java.lang.Object context,
                        IMBridger.IMSendMessageListener listener)

加入房间

参数:

rid - 房间ID

context - 自定义标记对象

listener - 自定义回调

返回:

成功返回0, 否则返回非0

leaveChatRoom

public int leaveChatRoom(java.lang.String rid,
                         java.lang.Object context,
                         IMBridger.IMSendMessageListener listener)

离开房间

参数:

rid - 房间ID

context - 自定义上下文

listener - 自定义回调

返回:

成功返回0, 否则返回非0

getCurrentRoomState

public com.im.imlogic.IMRoomState getCurrentRoomState()

获取当前房间状态

queryRemoteSessionList

public int queryRemoteSessionList(int pageIndex,
                                  int pageSize,
                                  IMBridger.IMQueryRemoteSessionListListener listener)

从远程接口拉取历史会话列表

参数:

pageIndex - 页面编号

pageSize - 页面大小

listener - 回调监听器

queryRemoteSessionMessage

public int queryRemoteSessionMessage(java.lang.String tuid,
                                     long smsgid,
                                     long sequence,
                                     int size,
                                     IMBridger.IMQueryRemoteSessionMessageListener listener)

从远程拉取某个会话的历史消息

参数:

tuid - 会话ID

smsgid - 本地参考消息ID

sequence - 本地参考消息序列

size - 拉取多少

listener - 回调监听器

deleteLocalPrivateHistoryMessage

public int deleteLocalPrivateHistoryMessage(java.lang.String sessionid)

删除本地私信历史消息记录

参数:

sessionid - 某个人的UID

返回:

成功返回删除条数, 失败返回<0的值

deleteLocalGroupHistoryMessage

public int deleteLocalGroupHistoryMessage(java.lang.String sessionid)

删除本地群组历史消息记录

参数:

sessionid - 群组ID

返回:

成功返回删除条数, 失败返回<0的值

queryLocalPrivateHistoryMessage

public int queryLocalPrivateHistoryMessage(java.lang.String sessionid,
                                           long dbid,
                                           int limit,
                                           boolean desc,
                                           java.util.List<IMMsg> msgs)

查询本地私信消息历史记录

参数:

sessionid - 某个人的UID

dbid - 参考数据id

limit - 限制结果数量

desc - 是否降序查询

msgs - 结果集

返回:

成功返回结果数量, 失败返回<0的值

queryLocalGroupHistoryMessage

public int queryLocalGroupHistoryMessage(java.lang.String sessionid,
                                         long dbid,
                                         int limit,
                                         boolean desc,
                                         java.util.List<IMMsg> msgs)

查询本地群组消息历史记录

参数:

sessionid - 某个人的UID

dbid - 参考数据id

limit - 限制结果数量

limit - 限制结果数量

desc - 是否降序查询

msgs - 结果集

返回:

成功返回结果数量, 失败返回<0的值

isHttpMessageEnabled

public static int isHttpMessageEnabled()

是否启用了http消息

返回:

未启用返回0, 独立连接启用返回1, 主连接启用返回2

sendHttpMessage

public int sendHttpMessage(java.lang.String url,
                           java.lang.String method,
                           java.util.Map<java.lang.String,java.lang.String> params,
                           java.util.Map<java.lang.String,java.lang.String> headers,
                           int sendtmo,
                           int recvtmo,
                           java.lang.Object context,
                           IMBridger.IMSendMessageListener listener)

发送HTTP消息

参数:

url - 请求地址

method - 请求方法

params - 请求参数

headers - 附加头部

sendtmo - 发送超时(1000ms ~ 60000ms)

recvtmo - 接收超时(1000ms ~ 60000ms)

context - 自定义上下文

listener - 自定义监听器

返回:

成功返回0, 否则返回非0