HyphenateChatSDK 3.9.9.1
构造函数 | 所有成员列表
<IEMChatroomManager>协议 参考

#import <IEMChatroomManager.h>

类 <IEMChatroomManager> 继承关系图:

构造函数

(void) - addDelegate:delegateQueue:
 
(void) - removeDelegate:
 
(EMPageResult< EMChatroom * > *_Nullable) - getChatroomsFromServerWithPage:pageSize:error:
 
(void) - getChatroomsFromServerWithPage:pageSize:completion:
 
(EMChatroom *_Nullable) - createChatroomWithSubject:description:invitees:message:maxMembersCount:error:
 
(void) - createChatroomWithSubject:description:invitees:message:maxMembersCount:completion:
 
(EMChatroom *) - joinChatroom:error:
 
(void) - joinChatroom:completion:
 
(void) - leaveChatroom:error:
 
(void) - leaveChatroom:completion:
 
(EMError *_Nullable) - destroyChatroom:
 
(void) - destroyChatroom:completion:
 
(EMChatroom *_Nullable) - getChatroomSpecificationFromServerWithId:error:
 
(void) - getChatroomSpecificationFromServerWithId:completion:
 
(void) - getChatroomSpecificationFromServerWithId:fetchMembers:completion:
 
(EMCursorResult< NSString * > *_Nullable) - getChatroomMemberListFromServerWithId:cursor:pageSize:error:
 
(void) - getChatroomMemberListFromServerWithId:cursor:pageSize:completion:
 
(NSArray< NSString * > *_Nullable) - getChatroomBlacklistFromServerWithId:pageNumber:pageSize:error:
 
(void) - getChatroomBlacklistFromServerWithId:pageNumber:pageSize:completion:
 
(NSArray< NSString * > *_Nullable) - getChatroomMuteListFromServerWithId:pageNumber:pageSize:error:
 
(void) - getChatroomMuteListFromServerWithId:pageNumber:pageSize:completion:
 
(NSArray< NSString * > *_Nullable) - getChatroomWhiteListFromServerWithId:error:
 
(void) - getChatroomWhiteListFromServerWithId:completion:
 
(BOOL) - isMemberInWhiteListFromServerWithChatroomId:error:
 
(void) - isMemberInWhiteListFromServerWithChatroomId:completion:
 
(NSString *_Nullable) - getChatroomAnnouncementWithId:error:
 
(void) - getChatroomAnnouncementWithId:completion:
 
(EMChatroom *) - updateSubject:forChatroom:error:
 
(void) - updateSubject:forChatroom:completion:
 
(EMChatroom *_Nullable) - updateDescription:forChatroom:error:
 
(void) - updateDescription:forChatroom:completion:
 
(EMChatroom *_Nullable) - removeMembers:fromChatroom:error:
 
(void) - removeMembers:fromChatroom:completion:
 
(EMChatroom *_Nullable) - blockMembers:fromChatroom:error:
 
(void) - blockMembers:fromChatroom:completion:
 
(EMChatroom *_Nullable) - unblockMembers:fromChatroom:error:
 
(void) - unblockMembers:fromChatroom:completion:
 
(EMChatroom *_Nullable) - updateChatroomOwner:newOwner:error:
 
(void) - updateChatroomOwner:newOwner:completion:
 
(EMChatroom *_Nullable) - addAdmin:toChatroom:error:
 
(void) - addAdmin:toChatroom:completion:
 
(EMChatroom *_Nullable) - removeAdmin:fromChatroom:error:
 
(void) - removeAdmin:fromChatroom:completion:
 
(EMChatroom *_Nullable) - muteMembers:muteMilliseconds:fromChatroom:error:
 
(void) - muteMembers:muteMilliseconds:fromChatroom:completion:
 
(EMChatroom *_Nullable) - unmuteMembers:fromChatroom:error:
 
(void) - unmuteMembers:fromChatroom:completion:
 
(EMChatroom *_Nullable) - muteAllMembersFromChatroom:error:
 
(void) - muteAllMembersFromChatroom:completion:
 
(EMChatroom *_Nullable) - unmuteAllMembersFromChatroom:error:
 
(void) - unmuteAllMembersFromChatroom:completion:
 
(EMChatroom *_Nullable) - addWhiteListMembers:fromChatroom:error:
 
(void) - addWhiteListMembers:fromChatroom:completion:
 
(EMChatroom *_Nullable) - removeWhiteListMembers:fromChatroom:error:
 
(void) - removeWhiteListMembers:fromChatroom:completion:
 
(EMChatroom *_Nullable) - updateChatroomAnnouncementWithId:announcement:error:
 
(void) - updateChatroomAnnouncementWithId:announcement:completion:
 
(void) - setChatroomAttributes:attributes:autoDelete:completionBlock:
 
(void) - setChatroomAttribute:key:value:autoDelete:completionBlock:
 
(void) - setChatroomAttributesForced:attributes:autoDelete:completionBlock:
 
(void) - setChatroomAttributeForced:key:value:autoDelete:completionBlock:
 
(void) - removeChatroomAttributes:attributes:completionBlock:
 
(void) - removeChatroomAttribute:key:completionBlock:
 
(void) - removeChatroomAttributesForced:attributes:completionBlock:
 
(void) - removeChatroomAttributeForced:key:completionBlock:
 
(void) - fetchChatroomAttributes:keys:completion:
 
(void) - fetchChatroomAllAttributes:completion:
 
(EMChatroom *) - fetchChatroomInfo:includeMembersList:error:
 
(void) - getChatroomSpecificationFromServerByID:includeMembersList:completion:
 
(void) - addDelegate:
 
(NSArray *) - getAllChatroomsFromServerWithError:
 
(void) - getAllChatroomsFromServerWithCompletion:
 
(void) - asyncGetAllChatroomsFromServer:failure:
 
