You need to enable JavaScript to run this app.
导航
实时音视频
  • 文档首页
    • /实时音视频/即时通讯 IM/客户端 API 参考/Android/概览
概览
最近更新时间：2024.12.04 19:16:14首次发布时间：2023.04.24 11:11:45
我的收藏
方法

初始化登录

方法描述
getInstance获取 BIMClient 单例
initSDK初始化 SDK。
initSDK初始化 SDK。
你可以设置使用国内或海外环境。
unInitSDK注销 SDK, 释放内存缓存资源、注销监听等。
getVersion获取 SDK 版本号名称。
getVersionCode获取 SDK 版本号。
getAppID获取当前 appID。
getCurrentUserID获取当前用户 ID。
getToken获取当前用户 Token。
login登录服务器。
logout登出服务器。
logout登出服务器。
addConnectListener设置长链状态监听。
removeConnectListener设置长链状态监听。
getConnectStatus获取连接状态。
getServerTime获取服务端时间。
getSDKDid获取设备 did。

消息收发

方法描述
addMessageListener设置消息监听。
removeMessageListener移除消息监听。
createTextMessage创建文本消息。
createTextMessage创建带 @ 标记的消息。
createTextMessage创建带引用消息的文本消息。
createCustomMessage创建自定义消息。
createImageMessage创建图片消息。
createImageMessage创建图片消息。
createAudioMessage创建语音消息。
createAudioMessage创建语音消息。
createVideoMessage创建视频消息。
createVideoMessage创建视频消息。
createFileMessage创建文件消息。
sendMessage发送消息。
deleteMessage删除本地和服务端消息。
recallMessage撤回消息。
addLocalMessage添加消息到本地。
deleteLocalMessage删除本地消息。
getHistoryMessageList获取历史消息（锚点之前的消息），返回消息顺序从新到旧。
getNewerMessageList获取历史消息（锚点之后的消息），返回消息顺序从旧到新。
getMessagesReadReceipt从服务端批量获取消息已读回执。
sendMessageReadReceipts发送消息已读回执。
getMessage返回查询到的消息。
getMessageByServerID返回查询到的消息。
getLocalMessageListByType获取指定消息类型的本地历史消息（锚点之后的消息），返回消息顺序从旧到新。
sendP2PMessage发送自定义透传消息（会话纬度），给会话内所有用户发送自定义透传消息。
sendP2PMessage发送自定义透传消息（用户纬度），给指定用户发送自定义透传消息。
searchLocalMessage搜索本地消息。
searchLocalMessageWithMsgType按照消息类型和关键词搜索本地消息。
searchLocalGlobalMessage按照关键词搜索全局本地消息
downloadFile下载消息体附件到本地，不建议直播群调用。
cancelMediaFileMessageUpload取消文件上传。
getConversationUnReadMessageList获取未读历史消息，返回消息顺序从新到旧。

群组会话

方法描述
addGroupMemberList添加群成员。
removeGroupMemberList移除群成员。
getConversationMemberList获取群成员。
createGroupConversation创建群聊。
setGroupName设置群组名称。
setGroupNotice设置群公告。
setGroupMemberRole设置群成员角色。
dissolveGroup解散群组。
leaveGroup离开群组。
createSingleConversation创建单聊会话。
addConversationListener添加会话监听。
removeConversationListener移除会话监听。
getConversationList获取会话列表。
getConversation获取指定单个会话。
getConversationByShortID返回查询到的会话。
getConversationByShortIDList返回批量查询到的会话。
deleteConversation通过用户 ID 删除会话。
deleteConversation通过会话 ID 删除会话。
stickTopConversation置顶会话。
markConversationRead标记会话已读。
markConversationRead以指定消息标记已读。
setConversationDraft设置会话草稿。
getTotalUnreadMessageCount获取所有会话的未读消息总数。
setConversationLocalExt设置会话本地额外信息。
setConversationMyExt设置会话私有额外信息。
setConversationCoreExt设置会话额外信息。
refreshMediaMessage刷新媒体信息，媒体 URL 过期时调用该方法。
modifyMessageProperty批量修改消息属性。
muteConversation设置会话免打扰。
modifyMessage修改消息内容和ext。
markConversationMessagesRead发送会话已读回执，该方法仅适用于单聊会话。
setMessageLocalExt设置消息额外信息。
searchLocalGlobalGroup按照关键词搜索本地群组 (会话名称、群成员昵称、群成员好友备注、群成员 uid)。
searchLocalGroupMember搜索群组成员(昵称、好友备注、uid)
searchLocalGlobalEmptyGroup按照关键词搜索本地无消息的群组 (会话名称、群成员昵称、群成员好友备注、群成员 uid)。

