API 文档汇总
此分类下主要包括初始化IM SDK和即时通信的方法，适用于点对点发消息、直播间消息、多人聊天等应用场景。
初始化
| 方法 | 说明 |
|---|---|
| initWithAppId | 设置应用的appId和appSecret并初始化 |
| sharedInstance | 获取IMSDK 对外功能类的单例对象 |
| start | 启动工作线程，执行更新token和派发消息等工作 |
| release | 释放销毁 |
| requestDebugToken | 请求IM的token,此方法仅在debug模式下有效 |
| stop | 停止 |
登录
| 方法 | 说明 |
|---|---|
| isAppUserLoginSucceed | 是否已经登录IM |
| login | 登录IM |
| logout | 登出 |
配置
| 方法 | 说明 |
|---|---|
| setAppDeviceID | 设置应用的设备ID |
| setAppXAID | 设置应用AID |
| setChatroomEnableState | 设置房间状态 |
| setChatroomReceiveMessageListener | 设置房间消息监听器 |
| setDebugEnableState | 设置调试状态 |
| setEventListener | 设置事件回调监听器 |
| setGlobalReceiveMessageListener | 设置全局消息监听器 |
| setGroupEnableState | 设置群组可用状态 |
| setHost | 设置服务器域名 |
| setIMToken | 设置IM的验证token |
| setLocalConfig | 通过加密的配置文本得到配置信息 |
| setLogVisibleState | 设置日志是否可见 |
| setPrivateEnableState | 设置私信可用状态 |
| setReportListener | 设置回报监听器 |
| setUnReadMsgNumber | 设置未读消息数量 |
| setUploadLogFilterListener | 设置日志上传监听器 |
| getAppID | 获取应用ID |
| getAppKEY | 获取应用KEY |
| getApplication | 获取应用实例 |
| getCacheDataBasePath | 获取数据库路径 |
| getCacheMediaFileName | 获取本地随机缓存媒体文件名 |
| getConfig | 获取config |
| getCurrentRoomState | 获取当前房间状态 |
| getDeviceID | 获取设备ID |
| getLogPath | 获取日志路径 |
| getUserID | 获取用户ID |
| isAuthed | 检测是否已经认证成功 |
| isConnected | 检测是否已经连接成功 |
| isDebugMode | 检测是否是调试模式 |
| isGroupEnabled | 检测群组是否已启用 |
| isHttpMessageEnabled | 是否启用了http消息 |
| isPrivateEnabled | 检测私信是否已启用 |
| isChatroomEnabled | 检测房间是否已启用 |
私信消息
| 方法 | 说明 |
|---|---|
| sendMessage | 发送消息 |
| deleteLocalPrivateHistoryMessage | 删除本地私信历史消息记录 |
| queryLocalGroupHistoryMessage | 查询本地群组消息历史记录 |
| queryLocalPrivateHistoryMessage | 查询本地私信消息历史记录 |
| queryRemoteSessionList | 从远程接口拉取历史会话列表 |
| queryRemoteSessionMessage | 从远程拉取某个会话的历史消息 |
| querySessionMessage | 拉取某个会话的历史消息 |
| deleteLocalGroupHistoryMessage | 删除本地群组历史消息记录 |
| sendHttpMessage | 发送HTTP消息 |
房间消息
| 方法 | 说明 |
|---|---|
| createChatRoom | 创建房间 |
| joinChatRoom | 加入房间 |
| leaveChatRoom | 离开房间 |
构建消息实体类（IMMsg）
| 方法 | 说明 |
|---|---|
| buildTextPrivateMessage | 构建文本私信消息、发送文本消息请使用本方法构建消息对象，使用正确的方法构建对象发送消息可加速消息的处理 |
| buildAudioPrivateMessage | 构建音频私信消息 |
| buildImagePrivateMessage | 构建图片私信消息 |
| buildVideoPrivateMessage | 构建视频私信消息 |
| buildChatRoomMessage | 构建房间消息 |
| buildGroupMessage | 构建群组消息 |