(void) - asyncJoinChatroom:success:failure:
 
(void) - asyncLeaveChatroom:success:failure:
 
(void) - asyncFetchChatroomInfo:includeMembersList:success:failure:
 

详细描述

管理聊天室的类。

函数文档

◆ addAdmin:toChatroom:completion:

- (void) addAdmin: (NSString *_Nonnull)  aAdmin
toChatroom: (NSString *_Nonnull)  aChatroomId
completion: (void(^)(EMChatroom *_Nullable aChatroomp, EMError *_Nullable aError))  aCompletionBlock 
required

添加聊天室管理员。

仅聊天室所有者可调用此方法。

异步方法。

参数
aAdmin要添加的聊天室管理员。
aChatroomId聊天室 ID。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ addAdmin:toChatroom:error:

- (EMChatroom *_Nullable) addAdmin: (NSString *_Nonnull)  aAdmin
toChatroom: (NSString *_Nonnull)  aChatroomId
error: (EMError **_Nullable)  pError 
required

添加聊天室管理员。

仅聊天室所有者可调用此方法。

同步方法，会阻塞当前线程。

参数
aAdmin要添加的管理员。
aChatroomId聊天室 ID。
pError错误信息。
返回
聊天室实例，详见 EMChatroom。

◆ addDelegate:

- (void) addDelegate: (3_1_0) 
(3_2_2) 
("Use -IEMChatroomManager addDelegate:delegateQueue: instead")  EM_DEPRECATED_IOS 
required

添加回调代理。

已废弃，请用 addDelegate:delegateQueue: 代替。

参数
aDelegate要添加的代理。

◆ addDelegate:delegateQueue:

- (void) addDelegate: (id< EMChatroomManagerDelegate > _Nonnull)  aDelegate
delegateQueue: (dispatch_queue_t _Nullable)  aQueue 
required

添加回调代理。

参数
aDelegate要添加的代理。
aQueue代理执行的队列。

◆ addWhiteListMembers:fromChatroom:completion:

- (void) addWhiteListMembers: (NSArray< NSString * > *_Nonnull)  aMembers
fromChatroom: (NSString *_Nonnull)  aChatroomId
completion: (void(^)(EMChatroom *_Nullable aChatroom, EMError *_Nullable aError))  aCompletionBlock 
required

添加白名单。

仅聊天室所有者和管理员可调用此方法。

异步方法。

参数
aMembers被添加的列表。
aChatroomId聊天室 ID。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ addWhiteListMembers:fromChatroom:error:

- (EMChatroom *_Nullable) addWhiteListMembers: (NSArray< NSString * > *_Nonnull)  aMembers
fromChatroom: (NSString *_Nonnull)  aChatroomId
error: (EMError **_Nullable)  pError 
required

添加白名单。

仅聊天室所有者和管理员可调用此方法。

同步方法，会阻塞当前线程。

参数
aMembers被添加的列表。
aChatroomId聊天室 ID。
pError错误信息
返回
聊天室实例，详见 EMChatroom。

◆ asyncFetchChatroomInfo:includeMembersList:success:failure:

- (void) asyncFetchChatroomInfo: (NSString *)  aChatroomId
includeMembersList: (BOOL)  aIncludeMembersList
success: (void(^)(EMChatroom *aChatroom))  aSuccessBlock
failure: ("Use -getChatroomSpecificationFromServerByID:includeMembersList:completion: instead")  __deprecated_msg 
required

获取聊天室详情。

已废弃，请用 getChatroomSpecificationFromServerByID:includeMembersList:completion: 代替。

参数
aChatroomId聊天室 ID。
aIncludeMembersList是否获取成员列表。
aSuccessBlock成功的回调。
aFailureBlock失败的回调。

◆ asyncGetAllChatroomsFromServer:failure:

- (void) asyncGetAllChatroomsFromServer: (void(^)(NSArray *aList))  aSuccessBlock
failure: ("Use -getAllChatroomsFromServerWithCompletion: instead")  __deprecated_msg 
required

从服务器获取所有的聊天室。

已废弃，请用 getAllChatroomsFromServerWithCompletion 代替。

参数
aSuccessBlock成功的回调。
aFailureBlock失败的回调。

◆ asyncJoinChatroom:success:failure:

- (void) asyncJoinChatroom: (NSString *)  aChatroomId
success: (void(^)(EMChatroom *aRoom))  aSuccessBlock
failure: ("Use -joinChatroom:completion: instead")  __deprecated_msg 
required

加入一个聊天室。

已废弃，请用 joinChatroom:completion: 代替。

参数
aChatroomId聊天室的 ID。
aSuccessBlock成功的回调。
aFailureBlock失败的回调。

◆ asyncLeaveChatroom:success:failure:

- (void) asyncLeaveChatroom: (NSString *)  aChatroomId
success: (void(^)(EMChatroom *aRoom))  aSuccessBlock
failure: ("Use -leaveChatroom:completion: instead")  __deprecated_msg 
required

退出聊天室。

已废弃，请用 leaveChatroom:completion: 代替。

参数
aChatroomId聊天室 ID。
aSuccessBlock成功的回调。
aFailureBlock失败的回调。
返回
退出的聊天室。

◆ blockMembers:fromChatroom:completion:

- (void) blockMembers: (NSArray< NSString * > *_Nonnull)  aMembers
fromChatroom: (NSString *_Nonnull)  aChatroomId
completion: (void(^)(EMChatroom *_Nullable aChatroom, EMError *_Nullable aError))  aCompletionBlock 
required

将用户加入聊天室黑名单。

仅聊天室所有者有权限调用此方法。

异步方法。

参数
aMembers要加入黑名单的用户。
aChatroomId聊天室 ID。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ blockMembers:fromChatroom:error:

- (EMChatroom *_Nullable) blockMembers: (NSArray< NSString * > *_Nonnull)  aMembers
fromChatroom: (NSString *_Nonnull)  aChatroomId
error: (EMError **_Nullable)  pError 
required

将用户加入聊天室黑名单。

仅聊天室所有者有权限调用此方法。

同步方法，会阻塞当前线程。

参数
aMembers要加入黑名单的用户。
aChatroomId聊天室 ID。
pError错误信息。
返回
聊天室实例。

◆ createChatroomWithSubject:description:invitees:message:maxMembersCount:completion:

- (void) createChatroomWithSubject: (NSString *_Nullable)  aSubject
description: (NSString *_Nullable)  aDescription
invitees: (NSArray< NSString * > *_Nullable)  aInvitees
message: (NSString *_Nullable)  aMessage
maxMembersCount: (NSInteger)  aMaxMembersCount
completion: (void(^)(EMChatroom *_Nullable aChatroom, EMError *_Nullable aError))  aCompletionBlock 
required

创建一个聊天室。

异步方法。

参数
aSubject聊天室主题。
aDescription聊天室描述。
aInvitees聊天室的成员，不包括聊天室创建者自己。
aMessage加入聊天室的邀请内容。
aMaxMembersCount聊天室最大成员数。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ createChatroomWithSubject:description:invitees:message:maxMembersCount:error:

- (EMChatroom *_Nullable) createChatroomWithSubject: (NSString *_Nullable)  aSubject
description: (NSString *_Nullable)  aDescription
invitees: (NSArray< NSString * > *_Nullable)  aInvitees
message: (NSString *_Nullable)  aMessage
maxMembersCount: (NSInteger)  aMaxMembersCount
error: (EMError **_Nullable)  pError 
required

创建聊天室。

同步方法，会阻塞当前线程。

参数
aSubject聊天室主题。
aDescription聊天室描述。
aInvitees聊天室的成员，不包括聊天室创建者自己。
aMessage加入聊天室的邀请内容。
aMaxMembersCount聊天室最大成员数。
pError出错信息。
返回
创建的聊天室，详见 EMChatroom。

◆ destroyChatroom:

- (EMError *_Nullable) destroyChatroom: (NSString *_Nonnull)  aChatroomId
required

解散聊天室。

仅聊天室所有者可以解散聊天室。

同步方法，会阻塞当前线程。

参数
aChatroomId聊天室 ID。
返回
- 如果方法调用成功，返回 nil。
  • 如果方法调用失败，返回错误信息。详见 EMError。

◆ destroyChatroom:completion:

- (void) destroyChatroom: (NSString *_Nonnull)  aChatroomId
completion: (void(^)(EMError *_Nullable aError))  aCompletionBlock 
required

解散聊天室。

仅聊天室所有者可以解散聊天室。

异步方法。

参数
aChatroomId聊天室 ID。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ fetchChatroomAllAttributes:completion:

- (void) fetchChatroomAllAttributes: (NSString *_Nonnull)  roomId
completion: (void(^)(EMError *_Nullable error, NSDictionary< NSString *, NSString * > *_Nullable properties))  completionBlock 
required

获取所有聊天室属性。 异步方法。

参数
roomId聊天室 ID。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因，成功返回所有键值对。

◆ fetchChatroomAttributes:keys:completion:

- (void) fetchChatroomAttributes: (NSString *_Nonnull)  roomId
keys: (NSArray< __kindof NSString * > *_Nullable)  keys
completion: (void(^)(EMError *_Nullable aError, NSDictionary< NSString *, NSString * > *_Nullable properties))  completionBlock 
required

获取所有聊天室属性。 异步方法。

参数
roomId聊天室 ID。
keys聊天室的属性keys。传nil会返回全部
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因，成功返回所有键值对。

◆ fetchChatroomInfo:includeMembersList:error:

- (EMChatroom *) fetchChatroomInfo: (NSString *)  aChatroomId
includeMembersList: (BOOL)  aIncludeMembersList
error: (3_1_0) 
(3_3_0) 
("Use -IEMChatroomManager getChatroomSpecificationFromServerWithId:error: instead")  EM_DEPRECATED_IOS 
required

获取聊天室详情。

已废弃，请用 getChatroomSpecificationFromServerWithId:error: 代替。

同步方法，会阻塞当前线程。

参数
aChatroomId聊天室 ID。
aIncludeMembersList是否获取成员列表，为 YES 时，一次性返回 200 个以内成员。
pError错误信息。
返回
聊天室实例，详见 EMChatroom。

◆ getAllChatroomsFromServerWithCompletion:

- (void) getAllChatroomsFromServerWithCompletion: ("Use -getChatroomsFromServerWithPage instead")  __deprecated_msg
required

从服务器获取所有的聊天室。

已废弃，请用 getChatroomsFromServerWithPage 代替。

参数
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ getAllChatroomsFromServerWithError:

- (NSArray *) getAllChatroomsFromServerWithError: ("Use -getChatroomsFromServerWithPage instead")  __deprecated_msg
required

从服务器获取所有的聊天室。

已废弃，请用 getChatroomsFromServerWithPage 代替。

同步方法，会阻塞当前线程。

参数
pError出错信息。
返回
聊天室列表，详见 <EMChatroom>。

◆ getChatroomAnnouncementWithId:completion:

- (void) getChatroomAnnouncementWithId: (NSString *_Nonnull)  aChatroomId
completion: (void(^)(NSString *_Nullable aAnnouncement, EMError *_Nullable aError))  aCompletionBlock 
required

获取聊天室公告。

异步方法。

参数
aChatroomId聊天室 ID。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ getChatroomAnnouncementWithId:error:

- (NSString *_Nullable) getChatroomAnnouncementWithId: (NSString *_Nonnull)  aChatroomId
error: (EMError **_Nullable)  pError 
required

获取聊天室公告。

同步方法，会阻塞当前线程。

