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

初始化登录

方法描述
sharedInstance获取 BIMClient 单例。
initSDK:config:初始化 SDK。
unInitSDK注销 SDK，释放内存缓存资源、注销监听等。
getVersion获取 SDK 版本号。
getCurrentUserID获取当前用户 ID。
getToken获取当前用户 Token。
login:token:completion:登录服务器。
logoutWithCompletion:登出服务器。
addConnectListener:设置长链状态监听。
removeConnectListener:移除长链状态监听。
getConnectStatus获取连接状态。
getServerTime获取服务端时间。
getDid:获取设备 did。

消息收发

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

群组会话

方法描述
addGroupMemberList:memberList:completion:添加群成员。
removeGroupMemberList:uidList:completion:移除群成员。
getConversationMemberList:获取群成员。
createGroupConversation:completion:创建群聊。
setGroupName:name:completion:设置群组名称。
setGroupNotice:notice:completion:设置群公告。
setGroupMemberRole:uidList:role:completion:设置群成员角色。
dissolveGroup:completion:解散群组。
leaveGroup:completion:离开群组。
createSingleConversation:completion:创建单聊会话。
addConversationListener:添加会话监听。
removeConversationListener:移除会话监听。
getConversationList:count:completion:获取本地会话列表。
getConversation:completion:获取指定单个会话。
getConversationByShortID:isServer:completion:返回查询到的会话。
getConversationByShortIDList:isServer:completion:返回批量查询到的会话。
deleteConversation:completion:通过会话 ID 删除会话。
deleteConversationWithToUid:completion:通过用户 ID 删除会话。
stickTopConversation:isStickTop:completion:置顶会话。
markConversationRead:completion:标记会话已读。
setConversationDraft:draft:设置会话草稿。
getTotalUnreadMessageCount:获取所有会话的未读消息总数。
setConversationLocalExt:value:completion:设置会话本地额外信息。
setConversationMyExt:value:completion:设置会话私有额外信息。
setConversationCoreExt:value:completion:设置会话额外信息。
refreshMediaMessage:completion:刷新媒体信息，媒体 URL 过期时调用该方法。
modifyMessageProperty:propertyItems:completion:批量修改消息属性。
muteConversation:mute:completion:设置会话免打扰。
modifyMessage:completion:修改消息内容和额外信息。
markConversationMessagesRead:completion:发送会话已读回执，该方法仅适用于单聊会话。
markConversationRead:beforeMessage:completion:以指定消息标记已读。

直播群

方法描述
createLiveGroup:completion:创建直播群。
joinLiveGroup:completion:加入直播群。
joinLiveGroup:memberInfo:completion:加入直播群并设置当前用户成员信息。
leaveLiveGroup:completion:离开直播群。
dissolveLiveGroup:completion:解散直播群（仅群主）。
addLiveConversationListener:设置直播群会话监听。
addLiveGroupMemberBlockList:uidList:completion:添加直播群成员黑名单。
addLiveGroupMemberListener:设置直播群成员监听。
addLiveGroupMessageListener:设置直播群消息监听。
getALLLiveGroupList:count:completion:获取所有直播群列表。
getLiveGroup:completion:获取直播群信息。
getLiveGroupMemberBlockList:cursor:count:completion:获取直播群成员黑名单。
getLiveGroupMemberOnlineList:cursor:count:completion:获取直播群在线成员列表。
getLiveGroupMemberSilentList:cursor:count:completion:获取直播群被禁言成员列表。
kickLiveGroupMemberList:uidList:completion:踢出直播群成员。
removeLiveConversationListener:移除直播群会话监听。
removeLiveGroupMemberBlockList:uidList:completion:移除直播群成员黑名单。
removeLiveGroupMemberListener:移除直播群成员监听。
removeLiveGroupMessageListener:移除直播群消息监听。
setLiveGroupDescription:description:completion:设置直播群描述。
setLiveGroupIcon:url:completion:设置直播群头像。
setLiveGroupName:name:completion:设置直播群名称。
setLiveGroupNotice:notice:completion:设置直播群公告。
setLiveGroupSilent:isSilent:completion:设置直播群禁言(所有人)。
transLiveGroupOwner:uid:completion:转让群主。
addLiveGroupAdmin:uidList:completion:设置直播群管理员。
addLiveGroupMemberSilentList:uidList:blockTime:completion:设置直播群禁言(指定用户)。
addLiveGroupMemberSilentWhiteList:uidList:completion:添加禁言会话白名单。
getLiveGroupMemberList:cursor:count:completion:获取直播群群主管理员等常驻成员列表。
getLiveGroupMemberOnlineInfo:uidList:completion:获取直播群成员在线信息。
getLiveGroupMemberSilentWhiteList:cursor:count:completion:获取直播群会话禁言白名单。
getLiveGroupOnlineMemberCount:completion:获取直播群在线人数。
getOwnerLiveGroupList:count:completion:获取我是群主和管理员的直播群列表。
removeLiveGroupAdmin:uidList:completion:移除直播群管理员。
removeLiveGroupMemberSilentList:uidList:completion:设置直播群用户解除禁言(指定用户)。
removeLiveGroupMemberSilentWhiteList:uidList:completion:移除禁言会话白名单。
sendLiveGroupMessage:conversation:completion:发送直播群消息。
sendLiveGroupMessage:conversation:priority:completion:发送直播群消息。
getLiveGroupHistoryMessageList:cursor:limit:completion:获取直播群历史消息(从新到旧)。
setLiveGroupMemberInfo:memberInfo:completion:设置直播群成员信息，覆盖服务端存储。
setLiveGroupMemberAlias:alias:completion:设置直播群成员昵称。
setLiveGroupMemberAvatar:avatarUrl:completion:设置直播群成员头像。
addLiveGroupMemberExt:ext:completion:设置直播群成员自定义信息，相同 key 会覆盖。
getLiveGroupMemberInfo:uid:completion:获取直播群成员信息，其中包括当前在直播群的成员以及群主管理员，退出群的游客信息无法获取。
refreshLiveGroupMediaMessage:completion:刷新直播群媒体信息，媒体 URL 过期时调用该方法。
addLiveGroupMarkTypeListener:新增直播群标记事件监听。
removeLiveGroupMarkTypeListener:移除直播群标记事件监听。
markLiveGroupMemberList:uidList:action:markTypeList:completion:标记群成员。
getLiveGroupMarkTypeList:completion:获取群聊标记类型列表。
getLiveGroupMemberOnlineList:cursor:count:markType:completion:根据标记获取直播群在线成员列表。
支持拉取近 1000 个在线游客。
manageLiveGroupMarkTypes:action:markTypeList:completion:管理群成员标记类型。

