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

#import <IEMGroupManager.h>

类 <IEMGroupManager> 继承关系图:

构造函数

(void) - addDelegate:delegateQueue:
 
(void) - removeDelegate:
 
(NSArray< EMGroup * > *_Nullable) - getJoinedGroups
 
(void) - cleanAllGroupsFromDB
 
(void) - getJoinedGroupsCountFromServerWithCompletion:
 
(void) - createGroupWithSubject:avatar:description:invitees:message:setting:completion:
 
(void) - getGroupSpecificationFromServerWithId:completion:
 
(void) - getGroupSpecificationFromServerWithId:fetchMembers:completion:
 
(void) - getGroupMemberListFromServerWithId:cursor:pageSize:completion:
 
(void) - fetchGroupMemberInfoListFromServerWithGroupId:cursor:limit:completion:
 
(void) - getGroupBlacklistFromServerWithId:pageNumber:pageSize:completion:
 
(void) - getGroupMuteListFromServerWithId:pageNumber:pageSize:completion:
 
(void) - fetchGroupMuteListFromServerWithId:pageNumber:pageSize:completion:
 
(void) - getGroupFileListWithId:pageNumber:pageSize:completion:
 
(void) - getGroupWhiteListFromServerWithId:completion:
 
(void) - isMemberInWhiteListFromServerWithGroupId:completion:
 
(void) - isMemberInMuteListFromServerWithGroupId:completion:
 
(void) - getGroupAnnouncementWithId:completion:
 
(void) - joinPublicGroup:completion:
 
(void) - requestToJoinPublicGroup:message:completion:
 
(void) - addMembers:toGroup:message:completion:
 
(void) - removeMembers:fromGroup:completion:
 
(void) - blockMembers:fromGroup:completion:
 
(void) - unblockMembers:fromGroup:completion:
 
(void) - updateGroupSubject:forGroup:completion:
 
(void) - updateGroupAvatar:groupId:completion:
 
(void) - updateGroupWithId:types:configs:completion:
 
(void) - updateDescription:forGroup:completion:
 
(void) - leaveGroup:completion:
 
(void) - destroyGroup:finishCompletion:
 
(void) - blockGroup:completion:
 
(void) - unblockGroup:completion:
 
(void) - updateGroupOwner:newOwner:completion:
 
(void) - addAdmin:toGroup:completion:
 
(void) - removeAdmin:fromGroup:completion:
 
(void) - muteMembers:muteMilliseconds:fromGroup:completion:
 
(void) - unmuteMembers:fromGroup:completion:
 
(void) - muteAllMembersFromGroup:completion:
 
(void) - unmuteAllMembersFromGroup:completion:
 
(void) - addWhiteListMembers:fromGroup:completion:
 
(void) - removeWhiteListMembers:fromGroup:completion:
 
(void) - uploadGroupSharedFileWithId:filePath:progress:completion:
 
(void) - downloadGroupSharedFileWithId:filePath:sharedFileId:progress:completion:
 
(void) - removeGroupSharedFileWithId:sharedFileId:completion:
 
(void) - updateGroupAnnouncementWithId:announcement:completion:
 
(void) - updateGroupExtWithId:ext:completion:
 
(void) - approveJoinGroupRequest:sender:completion:
 
(void) - declineJoinGroupRequest:sender:reason:completion:
 
(void) - acceptInvitationFromGroup:inviter:completion:
 
(void) - declineGroupInvitation:inviter:reason:completion:
 
(void) - setMemberAttribute:userId:attributes:completion:
 
(void) - fetchMemberAttribute:userId:completion:
 
(void) - fetchMembersAttributes:userIds:keys:completion:
 
(void) - updateGroupNamecard:namecard:completion:
 
(NSString *_Nullable) - getGroupNamecardWithGroupId:userId:
 

详细描述

@header IEMGroupManager.h @abstract 群组相关操作类。

作者
Hyphenate
版本
3.00

群组相关操作类。

函数文档

◆ acceptInvitationFromGroup:inviter:completion:

- (void) acceptInvitationFromGroup: (NSString *_Nonnull)  aGroupId
inviter: (NSString *_Nonnull)  aUsername
completion: (void(^)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))  aCompletionBlock 
required

接受入群邀请。

异步方法。