参数
aChatroomId聊天室 ID。
pError错误信息。
返回
聊天室公告。

◆ getChatroomBlacklistFromServerWithId:pageNumber:pageSize:completion:

- (void) getChatroomBlacklistFromServerWithId: (NSString *_Nonnull)  aChatroomId
pageNumber: (NSInteger)  aPageNum
pageSize: (NSInteger)  aPageSize
completion: (void(^)(NSArray< NSString * > *_Nullable aList, EMError *_Nullable aError))  aCompletionBlock 
required

获取聊天室黑名单列表。

仅聊天室所有者或者管理员可以获取黑名单。

异步方法。

参数
aChatroomId聊天室 ID。
aPageNum获取第几页。
aPageSize获取多少条。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ getChatroomBlacklistFromServerWithId:pageNumber:pageSize:error:

- (NSArray< NSString * > *_Nullable) getChatroomBlacklistFromServerWithId: (NSString *_Nonnull)  aChatroomId
pageNumber: (NSInteger)  aPageNum
pageSize: (NSInteger)  aPageSize
error: (EMError **_Nullable)  pError 
required

获取聊天室黑名单列表。

仅聊天室所有者或者管理员可以获取黑名单。

同步方法，会阻塞当前线程。

参数
aChatroomId聊天室 ID。
aPageNum获取第几页。
aPageSize获取多少条。
pError错误信息。

◆ getChatroomMemberListFromServerWithId:cursor:pageSize:completion:

- (void) getChatroomMemberListFromServerWithId: (NSString *_Nonnull)  aChatroomId
cursor: (NSString *_Nullable)  aCursor
pageSize: (NSInteger)  aPageSize
completion: (void(^)(EMCursorResult< NSString * > *_Nullable aResult, EMError *_Nullable aError))  aCompletionBlock 
required

获取聊天室成员列表。

异步方法。

参数
aChatroomId聊天室 ID。
aCursor游标，首次调用传空。
aPageSize获取多少条。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ getChatroomMemberListFromServerWithId:cursor:pageSize:error:

- (EMCursorResult< NSString * > *_Nullable) getChatroomMemberListFromServerWithId: (NSString *_Nonnull)  aChatroomId
cursor: (NSString *_Nullable)  aCursor
pageSize: (NSInteger)  aPageSize
error: (EMError **_Nullable)  pError 
required

获取聊天室成员列表。

同步方法，会阻塞当前线程。

参数
aChatroomId聊天室 ID。
aCursor游标，首次调用传空。
aPageSize获取多少条。
pError错误信息。
返回
聊天室成员列表和游标。

◆ getChatroomMuteListFromServerWithId:pageNumber:pageSize:completion:

- (void) getChatroomMuteListFromServerWithId: (NSString *_Nonnull)  aChatroomId
pageNumber: (NSInteger)  aPageNum
pageSize: (NSInteger)  aPageSize
completion: (void(^)(NSArray< NSString * > *_Nullable aList, EMError *_Nullable aError))  aCompletionBlock 
required

获取聊天室被禁言列表。

仅聊天室所有者和管理员可调用此方法。

异步方法。

参数
aChatroomId聊天室 ID。
aPageNum获取第几页。
aPageSize获取多少条。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ getChatroomMuteListFromServerWithId:pageNumber:pageSize:error:

- (NSArray< NSString * > *_Nullable) getChatroomMuteListFromServerWithId: (NSString *_Nonnull)  aChatroomId
pageNumber: (NSInteger)  aPageNum
pageSize: (NSInteger)  aPageSize
error: (EMError **_Nullable)  pError 
required

获取聊天室被禁言列表。

仅聊天室所有者和管理员可调用此方法。

同步方法，会阻塞当前线程。

参数
aChatroomId聊天室 ID。
aPageNum获取第几页。
aPageSize获取多少条。
pError错误信息。

◆ getChatroomsFromServerWithPage:pageSize:completion:

- (void) getChatroomsFromServerWithPage: (NSInteger)  aPageNum
pageSize: (NSInteger)  aPageSize
completion: (void(^)(EMPageResult< EMChatroom * > *_Nullable aResult, EMError *_Nullable aError))  aCompletionBlock 
required

从服务器获取指定数目的聊天室。

异步方法。

参数
aPageNum获取第几页。
aPageSize获取多少条。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ getChatroomsFromServerWithPage:pageSize:error:

- (EMPageResult< EMChatroom * > *_Nullable) getChatroomsFromServerWithPage: (NSInteger)  aPageNum
pageSize: (NSInteger)  aPageSize
error: (EMError **_Nullable)  pError 
required

从服务器获取指定数目的聊天室。

同步方法，会阻塞当前线程。

参数
aPageNum获取第几页。
aPageSize获取多少条。
pError出错信息。
返回
获取的聊天室列表，详见 EMPageResult。

◆ getChatroomSpecificationFromServerByID:includeMembersList:completion:

- (void) getChatroomSpecificationFromServerByID: (NSString *)  aChatroomId
includeMembersList: (BOOL)  aIncludeMembersList
completion: (3_1_0) 
(3_3_0) 
("Use -IEMChatroomManager getChatroomSpecificationFromServerWithId:completion: instead")  EM_DEPRECATED_IOS 
required

获取聊天室详情。

已废弃，请用 getChatroomSpecificationFromServerWithId:completion: 代替。

参数
aChatroomId聊天室 ID。
aIncludeMembersList是否获取成员列表，为 YES 时，返回 200 个成员
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ getChatroomSpecificationFromServerWithId:completion:

- (void) getChatroomSpecificationFromServerWithId: (NSString *_Nonnull)  aChatroomId
completion: (void(^)(EMChatroom *_Nullable aChatroom, EMError *_Nullable aError))  aCompletionBlock 
required

获取聊天室详情。

异步方法。

