You need to enable JavaScript to run this app.
导航

概览

最近更新时间2024.01.23 21:46:40

首次发布时间2023.04.24 11:11:45

BytedIM

IM 类,所有 API 交互都通过该类的实例来操作,实例化支持的参数参见 IMOption

方法描述
init初始化 SDK。
初始化时会完成与服务端的消息游标同步和历史信息同步。
createCustomMessage创建自定义消息。
createTextMessage创建文本消息。
sendMessage发送消息。
deleteMessage删除消息。(直播群不适用)
recallMessage撤回消息。(直播群不适用)
getMessageByServerId根据指定会话中的消息服务端 ID 获取对应消息 (直播群不适用)
getMessageReferenceList获取引用消息链。(直播群不适用)
若消息 B 引用了消息 A,消息 C 引用了消息 B,那么 A -> B -> C 就是一条引用消息链。通过 A、B、C 任意一条消息都可以获取这条消息链。
modifyMessageProperty设置消息属性,常见使用场景:给某条消息点赞、加急等。(直播群不适用)
getConversation获取指定单个本地会话。(直播群不适用)
getConversationOnline请求服务端更新本地会话后,获取指定单个会话。
getConversationList获取本地会话列表。
getConversationListOnline请求服务端更新本地会话后,获取会话列表。直播群列表请使用 getLiveConversationListOnline
getMessagesByConversation从服务器获取会话内区间的消息,默认情况下从本地最早的消息开始拉取 (cursor = conversation.firstMessageIndex) 。拉取直播群区间消息请使用 getLiveGroupHistoryMessageListOnline。
getUserConversationList请求服务器获取用户的会话列表。
createConversation创建群聊。
leaveConversation离开群组。
deleteConversation删除会话。(直播群不适用)
dissolveConversation解散群聊。
setConversationSettingInfo设置会话附加信息,如置顶、免打扰、收藏等。(直播群不适用)
setConversationWeakMuteConfig配置会话低打扰模式。(直播群不适用)
upsertConversationSettingExtInfo更新 Setting ext 拓展信息。(直播群不适用)
setConversationCoreInfo设置群聊信息。
upsertConversationCoreExtInfo更新 Core ext 拓展信息。
getConversationListByTop获取顶置会话。(直播群不适用)
getConversationListByFavorite获取收藏会话。(直播群不适用)
markConversationRead标记会话已读。(直播群不适用)
addParticipants添加群成员。(直播群不适用,如需加入直播群请在用户端加入直播群 joinLiveGroup)
removeParticipants移除普通群成员/移除直播群内其它成员,v1.1.0 新增直播群功能。
注:如需自己退出直播群,请使用 leaveLiveGroup
updateParticipant更新群成员信息。
getParticipants获取 SDK 本地维护的群成员列表。(直播群不适用)
getParticipantsOnline从服务端获取群成员列表。
setConversationMute设置群禁言(会话维度)。
setParticipantMuteTime设置群禁言(成员维度)。
dispose手动卸载 SDK。

MultimediaPlugin

多媒体消息插件,在 IM 实例化时传入后,IM 实例增加发送媒体消息的方法。

方法描述
createImageMessage创建图片消息。
createAudioMessage创建音频消息。
createVideoMessage创建视频消息。
createFileMessage创建文件消息。
refreshFileUrl根据消息内容刷新文件 URL。
validateFileUrl校验文件 URL 是否在有效期。
getImageResizeUrls获取图片 URL(缩放、转码)。

LivePlugin

直播群插件,在 IM 实例化时传入后,IM 实例增加直播群相关的方法。v1.1.0 新增。

方法描述
joinLiveGroup加入直播群,加入成功时会启动直播 ping 和断线恢复重进(接口基于 addParticipants)
leaveLiveGroup离开直播群,并且会停止直播 ping(接口基于 removeParticipants)
setParticipantBlockTime拉黑直播群成员。
getMuteParticipantsOnline获取直播群禁言成员列表。
getBlockParticipantsOnline获取直播群被拉黑成员列表。
getLiveParticipantMuteWhiteListOnline获取直播群禁言白名单。
addLiveParticipantMuteWhiteList添加指定成员到直播群禁言白名单。
removeLiveParticipantMuteWhiteList从直播群禁言白名单移除指定成员。
getLiveConversationListOnline获取直播群列表。
getLiveParticipantsOnline获取直播群在线成员列表。
getLiveParticipantCountOnline获取直播群在线人数
getLiveParticipantInfoOnline获取直播群指定成员状态信息(例如是否在线、最后活跃时间),v1.1.2 新增。
getLiveParticipantDetailOnline获取直播群指定成员资料(例如成员在群中的昵称、头像),v1.5.0 新增。
getLiveGroupHistoryMessageListOnline获取直播群历史消息
updateLiveConversationMarks更新直播群内的标记类型
getLiveConversationMarksOnline获取直播群内的标记类型
updateLiveParticipantsMarks更新直播群内指定成员的标记,需要先在群中创建好对应标记类型

ContactPlugin

联系人插件,提供好友关系等能力;在 IM 实例化时传入后,IM 实例增加联系人相关的方法。v1.2.0 新增。

方法描述
getFriendReceiveApplyListOnline获取好友申请列表。
getFriendListOnline获取好友列表。
applyFriend申请添加好友。
deleteFriend删除好友。
replyFriendApply回应好友申请。
markFriendReceiveApplyAsRead标记好友申请已读。(用于同步申请未读数等场景)
addUserToBlack将指定用户加入黑名单
removeUserFromBlack将指定用户从黑名单移除
userIsInMyBlack检查用户是否在黑名单中
updateBlackUserState更新指定用户黑名单条目(例如更新 ext)
getBlacklistOnline获取用户黑名单
updateFriend更新好友信息
getUserProfilesOnline获取用户资料
setUserProfile设置用户资料

EventBus

方法描述
subscribe创建一个事件订阅
unsubscribe取消一个事件订阅