tencent cloud

文档反馈

SDK API(React Native)

最后更新时间:2023-02-02 15:27:44

    初始化登录接口

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

    API 描述
    initSDK 初始化 SDK
    unInitSDK 反初始化 SDK
    login 登录
    logout 登出
    getLoginUser 获取当前登录用户的 UserID
    getLoginStatus 获取登录状态
    getServerTime 获取服务器当前时间
    getVersion 获取版本号

    信令接口

    API 描述
    accept 接收方接受邀请
    addInvitedSignaling 创建一个信令请求
    addSignalingListener 添加信令监听
    cancel 邀请方取消邀请
    getSignalingInfo 获取信令信息
    invite 邀请某个人
    inviteInGroup 邀请群内的某些人
    reject 接收方拒绝邀请
    removeSignalingListener 移除信令监听器

    消息相关接口

    API 描述
    addAdvancedMsgListener 添加高级消息的事件监听器
    appendMessage 为一条消息,附着另一条消息,添加至链表。
    clearC2CHistoryMessage 清空单聊本地及云端的消息(不删除会话)
    clearGroupHistoryMessage 清空群聊本地及云端的消息(不删除会话)
    createCustomMessage 创建定制化消息
    createFaceMessage 创建表情消息
    createFileMessage 创建文件消息
    createForwardMessage 创建转发消息
    createImageMessage 创建图片消息
    createLocationMessage 创建位置信息
    createMergerMessage 创建合并消息
    createSoundMessage 创建音频消息
    createTargetedGroupMessage 创建一条定向群消息
    createTextAtMessage 创建文本消息,并且可以附带 @ 提醒功能(直播群不支持)
    createTextMessage 创建文本消息
    createVideoMessage 创建视频文件
    deleteMessageExtensions 删除消息扩展
    deleteMessageFromLocalStorage 删除本地消息
    deleteMessages 删除本地及漫游消息
    downloadMergerMessage 获取合并消息的子消息列表
    downloadMessage 下载多媒体消息
    getC2CHistoryMessageList 获取单聊历史消息
    getC2CReceiveMessageOpt 查询某个用户的 C2C 消息接收选项
    getGroupHistoryMessageList 获取群组历史消息
    getGroupMessageReadMemberList 获取群消息已读或未读群成员列表
    getHistoryMessageList 获取历史消息高级接口
    getMessageExtensions 获取消息扩展
    getMessageOnlineUrl 获取多媒体消息URL
    getMessageReadReceipts 获取消息已读回执。
    insertC2CMessageToLocalStorage 向C2C消息列表中添加一条消息
    insertGroupMessageToLocalStorage 向群组消息列表中添加一条消息
    markAllMessageAsRead 标记所有消息为已读
    markC2CMessageAsRead 设置单聊消息已读
    markGroupMessageAsRead 设置群组消息已读
    modifyMessage 消息编辑
    removeAdvancedMsgListener 移除高级消息监听器
    reSendMessage 消息重发
    revokeMessage 撤回消息
    searchLocalMessages 搜索本地消息
    sendMessage 发送消息
    sendMessageReadReceipts 发送消息已读回执
    sendReplyMessage 发送回复消息
    setC2CReceiveMessageOpt 设置用户消息接收选项
    setGroupReceiveMessageOpt 设置群组消息接收选项
    setLocalCustomData 设置消息自定义数据
    setLocalCustomInt 设置消息自定义数据
    setMessageExtensions 设置消息扩展

    会话相关接口

    API 描述
    addConversationListener 设置会话监听器
    deleteConversation 删除会话
    getConversation 获取会话信息
    getConversationList 获取会话列表
    getConversationListByConversaionIds 通过会话ID获取指定会话列表
    getTotalUnreadMessageCount 获取会话未读总数
    pinConversation 会话置顶
    removeConversationListener 移除会话监听器
    setConversationDraft 设置会话草稿

    关系链相关接口

    API 描述
    acceptFriendApplication 同意好友申请
    addFriend 添加好友
    addFriendListener 添加关系链监听器
    addFriendsToFriendGroup 添加好友到一个好友分组
    addToBlackList 添加用户到黑名单
    checkFriend 检查指定用户的好友关系
    createFriendGroup 新建好友分组
    deleteFriendApplication 删除好友申请
    deleteFriendGroup 删除好友分组
    deleteFriendsFromFriendGroup 同意好友申请
    deleteFromBlackList 把用户从黑名单中删除
    deleteFromFriendList 删除好友
    getBlackList 获取黑名单列表
    getFriendApplicationList 获取好友申请列表
    getFriendGroups 获取好友分组列表
    getFriendList 获取好友列表
    getFriendsInfo 获取指定好友资料
    refuseFriendApplication 拒绝好友申请
    removeFriendListener 移除关系链监听器
    renameFriendGroup 修改好友分组的名称
    searchFriends 搜索好友
    setFriendApplicationRead 设置好友申请已读
    setFriendInfo 设置指定好友资料

    群组相关接口

    API 描述
    addGroupListener 添加群组监听器
    dismissGroup 解散群组
    joinGroup 加入群组
    quitGroup 退出群组
    removeGroupListener 移除群组监听器
    acceptGroupApplication 同意某一条加群申请
    createGroup 创建自定义群组
    createTopicInCommunity 创建话题
    deleteGroupAttributes 删除指定群属性
    deleteTopicFromCommunity 删除话题
    getGroupApplicationList 获取加群的申请列表
    getGroupAttributes 获取指定群属性
    getGroupMemberList 获取群成员列表
    getGroupMembersInfo 获取指定的群成员资料
    getGroupOnlineMemberCount 获取指定群在线人数
    getGroupsInfo 获取群资料
    getJoinedCommunityList 获取当前用户已经加入的支持话题的社群列表
    getJoinedGroupList 获取当前用户已经加入的群组
    getTopicInfoList 获取话题属性的列表
    initGroupAttributes 初始化群属性
    inviteUserToGroup 邀请他人入群
    kickGroupMember 踢人
    muteGroupMember 禁言
    refuseGroupApplication 拒绝某一条加群申请
    searchGroupMembers 搜索群成员
    searchGroups 搜索群资料
    setGroupApplicationRead 标记所有群组申请列表为已读
    setGroupAttributes 设置群属性
    setGroupInfo 修改群资料
    setGroupMemberInfo 修改指定的群成员资料
    setGroupMemberRole 设置群成员的角色
    setTopicInfo 设置话题属性
    transferGroupOwner 转让群主

    离线推送相关接口

    API 描述
    doBackground APP 检测到应用退后台时可以调用此接口
    doForeground APP 检测到应用返回到前台时可以调用此接口
    setOfflinePushConfig 设置离线推送配置信息
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持