同旧版本中的 Private
同旧版本中的 ChatRoom 新接入的开发者推荐使用 新版本 API。
TIMManager
IM SDK 主核心模块，负责 IM SDK 的初始化、登录、创建会话以及管理推送等功能。
初始化：初始化是使用 IM SDK 的前提，调用 init 接口后，才能调用其它 API。
登录：需要设置 SDKAppID，UserID 和 UserSig 才能使用即时通信 IM 服务。
会话：一个会话对应一个聊天窗口，例如，与单个好友的 C2C 聊天或者一个聊天群都是一个会话。
推送：管理和设置离线推送的相关功能，包括 token 和开关等。
初始化相关接口
API | 描述 |
初始化 SDK，设置全局配置信息。 | |
反初始化。 | |
获取全局配置信息。 | |
设置用户配置信息。 | |
获取用户配置信息。 | |
新增新消息接收监听。 | |
移除消息监听。 |
登录相关接口
API | 描述 |
登录。 | |
自动登录。 | |
登出。 | |
获取当前登录的用户。 | |
获取当前登录状态。 |
会话管理器
API | 描述 |
获取会话列表。 | |
获取单个会话。 | |
删除单个会话。 | |
删除单个会话和对应的会话消息。 |
设置 APNs 推送
API | 描述 |
设置客户端 Token 和证书 busiID。 | |
配置 APNS。 | |
获取 APNS 配置。 | |
上报 App 应用退至后台。 | |
上报 App 应用切换回前台。 |
未登录查看本地会话和消息
API | 描述 |
在未登录的情况下加载本地存储。 |
调试相关接口
API | 描述 |
获取版本号。 | |
打印日志。 | |
获取日志文件路径。 | |
获取日志打印开启状态。 | |
获取日志级别。 |
TIMConversation
一个会话对应一个聊天窗口，例如，与单个好友的 C2C 聊天或者一个聊天群都是一个会话。
TIMConversation 提供的接口函数都是围绕消息的相关操作，包括发送消息、获取历史消息、设置消息已读设置、撤回和删除等。
发消息相关接口
API | 描述 |
发送消息。 | |
发送在线消息（无痕消息）。 |
获取消息相关接口
API | 描述 |
从云端拉取历史消息。 | |
从本地数据库中获取历史消息。 | |
获取当前会话的最后一条消息。 |
设置消息已读
API | 描述 |
标记消息为已读状态。 | |
获取会话的未读消息计数。 |
撤回/删除消息相关接口
API | 描述 |
撤回一条已发送的消息（消息发送成功后 ）。 | |
删除当前会话的本地历史消息。 |
获取会话信息相关接口
API | 描述 |
获取会话类型。 | |
获取会话 ID。 | |
获取群名称。 |
草稿箱
导入消息到会话相关接口
API | 描述 |
向本地消息列表中添加一条消息，但并不将其发送出去。 | |
将消息导入本地数据库。 |
TIMGroupManager
群组管理模块负责群组的创建群组、删除群组、邀请群成员、删除群成员、修改群信息和修改群成员信息等功能。
获取群组实例
API | 描述 |
获取群管理器实例。 |
创建/删除/加入/退出群组
API | 描述 |
创建私有群，同新版本中的 Work。 | |
创建公开群。 | |
创建聊天室，同新版本中的 Meeting。 | |
创建音视频聊天室。 | |
创建指定类型和 ID 的群组。 | |
创建自定义群组。 | |
解散群组。 | |
申请加群。 | |
主动退出群组。 |
邀请/删除群成员
API | 描述 |
邀请好友入群。 | |
删除群成员。 |
获取群信息
API | 描述 |
获取群列表。 | |
获取服务器存储的群组信息。 | |
获取本地存储的群组信息。 | |
获取群成员列表。 | |
获取本人在群组内的成员信息。 | |
获取群组指定成员的信息。 | |
获取指定类型的成员列表（支持按字段拉取，分页）。 | |
获取接受消息选项。 |
修改群信息
API | 描述 |
修改群名。 | |
修改群简介。 | |
修改群公告。 | |
修改群头像。 | |
修改加群选项。 | |
修改群组是否可被搜索属性。 | |
修改接受消息选项。 | |
修改群组全员禁言属性。 | |
修改群自定义字段集合。 | |
转让群给新群主。 |
修改群成员信息
API | 描述 |
修改群成员名片。 | |
修改群成员角色。 | |
修改群组成员是否可见属性。 | |
禁言用户。 | |
修改群成员自定义字段集合。 |
群未处理请求逻辑
API | 描述 |
获取群组未处理请求列表。 | |
上报群未处理列表已读。 |
TIMFriendshipManager
资料关系链管理模块负责添加好友、删除好友、获取好友相关信息以及修改资料等功能。
API | 描述 |
获取好友管理器实例。 | |
设置自己的资料。 | |
获取自己的资料。 | |
在缓存中查询自己的资料。 | |
获取指定用户资料。 | |
在缓存中查询用户的资料。 | |
获取好友列表。 | |
在缓存中查询用户的关系链数据。 | |
获取缓存中的关系链列表。 | |
检查指定用户的好友关系。 | |
添加好友。 | |
响应对方好友邀请。 | |
删除好友。 | |
修改好友。 | |
获取未决列表。 | |
删除未决消息。 | |
上报未决消息已读。 | |
获取黑名单列表。 | |
添加用户到黑名单。 | |
从黑名单中删除指定用户。 | |
新建好友分组。 | |
获取指定的好友分组信息。 | |
删除好友分组。 | |
修改好友分组的名称。 | |
添加好友至指定好友分组。 | |
从指定分组中删除指定好友。 |
TIMMessage
API | 描述 |
增加 Elem。 | |
获取对应索引的 Elem。 | |
获取 Elem 数量。 | |
设置业务命令字。 | |
查询消息状态。 | |
确认自己是否为发送方。 | |
获取消息的发送方。 | |
获取消息 ID。 | |
获取消息 uniqueId。 | |
获取当前消息的时间戳。 | |
确认自己是否已读。 | |
确认对方是否已读（仅 C2C 消息有效）。 | |
获取消息定位符。 | |
确认是否为 locator 对应的消息。 | |
删除消息。 | |
获取会话。 | |
获取发送者资料。 | |
获取发送者群内资料。 | |
设置消息的优先级（仅对群组消息有效）。 | |
获取消息的优先级（仅对群组消息有效）。 | |
配置消息离线推送相关参数。 | |
获取消息离线推送配置。 | |
设置自定义整数，默认为0。 | |
获取 CustomInt。 | |
设置自定义数据，默认为空串 ""。 | |
获取 CustomData。 | |
复制消息中的属性（复制对象包括 ELem、priority、online 以及 offlinePushInfo）。 | |
将消息导入到本地。 | |
设置消息时间戳。 | |
设置消息发送方。 |