参数
groupId接受的群组 ID。
aUsername邀请者。
pError错误信息。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ addAdmin:toGroup:completion:

- (void) addAdmin: (NSString *_Nonnull)  aAdmin
toGroup: (NSString *_Nonnull)  aGroupId
completion: (void(^)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))  aCompletionBlock 
required

添加群组管理员。

异步方法。

该方法只有群主才有权限调用。

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

◆ addDelegate:delegateQueue:

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

添加回调代理。

参数
aDelegate要添加的代理。
aQueue代理执行的队列，如果是空值，则在主线程。

◆ addMembers:toGroup:message:completion:

- (void) addMembers: (NSArray< NSString * > *_Nonnull)  aUsers
toGroup: (NSString *_Nonnull)  aGroupId
message: (NSString *_Nullable)  aMessage
completion: (void(^)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))  aCompletionBlock 
required

邀请用户加入群组。

参数
aUsers被邀请的用户名列表。
aGroupId群组 ID。
aMessage欢迎信息。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ addWhiteListMembers:fromGroup:completion:

- (void) addWhiteListMembers: (NSArray< NSString * > *_Nonnull)  aMembers
fromGroup: (NSString *_Nonnull)  aGroupId
completion: (void(^)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))  aCompletionBlock 
required

添加白名单。

该方法只有管理员或者群主才有权限调用。

异步方法。

参数
aMembers要添加的成员列表。
aGroupId群组 ID。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ approveJoinGroupRequest:sender:completion:

- (void) approveJoinGroupRequest: (NSString *_Nonnull)  aGroupId
sender: (NSString *_Nonnull)  aUsername
completion: (void(^)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))  aCompletionBlock 
required

批准入群申请。

该方法只有群主才有权限调用。

异步方法。

参数
aGroupId所申请的群组 ID。
aUsername申请人。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ blockGroup:completion:

- (void) blockGroup: (NSString *_Nonnull)  aGroupId
completion: (void(^)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))  aCompletionBlock 
required

屏蔽群消息，服务器不再发送此群的消息给用户，群主不能屏蔽群消息。

参数
aGroupId要屏蔽的群组 ID。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ blockMembers:fromGroup:completion:

- (void) blockMembers: (NSArray< NSString * > *_Nonnull)  aMembers
fromGroup: (NSString *_Nonnull)  aGroupId
completion: (void(^)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))  aCompletionBlock 
required

加人到群组黑名单。

该方法只有群主才有权限调用。

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

◆ cleanAllGroupsFromDB

- (void) cleanAllGroupsFromDB
required

清理数据库中当前用户的所有群组。

◆ createGroupWithSubject:avatar:description:invitees:message:setting:completion:

- (void) createGroupWithSubject: (NSString *_Nullable)  subject
avatar: (NSString *_Nullable)  avatar
description: (NSString *_Nullable)  description
invitees: (NSArray< NSString * > *_Nullable)  invitees
message: (NSString *_Nullable)  message
setting: (EMGroupConfigs *_Nullable)  setting
completion: (void(^)(EMGroup *_Nullable group, EMError *_Nullable error))  completionBlock 
required

创建群组（可带头像）。

异步方法。

参数
subject群组名称。
avatar群组头像。
description群组描述。
invitees群组成员，不包括创建者自己。
message加入群组的邀请消息。
setting群组属性。
completionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ declineGroupInvitation:inviter:reason:completion:

- (void) declineGroupInvitation: (NSString *_Nonnull)  aGroupId
inviter: (NSString *_Nonnull)  aInviter
reason: (NSString *_Nullable)  aReason
completion: (void(^)(EMError *_Nullable aError))  aCompletionBlock 
required

拒绝入群邀请。

异步方法。

参数
aGroupId被拒绝的群组 ID。
aInviter邀请人。
aReason拒绝理由。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ declineJoinGroupRequest:sender:reason:completion:

- (void) declineJoinGroupRequest: (NSString *_Nonnull)  aGroupId
sender: (NSString *_Nonnull)  aUsername
reason: (NSString *_Nullable)  aReason
completion: (void(^)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))  aCompletionBlock 
required

拒绝入群申请。

该方法只有群主才有权限调用。

异步方法。

参数
aGroupId被拒绝的群组 ID。
aUsername申请人。
aReason拒绝理由。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ destroyGroup:finishCompletion:

- (void) destroyGroup: (NSString *_Nonnull)  aGroupId
finishCompletion: (void(^)(EMError *_Nullable aError))  aCompletionBlock 
required

解散群组。

该方法只有群主才有权限调用。

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

◆ downloadGroupSharedFileWithId:filePath:sharedFileId:progress:completion:

- (void) downloadGroupSharedFileWithId: (NSString *_Nonnull)  aGroupId
filePath: (NSString *_Nonnull)  aFilePath
sharedFileId: (NSString *_Nonnull)  aSharedFileId
progress: (void(^)(int progress))  aProgressBlock
completion: (void(^)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))  aCompletionBlock 
required

下载群共享文件。

参数
aGroupId群组 ID。
aFilePath文件路径。
aSharedFileId共享文件 ID。
aProgressBlock文件下载进度回调。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ fetchGroupMemberInfoListFromServerWithGroupId:cursor:limit:completion:

- (void) fetchGroupMemberInfoListFromServerWithGroupId: (NSString *_Nonnull)  groupId
cursor: (NSString *_Nonnull)  cursor
limit: (NSInteger)  limit
completion: (void(^)(EMCursorResult< EMGroupMemberInfo * > *_Nullable cursorResult, EMError *_Nullable error))  completionBlock 
required

获取群组成员列表。 这里需要注意的是：

  • 每次调用只返回一页的数据。首次调用传空值，会从最新的第一条开始取；
  • aPageSize 是这次接口调用期望返回的列表数据个数，如当前在最后一页，返回的数据会是 count < aPageSize；
  • 列表页码 aPageNum 是方便服务器分页查询返回，对于数据量未知且很大的情况，分页获取，服务器会根据每次的页数和每次的pagesize 返回数据，直到返回所有数据。
参数
groupId群组 ID。
cursor游标，首次调用传空。下次传上次返回的值。
limit获取多少条。
completionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。返回结果中携带的群成员的信息包括id以及加群时间

◆ fetchGroupMuteListFromServerWithId:pageNumber:pageSize:completion:

- (void) fetchGroupMuteListFromServerWithId: (NSString *_Nonnull)  aGroupId
pageNumber: (NSInteger)  aPageNum
pageSize: (NSInteger)  aPageSize
completion: (void(^)(NSDictionary< NSString *, NSNumber * > *_Nullable aDict, EMError *_Nullable aError))  aCompletionBlock 
required

获取群组被禁言列表。

该方法只有群主和群管理员允许调用。

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

◆ fetchMemberAttribute:userId:completion:

- (void) fetchMemberAttribute: (NSString *_Nonnull)  groupId
userId: (NSString *_Nonnull)  userId
completion: (void(^)(NSDictionary< NSString *, NSString * > *_Nullable, EMError *_Nullable))  completionBlock 
required

获取单个群成员所有自定义属性。

参数
groupId群组 ID。
userId要获取的自定义属性的群成员的用户 ID。
completion该方法完成调用的回调，返回错误 EMError 和获取的属性的 Map。
  • 若该方法调用成功，返回获取的属性的 Map，包含获取的所有键值对，此时 EMError 为空。
  • 如果该方法调用失败，返回调用失败的原因，即 EMError，此时属性的 Map 为空。
  • 若获取的属性的 Map 为空，而且 EMError 也为空，表示该群成员未设置任何属性。

◆ fetchMembersAttributes:userIds:keys:completion:

- (void) fetchMembersAttributes: (NSString *_Nonnull)  groupId
userIds: (NSArray< __kindof NSString * > *_Nonnull)  userIds
keys: (NSArray< __kindof NSString * > *_Nonnull)  keys
completion: (void(^)(NSDictionary< NSString *, NSDictionary< NSString *, NSString * > * > *_Nullable attributes, EMError *_Nullable error))  completionBlock 
required

根据指定的属性 key 获取多个群成员的自定义属性

参数
groupId群组 ID。
userIds要获取自定义属性的群成员的用户 ID 数组。（最多10个，多则报错）
keys要获取自定义属性的 key 的数组。
completion该方法完成调用的回调，返回错误 EMError 和获取的属性的 Map。
  • 若该方法调用成功，返回获取的属性的 Map，包含获取的所有键值对，此时 EMError 为空。若某个群成员未设置自定义属性，其属性的 Map 为空。
  • 如果该方法调用失败，会包含调用失败的原因，此时属性的 Map 为空。
  • 若获取这些群成员的属性的 Map 为空，而且 EMError 也为空，表示这些群成员未设置任何属性。

