温馨提示即时通信 IM 为您准备了 Flutter 的 API 调用示例,您可以访问 GitHub 获取源码。
初始化并成功登录,是正常使用腾讯云 IM 服务的前提。
API | 描述 |
---|---|
initSDK | 初始化 SDK |
unInitSDK | 反初始化 SDK |
login | 登录 |
logout | 登出 |
getLoginUser | 获取当前登录用户的 UserID |
getLoginStatus | 获取登录状态 |
getServerTime | 获取服务器当前时间(Web不支持) |
getVersion | 获取版本号 |
getConversationManager | 会话功能入口 |
getFriendshipManager | 关系链功能入口 |
getGroupManager | 高级群组功能入口 |
getMessageManager | 高级消息功能入口 |
getOfflinePushManager | 获取版本号 |
getSignalingManager | 信令入口 |
API | 描述 |
---|---|
addSignalingListener | 添加信令监听 |
removeSignalingListener | 移除信令监听 |
invite | 邀请某个人 |
inviteInGroup | 邀请群内的某些人 |
cancel | 邀请方取消邀请 |
accept | 接收方接受邀请 |
reject | 接收方拒绝邀请 |
getSignalingInfo | 获取信令信息 |
addInvitedSignaling | 创建一个信令请求 |
创建的消息会返回一个id字段,将id字段等传递给统一的发送接口(sendMessage)即可发送消息。
API | 描述 |
---|---|
createTextMessage | 创建文本消息 |
createCustomMessage | 创建定制化消息 |
createImageMessage | 创建图片消息 |
createSoundMessage | 创建音频文件 |
createVideoMessage | 创建视频文件 |
createTextAtMessage | 创建AT消息 |
createFileMessage | 创建文件消息 |
createLocationMessage | 创建位置信息 |
createFaceMessage | 创建表情消息 |
createMergerMessage | 创建合并消息 |
createForwardMessage | 创建转发消息 |
createTargetedGroupMessage | 创建一条定向群消息 |
appendMessage | 添加多Element消息 |
如果您需要收发图片、视频、文件等富媒体消息,并需要撤回消息、标记已读、查询历史消息等高级功能,推荐使用下面这套高级消息接口(原3.6.0前的高级消息部分接口已弃用,请使用新版创建消息接口后调用发送消息接口)。
腾讯云 IM SDK 支持五种预设的群组类型,每种类型都有其适用场景:
会话列表,即登录后首屏看到的列表,包含会话节点、会话名称、群名称、最后一条消息以及未读消息数等元素。
API | 描述 |
---|---|
addConversationListener | 添加关系链监听器 |
removeConversationListener | 移除关系链监听器 |
setConversationListener | 设置会话监听器 |
getConversationList | 获取会话列表 |
getConversationListByConversaionIds | 通过会话ID获取指定会话列表 |
pinConversation | 会话置顶 |
getTotalUnreadMessageCount | 获取会话未读总数 |
getConversation | 获取指定会话 |
deleteConversation | 删除会话 |
setConversationDraft | 设置会话草稿 |
包含查询用户资料、修改个人资料以及屏蔽某人消息(即把某用户加入黑名单中)的相关接口。
API | 描述 |
---|---|
getUsersInfo | 获取用户资料 |
getUserStatus | 获取用户在线状态 |
setSelfInfo | 修改个人资料 |
setSelfStatus | 设置当前登录用户在线状态 |
addToBlackList | 屏蔽某人的消息(添加该用户到黑名单中) |
deleteFromBlackList | 取消某人的消息屏蔽(把该用户从黑名单中移除) |
getBlackList | 获取黑名单列表 |
如果想要在 App 切后台时依然能够实时收到 IM 消息,可以使用离线推送服务。由于大陆境内尚没有统一的推送服务,Android 的离线推送需要针对不同厂商的手机进行 逐一适配。
API | 描述 |
---|---|
setAPNSListener | 设置苹果系统离线推送专用监听器 |
doBackground | 设置离线推送配置信息 |
doForeground | 设置离线推送配置信息 |
setOfflinePushConfig | 设置离线推送配置信息 |
腾讯云 IM 在收发消息时默认不检查是不是好友关系,您可以在 控制台 >功能配置>登录与消息>好友关系检查中开启"发送单聊消息检查关系链"开关,并使用如下接口增删好友和管理好友列表。
API | 描述 |
---|---|
setFriendListener | 设置关系链的监听器,用于接收好友列表和黑名单的变更事件 |
addFriendListener | 添加关系链监听器 |
removeFriendListener | 移除关系链监听器 |
getFriendList | 获取好友列表 |
getFriendsInfo | 获取指定好友资料 |
setFriendInfo | 设置指定好友资料 |
addFriend | 添加好友 |
deleteFromFriendList | 删除好友 |
checkFriend | 检查指定用户的好友关系 |
getFriendApplicationList | 获取好友申请列表 |
acceptFriendApplication | 同意好友申请 |
refuseFriendApplication | 拒绝好友申请 |
deleteFriendApplication | 删除好友申请 |
setFriendApplicationRead | 设置好友申请已读 |
createFriendGroup | 新建好友分组 |
getFriendGroups | 获取分组信息 |
deleteFriendGroup | 删除好友分组 |
renameFriendGroup | 修改好友分组的名称 |
addFriendsToFriendGroup | 添加好友到一个好友分组 |
deleteFriendsFromFriendGroup | 从好友分组中删除好友 |
searchFriends | 搜索好友 |
本页内容是否解决了您的问题?