BIMClient

@interface BIMClient : NSObject
objectivec

BIMClient Class
IM SDK 对外接口类，通过此类提供所有 IM SDK 能力接口。

静态函数

返回	名称
instancetype	sharedInstance

成员函数

返回	名称
BOOL	initSDK:config:
void	unInitSDK
void	addConnectListener:
void	removeConnectListener:
NSString*	getVersion
long long	getServerTime
BIMConnectStauts	getConnectStatus
void	login:token:completion:
void	logoutWithCompletion:
NSString*	getCurrentUserID
NSString*	getToken
void	addMessageListener:
void	removeMessageListener:
BIMMessage*	createTextMessage:
BIMMessage*	createTextMessage:atUserList:
BIMMessage*	createTextAtMessage:atUserList:refMessage:hint:
BIMMessage*	createCustomMessage:
BIMMessage*	createImageMessage:
BIMMessage*	createAudioMessage:
BIMMessage*	createVideoMessage:
BIMMessage*	createFileMessage:fileName:
NSString*	sendMessage:conversationId:saved:progress:completion:
NSString*	addLocalMessage:conversationId:saved:
void	deleteMessage:completion:
void	deleteLocalMessage:completion:
void	recallMessage:completion:
void	getHistoryMessageList:option:completion:
void	getNewerMessageList:option:completion:
void	refreshMediaMessage:completion:
void	getDid:

函数说明

sharedInstance

+ (instancetype)sharedInstance;
objectivec

获取 BIMClient 单例。

返回值
BIMClient 单例。

initSDK:config:

- (BOOL)initSDK:(int)sdkAppID config:(BIMSDKConfig *)config;
objectivec

初始化 SDK。

传入参数

参数名	类型	说明
sdkAppID	int	从控制台获取的应用 ID。不同应用 ID 无法进行互通。
config	BIMSDKConfig*	配置信息，参看 BIMSDKConfig。

返回值

true: 成功。
false: 失败。

unInitSDK

- (void)unInitSDK;
objectivec

注销 SDK，释放内存缓存资源、注销监听等。

addConnectListener:

- (void)addConnectListener:(id<BIMConnectListener>)listener;
objectivec

设置长链状态监听。

传入参数

参数名	类型	说明
listener	id	长链状态监听方，参看 BIMConnectListener。

removeConnectListener:

- (void)removeConnectListener:(id<BIMConnectListener>)listener;
objectivec

移除长链状态监听。

传入参数

参数名	类型	说明
listener	id	长链状态监听方，参看 BIMConnectListener。

getVersion

- (NSString*)getVersion;
objectivec

获取 SDK 版本号。

返回值
SDK 版本号。

getServerTime

- (long long)getServerTime;
objectivec

获取服务端时间。

返回值
服务端时间戳，单位为毫秒。

getConnectStatus

- (BIMConnectStauts)getConnectStatus;
objectivec

获取连接状态。

返回值
连接状态，参看 BIMConnectStauts。

- (void)login:(NSString *)userID token:(NSString *)token completion:(BIMCompletion)completion;
objectivec

登录服务器。

传入参数

参数名	类型	说明
userID	NSString*	用户 ID。
token	NSString*	用户 Token。
completion	BIMCompletion	登录完成回调，其中 `error` 参看 BIMErrorCode。

logoutWithCompletion:

- (void)logoutWithCompletion:(BIMCompletion)completion;
objectivec

登出服务器。

传入参数

参数名	类型	说明
completion	BIMCompletion	登出完成回调，其中 `error` 参看 BIMErrorCode。

getCurrentUserID

- (NSString *)getCurrentUserID;
objectivec

获取当前用户 ID。

返回值
用户 ID。

getToken

- (NSString *)getToken;
objectivec

获取当前用户 Token。

返回值
用户 Token。

addMessageListener:

- (void)addMessageListener:(id<BIMMessageListener>)listener;
objectivec

设置消息监听。

传入参数

参数名	类型	说明
listener	id	消息监听方，参看 BIMMessageListener。

removeMessageListener:

- (void)removeMessageListener:(id<BIMMessageListener>)listener;
objectivec

移除消息监听。

传入参数

参数名	类型	说明
listener	id	消息监听方，参看 BIMMessageListener。

createTextMessage:

- (BIMMessage *)createTextMessage:(NSString *)text;
objectivec

创建文本消息。

传入参数

参数名	类型	说明
text	NSString*	消息文本。

返回值
消息体，参看 BIMMessage。

createTextMessage:atUserList:

- (BIMMessage *)createTextMessage:(NSString *)text atUserList:(NSArray<NSNumber *> *)atUserList;
objectivec

创建带 @ 标记的消息。

传入参数

参数名	类型	说明
text	NSString*	消息文本。
atUserList	NSArray<NSNumber>**	需要 @ 的用户列表。

返回值
消息体，参看 BIMMessage。

注意
仅可在群组中发送带 @ 标记的消息。

createTextAtMessage:atUserList:refMessage:hint:

- (BIMMessage *)createTextAtMessage:(NSString *)text atUserList:(NSArray<NSNumber *> *)atUserList refMessage:(BIMMessage *)refMessage hint:(NSString *)hint;
objectivec

创建带引用消息的文本消息。

传入参数

参数名	类型	说明
text	NSString*	消息文本。
atUserList	NSArray<NSNumber>**	需要 @ 的用户列表。
refMessage	BIMMessage*	引用的消息，参看 BIMMessage。
hint	NSString*	业务透传的引用信息

返回值
消息体，参看 BIMMessage。

createCustomMessage:

- (BIMMessage *)createCustomMessage:(NSDictionary *)content;
objectivec

创建自定义消息。

传入参数

参数名	类型	说明
content	NSDictionary*	自定义参数。

返回值
消息体，参看 BIMMessage。

createImageMessage:

- (BIMMessage *)createImageMessage:(NSString *)imagePath;
objectivec

创建图片消息。

传入参数

参数名	类型	说明
imagePath	NSString*	图片路径。

返回值
消息体，参看 BIMMessage。
@note 若图片来自系统相册，需要先把图片导入 App 目录下。

createAudioMessage:

- (BIMMessage *)createAudioMessage:(NSString *)audioFilePath;
objectivec

创建语音消息。

传入参数

参数名	类型	说明
audioFilePath	NSString*	音频路径。

返回值
消息体，参看 BIMMessage。

createVideoMessage:

- (BIMMessage *)createVideoMessage:(NSString *)videoFilePath;
objectivec

创建视频消息。

传入参数

参数名	类型	说明
videoFilePath	NSString*	视频路径。

返回值
消息体，参看 BIMMessage。
@note 若视频来自系统相册，需要先把视频导入 App 目录下。

createFileMessage:fileName:

- (BIMMessage *)createFileMessage:(NSString *)filePath fileName:(NSString *)fileName;
objectivec

创建文件消息。

传入参数

参数名	类型	说明
filePath	NSString*	文件路径。
fileName	NSString*	文件名称。

返回值
消息体，参看 BIMMessage。

sendMessage:conversationId:saved:progress:completion:

- (NSString *)sendMessage:(BIMMessage *)message conversationId:(NSString *)conversationId saved:(BIMMessageCompletion)saved progress:(BIMProgress)progress completion:(BIMMessageCompletion)completion;
objectivec

发送消息。
目前仅支持直接发送普通文本消息，发送图片消息、视频消息、语音消息、文件消息前请联系技术支持同学进行配置。

传入参数

参数名	类型	说明
message	BIMMessage*	消息体，由 `createXxxMessage` 接口创建，参看 BIMMessage。
conversationId	NSString*	会话 ID。
saved	BIMMessageCompletion	消息入库回调，其中message参看BIMMessage， `error` 参看 BIMErrorCode。
progress	BIMProgress	媒体消息上传进度回调。
completion	BIMMessageCompletion	发送结果回调，其中message参看BIMMessage， `error` 参看 BIMErrorCode。

addLocalMessage:conversationId:saved:

- (NSString *)addLocalMessage:(BIMMessage *)message conversationId:(NSString *)conversationId saved:(BIMMessageCompletion)saved;
objectivec