◆ getGroupAnnouncementWithId:completion:

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

获取群公告。

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

◆ getGroupBlacklistFromServerWithId:pageNumber:pageSize:completion:

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

获取群组黑名单列表。

该方法只有群主和管理员才有权限调用。

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

◆ getGroupFileListWithId:pageNumber:pageSize:completion:

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

获取群共享文件列表。

异步方法。

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

◆ getGroupMemberListFromServerWithId:cursor:pageSize:completion:

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

获取群组成员列表。 这里需要注意的是：

  • 每次调用只返回一页的数据。首次调用传空值，会从最新的第一条开始取；
  • aPageSize 是这次接口调用期望返回的列表数据个数，如当前在最后一页，返回的数据会是 count < aPageSize；
  • 列表页码 aPageNum 是方便服务器分页查询返回，对于数据量未知且很大的情况，分页获取，服务器会根据每次的页数和每次的pagesize 返回数据，直到返回所有数据。
参数
aGroupId群组 ID。
aCursor游标，首次调用传空。
aPageSize获取多少条。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ getGroupMuteListFromServerWithId:pageNumber:pageSize:completion:

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

获取群组被禁言列表。

该方法只有群主和群管理员允许调用。

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

◆ getGroupNamecardWithGroupId:userId:

- (NSString *_Nullable) getGroupNamecardWithGroupId: (NSString *_Nonnull)  groupId
userId: (NSString *_Nonnull)  userId 
required

获取本地缓存的群成员名片。

参数
groupId群组 ID。
userId要获取群名片的成员用户 ID。
返回
返回缓存中的群昵称，获取不到返回nil。

◆ getGroupSpecificationFromServerWithId:completion:

- (void) getGroupSpecificationFromServerWithId: (NSString *_Nonnull)  aGroupId
completion: (void(^)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))  aCompletionBlock 
required

获取群组详情，包含群组 ID，群组名称，群组描述，群组基本属性，群主，群组管理员。

异步方法。

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

◆ getGroupSpecificationFromServerWithId:fetchMembers:completion:

- (void) getGroupSpecificationFromServerWithId: (NSString *_Nonnull)  aGroupId
fetchMembers: (BOOL)  fetchMembers
completion: (void(^)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))  aCompletionBlock 
required

获取群组详情，包含群组 ID，群组名称，群组描述，群组基本属性，群主，群组管理员。

异步方法。

参数
aGroupId群组 ID。
fetchMembers是否获取群组成员，默认最多取 200 人数。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ getGroupWhiteListFromServerWithId:completion:

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

获取群组白名单列表。

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

◆ getJoinedGroups

- (NSArray< EMGroup * > *_Nullable) getJoinedGroups
required

获取本地缓存用户所有的群组信息。

返回
群组列表。

◆ getJoinedGroupsCountFromServerWithCompletion:

- (void) getJoinedGroupsCountFromServerWithCompletion: (void(^)(NSInteger groupCount, EMError *_Nullable aError))  aCompletionBlock
required

从服务器获取当前用户已加入的群组数量。

异步方法。

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

◆ isMemberInMuteListFromServerWithGroupId:completion:

- (void) isMemberInMuteListFromServerWithGroupId: (NSString *_Nonnull)  aGroupId
completion: (void(^)(BOOL inMuteList, EMError *_Nullable aError))  aCompletionBlock 
required

查看自己是否在群组禁言名单中。

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

◆ isMemberInWhiteListFromServerWithGroupId:completion:

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

查看自己是否在群组白名单中。

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

◆ joinPublicGroup:completion:

- (void) joinPublicGroup: (NSString *_Nonnull)  aGroupId
completion: (void(^)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))  aCompletionBlock 
required

加入一个公开群组。该群组应为公开群，且不需要审批入群申请。

参数
aGroupId公开群组的 ID。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ leaveGroup:completion:

- (void) leaveGroup: (NSString *_Nonnull)  aGroupId
completion: (void(^)(EMError *_Nullable aError))  aCompletionBlock 
required