好友关系

方法描述
addFriendListener:设置联系人监听。
applyFriend:completion:申请添加好友。
deleteFriend:completion:删除好友。
getFriendApplyList:limit:completion:获取好友申请列表，按发起申请的时间排序（从新到旧）。
getFriendApplyUnreadCount:获取好友申请未读数。
getFriendListCompletion:获取好友列表（全量）。
markFriendApplyRead:标记好友申请列表已读。
removeFriendListener:移除联系人监听。
replyFriendApply:completion:回应好友申请。
addToBlackList:completion:添加该用户到黑名单。
deleteFromBlackList:completion:把该用户从黑名单中移除。
checkUserInBlackList:completion:校验用户是否在黑名单中。
getBlackListCompletion:获取黑名单信息（全量）。
getBlackList:limit:completion:分页获取黑名单信息，按照拉黑时间从新到旧。
updateFriend:alias:completion:修改好友备注名。
addFriendConversationListener:添加好友会话监听。
removeFriendConversationListener:移除好友会话监听。
getFriendConversationList:count:completion:获取好友会话列表。
getFriendConversationListTotalUnreadCount:获取所有好友会话的未读消息总数。

用户资料

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

初始化登录

回调描述
onTokenInvalidToken 失效回调。
onConnectStatusChanged:长链状态改变回调。

消息收发

回调描述
onDeleteMessage:收到的消息被删除。
onRecallMessage:收到的消息被撤回。
onReceiveMessage:收到新消息。
onSendMessage:发送消息入库完成。
onUpdateMessage:收到的消息被修改。（内容+扩展）
onReceiveMessagesReadReceipt:收到消息已读回执。废弃接口，请使用 onReceiveReadReceipt 代替。
onReceiveReadReceipt:收到消息已读回执。
onReceiveP2PMessage:收到自定义透传消息。
onSendP2PMessage:发送自定义透传消息。

群组会话

回调描述
onConversationChanged:会话发生更新。
某些会话的关键信息发生变化（未读计数发生变化、最后一条消息被更新等等），可以根据会话的 lastMessage 重新对会话列表做排序。
onConversationDeleted:会话被删除。
onNewConversation:获取到新的会话。
onTotalUnreadMessageCountChanged:会话未读消息数发生变化。
onConversationRead:fromUid:收到会话已读回执。

直播群

回调描述
onConversationChanged:会话发生更新。
onMemberJoined:memberList:成员加入直播群。
onMemberLeave:memberList:成员离开直播群。
onMemberKicked:memberList:operatorID:成员被踢出直播群。
onMemberOwnerChanged:fromUID:toUID:群主发生变化。
onMemberSilent:memberSilentList:status:operatorID:群成员被禁言/解禁。
onAllMemberSilent:status:禁言、取消会话(禁言、取消所有人)。
onReceiveMessage:收到新消息。
onSendMessage:发送消息请求前调用。
onDeleteMessage:收到的消息被删除。
onUpdateMessage:收到的消息被修改。（内容+扩展）
onAddAdmin:memberList:operatorID:添加管理员
onRemoveAdmin:memberList:operatorID:移除管理员。
onMemberInfoChanged:member:成员信息变更。
onMarkTypesAdded:changeInfo:新增标记类型。
onMarkTypesDeleted:changeInfo:删除标记类型。
onBatchMemberInfoChanged:members:批量成员信息变更。

好友关系

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

用户资料

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