添加本地消息，不会发送到服务端。

传入参数

参数名	类型	说明
message	BIMMessage*	待发送的消息对象，需要通过对应的 createXXXMessage 接口进行创建。
conversationId	NSString*	回话id
saved	BIMMessageCompletion	消息入库回调，其中 message 参看 BIMMessage， `error` 参看 BIMErrorCode。

返回值
msgID 消息唯一标识

deleteMessage:completion:

- (void)deleteMessage:(BIMMessage *)message completion:(BIMCompletion)completion;
objectivec

删除本地和服务端消息。

传入参数

参数名	类型	说明
message	BIMMessage*	待删除的消息，参看 BIMMessage。
completion	BIMCompletion	结果回调，其中 message 参看 BIMMessage， `error` 参看 BIMErrorCode。

deleteLocalMessage:completion:

- (void)deleteLocalMessage:(BIMMessage *)message completion:(BIMCompletion)completion;
objectivec

删除本地消息。

传入参数

参数名	类型	说明
message	BIMMessage*	待删除的消息，参看 BIMMessage。
completion	BIMCompletion	结果回调，其中 `error` 参看 BIMErrorCode。

recallMessage:completion:

- (void)recallMessage:(BIMMessage *)message completion:(BIMCompletion)completion;
objectivec

撤回消息。

传入参数

参数名	类型	说明
message	BIMMessage*	待撤回的消息，参看 BIMMessage。
completion	BIMCompletion	结果回调，其中 `error` 参看 BIMErrorCode。

getHistoryMessageList:option:completion:

- (void)getHistoryMessageList:(NSString *)conversationId option:(BIMGetMessageOption *)option completion:(BIMMessageListCompletion)completion;
objectivec

获取历史消息（锚点之前的消息），返回消息顺序从新到旧。

传入参数

参数名	类型	说明
conversationId	NSString*	会话 ID。
option	BIMGetMessageOption*	获取消息选项，参看 BIMGetMessageOption。
completion	BIMMessageListCompletion	结果回调，其中message参看BIMMessage， `error` 参看 BIMErrorCode。

getNewerMessageList:option:completion:

- (void)getNewerMessageList:(NSString *)conversationId option:(BIMGetMessageOption *)option completion:(BIMMessageListCompletion)completion;
objectivec

获取历史消息（锚点之后的消息），返回消息顺序从旧到新。

传入参数

参数名	类型	说明
conversationId	NSString*	会话 ID。
option	BIMGetMessageOption*	获取消息选项，参看 BIMGetMessageOption。
completion	BIMMessageListCompletion	结果回调，其中message参看BIMMessage， `error` 参看 BIMErrorCode。

refreshMediaMessage:completion:

- (void)refreshMediaMessage:(BIMMessage *)message completion:(BIMCompletion)completion;
objectivec

刷新媒体信息，媒体 URL 过期时调用该方法。

传入参数

参数名	类型	说明
message	BIMMessage*	待刷新的消息，参看 BIMMessage。
completion	BIMCompletion	结果回调，其中 `error` 参看 BIMErrorCode。

getDid:

- (void)getDid:(BIMDeviceIDCompletion)completion;
objectivec

获取设备 did。

传入参数

参数名	类型	说明
completion	BIMDeviceIDCompletion	结果回调。

BIMClient (conversation)

@interface BIMClient (conversation)
objectivec

BIMClient (conversation) Class
IM SDK 会话对外接口类，通过此类提供所有会话能力接口。

成员函数

返回	名称
void	addConversationListener:
void	removeConversationListener:
void	getConversationList:count:completion:
void	getConversation:completion:
void	deleteConversation:completion:
void	deleteConversationWithToUid:completion:
void	setConversationDraft:draft:
void	stickTopConversation:isStickTop:completion:
void	muteConversation:mute:completion:
void	getTotalUnreadMessageCount:
void	markConversationRead:completion:
void	createSingleConversation:completion:
void	createGroupConversation:completion:
NSArray<id>*	getConversationMemberList:
void	setGroupName:name:completion:
void	setGroupNotice:notice:completion:
void	addGroupMemberList:memberList:completion:
void	removeGroupMemberList:uidList:completion:
void	leaveGroup:completion:
void	dissolveGroup:completion:
void	setGroupMemberRole:uidList:role:completion:

函数说明

addConversationListener:

- (void)addConversationListener:(id<BIMConversationListListener>)listener;
objectivec

添加会话监听。

传入参数

参数名	类型	说明
listener	id	会话监听方，参看 BIMConversationListListener。

removeConversationListener:

- (void)removeConversationListener:(id<BIMConversationListListener>)listener;
objectivec

移除会话监听。

传入参数

参数名	类型	说明
listener	id	会话监听方，参看 BIMConversationListListener。

getConversationList:count:completion:

- (void)getConversationList:(long long)cursor count:(int)count completion:(BIMConversationListCompletion)completion;
objectivec

获取会话列表。

传入参数

参数名	类型	说明
cursor	long long	分页拉取的游标，第一次默认取传 0。
count	int	分页拉取的个数。一次分页拉取不宜太多，否则可能影响拉取的速度，建议每次拉取 100 个会话。
completion	BIMConversationListCompletion	结果回调，其中 `*conversations` 是拉取到的会话，`hasMore`标记数据库是否还有会话，`error` 参看 BIMErrorCode。

注意

历史会话数量可能很多，因此建议采用分页查询的方式进行接口调用。
如果会话全部拉取完毕，结果回调 BIMConversationListCompletion 中的 hasMore 获取字段值为 NO。

getConversation:completion:

- (void)getConversation:(NSString *)conversationId completion:(BIMConversationCompletion)completion;
objectivec

获取指定单个会话。

传入参数

参数名	类型	说明
conversationId	NSString*	会话 ID。
completion	BIMConversationCompletion	结果回调，其中 `conversation` 是拉取到的会话 BIMConversation，`error` 参看 BIMErrorCode。

deleteConversation:completion:

- (void)deleteConversation:(NSString *)conversationId completion:(BIMCompletion)completion;
objectivec

通过会话 ID 删除会话。

传入参数

参数名	类型	说明
conversationId	NSString*	会话 ID。
completion	BIMCompletion	结果回调，`error` 参看 BIMErrorCode。

注意
调用本接口后，SDK 会从本地和服务端删除该会话及会话中的历史消息，且不可恢复。

deleteConversationWithToUid:completion:

- (void)deleteConversationWithToUid:(NSNumber *)toUid completion:(BIMCompletion)completion;
objectivec

通过用户 ID 删除会话。

传入参数

参数名	类型	说明
toUid	NSNumber*	对方用户ID。
completion	BIMCompletion	结果回调，`error` 参看 BIMErrorCode。

注意
调用本接口后，SDK 会从本地和服务端删除该会话及会话中的历史消息，且不可恢复。

setConversationDraft:draft:

- (void)setConversationDraft:(NSString *)conversationId draft:(NSString *)draft;
objectivec

设置会话草稿。

传入参数

参数名	类型	说明
conversationId	NSString*	会话 ID。
draft	NSString*	草稿内容。

stickTopConversation:isStickTop:completion:

- (void)stickTopConversation:(NSString *)conversationId isStickTop:(BOOL)isStickTop completion:(BIMCompletion)completion;
objectivec

置顶会话。

传入参数

参数名	类型	说明
conversationId	NSString*	会话 ID。
isStickTop	BOOL	是否置顶。
completion	BIMCompletion	结果回调，其中 `error` 参看 BIMErrorCode。

muteConversation:mute:completion:

- (void)muteConversation:(NSString *)conversationId mute:(BOOL)mute completion:(BIMCompletion)completion;
objectivec

设置会话免打扰。

传入参数

参数名	类型	说明
conversationId	NSString*	会话 ID。
mute	BOOL	是否设置为免打扰。
completion	BIMCompletion	结果回调，其中 `error` 参看 BIMErrorCode。

getTotalUnreadMessageCount:

- (void)getTotalUnreadMessageCount:(BIMConversationUnreadCountCompletion)completion;
objectivec

获取所有会话的未读消息总数。

传入参数