直播群

方法描述
createLiveGroup创建直播群。
joinLiveGroup加入直播群，加入直播群后可以收发当前群的信息，直播群不提供本地存储。
joinLiveGroup加入直播群并设置当前用户成员信息。
leaveLiveGroup离开直播群。
dissolveLiveGroup解散直播群，仅群主可操作。
addLiveConversationListener设置直播群会话监听。
addLiveGroupMemberListener设置直播群成员监听。
addLiveGroupMessageListener设置直播群消息监听。
removeLiveConversationListener移除直播群会话监听。
removeLiveGroupMemberListener移除直播群成员监听。
removeLiveGroupMessageListener设置直播群消息监听。
addLiveGroupMemberBlockList添加群进群黑名单。
addLiveGroupMemberSilentList添加群成员禁言。
getAllLiveGroupList获取当前应用下的所有直播群列表。
getLiveGroup获取直播群信息。
getLiveGroupMemberBlockList获取直播群进群黑名单。
getLiveGroupMemberOnlineList获取直播群在线用户列表。
getLiveGroupMemberOnlineList根据标记获取直播群在线用户列表。
支持拉取近 1000 个在线游客。
getLiveGroupMemberSilentList获取直播群禁言用户列表。
getOwnerLiveGroupList获取我是群主的直播群列表。
kickLiveGroupMemberList踢出在线成员。
removeLiveGroupMemberBlockList添加群进群黑名单。
removeLiveGroupMemberSilentList移出群成员禁言。
sendLiveGroupMessage发送直播群消息。
sendLiveGroupMessage发送直播群消息。
setLiveGroupDescription设置群描述。
setLiveGroupIcon设置群头像。
setLiveGroupName设置群名称。
setLiveGroupNotice设置群公告。
setLiveGroupSilent设置会话禁言(所有成员禁言)。
transLiveGroupOwner转让群主。
addLiveGroupAdmin设置直播群管理员。
addLiveGroupMemberSilentWhiteList添加禁言会话白名单。
getLiveGroupMemberList获取直播群群主管理员等常驻成员列表。
getLiveGroupMemberOnlineInfo获取直播群成员在线信息。
getLiveGroupMemberSilentWhiteList获取会话禁言白名单。
getLiveGroupOnLineCount获取直播群在线人数。
removeLiveGroupAdmin移除直播群管理员。
removeLiveGroupMemberSilentWhiteList移除禁言会话白名单。
setLiveGroupMemberRole设置成员角色。
getLiveGroupHistoryMessageList获取直播群历史消息(从新到旧)。
setLiveGroupMemberInfo设置直播群成员信息，覆盖服务端存储。
setLiveGroupMemberAlias设置直播群成员昵称。
setLiveGroupMemberAvatar设置直播群成员头像。
addLiveGroupMemberExt设置直播群成员自定义信息，相同 key 会覆盖。
getLiveGroupMemberInfo获取直播群成员信息，其中包括当前在直播群的成员以及群主管理员，退出群的游客信息无法获取。
refreshLiveGroupMediaMessage刷新直播群媒体信息，媒体 URL 过期时调用该方法。
addLiveGroupMarkTypeListener新增直播群标记事件监听。
removeLiveGroupMarkTypeListener移除直播群标记事件监听。
markLiveGroupMemberList标记群成员。
getLiveGroupMarkTypeList获取群聊标记类型列表。
manageLiveGroupMarkTypes管理群成员标记类型。

好友关系