参数
aChatroomId聊天室 ID
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ getChatroomSpecificationFromServerWithId:error:

- (EMChatroom *_Nullable) getChatroomSpecificationFromServerWithId: (NSString *_Nonnull)  aChatroomId
error: (EMError *_Nullable *)  pError 
required

获取指定的聊天室。

同步方法，会阻塞当前线程。

参数
aChatroomId聊天室 ID。
pError错误信息。
返回
聊天室实例，详见 EMChatroom。

◆ getChatroomSpecificationFromServerWithId:fetchMembers:completion:

- (void) getChatroomSpecificationFromServerWithId: (NSString *_Nonnull)  aChatroomId
fetchMembers: (bool)  aFetchMembers
completion: (void(^)(EMChatroom *_Nullable aChatroom, EMError *_Nullable aError))  aCompletionBlock 
required

获取聊天室详情。

异步方法。

参数
aChatroomId聊天室 ID
aFetchMembers是否获取聊天室成员，为 YES 时，一次性返回 200 个以内成员。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ getChatroomWhiteListFromServerWithId:completion:

- (void) getChatroomWhiteListFromServerWithId: (NSString *_Nonnull)  aChatroomId
completion: (void(^)(NSArray< NSString * > *_Nullable aList, EMError *_Nullable aError))  aCompletionBlock 
required

获取聊天室白名单列表。

仅聊天室所有者和管理员可调用此方法。

异步方法。

参数
aChatroomId聊天室 ID。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ getChatroomWhiteListFromServerWithId:error:

- (NSArray< NSString * > *_Nullable) getChatroomWhiteListFromServerWithId: (NSString *_Nonnull)  aChatroomId
error: (EMError **_Nullable)  pError 
required

获取聊天室白名单列表。

仅聊天室所有者和管理员可调用此方法。

同步方法，会阻塞当前线程。

参数
aChatroomId聊天室 ID。
pError错误信息。

◆ isMemberInWhiteListFromServerWithChatroomId:completion:

- (void) isMemberInWhiteListFromServerWithChatroomId: (NSString *_Nonnull)  aChatroomId
completion: (void(^)(BOOL inWhiteList, EMError *_Nullable aError))  aCompletionBlock 
required

查看当前用户是否在聊天室白名单中。

异步方法。

参数
aChatroomId聊天室 ID。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ isMemberInWhiteListFromServerWithChatroomId:error:

- (BOOL) isMemberInWhiteListFromServerWithChatroomId: (NSString *_Nonnull)  aChatroomId
error: (EMError **_Nullable)  pError 
required

查看当前用户是否在聊天室白名单中。

同步方法，会阻塞当前线程。

参数
aChatroomId聊天室 ID。
pError错误信息。

◆ joinChatroom:completion:

- (void) joinChatroom: (NSString *_Nonnull)  aChatroomId
completion: (void(^)(EMChatroom *_Nullable aChatroom, EMError *_Nullable aError))  aCompletionBlock 
required

加入聊天室。

异步方法。

参数
aChatroomId聊天室的 ID。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ joinChatroom:error:

- (EMChatroom *) joinChatroom: (NSString *_Nonnull)  aChatroomId
error: (EMError **_Nullable)  pError 
required

加入一个聊天室。

同步方法，会阻塞当前线程。

参数
aChatroomId聊天室的 ID。
pError返回的错误信息。
返回
所加入的聊天室，详见 EMChatroom。

◆ leaveChatroom:completion:

- (void) leaveChatroom: (NSString *_Nonnull)  aChatroomId
completion: (void(^)(EMError *_Nullable aError))  aCompletionBlock 
required

退出聊天室。

异步方法。

参数
aChatroomId聊天室 ID。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ leaveChatroom:error:

- (void) leaveChatroom: (NSString *_Nonnull)  aChatroomId
error: (EMError **_Nullable)  pError 
required

退出聊天室。

同步方法，会阻塞当前线程。

参数
aChatroomId聊天室 ID。
pError错误信息。

◆ muteAllMembersFromChatroom:completion:

- (void) muteAllMembersFromChatroom: (NSString *_Nonnull)  aChatroomId
completion: (void(^)(EMChatroom *_Nullable aChatroom, EMError *_Nullable aError))  aCompletionBlock 
required

设置全员禁言。

仅聊天室所有者和管理员可调用此方法。

异步方法。

参数
aChatroomId聊天室 ID。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ muteAllMembersFromChatroom:error:

- (EMChatroom *_Nullable) muteAllMembersFromChatroom: (NSString *_Nonnull)  aChatroomId
error: (EMError **_Nullable)  pError 
required

设置全员禁言。

仅聊天室所有者和管理员可调用此方法。

同步方法，会阻塞当前线程。

参数
aChatroomId聊天室 ID。
pError错误信息
返回
聊天室实例，详见 EMChatroom。

◆ muteMembers:muteMilliseconds:fromChatroom:completion:

- (void) muteMembers: (NSArray< NSString * > *_Nonnull)  aMuteMembers
muteMilliseconds: (NSInteger)  aMuteMilliseconds
fromChatroom: (NSString *_Nonnull)  aChatroomId
completion: (void(^)(EMChatroom *_Nullable aChatroom, EMError *_Nullable aError))  aCompletionBlock 
required

将一组成员禁言。

仅聊天室所有者和管理员可调用此方法。

异步方法。

参数
aMuteMembers要禁言的成员列表。
aMuteMilliseconds禁言时长
aChatroomId聊天室 ID。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ muteMembers:muteMilliseconds:fromChatroom:error:

- (EMChatroom *_Nullable) muteMembers: (NSArray< NSString * > *_Nonnull)  aMuteMembers
muteMilliseconds: (NSInteger)  aMuteMilliseconds
fromChatroom: (NSString *_Nonnull)  aChatroomId
error: (EMError **_Nullable)  pError 
required