参数名	类型	说明
completion	BIMConversationUnreadCountCompletion	结果回调，其中 `unreadCount` 是获取到的未读数，`error` 参看 BIMErrorCode。

注意
会话未读消息不包括设置为免打扰会话中的未读消息。

markConversationRead:completion:

- (void)markConversationRead:(NSString *)conversationId completion:(BIMCompletion)completion;
objectivec

标记会话已读。

传入参数

参数名	类型	说明
conversationId	NSString*	会话 ID。
completion	BIMCompletion	结果回调，其中 `error` 参看 BIMErrorCode。

createSingleConversation:completion:

- (void)createSingleConversation:(NSNumber *)toUid completion:(BIMConversationCompletion)completion;
objectivec

创建单聊会话。

传入参数

参数名	类型	说明
toUid	NSNumber*	对方用户 ID。
completion	BIMConversationCompletion	结果回调，其中 `conversation` 是拉取到的会话，参看 BIMConversation，`error` 参看 BIMErrorCode

createGroupConversation:completion:

- (void)createGroupConversation:(NSSet<NSNumber *> *)uidList completion:(BIMConversationCompletion)completion;
objectivec

创建群聊。

传入参数

参数名	类型	说明
uidList	NSSet<NSNumber>**	用户 ID 列表。
completion	BIMConversationCompletion	结果回调，其中 `conversation` 是拉取到的会话，参看 BIMConversation，`error` 参看 BIMErrorCode

getConversationMemberList:

- (NSArray<id<BIMMember>> *)getConversationMemberList:(NSString *)conversationId;
objectivec

获取群成员。

传入参数

参数名	类型	说明
conversationId	NSString*	会话 ID。

返回值
群成员列表回调，参看 BIMMember。

setGroupName:name:completion:

- (void)setGroupName:(NSString *)conversationId name:(NSString *)name completion:(BIMCompletion)completion;
objectivec

设置群组名称。

传入参数

参数名	类型	说明
conversationId	NSString*	会话 ID。
name	NSString*	群组名称。
completion	BIMCompletion	完成回调，其中 `error` 参看 BIMErrorCode。

setGroupNotice:notice:completion:

- (void)setGroupNotice:(NSString *)conversationId notice:(NSString *)notice completion:(BIMCompletion)completion;
objectivec

设置群公告。

传入参数

参数名	类型	说明
conversationId	NSString*	会话 ID。
notice	NSString*	群公告内容。
completion	BIMCompletion	完成回调，其中 `error` 参看 BIMErrorCode。

addGroupMemberList:memberList:completion:

- (void)addGroupMemberList:(NSString *)conversationId memberList:(NSOrderedSet<NSNumber *> *)memberList completion:(BIMParticipantsCompletion)completion;
objectivec

添加群成员。

传入参数

参数名	类型	说明
conversationId	NSString*	会话 ID。
memberList	NSOrderedSet<NSNumber>**	待添加的群成员 ID 列表。
completion	BIMParticipantsCompletion	结果回调，其中 `*participants` 是群成员 ID, `error` 参看 BIMErrorCode。

removeGroupMemberList:uidList:completion:

- (void)removeGroupMemberList:(NSString *)conversationId uidList:(NSSet<NSNumber *> *)uidList completion:(BIMParticipantsCompletion)completion;
objectivec

移除群成员。

传入参数

参数名	类型	说明
conversationId	NSString*	会话 ID。
uidList	NSSet<NSNumber>**	待移除的群成员 ID 列表。
completion	BIMParticipantsCompletion	结果回调，其中 `*participants` 是群成员 ID，`error` 参看 BIMErrorCode。

leaveGroup:completion:

- (void)leaveGroup:(NSString *)conversationId completion:(BIMCompletion)completion;
objectivec

离开群组。

传入参数

参数名	类型	说明
conversationId	NSString*	会话 ID。
completion	BIMCompletion	结果回调，其中 `error` 参看 BIMErrorCode。

dissolveGroup:completion:

- (void)dissolveGroup:(NSString *)conversationId completion:(BIMCompletion)completion;
objectivec

解散群组。

传入参数

参数名	类型	说明
conversationId	NSString*	会话 ID。
completion	BIMCompletion	结果回调，其中 `error` 参看 BIMErrorCode。

setGroupMemberRole:uidList:role:completion:

- (void)setGroupMemberRole:(NSString *)conversationId uidList:(NSSet<NSNumber *> *)uidList role:(BIMMemberRole)role completion:(BIMCompletion)completion;
objectivec

设置群成员角色。

传入参数

参数名	类型	说明
conversationId	NSString*	会话 ID。
uidList	NSSet<NSNumber>**	需要更改身份的群成员列表。
role	BIMMemberRole	群组角色，参看 BIMMemberRole。
completion	BIMCompletion	结果回调，其中 `error` 参看 BIMErrorCode。

BIMClient (Friend)

@interface BIMClient (Friend)
objectivec

BIMClient (Friend) Class
IM SDK 联系人对外接口类，通过此类提供所有联系人能力接口。

成员函数

返回	名称
void	getFriendApplyList:limit:completion:
void	getFriendListCompletion:
void	applyFriend:completion:
void	replyFriendApply:completion:
void	deleteFriend:completion:
void	updateFriend:alias:completion:
void	markFriendApplyRead:
void	getFriendApplyUnreadCount:
void	addFriendListener:
void	removeFriendListener:
void	addToBlackList:completion:
void	deleteFromBlackList:completion:
void	checkUserInBlackList:completion:
void	getBlackListCompletion:
void	getBlackList:limit:completion:
void	setUserSelfPortrait:completion:
void	setUserSelfNickName:completion:
void	setUserSelfExt:completion:
void	updateUserSelfProfile:completion:
void	getUserFullInfo:completion:
void	getUserFullInfo:syncServer:completion:
void	getUserFullInfoList:completion:
void	getUserFullInfoList:syncServer:completion:

函数说明

getFriendApplyList:limit:completion:

- (void)getFriendApplyList:(long long)cursor limit:(long)limit completion:(BIMFriendApplyListCompletion)completion;
objectivec

获取好友申请列表，按发起申请的时间排序（从新到旧）。

传入参数

参数名	类型	说明
cursor	long long	游标，首页拉取可使用 0。
limit	long	查询条数。
completion	BIMFriendApplyListCompletion	完成回调，其中 `infos` 是好友申请信息，参看 BIMFriendApplyInfo，`error` 参看 BIMErrorCode。

getFriendListCompletion:

- (void)getFriendListCompletion:(BIMFriendListCompletion)completion;
objectivec

获取好友列表（全量）。

传入参数

参数名	类型	说明
completion	BIMFriendListCompletion	完成回调，其中 `infos` 是好友信息，参看 BIMUserFullInfo，`error` 参看 BIMErrorCode。

applyFriend:completion:

- (void)applyFriend:(BIMApplyInfo *)applyInfo completion:(BIMCompletion)completion;
objectivec

申请添加好友。

传入参数

参数名	类型	说明
applyInfo	BIMApplyInfo*	申请信息，参看 BIMApplyInfo。
completion	BIMCompletion	结果回调，其中 `error` 参看 BIMErrorCode。

replyFriendApply:completion:

- (void)replyFriendApply:(BIMReplyInfo *)replyInfo completion:(BIMCompletion)completion;
objectivec

回应好友申请。

传入参数

参数名	类型	说明
replyInfo	BIMReplyInfo*	回应信息, 参看 BIMReplyInfo。
completion	BIMCompletion	结果回调，其中 `error` 参看 BIMErrorCode。

deleteFriend:completion:

- (void)deleteFriend:(long long)uid completion:(BIMCompletion)completion;
objectivec

删除好友。

传入参数

参数名	类型	说明
uid	long long	联系人用户 ID。
completion	BIMCompletion	结果回调，其中 `error` 参看 BIMErrorCode。

updateFriend:alias:completion:

- (void)updateFriend:(long long)uid alias:(NSString *)alias completion:(BIMCompletion)completion;
objectivec

修改好友备注名。

传入参数

参数名	类型	说明
uid	long long	好友用户 ID。
alias	NSString*	好友备注名。
completion	BIMCompletion	结果回调，其中 `error` 参看 BIMErrorCode。

