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 | 构建群组消息 |