将一组成员禁言。

仅聊天室所有者和管理员可调用此方法。

同步方法，会阻塞当前线程。

参数
aMuteMembers要禁言的成员列表。
aMuteMilliseconds禁言时长
aChatroomId聊天室 ID。
pError错误信息
返回
聊天室实例，详见 EMChatroom。

◆ removeAdmin:fromChatroom:completion:

- (void) removeAdmin: (NSString *_Nonnull)  aAdmin
fromChatroom: (NSString *_Nonnull)  aChatroomId
completion: (void(^)(EMChatroom *_Nullable aChatroom, EMError *_Nullable aError))  aCompletionBlock 
required

移除聊天室管理员。

仅聊天室所有者可调用此方法。

异步方法。

参数
aAdmin要添加的聊天室管理员。
aChatroomId聊天室 ID。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ removeAdmin:fromChatroom:error:

- (EMChatroom *_Nullable) removeAdmin: (NSString *_Nonnull)  aAdmin
fromChatroom: (NSString *_Nonnull)  aChatroomId
error: (EMError **_Nullable)  pError 
required

移除聊天室管理员。

仅聊天室所有者可调用此方法。

同步方法，会阻塞当前线程。

参数
aAdmin要移除的聊天室管理员。
aChatroomId聊天室 ID。
pError错误信息
返回
聊天室实例，详见 EMChatroom。

◆ removeChatroomAttribute:key:completionBlock:

- (void) removeChatroomAttribute: (NSString *_Nonnull)  roomId
key: (NSString *_Nonnull)  key
completionBlock: (void(^)(EMError *_Nullable aError))  completionBlock 
required

删除单个聊天室自定义属性。

注解
该方法不删除其他成员设置的属性。

异步方法。

参数
aChatroomId聊天室 ID。
key要删除聊天室自定义属性键值对的 key。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。如果有部分 Key 失败，会返回 failureKeys map，value 是失败原因。

◆ removeChatroomAttributeForced:key:completionBlock:

- (void) removeChatroomAttributeForced: (NSString *_Nonnull)  roomId
key: (NSString *_Nonnull)  key
completionBlock: (void(^)(EMError *_Nullable aError))  completionBlock 
required

强制删除聊天室自定义属性。

注解
该方法支持删除其他成员设置的属性。

异步方法。

参数
aChatroomId聊天室 ID。
key要删除聊天室自定义属性键值对的 key。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。如果有部分 Key 失败，会返回 failureKeys map，value 是失败原因。

◆ removeChatroomAttributes:attributes:completionBlock:

- (void) removeChatroomAttributes: (NSString *_Nonnull)  roomId
attributes: (NSArray< __kindof NSString * > *_Nonnull)  keyValues
completionBlock: (void(^)(EMError *_Nullable aError, NSDictionary< NSString *, EMError * > *_Nullable failureKeys))  completionBlock 
required

删除多个聊天室自定义属性。

注解
该方法不删除其他成员设置的属性。

异步方法。

参数
aChatroomId聊天室 ID。
attributes要删除的聊天室自定义属性的 key 列表。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。如果该方法调用失败，会包含调用失败的原因。如果有部分 Key 失败，会返回 failureKeys map，value 是失败原因。

◆ removeChatroomAttributesForced:attributes:completionBlock:

- (void) removeChatroomAttributesForced: (NSString *_Nonnull)  roomId
attributes: (NSArray< __kindof NSString * > *_Nonnull)  keyValues
completionBlock: (void(^)(EMError *_Nullable aError, NSDictionary< NSString *, EMError * > *_Nullable failureKeys))  completionBlock 
required

强制删除多个聊天室自定义属性。

注解
该方法支持删除其他成员设置的属性。

异步方法。

参数
aChatroomId聊天室 ID。
keyValues要删除聊天室自定义属性的 key 数组。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ removeDelegate:

- (void) removeDelegate: (id< EMChatroomManagerDelegate > _Nonnull)  aDelegate
required

移除回调代理。

参数
aDelegate要移除的代理。

◆ removeMembers:fromChatroom:completion:

- (void) removeMembers: (NSArray< NSString * > *_Nonnull)  aMembers
fromChatroom: (NSString *_Nonnull)  aChatroomId
completion: (void(^)(EMChatroom *_Nullable aChatroom, EMError *_Nullable aError))  aCompletionBlock 
required

将成员移出聊天室。

仅聊天室所有者和管理员可调用此方法。

异步方法。

参数
aMembers要移出的用户列表。
aChatroomId聊天室 ID。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ removeMembers:fromChatroom:error:

- (EMChatroom *_Nullable) removeMembers: (NSArray< NSString * > *_Nonnull)  aMembers
fromChatroom: (NSString *_Nonnull)  aChatroomId
error: (EMError **_Nullable)  pError 
required

将成员移出聊天室。

仅聊天室所有者和管理员可调用此方法。

同步方法，会阻塞当前线程。

参数
aMembers要移出的用户列表。
aChatroomId聊天室 ID。
pError错误信息。
返回
聊天室实例。

◆ removeWhiteListMembers:fromChatroom:completion:

- (void) removeWhiteListMembers: (NSArray< NSString * > *_Nonnull)  aMembers
fromChatroom: (NSString *_Nonnull)  aChatroomId
completion: (void(^)(EMChatroom *_Nullable aChatroom, EMError *_Nullable aError))  aCompletionBlock 
required

移除白名单。

仅聊天室所有者和管理员可调用此方法。

异步方法。

参数
aMembers被移除的列表。
aChatroomId聊天室 ID。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ removeWhiteListMembers:fromChatroom:error:

- (EMChatroom *_Nullable) removeWhiteListMembers: (NSArray< NSString * > *_Nonnull)  aMembers
fromChatroom: (NSString *_Nonnull)  aChatroomId
error: (EMError **_Nullable)  pError 
required