markFriendApplyRead:

- (void)markFriendApplyRead:(BIMCompletion)completion;
objectivec

标记好友申请列表已读。

传入参数

参数名	类型	说明
completion	BIMCompletion	结果回调，其中 `error` 参看 BIMErrorCode。

getFriendApplyUnreadCount:

- (void)getFriendApplyUnreadCount:(BIMFriendApplyUnreadCompletion)completion;
objectivec

获取好友申请未读数。

传入参数

参数名	类型	说明
completion	BIMFriendApplyUnreadCompletion	结果回调，其中 `error` 参看 BIMErrorCode。

addFriendListener:

- (void)addFriendListener:(id<BIMFriendListener>)listener;
objectivec

设置联系人监听。

传入参数

参数名	类型	说明
listener	id	联系人消息事件回调监听方，参看 BIMFriendListener。

removeFriendListener:

- (void)removeFriendListener:(id<BIMFriendListener>)listener;
objectivec

移除联系人监听。

传入参数

参数名	类型	说明
listener	id	结果回调，参看 BIMFriendListener 。

addToBlackList:completion:

- (void)addToBlackList:(BIMBlackListFriendInfo *)blackListFriendInfo completion:(BIMCompletion)completion;
objectivec

添加该用户到黑名单。

传入参数

参数名	类型	说明
blackListFriendInfo	BIMBlackListFriendInfo*	黑名单信息，参看BIMBlackListFriendInfo。
completion	BIMCompletion	结果回调，其中 `error` 参看 BIMErrorCode。

deleteFromBlackList:completion:

- (void)deleteFromBlackList:(long long)uid completion:(BIMCompletion)completion;
objectivec

把该用户从黑名单中移除。

传入参数

参数名	类型	说明
uid	long long	用户ID。
completion	BIMCompletion	结果回调，其中 `error` 参看 BIMErrorCode。

checkUserInBlackList:completion:

- (void)checkUserInBlackList:(long long)uid completion:(BIMCheckIsInBlackListCompletion)completion;
objectivec

校验用户是否在黑名单中。

传入参数

参数名	类型	说明
uid	long long	用户ID。
completion	BIMCheckIsInBlackListCompletion	结果回调，其中 `error` 参看 BIMErrorCode。

getBlackListCompletion:

- (void)getBlackListCompletion:(BIMFriendAllBlackListCompletion)completion;
objectivec

获取黑名单信息（全量）。

传入参数

参数名	类型	说明
completion	BIMFriendAllBlackListCompletion	结果回调，其中 `infos` 是黑名单好友信息，参看BIMUserFullInfo，`error` 参看 BIMErrorCode。

getBlackList:limit:completion:

- (void)getBlackList:(long long)cursor limit:(long long)limit completion:(BIMFriendBlackListCompletion)completion;
objectivec

分页获取黑名单信息，按照拉黑时间从新到旧。

传入参数

参数名	类型	说明
cursor	long long	游标，首页拉取可使用0。
limit	long long	查询条数。
completion	BIMFriendBlackListCompletion	结果回调，其中 `infos` 是黑名单好友信息，参看BIMUserFullInfo，`error` 参看 BIMErrorCode。

setUserSelfPortrait:completion:

- (void)setUserSelfPortrait:(NSString *)portraitUrl completion:(BIMCompletion)completion;
objectivec

更新用户头像信息。

传入参数

参数名	类型	说明
portraitUrl	NSString*	用户头像 url
completion	BIMCompletion	结果回调。

setUserSelfNickName:completion:

- (void)setUserSelfNickName:(NSString *)nickName completion:(BIMCompletion)completion;
objectivec

更新用户昵称。

传入参数

参数名	类型	说明
nickName	NSString*	用户昵称
completion	BIMCompletion	结果回调。

setUserSelfExt:completion:

- (void)setUserSelfExt:(NSDictionary<NSString *, NSString *> *)ext completion:(BIMCompletion)completion;
objectivec

更新用户额外信息。

传入参数

参数名	类型	说明
ext	NSDictionary<NSString, NSString>***	用户额外信息
completion	BIMCompletion	结果回调。

updateUserSelfProfile:completion:

- (void)updateUserSelfProfile:(BIMUserProfile *)profile completion:(BIMCompletion)completion;
objectivec

更新用户信息详情。

传入参数

参数名	类型	说明
profile	BIMUserProfile*	用户信息详情
completion	BIMCompletion	结果回调。

getUserFullInfo:completion:

- (void)getUserFullInfo:(long long)uid completion:(BIMUserFullInfoCompletion)completion;
objectivec

获取用户全量信息，首先查询本地用户数据，不存在则拉取服务端用户信息。

传入参数

参数名	类型	说明
uid	long long	用户 ID 。
completion	BIMUserFullInfoCompletion	结果回调，其中 `info` 是用户全量信息，参看 BIMUserFullInfo, `error` 参看 BIMErrorCode。

getUserFullInfo:syncServer:completion:

- (void)getUserFullInfo:(long long)uid syncServer:(BOOL)syncServer completion:(BIMUserFullInfoCompletion)completion;
objectivec

获取用户全量信息，首先查询本地用户数据，不存在则拉取服务端用户信息。

传入参数

参数名	类型	说明
uid	long long	用户 ID。
syncServer	BOOL	是否强制同步服务端数据，如 false 则优先使用本地数据
completion	BIMUserFullInfoCompletion	结果回调，其中 `info` 是用户全量信息，参看 BIMUserFullInfo, `error` 参看 BIMErrorCode。

getUserFullInfoList:completion:

- (void)getUserFullInfoList:(NSArray<NSNumber *> *)uidList completion:(BIMMUserFullInfoListCompletion)completion;
objectivec

获取用户全量信息，首先查询本地用户数据，不存在则拉取服务端用户信息。

传入参数

参数名	类型	说明
uidList	NSArray<NSNumber>**	用户 ID 列表。
completion	BIMMUserFullInfoListCompletion	结果回调，其中 `info` 是用户全量信息，参看 BIMUserFullInfo, `error` 参看 BIMErrorCode。

getUserFullInfoList:syncServer:completion:

- (void)getUserFullInfoList:(NSArray<NSNumber *> *)uidList syncServer:(BOOL)syncServer completion:(BIMMUserFullInfoListCompletion)completion;
objectivec

获取用户全量信息，首先查询本地用户数据，不存在则拉取服务端用户信息。

传入参数

参数名	类型	说明
uidList	NSArray<NSNumber>**	用户 ID 列表。
syncServer	BOOL	是否强制同步服务端数据，如 false 则优先使用本地数据
completion	BIMMUserFullInfoListCompletion	结果回调，其中 `info` 是用户全量信息，参看 BIMUserFullInfo, `error` 参看 BIMErrorCode。

BIMClient (FriendConversation)

@interface BIMClient (FriendConversation)
objectivec

BIMClient (FriendConversation) Class

成员函数

返回	名称
void	addFriendConversationListener:
void	removeFriendConversationListener:
void	getFriendConversationList:count:completion:
void	getFriendConversationListTotalUnreadCount:

函数说明

addFriendConversationListener:

- (void)addFriendConversationListener:(id<BIMConversationListListener>)listener;
objectivec

添加好友会话监听。

传入参数

参数名	类型	说明
listener	id	会话监听方，参看 BIMConversationListListener。

removeFriendConversationListener:

- (void)removeFriendConversationListener:(id<BIMConversationListListener>)listener;
objectivec

移除好友会话监听。

传入参数

参数名	类型	说明
listener	id	会话监听方，参看 BIMConversationListListener。

getFriendConversationList:count:completion:

- (void)getFriendConversationList:(long long)cursor count:(int)count completion:(BIMConversationListCompletion)completion;
objectivec

获取好友会话列表。

传入参数

参数名	类型	说明
cursor	long long	分页拉取的游标，第一次默认取传 0。
count	int	分页拉取的个数。一次分页拉取不宜太多，否则可能影响拉取的速度，建议每次拉取 100 个好友会话。
completion	BIMConversationListCompletion	结果回调，其中 `*conversations` 是拉取到的好友会话，`hasMore`标记数据库是否还有会话，`error` 参看 BIMErrorCode。