退出群组，群主不能退出群，只能销毁群。

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

◆ muteAllMembersFromGroup:completion:

- (void) muteAllMembersFromGroup: (NSString *_Nonnull)  aGroupId
completion: (void(^)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))  aCompletionBlock 
required

设置全员禁言。

该方法只有管理员或者群主才有权限调用。

异步方法。

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

◆ muteMembers:muteMilliseconds:fromGroup:completion:

- (void) muteMembers: (NSArray< NSString * > *_Nonnull)  aMuteMembers
muteMilliseconds: (NSInteger)  aMuteMilliseconds
fromGroup: (NSString *_Nonnull)  aGroupId
completion: (void(^)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))  aCompletionBlock 
required

将一组成员禁言。

该方法只有管理员或者群主才有权限调用。

异步方法。

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

◆ removeAdmin:fromGroup:completion:

- (void) removeAdmin: (NSString *_Nonnull)  aAdmin
fromGroup: (NSString *_Nonnull)  aGroupId
completion: (void(^)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))  aCompletionBlock 
required

移除群组管理员。

该方法只有群主才有权限调用。

异步方法。

参数
aAdmin要移除的群组管理员。
aGroupId群组 ID。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ removeDelegate:

- (void) removeDelegate: (id _Nonnull)  aDelegate
required

移除回调代理。

参数
aDelegate要移除的代理。

◆ removeGroupSharedFileWithId:sharedFileId:completion:

- (void) removeGroupSharedFileWithId: (NSString *_Nonnull)  aGroupId
sharedFileId: (NSString *_Nonnull)  aSharedFileId
completion: (void(^)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))  aCompletionBlock 
required

删除群共享文件。

参数
aGroupId群组 ID。
aSharedFileId共享文件 ID。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ removeMembers:fromGroup:completion:

- (void) removeMembers: (NSArray< NSString * > *_Nonnull)  aUsers
fromGroup: (NSString *_Nonnull)  aGroupId
completion: (void(^)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))  aCompletionBlock 
required

将群成员移出群组。

该方法只有群主才有权限调用。

参数
aUsers要移出群组的用户列表。
aGroupId群组 ID。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ removeWhiteListMembers:fromGroup:completion:

- (void) removeWhiteListMembers: (NSArray< NSString * > *_Nonnull)  aMembers
fromGroup: (NSString *_Nonnull)  aGroupId
completion: (void(^)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))  aCompletionBlock 
required

移除白名单。

异步方法。

该方法只有管理员或者群主才有权限调用。

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

◆ requestToJoinPublicGroup:message:completion:

- (void) requestToJoinPublicGroup: (NSString *_Nonnull)  aGroupId
message: (NSString *_Nullable)  aMessage
completion: (void(^)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))  aCompletionBlock 
required

申请加入一个需要审批的公开群组。

参数
aGroupId公开群组的 ID。
aMessage请求加入的信息。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ setMemberAttribute:userId:attributes:completion:

- (void) setMemberAttribute: (NSString *_Nonnull)  groupId
userId: (NSString *_Nonnull)  userId
attributes: (NSDictionary< NSString *, NSString * > *_Nonnull)  attributes
completion: (void(^)(EMError *_Nullable error))  completionBlock 
required

设置群成员自定义属性。

参数
groupId群组 ID。
userId要设置自定义属性的群成员的用户 ID。
attributes要设置的群成员自定义属性的 map，为 key-value 格式。对于一个 key-value 键值对，若 value 设置空字符串即删除该自定义属性。
completion该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ unblockGroup:completion:

- (void) unblockGroup: (NSString *_Nonnull)  aGroupId
completion: (void(^)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))  aCompletionBlock 
required

取消屏蔽群消息。

参数
aGroupId要取消屏蔽的群组 ID。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ unblockMembers:fromGroup:completion:

- (void) unblockMembers: (NSArray< NSString * > *_Nonnull)  aMembers
fromGroup: (NSString *_Nonnull)  aGroupId
completion: (void(^)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))  aCompletionBlock 
required

从群组黑名单中移除。

该方法只有群主才有权限调用。

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

◆ unmuteAllMembersFromGroup:completion:

- (void) unmuteAllMembersFromGroup: (NSString *_Nonnull)  aGroupId
completion: (void(^)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))  aCompletionBlock 
required