方法描述
addFriendListener设置联系人监听。
applyFriend申请添加好友。
deleteFriend删除好友。
getFriendApplyList获取好友申请列表，按发起申请的时间排序（从新到旧）。
getFriendApplyUnreadCount获取好友申请未读数。
getFriendList获取好友列表（全量）。
markFriendApplyRead标记好友申请已读。
removeFriendListener移除联系人监听。
replyFriendApply回应好友申请。
addToBlackList添加该用户到黑名单。
deleteFromBlackList把该用户从黑名单中移除。
checkUserInBlackList校验用户是否在黑名单中。
getBlackList获取黑名单信息（全量）。
getBlackList分页获取黑名单信息，按照拉黑时间从新到旧。
updateFriendAlias修改好友备注名。
addFriendConversationListener添加好友会话监听。
getFriendConversationList获取好友会话列表。
getFriendConversationListTotalUnreadCount获取所有好友会话的未读消息总数。
removeFriendConversationListener移除好友会话监听。
searchLocalGlobalFriend按照关键词搜索本地好友 (昵称、好友备注、uid)。

用户资料

方法描述
getUserFullInfo获取用户全量信息，首先查询本地用户数据，不存在则拉取服务端用户信息。
getUserFullInfo获取用户全量信息，首先查询本地用户数据，不存在则拉取服务端用户信息。
getUserFullInfoList获取用户全量信息，首先查询本地用户数据，不存在则拉取服务端用户信息。
getUserFullInfoList获取用户全量信息，首先查询本地用户数据，不存在则拉取服务端用户信息。
setUserSelfPortrait更新用户头像信息。
setUserSelfNickName更新用户昵称。
setUserSelfExt更新用户额外信息。
updateUserSelfProfile更新用户信息详情。
回调

初始化登录

回调描述
onTokenInvalidToken 失效回调。
onConnectStatusChanged长链状态改变回调。
onLog主线程日志回调。
onSyncServerFailed同步服务端会话、消息数据失败。
onSyncServerFinish同步服务端会话、消息数据成功。
onSyncServerStart开始同步服务端会话、消息数据。

消息收发

回调描述
onDeleteMessage收到的消息被删除。
onRecallMessage收到的消息被撤回。
onReceiveMessage收到新消息。
onSendMessage发送消息入库完成。
onUpdateMessage收到的消息被修改。（内容+扩展）
onReceiveMessagesReadReceipt收到单聊消息已读回执(已过时)。
onReceiveReadReceipt收到消息已读回执。

群组会话

回调描述
onConversationChanged会话发生更新。
onConversationDelete会话被删除。
onNewConversation获取到新的会话。
onTotalUnreadMessageCountChanged会话未读消息数发生变化。
onConversationRead收到会话已读回执。

直播群

回调描述
onConversationChanged直播群信息发生变化。
onMemberJoined成员加入群聊。
onMemberLeave成员退出群聊。
onMemberKicked成员被踢出直播群。
onMemberOwnerChanged群主发生变化。
onMemberSilent群成员被禁言。
onAllMemberSilent禁言、取消会话(禁言、取消所有人)。
onReceiveMessage收到新消息。
onSendMessage发送消息入库完成。
onDeleteMessage收到的消息被删除。
onUpdateMessage收到的消息被修改。（内容+扩展）
onAddAdmin添加管理员。
onRemoveAdmin添加管理员移除管理员。
onMemberInfoChanged成员信息变更。
onMarkTypesAdd直播群新增标记类型。
onMarkTypesDeleted直播群删除标记类型。
onBatchMemberInfoChanged批量成员信息变更。

好友关系

回调描述
onFriendAdd好友新增（同意好友）。
onFriendApply申请成为好友回调。
onFriendAgree通过好友申请。
onFriendRefuse拒绝好友申请。
onFriendApplyUnreadCountChanged好友申请未读数变化
onFriendDelete删除好友回调。
onBlackListAdd新添加黑名单回调。
onBlackListDelete删除黑名单回调。
onBlackListUpdate修改黑名单回调。
onFriendUpdate好友信息变更回调。

用户资料

回调描述
onUserProfileUpdate用户信息更新回调。