注意

历史好友会话数量可能很多，因此建议采用分页查询的方式进行接口调用。
如果好友会话全部拉取完毕，结果回调 BIMConversationListCompletion 中的 hasMore 获取字段值为 NO。

getFriendConversationListTotalUnreadCount:

- (void)getFriendConversationListTotalUnreadCount:(BIMConversationUnreadCountCompletion)completion;
objectivec

获取所有好友会话的未读消息总数。

传入参数

参数名	类型	说明
completion	BIMConversationUnreadCountCompletion	结果回调，其中 `unreadCount` 是获取到的未读数，`error` 参看 BIMErrorCode。

注意
会话未读消息不包括设置为免打扰会话中的未读消息。

BIMClient (liveGroup)

@interface BIMClient (liveGroup)
objectivec

BIMClient (liveGroup) Class
IM SDK 直播群对外接口类，通过此类提供所有直播群能力接口。

成员函数

返回	名称
void	addLiveGroupMessageListener:
void	removeLiveGroupMessageListener:
void	addLiveConversationListener:
void	removeLiveConversationListener:
void	addLiveGroupMemberListener:
void	removeLiveGroupMemberListener:
NSString*	sendLiveGroupMessage:conversation:completion:
NSString*	sendLiveGroupMessage:conversation:priority:completion:
void	getOwnerLiveGroupList:count:completion:
void	getALLLiveGroupList:count:completion:
void	getLiveGroup:completion:
void	createLiveGroup:completion:
void	joinLiveGroup:completion:
void	joinLiveGroup:memberInfo:completion:
void	leaveLiveGroup:completion:
void	dissolveLiveGroup:completion:
void	getLiveGroupMemberBlockList:cursor:count:completion:
void	addLiveGroupMemberBlockList:uidList:completion:
void	removeLiveGroupMemberBlockList:uidList:completion:
void	getLiveGroupMemberOnlineList:cursor:count:completion:
void	getLiveGroupMemberSilentList:cursor:count:completion:
void	setLiveGroupSilent:isSilent:completion:
void	addLiveGroupMemberSilentList:uidList:blockTime:completion:
void	removeLiveGroupMemberSilentList:uidList:completion:
void	kickLiveGroupMemberList:uidList:completion:
void	transLiveGroupOwner:uid:completion:
void	addLiveGroupAdmin:uidList:completion:
void	removeLiveGroupAdmin:uidList:completion:
void	getLiveGroupMemberList:cursor:count:completion:
void	getLiveGroupMemberSilentWhiteList:cursor:count:completion:
void	addLiveGroupMemberSilentWhiteList:uidList:completion:
void	removeLiveGroupMemberSilentWhiteList:uidList:completion:
void	getLiveGroupOnlineMemberCount:completion:
void	setLiveGroupNotice:notice:completion:
void	setLiveGroupDescription:description:completion:
void	setLiveGroupName:name:completion:
void	setLiveGroupIcon:url:completion:
void	getLiveGroupMemberOnlineInfo:uidList:completion:
void	getLiveGroupHistoryMessageList:cursor:limit:completion:
void	setLiveGroupMemberInfo:memberInfo:completion:
void	setLiveGroupMemberAlias:alias:completion:
void	setLiveGroupMemberAvatar:avatarUrl:completion:
void	addLiveGroupMemberExt:ext:completion:
void	getLiveGroupMemberInfo:uid:completion:
void	refreshLiveGroupMediaMessage:completion:
void	addLiveGroupMarkTypeListener:
void	removeLiveGroupMarkTypeListener:
void	markLiveGroupMemberList:uidList:action:markTypeList:completion:
void	getLiveGroupMarkTypeList:completion:
void	getLiveGroupMemberOnlineList:cursor:count:markType:completion:
void	manageLiveGroupMarkTypes:action:markTypeList:completion:

函数说明

addLiveGroupMessageListener:

- (void)addLiveGroupMessageListener:(id<BIMLiveMessageListener>)listener;
objectivec

设置直播群消息监听。

传入参数

参数名	类型	说明
listener	id	直播群消息事件回调监听方，参看 BIMLiveMessageListener。

removeLiveGroupMessageListener:

- (void)removeLiveGroupMessageListener:(id<BIMLiveMessageListener>)listener;
objectivec

移除直播群消息监听。

传入参数

参数名	类型	说明
listener	id	直播群消息事件回调监听方，参看 BIMLiveMessageListener。

addLiveConversationListener:

- (void)addLiveConversationListener:(id<BIMLiveConversationListener>)listener;
objectivec

设置直播群会话监听。

传入参数

参数名	类型	说明
listener	id	直播群会话事件回调监听方，参看 BIMLiveConversationListener。

removeLiveConversationListener:

- (void)removeLiveConversationListener:(id<BIMLiveConversationListener>)listener;
objectivec

移除直播群会话监听。

传入参数

参数名	类型	说明
listener	id	直播群会话事件回调监听方，参看 BIMLiveConversationListener。

addLiveGroupMemberListener:

- (void)addLiveGroupMemberListener:(id<BIMLiveGroupMemberEventListener>)listener;
objectivec

设置直播群成员监听。

传入参数

参数名	类型	说明
listener	id	直播群成员事件回调监听方，参看 BIMLiveGroupMemberEventListener。

removeLiveGroupMemberListener:

- (void)removeLiveGroupMemberListener:(id<BIMLiveGroupMemberEventListener>)listener;
objectivec

移除直播群成员监听。

传入参数

参数名	类型	说明
listener	id	直播群成员事件回调监听方，参看 BIMLiveGroupMemberEventListener。

sendLiveGroupMessage:conversation:completion:

- (NSString *)sendLiveGroupMessage:(BIMMessage *)message conversation:(NSString *)shortId completion:(BIMMessageCompletion)completion;
objectivec

发送直播群消息。
目前仅支持直接发送普通文本消息，发送图片消息、视频消息、语音消息、文件消息前请联系技术支持同学进行配置。

传入参数

参数名	类型	说明
message	BIMMessage*	消息体，参看 BIMMessage。
shortId	NSString*	会话 shortId。
completion	BIMMessageCompletion	完成回调，其中`message`参看BIMMessage， `error` 参看 BIMErrorCode。

sendLiveGroupMessage:conversation:priority:completion:

- (NSString *)sendLiveGroupMessage:(BIMMessage *)message conversation:(NSString *)shortId priority:(BIMMessagePriority)priority completion:(BIMMessageCompletion)completion;
objectivec

发送直播群消息。

传入参数

参数名	类型	说明
message	BIMMessage*	消息体，参看 BIMMessage。
shortId	NSString*	会话 shortId。
priority	BIMMessagePriority	设置消息优先级，参看 BIMMessagePriority。
completion	BIMMessageCompletion	完成回调，其中 `message` 参看 BIMMessage， `error` 参看 BIMErrorCode。

getOwnerLiveGroupList:count:completion:

- (void)getOwnerLiveGroupList:(uint64_t)cursor count:(int)count completion:(BIMLiveGroupListCompletion)completion;
objectivec

获取我是群主和管理员的直播群列表。

传入参数

参数名	类型	说明
cursor	uint64_t	分页拉取的游标，第一次默认取传 0，后续分页拉传上一次分页拉取成功回调里的 nextCursor。
count	int	分页拉取的个数。一次分页拉取不宜太多，否则可能影响拉取的速度，建议每次拉取 20 个会话。
completion	BIMLiveGroupListCompletion	完成回调，其中 `conversations` 是拉取到的会话参看BIMConversation，`hasMore`标记数据库是否还有会话，`nextCursor`标记下次拉取游标的位置，`error` 参看 BIMErrorCode。

getALLLiveGroupList:count:completion:

- (void)getALLLiveGroupList:(uint64_t)cursor count:(int)count completion:(BIMLiveGroupListCompletion)completion;
objectivec

获取所有直播群列表。

传入参数