解除全员禁言。

该方法只有管理员或者群主才有权限调用。

异步方法。

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

◆ unmuteMembers:fromGroup:completion:

- (void) unmuteMembers: (NSArray< NSString * > *_Nonnull)  aMembers
fromGroup: (NSString *_Nonnull)  aGroupId
completion: (void(^)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))  aCompletionBlock 
required

解除禁言。

该方法只有管理员或者群主才有权限调用。

异步方法。

参数
aMuteMembers被解除禁言的用户列表。
aGroupId群组 ID。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ updateDescription:forGroup:completion:

- (void) updateDescription: (NSString *_Nullable)  aDescription
forGroup: (NSString *_Nonnull)  aGroupId
completion: (void(^)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))  aCompletionBlock 
required

更改群组说明信息。

该方法只有群主才有权限调用。

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

◆ updateGroupAnnouncementWithId:announcement:completion:

- (void) updateGroupAnnouncementWithId: (NSString *_Nonnull)  aGroupId
announcement: (NSString *_Nullable)  aAnnouncement
completion: (void(^)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))  aCompletionBlock 
required

修改群公告。

该方法只有管理员或者群主才有权限调用。

异步方法。

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

◆ updateGroupAvatar:groupId:completion:

- (void) updateGroupAvatar: (NSString *_Nullable)  avatar
groupId: (NSString *_Nonnull)  groupId
completion: (void(^)(EMGroup *_Nullable group, EMError *_Nullable error))  completionBlock 
required

更改群组头像 。

该方法只有群主才有权限调用。

参数
avatar新头像。
groupId群组 ID。
completionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ updateGroupExtWithId:ext:completion:

- (void) updateGroupExtWithId: (NSString *_Nonnull)  aGroupId
ext: (NSString *_Nullable)  aExt
completion: (void(^)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))  aCompletionBlock 
required

修改群扩展信息。

该方法只有群主才有权限调用。

参数
aGroupId群组 ID。
aExt扩展信息。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ updateGroupNamecard:namecard:completion:

- (void) updateGroupNamecard: (NSString *_Nonnull)  groupId
namecard: (NSString *_Nullable)  namecard
completion: (void(^)(EMError *_Nullable error))  completionBlock 
required

修改自己的群名片。

参数
groupId群组 ID。
namecard要设置的群名片，传 nil 表示删除
completion该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ updateGroupOwner:newOwner:completion:

- (void) updateGroupOwner: (NSString *_Nonnull)  aGroupId
newOwner: (NSString *_Nonnull)  aNewOwner
completion: (void(^)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))  aCompletionBlock 
required

改变群主。

该方法只有群主才有权限调用。

参数
aGroupId群组 ID。
aNewOwner新群主。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ updateGroupSubject:forGroup:completion:

- (void) updateGroupSubject: (NSString *_Nullable)  aSubject
forGroup: (NSString *_Nonnull)  aGroupId
completion: (void(^)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))  aCompletionBlock 
required

更改群组主题 。

该方法只有群主才有权限调用。

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

◆ updateGroupWithId:types:configs:completion:

- (void) updateGroupWithId: (NSString *_Nonnull)  groupId
types: (EMGroupConfigsType)  type
configs: (EMGroupConfigs *_Nonnull)  configs
completion: (void(^)(EMGroup *_Nullable group, EMError *_Nullable error))  aCompletionBlock 
required

批量更新群组属性。

该方法只有群主才有权限调用。

参数
groupId群组 ID。
type需要更新的群组属性字段，可按位或组合。只有选中的字段会从 options 中读取。
options群组属性选项。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ uploadGroupSharedFileWithId:filePath:progress:completion:

- (void) uploadGroupSharedFileWithId: (NSString *_Nonnull)  aGroupId
filePath: (NSString *_Nonnull)  aFilePath
progress: (void(^)(int progress))  aProgressBlock
completion: (void(^)(EMGroupSharedFile *_Nullable aSharedFile, EMError *_Nullable aError))  aCompletionBlock 
required

上传群共享文件。

参数
aGroupId群组 ID。
aFilePath文件路径。
pError错误信息。
返回
群组实例。
该协议的文档由以下文件生成:
制作者 doxygen 1.9.4