SDK API(Unity)

最后更新时间:2021-09-02 17:17:52

    初始化登录接口

    初始化并成功登录,是正常使用腾讯云 IM 服务的前提。

    API 描述
    initSDK 初始化 SDK
    unInitSDK 反初始化 SDK
    login 登录
    logout 登出
    getLoginStatus 获取登录状态
    getLoginUser 获取当前登录用户的 UserID

    简单消息收发接口

    如果您只需要使用文本和信令(即一段自定义buffer)消息,只需要使用这套简单消息收发接口即可。

    API 描述
    addSimpleMsgListener 设置基本消息(文本消息和自定义消息)的事件监听器, 请不要同 addAdvancedMsgListener 混用
    sendC2CTextMessage 发送单聊(C2C)普通文本消息
    sendC2CCustomMessage 发送单聊(C2C)自定义(信令)消息
    sendGroupTextMessage 发送群聊普通文本消息
    sendGroupCustomMessage 发送群聊自定义(信令)消息

    高级消息收发接口

    如果您需要收发图片、视频、文件等富媒体消息,并需要撤回消息、标记已读、查询历史消息等高级功能,推荐使用下面这套高级消息接口(简单消息接口和高级消息接口请不要混用)。

    API 描述
    addAdvancedMsgListener 设置高级消息的事件监听器, 请不要同 addSimpleMsgListener 混用
    sendCustomMessage 发送自定义消息
    sendImageMessage 发送图片消息
    sendSoundMessage 发送语音消息
    sendVideoMessage 发送视频消息
    sendFileMessage 发送文件消息
    sendLocationMessage 发送地理位置消息
    getC2CHistoryMessageList 获取单聊(C2C)历史消息
    getGroupHistoryMessageList 获取群组历史消息
    markC2CMessageAsRead 设置单聊(C2C)消息已读
    markGroupMessageAsRead 设置群组消息已读
    deleteMessageFromLocalStorage 删除本地消息
    insertGroupMessageToLocalStorage 向群组消息列表中添加一条消息

    群组相关接口

    腾讯云 IM SDK 支持四种预设的群组类型,每种类型都有其适用场景:

    • 工作群(Work) :类似普通微信群,创建后不能自由加入,必须由已经在群的用户邀请入群。
    • 公开群(Public) :类似 QQ 群,用户申请加入,但需要群主或管理员审批。
    • 会议群(Meeting):适合跟 TRTC 结合实现视频会议和在线教育等场景,支持随意进出,支持查看进群前的历史消息。
    • 直播群(AVChatRoom):适合直播弹幕聊天室等场景,支持随意进出,人数无上限。
    API 描述
    setGroupListener 设置群组相关的事件监听器
    createGroup 创建群组(高级版本),可在建群同时设置群信息和初始的群成员
    joinGroup 加入群组
    quitGroup 退出群组
    dismissGroup 解散群组(仅群主和管理员可以解散)
    getJoinedGroupList 获取已经加入的群列表(不包括已加入的直播群)
    getGroupsInfo 拉取群资料
    setGroupInfo 修改群资料
    getGroupMemberList 获取群成员列表
    getGroupMembersInfo 获取指定的群成员资料
    setGroupMemberInfo 修改指定的群成员资料
    muteGroupMember 禁言
    kickGroupMember 踢人
    setGroupMemberRole 切换群成员的角色
    transferGroupOwner 转让群主
    inviteUserToGroup 邀请他人入群
    getGroupApplicationList 获取加群的申请列表
    acceptGroupApplication 同意某一条加群申请
    refuseGroupApplication 拒绝某一条加群申请
    setGroupApplicationRead 标记申请列表为已读

    会话列表相关接口

    会话列表,即登录微信或 QQ 后首屏看到的列表,包含会话节点、会话名称、群名称、最后一条消息以及未读消息数等元素。

    API 描述
    setConversationListener 设置会话监听器
    getConversationList 获取会话列表
    deleteConversation 删除会话
    setConversationDraft 设置会话草稿

    用户资料相关接口

    包含查询用户资料、修改个人资料以及屏蔽某人消息(即把某用户加入黑名单中)的相关接口。

    API 描述
    getUsersInfo 获取用户资料
    setSelfInfo 修改个人资料
    addToBlackList 屏蔽某人的消息(添加该用户到黑名单中)
    deleteFromBlackList 取消某人的消息屏蔽(把该用户从黑名单中移除)
    getBlackList 获取黑名单列表
    setOfflinePushConfig 设置离线推送配置信息

    好友管理相关接口

    腾讯云 IM 在收发消息时默认不检查是不是好友关系,您可以在 控制台 >功能配置>登录与消息>好友关系检查中开启"发送单聊消息检查关系链"开关,并使用如下接口增删好友和管理好友列表。

    API 描述
    setFriendListener 设置关系链的监听器,用于接收好友列表和黑名单的变更事件
    getFriendsList 获取好友列表
    getFriendsInfo 获取指定好友资料
    setFriendInfo 设置指定好友资料
    addFriend 添加好友
    deleteFromFriendList 删除好友
    checkFriend 检查指定用户的好友关系
    getFriendApplicationList 获取好友申请列表
    acceptFriendApplication 同意好友申请
    refuseFriendApplication 拒绝好友申请
    deleteFriendApplication 删除好友申请
    setFriendApplicationRead 设置好友申请已读
    createFriendGroup 新建好友分组
    getFriendGroups 获取分组信息
    deleteFriendGroup 删除好友分组
    renameFriendGroup 修改好友分组的名称
    addFriendsToFriendGroup 添加好友到一个好友分组
    deleteFriendsFromFriendGroup 从好友分组中删除好友