参数名	类型	说明
cursor	uint64_t	分页拉取的游标，第一次默认取传 0，后续分页拉传上一次分页拉取成功回调里的 nextCursor。
count	int	分页拉取的个数。一次分页拉取不宜太多，否则可能影响拉取的速度，建议每次拉取 20 个会话。
completion	BIMLiveGroupListCompletion	完成回调，其中 `conversations` 是拉取到的会话参看BIMConversation，`hasMore`标记数据库是否还有会话，`nextCursor`标记下次拉取游标的位置，`error` 参看 BIMErrorCode。

getLiveGroup:completion:

- (void)getLiveGroup:(NSString *)shortId completion:(BIMConversationCompletion)completion;
objectivec

获取直播群信息。

传入参数

参数名	类型	说明
shortId	NSString*	直播群 shortId。
completion	BIMConversationCompletion	完成回调，其中 `conversations` 是拉取到的会话参看BIMConversation， `error` 参看 BIMErrorCode。

createLiveGroup:completion:

- (void)createLiveGroup:(BIMGroupInfo *)groupInfo completion:(BIMConversationCompletion)completion;
objectivec

创建直播群。

传入参数

参数名	类型	说明
groupInfo	BIMGroupInfo*	创建直播群参数信息，包括名称，头像等，参看 BIMGroupInfo。
completion	BIMConversationCompletion	完成回调，其中 `conversations` 是成功创建的会话参看BIMConversation， `error` 参看 BIMErrorCode。

joinLiveGroup:completion:

- (void)joinLiveGroup:(NSString *)shortId completion:(BIMConversationJoinCompletion)completion;
objectivec

加入直播群。

传入参数

参数名	类型	说明
shortId	NSString*	直播群 shortId。
completion	BIMConversationJoinCompletion	完成回调，其中 `conversations` 是拉取到的会话参看BIMConversation， `error` 参看 BIMErrorCode。

注意
同一时间只能进入一个直播群，直播群不提供本地存储

joinLiveGroup:memberInfo:completion:

- (void)joinLiveGroup:(NSString *)shortId memberInfo:(BIMMemberUpdateInfo *)memberInfo completion:(BIMConversationJoinCompletion)completion;
objectivec

加入直播群并设置当前用户成员信息。

传入参数

参数名	类型	说明
shortId	NSString*	直播群 shortId。
memberInfo	BIMMemberUpdateInfo*	当前用户成员信息，参看 BIMMemberUpdateInfo。
completion	BIMConversationJoinCompletion	完成回调，其中 `conversations` 是拉取到的会话参看 BIMConversation， `error` 参看 BIMErrorCode。

注意

同一时间只能进入一个直播群，直播群不提供本地存储。
成员信息与用户信息不同，用户在不同直播群可以拥有不同的成员信息，退群后信息自动销毁。

leaveLiveGroup:completion:

- (void)leaveLiveGroup:(NSString *)shortId completion:(BIMCompletion)completion;
objectivec

离开直播群。

传入参数

参数名	类型	说明
shortId	NSString*	直播群 shortId。
completion	BIMCompletion	完成回调，其中 `error` 参看 BIMErrorCode。

dissolveLiveGroup:completion:

- (void)dissolveLiveGroup:(NSString *)shortId completion:(BIMCompletion)completion;
objectivec

解散直播群（仅群主）。

传入参数

参数名	类型	说明
shortId	NSString*	直播群 shortId。
completion	BIMCompletion	完成回调，其中 `error` 参看 BIMErrorCode。

getLiveGroupMemberBlockList:cursor:count:completion:

- (void)getLiveGroupMemberBlockList:(NSString *)shortId cursor:(uint64_t)cursor count:(int)count completion:(BIMMemberListCompletion)completion;
objectivec

获取直播群成员黑名单。

传入参数

参数名	类型	说明
shortId	NSString*	直播群 shortId。
cursor	uint64_t	分页拉取的游标，第一次默认取传 0，后续分页拉传上一次分页拉取成功回调里的 nextCursor。
count	int	分页拉取的个数。一次分页拉取不宜太多，否则可能影响拉取的速度，建议每次拉取 20 个成员。
completion	BIMMemberListCompletion	完成回调，其中 `members` 是拉取到的成员列表，参看 BIMMember，`hasMore` 标记数据库是否还有成员，`nextCursor` 标记下次拉取游标的位置，`error` 参看 BIMErrorCode。

addLiveGroupMemberBlockList:uidList:completion:

- (void)addLiveGroupMemberBlockList:(NSString *)shortId uidList:(NSSet<NSNumber *> *)uidList completion:(BIMCompletion)completion;
objectivec

添加直播群成员黑名单。

传入参数

参数名	类型	说明
shortId	NSString*	直播群 shortId。
uidList	NSSet<NSNumber>**	待加入黑名单用户UID列表。
completion	BIMCompletion	完成回调，其中 `error` 参看 BIMErrorCode。

removeLiveGroupMemberBlockList:uidList:completion:

- (void)removeLiveGroupMemberBlockList:(NSString *)shortId uidList:(NSSet<NSNumber *> *)uidList completion:(BIMCompletion)completion;
objectivec

移除直播群成员黑名单。

传入参数

参数名	类型	说明
shortId	NSString*	直播群 shortId。
uidList	NSSet<NSNumber>**	待移除黑名单用户UID列表。
completion	BIMCompletion	完成回调，其中 `error` 参看 BIMErrorCode。

getLiveGroupMemberOnlineList:cursor:count:completion:

- (void)getLiveGroupMemberOnlineList:(NSString *)shortId cursor:(uint64_t)cursor count:(int)count completion:(BIMMemberListCompletion)completion;
objectivec

获取直播群在线成员列表。

传入参数

参数名	类型	说明
shortId	NSString*	直播群 shortId。
cursor	uint64_t	分页拉取的游标，第一次默认取传 0，后续分页拉传上一次分页拉取成功回调里的 nextCursor。
count	int	分页拉取的个数。一次分页拉取不宜太多，否则可能影响拉取的速度，建议每次拉取 20 个成员。
completion	BIMMemberListCompletion	完成回调，其中 `members` 是拉取到的成员列表，参看 BIMMember，`hasMore` 标记数据库是否还有成员，`nextCursor` 标记下次拉取游标的位置，`error` 参看 BIMErrorCode。

getLiveGroupMemberSilentList:cursor:count:completion:

- (void)getLiveGroupMemberSilentList:(NSString *)shortId cursor:(uint64_t)cursor count:(int)count completion:(BIMMemberListCompletion)completion;
objectivec

获取直播群被禁言成员列表。

传入参数

参数名	类型	说明
shortId	NSString*	直播群 shortId。
cursor	uint64_t	分页拉取的游标，第一次默认取传 0，后续分页拉传上一次分页拉取成功回调里的 nextCursor。
count	int	分页拉取的个数。一次分页拉取不宜太多，否则可能影响拉取的速度，建议每次拉取 20 个成员。
completion	BIMMemberListCompletion	完成回调，其中 `members` 是拉取到的成员列表，参看 BIMMember，`hasMore` 标记数据库是否还有成员，`nextCursor` 标记下次拉取游标的位置，`error` 参看 BIMErrorCode。

setLiveGroupSilent:isSilent:completion:

- (void)setLiveGroupSilent:(NSString *)shortId isSilent:(BOOL)isSilent completion:(BIMCompletion)completion;
objectivec

设置直播群禁言(所有人)。

传入参数

参数名	类型	说明
shortId	NSString*	直播群 shortId。
isSilent	BOOL	是否禁言。
completion	BIMCompletion	完成回调，其中 `error` 参看 BIMErrorCode。

addLiveGroupMemberSilentList:uidList:blockTime:completion:

- (void)addLiveGroupMemberSilentList:(NSString *)shortId uidList:(NSSet<NSNumber *> *)uidList blockTime:(long long)blockTime completion:(BIMCompletion)completion;
objectivec

设置直播群禁言(指定用户)。

传入参数

参数名	类型	说明
shortId	NSString*	直播群 shortId。
uidList	NSSet<NSNumber>**	待禁言用户UID列表。
blockTime	long long	禁言时间。
completion	BIMCompletion	完成回调，其中 `error` 参看 BIMErrorCode。

