API 文档汇总

初始化

方法说明
initWithAppId初始化
sharedInstance获取IMSDK 对外功能类的单例对象。
start启动工作线程,执行更新token和派发消息等工作
stop停止

登录

方法说明
login登录IM
logout登出

配置

方法说明
setChatroomEnable设置房间功能是否可用
setChatroomReceiveMessageDelegate设置房间消息代理对象
setDebugMode设置调试模式
setModuleEventDelegate设置事件回调代理对象
setGlobalReceiveMessageDelegate设置全局消息代理对象
setGroupEnable设置群组是否可用
setIMToken设置IM的验证token
setLogVisible设置日志是否可见
setPrivateEnable设置私信是否可用
setReportDelegate设置回调代理对象
setUploadLogFilterDelegate设置日志上传代理对象
getCacheDatabasePath获取数据库路径
getCacheMediaFileName获取本地随机缓存媒体文件名
getConfig获取config
getCurrentRoomState获取当前房间状态
getCacheLogPath获取日志路径
isAuthed检测是否已经认证成功
isConnected检测是否已经连接成功
isHttpMessageEnabled是否启用了http消息

私信消息

方法说明
sendMessage发送消息
deleteLocalPrivateHistoryMessage删除本地私信历史消息记录
queryLocalGroupHistoryMessage查询本地群组消息历史记录
queryLocalPrivateHistoryMessage查询本地私信消息历史记录
queryRemoteSessionList从远程接口拉取历史会话列表
queryRemoteSessionMessage从远程拉取某个会话的历史消息
deleteLocalGroupHistoryMessage删除本地群组历史消息记录
sendHttpMessage发送HTTP消息

房间消息

方法说明
createChatroom创建房间
joinChatroom加入房间
leaveChatroom离开房间

构建消息实体类(IMMsg)

方法说明
buildTextPrivateRequest构建文本私信消息、发送文本消息请使用本方法构建消息对象,使用正确的方法构建对象发送消息可加速消息的处理。
buildAudioPrivateRequest构建音频私信消息
buildImagePrivateRequest构建图片私信消息
buildVideoPrivateRequest构建视频私信消息
buildChatRoomTextMessage构建房间消息
buildGroupRequest构建群组消息