移除白名单。

仅聊天室所有者和管理员可调用此方法。

同步方法，会阻塞当前线程。

参数
aMuteMembers被移除的列表。
aChatroomId聊天室 ID。
pError错误信息。
返回
聊天室实例，详见 EMChatroom。

◆ setChatroomAttribute:key:value:autoDelete:completionBlock:

- (void) setChatroomAttribute: (NSString *_Nonnull)  roomId
key: (NSString *_Nonnull)  key
value: (NSString *_Nonnull)  value
autoDelete: (BOOL)  autoDelete
completionBlock: (void(^)(EMError *_Nullable aError))  completionBlock 
required

设置聊天室单个自定义属性。

注解
该方法不允许覆盖其他成员设置的属性。

异步方法。

参数
roomId聊天室 ID。
key聊天室属性 key，指定属性名。属性名不能超过 128 字符。每个聊天室最多可有 100 个属性。Key 支持以下字符集： • 26 个小写英文字母 a-z； • 26 个大写英文字母 A-Z； • 10 个数字 0-9； • “_”, “-”, “.”。
value聊天室属性值。每个属性值不超过 4096 字符，每个应用的聊天室属性总大小不能超过 10 GB。
autoDelete成员离开聊天室后是否自动删除该聊天室中其设置的所有聊天室自定义属性。
  • （默认）YES:是。
  • NO:否。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。如果有部分 Key 失败，会返回 failureKeys map，value 是失败原因。

◆ setChatroomAttributeForced:key:value:autoDelete:completionBlock:

- (void) setChatroomAttributeForced: (NSString *_Nonnull)  roomId
key: (NSString *_Nonnull)  key
value: (NSString *_Nonnull)  value
autoDelete: (BOOL)  autoDelete
completionBlock: (void(^)(EMError *_Nullable aError))  completionBlock 
required

强制设置单个聊天室自定义属性。

注解
该方法可覆盖其他成员已设置的自定义属性。

异步方法。

参数
roomId聊天室 ID。
key聊天室属性 Key。属性名不能超过 128 字符。每个聊天室最多可有 100 个属性。Key 支持以下字符集：
  • 26 个小写英文字母 a-z；
  • 26 个大写英文字母 A-Z；
  • 10 个数字 0-9；
  • “_”, “-”, “.”。
value聊天室属性 value，属性值。每个属性值不超过 4096 字符，每个应用的聊天室属性总大小不能超过 10 GB。
autoDelete成员离开聊天室后是否自动删除该聊天室中其设置的所有聊天室自定义属性。
  • （默认）YES:是。
  • NO:否。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。如果该方法调用失败，会包含调用失败的原因。如果有部分 Key 失败，会返回 failureKeys map，value 是失败原因。

◆ setChatroomAttributes:attributes:autoDelete:completionBlock:

- (void) setChatroomAttributes: (NSString *_Nonnull)  roomId
attributes: (NSDictionary< NSString *, NSString * > *_Nonnull)  keyValues
autoDelete: (BOOL)  autoDelete
completionBlock: (void(^)(EMError *_Nullable aError, NSDictionary< NSString *, EMError * > *_Nullable failureKeys))  completionBlock 
required

设置多个聊天室自定义属性。

注解
该方法不允许覆盖其他成员设置的属性。

异步方法。

参数
roomId聊天室 ID。
attributes聊天室自定义属性，为键值对（key-value）格式，key 为属性名称，value 为属性值。
autoDelete当前成员退出聊天室后是否自动删除该聊天室中其设置的所有聊天室自定义属性。
  • （默认）YES:是。
  • NO:否。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。如果有部分 Key 失败，会返回 failureKeys map，value 是失败原因。

◆ setChatroomAttributesForced:attributes:autoDelete:completionBlock:

- (void) setChatroomAttributesForced: (NSString *_Nonnull)  roomId
attributes: (NSDictionary< NSString *, NSString * > *_Nonnull)  keyValues
autoDelete: (BOOL)  autoDelete
completionBlock: (void(^)(EMError *_Nullable aError, NSDictionary< NSString *, EMError * > *_Nullable failureKeys))  completionBlock 
required

强制设置多个聊天室自定义属性。

注解
该方法可覆盖其他成员已设置的自定义属性。

异步方法。

参数
roomId聊天室 ID。
attributes聊天室自定义属性，为键值对（key-value）格式，key 为属性名称，value 为属性值。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。如果有部分 Key 失败，会返回 failureKeys map，value 是失败原因。

◆ unblockMembers:fromChatroom:completion:

- (void) unblockMembers: (NSArray< NSString * > *_Nonnull)  aMembers
fromChatroom: (NSString *_Nonnull)  aChatroomId
completion: (void(^)(EMChatroom *_Nullable aChatroom, EMError *_Nullable aError))  aCompletionBlock 
required

从聊天室黑名单中移除。

仅聊天室所有者有权限调用此方法。

异步方法。

参数
aMembers要从黑名单中移除的用户名列表。
aChatroomId聊天室 ID。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ unblockMembers:fromChatroom:error:

- (EMChatroom *_Nullable) unblockMembers: (NSArray< NSString * > *_Nonnull)  aMembers
fromChatroom: (NSString *_Nonnull)  aChatroomId
error: (EMError **_Nullable)  pError 
required

从聊天室黑名单中移除用户。

仅聊天室所有者有权限调用此方法。

同步方法，会阻塞当前线程。

参数
aMembers要从黑名单中移除的用户名列表。
aChatroomId聊天室 ID。
pError错误信息
返回
聊天室实例。

◆ unmuteAllMembersFromChatroom:completion:

- (void) unmuteAllMembersFromChatroom: (NSString *_Nonnull)  aChatroomId
completion: (void(^)(EMChatroom *_Nullable aChatroom, EMError *_Nullable aError))  aCompletionBlock 
required