removeLiveGroupMemberSilentList:uidList:completion:

- (void)removeLiveGroupMemberSilentList:(NSString *)shortId uidList:(NSSet<NSNumber *> *)uidList completion:(BIMCompletion)completion;
objectivec

设置直播群用户解除禁言(指定用户)。

传入参数

参数名	类型	说明
shortId	NSString*	直播群 shortId。
uidList	NSSet<NSNumber>**	待解除禁言用户UID列表。
completion	BIMCompletion	完成回调，其中 `error` 参看 BIMErrorCode。

kickLiveGroupMemberList:uidList:completion:

- (void)kickLiveGroupMemberList:(NSString *)shortId uidList:(NSSet<NSNumber *> *)uidList completion:(BIMCompletion)completion;
objectivec

踢出直播群成员。

传入参数

参数名	类型	说明
shortId	NSString*	直播群 shortId。
uidList	NSSet<NSNumber>**	待被踢出群用户UID列表。
completion	BIMCompletion	完成回调，其中 `error` 参看 BIMErrorCode。

transLiveGroupOwner:uid:completion:

- (void)transLiveGroupOwner:(NSString *)shortId uid:(long long)uid completion:(BIMCompletion)completion;
objectivec

转让群主。

传入参数

参数名	类型	说明
shortId	NSString*	直播群 shortId。
uid	long long	转让群主用户uid。
completion	BIMCompletion	完成回调，其中 `error` 参看 BIMErrorCode。

addLiveGroupAdmin:uidList:completion:

- (void)addLiveGroupAdmin:(NSString *)shortId uidList:(NSSet<NSNumber *> *)uidList completion:(BIMCompletion)completion;
objectivec

设置直播群管理员。

传入参数

参数名	类型	说明
shortId	NSString*	会话 ID。
uidList	NSSet<NSNumber>**	需要更改身份的群成员列表。
completion	BIMCompletion	结果回调。

removeLiveGroupAdmin:uidList:completion:

- (void)removeLiveGroupAdmin:(NSString *)shortId uidList:(NSSet<NSNumber *> *)uidList completion:(BIMCompletion)completion;
objectivec

移除直播群管理员。

传入参数

参数名	类型	说明
shortId	NSString*	会话 ID。
uidList	NSSet<NSNumber>**	需要更改身份的群成员列表。
completion	BIMCompletion	结果回调。

getLiveGroupMemberList:cursor:count:completion:

- (void)getLiveGroupMemberList:(NSString *)shortId cursor:(uint64_t)cursor count:(int)count completion:(BIMMemberListCompletion)completion;
objectivec

获取直播群群主管理员等常驻成员列表。

传入参数

参数名	类型	说明
shortId	NSString*	直播群 shortId。
cursor	uint64_t	分页拉取的游标，第一次默认取传 0，后续分页拉传上一次分页拉取成功回调里的 nextCursor。
count	int	分页拉取的个数。一次分页拉取不宜太多，否则可能影响拉取的速度，建议每次拉取 20 个成员。
completion	BIMMemberListCompletion	完成回调，其中 `members` 是拉取到的成员列表，参看 BIMMember，`hasMore` 标记数据库是否还有成员，`nextCursor` 标记下次拉取游标的位置，`error` 参看 BIMErrorCode。

getLiveGroupMemberSilentWhiteList:cursor:count:completion:

- (void)getLiveGroupMemberSilentWhiteList:(NSString *)shortId cursor:(uint64_t)cursor count:(int)count completion:(BIMMemberListCompletion)completion;
objectivec

获取直播群会话禁言白名单。

传入参数

参数名	类型	说明
shortId	NSString*	直播群 shortId。
cursor	uint64_t	分页拉取的游标，第一次默认取传 0，后续分页拉传上一次分页拉取成功回调里的 nextCursor。
count	int	分页拉取的个数。一次分页拉取不宜太多，否则可能影响拉取的速度，建议每次拉取 20 个成员。
completion	BIMMemberListCompletion	完成回调，其中 `members` 是拉取到的成员列表，参看 BIMMember，`hasMore` 标记数据库是否还有成员，`nextCursor` 标记下次拉取游标的位置，`error` 参看 BIMErrorCode。

addLiveGroupMemberSilentWhiteList:uidList:completion:

- (void)addLiveGroupMemberSilentWhiteList:(NSString *)shortId uidList:(NSSet<NSNumber *> *)uidList completion:(BIMCompletion)completion;
objectivec

添加禁言会话白名单。

传入参数

参数名	类型	说明
shortId	NSString*	直播群 shortId。
uidList	NSSet<NSNumber>**	待禁言用户UID列表。
completion	BIMCompletion	完成回调，其中 `error` 参看 BIMErrorCode。

removeLiveGroupMemberSilentWhiteList:uidList:completion:

- (void)removeLiveGroupMemberSilentWhiteList:(NSString *)shortId uidList:(NSSet<NSNumber *> *)uidList completion:(BIMCompletion)completion;
objectivec

移除禁言会话白名单。

传入参数

参数名	类型	说明
shortId	NSString*	直播群 shortId。
uidList	NSSet<NSNumber>**	待解除禁言用户UID列表。
completion	BIMCompletion	完成回调，其中 `error` 参看 BIMErrorCode。

getLiveGroupOnlineMemberCount:completion:

- (void)getLiveGroupOnlineMemberCount:(NSString *)shortId completion:(BIMOnlineMemberCountCompletion)completion;
objectivec

获取直播群在线人数。

传入参数

参数名	类型	说明
shortId	NSString*	直播群会话 shortId。
completion	BIMOnlineMemberCountCompletion	在线人数结果回调，其中 `error` 参看 BIMErrorCode。

setLiveGroupNotice:notice:completion:

- (void)setLiveGroupNotice:(NSString *)shortId notice:(NSString *)notice completion:(BIMCompletion)completion;
objectivec

设置直播群公告。

传入参数

参数名	类型	说明
shortId	NSString*	直播群 shortId。
notice	NSString*	直播群公告内容。
completion	BIMCompletion	完成回调，其中 `error` 参看 BIMErrorCode。

setLiveGroupDescription:description:completion:

- (void)setLiveGroupDescription:(NSString *)shortId description:(NSString *)description completion:(BIMCompletion)completion;
objectivec

设置直播群描述。

传入参数

参数名	类型	说明
shortId	NSString*	直播群 shortId。
description	NSString*	直播群描述内容。
completion	BIMCompletion	完成回调，其中 `error` 参看 BIMErrorCode。

setLiveGroupName:name:completion:

- (void)setLiveGroupName:(NSString *)shortId name:(NSString *)name completion:(BIMCompletion)completion;
objectivec

设置直播群名称。

传入参数

参数名	类型	说明
shortId	NSString*	直播群 shortId。
name	NSString*	直播群名称。
completion	BIMCompletion	完成回调，其中 `error` 参看 BIMErrorCode。

setLiveGroupIcon:url:completion:

- (void)setLiveGroupIcon:(NSString *)shortId url:(NSString *)url completion:(BIMCompletion)completion;
objectivec

设置直播群头像。

传入参数

参数名	类型	说明
shortId	NSString*	直播群 shortId。
url	NSString*	直播群头像 url 地址。
completion	BIMCompletion	完成回调，其中 `error` 参看 BIMErrorCode。

getLiveGroupMemberOnlineInfo:uidList:completion:

- (void)getLiveGroupMemberOnlineInfo:(NSString *)shortId uidList:(NSSet<NSNumber *> *)uidList completion:(BIMOnlineMemberInfoCompletion)completion;
objectivec

获取直播群成员在线信息。

传入参数

参数名	类型	说明
shortId	NSString*	直播群 shortId。
uidList	NSSet<NSNumber>**	用户 UID 列表
completion	BIMOnlineMemberInfoCompletion	结果回调，参看 BIMLiveMemberOnlineInfo

getLiveGroupHistoryMessageList:cursor:limit:completion:

- (void)getLiveGroupHistoryMessageList:(NSString *)shortId cursor:(uint64_t)cursor limit:(int)limit completion:(BIMLiveMessageListCompletion)completion;
objectivec

获取直播群历史消息(从新到旧)。

传入参数

参数名	类型	说明
shortId	NSString*	直播群会话 shortId。
cursor	uint64_t	直播群历史消息拉取起点
limit	int	分页拉取的个数。一次分页拉取不宜太多，否则可能影响拉取的速度，建议每次拉取 20 个。
completion	BIMLiveMessageListCompletion	结果回调

setLiveGroupMemberInfo:memberInfo:completion:

- (void)setLiveGroupMemberInfo:(NSString *)shortId memberInfo:(BIMMemberUpdateInfo *)memberInfo completion:(BIMCompletion)completion;
objectivec

设置直播群成员信息，覆盖服务端存储。

传入参数

参数名	类型	说明
shortId	NSString*	直播群 shortId。
memberInfo	BIMMemberUpdateInfo*	设置当前用户成员信息, 参看 BIMMemberUpdateInfo
completion	BIMCompletion	结果回调，其中 `error` 参看 BIMErrorCode。

注意
成员信息与用户信息不同，用户在不同直播群可以拥有不同的成员信息，退群后信息自动销毁。

setLiveGroupMemberAlias:alias:completion:

- (void)setLiveGroupMemberAlias:(NSString *)shortId alias:(NSString *)alias completion:(BIMCompletion)completion;
objectivec

设置直播群成员昵称。

传入参数

参数名	类型	说明
shortId	NSString*	直播群 shortId。
alias	NSString*	设置当前用户成员昵称。
completion	BIMCompletion	结果回调，其中 `error` 参看 BIMErrorCode。

setLiveGroupMemberAvatar:avatarUrl:completion:

- (void)setLiveGroupMemberAvatar:(NSString *)shortId avatarUrl:(NSString *)avatarUrl completion:(BIMCompletion)completion;
objectivec

设置直播群成员头像。

传入参数

参数名	类型	说明
shortId	NSString*	直播群 shortId。
avatarUrl	NSString*	设置当前用户成员头像 URL。
completion	BIMCompletion	结果回调，其中 `error` 参看 BIMErrorCode。

addLiveGroupMemberExt:ext:completion:

- (void)addLiveGroupMemberExt:(NSString *)shortId ext:(NSDictionary *)ext completion:(BIMCompletion)completion;
objectivec

设置直播群成员自定义信息，相同 key 会覆盖。

传入参数

参数名	类型	说明
shortId	NSString*	直播群 ShortId。
ext	NSDictionary*	设置直播群成员自定义信息。
completion	BIMCompletion	结果回调，其中 `error` 参看 BIMErrorCode。

getLiveGroupMemberInfo:uid:completion:

- (void)getLiveGroupMemberInfo:(NSString *)shortId uid:(long long)uid completion:(BIMMemberCompletion)completion;
objectivec

获取直播群成员信息，其中包括当前在直播群的成员以及群主管理员，退出群的游客信息无法获取。

传入参数

参数名	类型	说明
shortId	NSString*	直播群 shortId。
uid	long long	查询的用户 uid。
completion	BIMMemberCompletion	结果回调，其中 member 参看 BIMMember， `error` 参看 BIMErrorCode。

refreshLiveGroupMediaMessage:completion:

- (void)refreshLiveGroupMediaMessage:(BIMMessage *)message completion:(BIMCompletion)completion;
objectivec

刷新直播群媒体信息，媒体 URL 过期时调用该方法。

传入参数

参数名	类型	说明
message	BIMMessage*	待刷新的消息，参看 BIMMessage。
completion	BIMCompletion	结果回调，其中 `error` 参看 BIMErrorCode。

addLiveGroupMarkTypeListener:

- (void)addLiveGroupMarkTypeListener:(id<BIMLiveGroupMarkTypeListener>)listener;
objectivec

新增直播群标记事件监听。

传入参数

参数名	类型	说明
listener	id	直播群标记事件回调监听方，参看 BIMLiveGroupMarkTypeListener。

removeLiveGroupMarkTypeListener:

- (void)removeLiveGroupMarkTypeListener:(id<BIMLiveGroupMarkTypeListener>)listener;
objectivec

移除直播群标记事件监听。

传入参数

参数名	类型	说明
listener	id	直播群标记事件回调监听方，参看 BIMLiveGroupMarkTypeListener。

markLiveGroupMemberList:uidList:action:markTypeList:completion:

- (void)markLiveGroupMemberList:(NSString *)shortId uidList:(NSSet<NSNumber *> *)uidList action:(BIMLiveGroupMarkTypeAction)action markTypeList:(NSSet<NSString *> *)markTypeList completion:(BIMLiveGroupMarkMemberCompletion)completion;
objectivec

标记群成员。

传入参数

参数名	类型	说明
shortId	NSString*	直播群 ShortId。
uidList	NSSet<NSNumber>**	成员列表。
action	BIMLiveGroupMarkTypeAction	标记变更类型，参看 BIMLiveGroupMarkTypeAction。
markTypeList	NSSet<NSString>**	标记列表。
completion	BIMLiveGroupMarkMemberCompletion	结果回调，其中 `failedInfos` 参看 BIMLiveGroupMarkMemberFailedInfo，`error` 参看 BIMError。

getLiveGroupMarkTypeList:completion:

- (void)getLiveGroupMarkTypeList:(NSString *)shortId completion:(BIMLiveGroupMarkTypeListCompletion)completion;
objectivec

获取群聊标记类型列表。

传入参数

参数名	类型	说明
shortId	NSString*	直播群 ShortId。
completion	BIMLiveGroupMarkTypeListCompletion	结果回调，其中 `markTypeList` 为标记列表，`error` 参看 BIMError。

getLiveGroupMemberOnlineList:cursor:count:markType:completion:

- (void)getLiveGroupMemberOnlineList:(NSString *)shortId cursor:(uint64_t)cursor count:(int)count markType:(NSString *)markType completion:(BIMMemberListCompletion)completion;
objectivec

根据标记获取直播群在线成员列表。
支持拉取近 1000 个在线游客。

传入参数

参数名	类型	说明
shortId	NSString*	直播群 shortId。
cursor	uint64_t	分页拉取的游标，第一次默认取传 0，后续分页拉传上一次分页拉取成功回调里的 nextCursor。
count	int	分页拉取的个数。一次分页拉取不宜太多，否则可能影响拉取的速度，建议每次拉取 20 个成员。
markType	NSString*	标记类型。
completion	BIMMemberListCompletion	完成回调，其中 `members` 是拉取到的成员列表，参看 BIMMember，`hasMore` 标记数据库是否还有成员，`nextCursor` 标记下次拉取游标的位置，`error` 参看 BIMErrorCode。

manageLiveGroupMarkTypes:action:markTypeList:completion:

- (void)manageLiveGroupMarkTypes:(NSString *)shortId action:(BIMLiveGroupMarkTypeAction)action markTypeList:(NSSet<NSString *> *)markTypeList completion:(BIMCompletion)completion;
objectivec

管理群成员标记类型。

传入参数

参数名	类型	说明
shortId	NSString*	直播群 ShortId。
action	BIMLiveGroupMarkTypeAction	标记变更类型，参看 BIMLiveGroupMarkTypeAction。
markTypeList	NSSet<NSString>**	标记列表。
completion	BIMCompletion	完成回调，其中 `error` 参看 BIMErrorCode。

BIMClient (FTS)

@interface BIMClient (FTS)
objectivec

BIMClient (FTS) Class
IM SDK 搜索对外接口类，通过此类提供搜索能力。

成员函数

返回	名称
void	searchLocalMessage:key:completion:

函数说明

searchLocalMessage:key:completion:

- (void)searchLocalMessage:(NSString *)conversationId key:(NSString *)key completion:(BIMSearchMessageCompletion)completion;
objectivec

搜索本地消息。

传入参数

参数名	类型	说明
conversationId	NSString*	会话 ID，如果为空则全局搜索
key	NSString*	关键词
completion	BIMSearchMessageCompletion	完成回调，其中 `infos` 是搜索结果信息，参看 BIMSearchMsgInfo，`error` 参看 BIMErrorCode。