解除全员禁言。

仅聊天室所有者和管理员可调用此方法。

异步方法。

参数
aChatroomId聊天室 ID。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ unmuteAllMembersFromChatroom:error:

- (EMChatroom *_Nullable) unmuteAllMembersFromChatroom: (NSString *_Nonnull)  aChatroomId
error: (EMError **_Nullable)  pError 
required

解除全员禁言。

仅聊天室所有者和管理员可调用此方法。

同步方法，会阻塞当前线程。

参数
aChatroomId聊天室 ID。
pError错误信息
返回
聊天室实例，详见 EMChatroom。

◆ unmuteMembers:fromChatroom:completion:

- (void) unmuteMembers: (NSArray< NSString * > *_Nonnull)  aMembers
fromChatroom: (NSString *_Nonnull)  aChatroomId
completion: (void(^)(EMChatroom *_Nullable aChatroom, EMError *_Nullable aError))  aCompletionBlock 
required

解除禁言。

仅聊天室所有者和管理员可调用此方法。

异步方法。

参数
aMuteMembers被解除的列表
aChatroomId聊天室 ID。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ unmuteMembers:fromChatroom:error:

- (EMChatroom *_Nullable) unmuteMembers: (NSArray< NSString * > *_Nonnull)  aMembers
fromChatroom: (NSString *_Nonnull)  aChatroomId
error: (EMError **_Nullable)  pError 
required

解除禁言。

仅聊天室所有者和管理员可调用此方法。

同步方法，会阻塞当前线程。

参数
aMuteMembers解除禁言的用户列表。
aChatroomId聊天室 ID。
pError错误信息
返回
聊天室实例，详见 EMChatroom。

◆ updateChatroomAnnouncementWithId:announcement:completion:

- (void) updateChatroomAnnouncementWithId: (NSString *_Nonnull)  aChatroomId
announcement: (NSString *_Nullable)  aAnnouncement
completion: (void(^)(EMChatroom *_Nullable aChatroom, EMError *_Nullable aError))  aCompletionBlock 
required

修改聊天室公告。

仅聊天室所有者和管理员可调用此方法。

异步方法。

参数
aChatroomId聊天室 ID。
aAnnouncement群公告。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ updateChatroomAnnouncementWithId:announcement:error:

- (EMChatroom *_Nullable) updateChatroomAnnouncementWithId: (NSString *_Nonnull)  aChatroomId
announcement: (NSString *_Nullable)  aAnnouncement
error: (EMError **_Nullable)  pError 
required

修改聊天室公告。

仅聊天室所有者和管理员可调用此方法。

同步方法，会阻塞当前线程。

参数
aChatroomId聊天室 ID。
aAnnouncement群公告。
pError错误信息。
返回
聊天室实例，详见 EMChatroom。

◆ updateChatroomOwner:newOwner:completion:

- (void) updateChatroomOwner: (NSString *_Nonnull)  aChatroomId
newOwner: (NSString *_Nonnull)  aNewOwner
completion: (void(^)(EMChatroom *_Nullable aChatroom, EMError *_Nullable aError))  aCompletionBlock 
required

变更聊天室所有者。

仅聊天室所有者可调用此方法。

异步方法。

参数
aChatroomId聊天室 ID。
aNewOwner新聊天室所有者。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ updateChatroomOwner:newOwner:error:

- (EMChatroom *_Nullable) updateChatroomOwner: (NSString *_Nonnull)  aChatroomId
newOwner: (NSString *_Nonnull)  aNewOwner
error: (EMError **_Nullable)  pError 
required

变更聊天室所有者。

仅聊天室所有者可调用此方法。

同步方法，会阻塞当前线程。

参数
aChatroomId聊天室 ID。
aNewOwner新聊天室所有者。
pError错误信息。
返回
聊天室实例。

◆ updateDescription:forChatroom:completion:

- (void) updateDescription: (NSString *_Nullable)  aDescription
forChatroom: (NSString *_Nonnull)  aChatroomId
completion: (void(^)(EMChatroom *_Nullable aChatroom, EMError *_Nullable aError))  aCompletionBlock 
required

更改聊天室说明信息。

仅聊天室所有者有权限调用此方法。

异步方法。

参数
aDescription说明信息。
aChatroomId聊天室 ID。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ updateDescription:forChatroom:error:

- (EMChatroom *_Nullable) updateDescription: (NSString *_Nullable)  aDescription
forChatroom: (NSString *_Nonnull)  aChatroomId
error: (EMError **_Nullable)  pError 
required

更改聊天室说明信息。

仅聊天室所有者有权限调用此方法。

同步方法，会阻塞当前线程。

参数
aDescription说明信息。
aChatroomId聊天室 ID。
pError错误信息。
返回
聊天室实例。

◆ updateSubject:forChatroom:completion:

- (void) updateSubject: (NSString *_Nullable)  aSubject
forChatroom: (NSString *_Nonnull)  aChatroomId
completion: (void(^)(EMChatroom *_Nullable aChatroom, EMError *_Nullable aError))  aCompletionBlock 
required

更改聊天室主题。

仅聊天室所有者有权限调用此方法。

异步方法。

参数
aSubject聊天室新主题。
aChatroomId聊天室 ID。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ updateSubject:forChatroom:error:

- (EMChatroom *) updateSubject: (NSString *_Nullable)  aSubject
forChatroom: (NSString *_Nonnull)  aChatroomId
error: (EMError **_Nullable)  pError 
required

更改聊天室主题。

仅聊天室所有者有权限调用此方法。

同步方法，会阻塞当前线程。

参数
aSubject新聊天室主题。
aChatroomId聊天室 ID。
pError错误信息。
返回
聊天室实例。
该协议的文档由以下文件生成:
制作者 doxygen 1.9.4