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

#import <IEMGroupManager.h>

类 <IEMGroupManager> 继承关系图:

构造函数

(void) - addDelegate:delegateQueue:
 
(void) - removeDelegate:
 
(NSArray< EMGroup * > *_Nullable) - getJoinedGroups
 
(NSArray *) - getGroupsWithoutPushNotification:
 
(NSArray< EMGroup * > *_Nullable) - getJoinedGroupsFromServerWithPage:pageSize:error:
 
(EMCursorResult< EMGroup * > *_Nullable) - getPublicGroupsFromServerWithCursor:pageSize:error:
 
(void) - getPublicGroupsFromServerWithCursor:pageSize:completion:
 
(EMGroup *_Nullable) - searchPublicGroupWithId:error:
 
(void) - searchPublicGroupWithId:completion:
 
(void) - getJoinedGroupsCountFromServerWithCompletion:
 
(EMGroup *_Nullable) - createGroupWithSubject:description:invitees:message:setting:error:
 
(void) - createGroupWithSubject:description:invitees:message:setting:completion:
 
(EMGroup *_Nullable) - getGroupSpecificationFromServerWithId:error:
 
(EMGroup *_Nullable) - getGroupSpecificationFromServerWithId:fetchMembers:error:
 
(void) - getGroupSpecificationFromServerWithId:completion:
 
(void) - getGroupSpecificationFromServerWithId:fetchMembers:completion:
 
(EMCursorResult< NSString * > *) - getGroupMemberListFromServerWithId:cursor:pageSize:error:
 
(void) - getGroupMemberListFromServerWithId:cursor:pageSize:completion:
 
(NSArray< NSString * > *_Nullable) - getGroupBlacklistFromServerWithId:pageNumber:pageSize:error:
 
(void) - getGroupBlacklistFromServerWithId:pageNumber:pageSize:completion:
 
(NSArray< NSString * > *_Nullable) - getGroupMuteListFromServerWithId:pageNumber:pageSize:error:
 
(void) - getGroupMuteListFromServerWithId:pageNumber:pageSize:completion:
 
(void) - fetchGroupMuteListFromServerWithId:pageNumber:pageSize:completion:
 
(NSArray< EMGroupSharedFile * > *_Nullable) - getGroupFileListWithId:pageNumber:pageSize:error:
 
(void) - getGroupFileListWithId:pageNumber:pageSize:completion:
 
(NSArray *) - getGroupWhiteListFromServerWithId:error:
 
(void) - getGroupWhiteListFromServerWithId:completion:
 
(BOOL) - isMemberInWhiteListFromServerWithGroupId:error:
 
(void) - isMemberInWhiteListFromServerWithGroupId:completion:
 
(NSString *_Nullable) - getGroupAnnouncementWithId:error:
 
(void) - getGroupAnnouncementWithId:completion:
 
(EMGroup *_Nullable) - addOccupants:toGroup:welcomeMessage:error:
 
(void) - addMembers:toGroup:message:completion:
 
(EMGroup *_Nullable) - removeOccupants:fromGroup:error:
 
(void) - removeMembers:fromGroup:completion:
 
(EMGroup *_Nullable) - blockOccupants:fromGroup:error:
 
(void) - blockMembers:fromGroup:completion:
 
(EMGroup *_Nullable) - unblockOccupants:forGroup:error:
 
(void) - unblockMembers:fromGroup:completion:
 
(EMGroup *_Nullable) - changeGroupSubject:forGroup:error:
 
(void) - updateGroupSubject:forGroup:completion:
 
(EMGroup *_Nullable) - changeDescription:forGroup:error:
 
(void) - updateDescription:forGroup:completion:
 
(void) - leaveGroup:error:
 
(void) - leaveGroup:completion:
 
(EMError *) - destroyGroup:
 
(void) - destroyGroup:finishCompletion:
 
(EMGroup *_Nullable) - blockGroup:error:
 
(void) - blockGroup:completion:
 
(EMGroup *_Nullable) - unblockGroup:error:
 
(void) - unblockGroup:completion:
 
(EMGroup *_Nullable) - updateGroupOwner:newOwner:error:
 
(void) - updateGroupOwner:newOwner:completion:
 
(EMGroup *_Nullable) - addAdmin:toGroup:error:
 
(void) - addAdmin:toGroup:completion:
 
(EMGroup *_Nullable) - removeAdmin:fromGroup:error:
 
(void) - removeAdmin:fromGroup:completion:
 
(EMGroup *_Nullable) - muteMembers:muteMilliseconds:fromGroup:error:
 
(void) - muteMembers:muteMilliseconds:fromGroup:completion:
 
(EMGroup *_Nullable) - unmuteMembers:fromGroup:error:
 
(void) - unmuteMembers:fromGroup:completion:
 
(EMGroup *_Nullable) - muteAllMembersFromGroup:error:
 
(void) - muteAllMembersFromGroup:completion:
 
(EMGroup *_Nullable) - unmuteAllMembersFromGroup:error:
 
(void) - unmuteAllMembersFromGroup:completion:
 
(EMGroup *_Nullable) - addWhiteListMembers:fromGroup:error:
 
(void) - addWhiteListMembers:fromGroup:completion:
 
(EMGroup *_Nullable) - removeWhiteListMembers:fromGroup:error:
 
(void) - removeWhiteListMembers:fromGroup:completion:
 
(void) - uploadGroupSharedFileWithId:filePath:progress:completion:
 
(void) - downloadGroupSharedFileWithId:filePath:sharedFileId:progress:completion:
 
(EMGroup *_Nullable) - removeGroupSharedFileWithId:sharedFileId:error:
 
(void) - removeGroupSharedFileWithId:sharedFileId:completion:
 
(EMGroup *_Nullable) - updateGroupAnnouncementWithId:announcement:error:
 
(void) - updateGroupAnnouncementWithId:announcement:completion:
 
(EMGroup *_Nullable) - updateGroupExtWithId:ext:error:
 
(void) - updateGroupExtWithId:ext:completion:
 
(EMGroup *_Nullable) - joinPublicGroup:error:
 
(void) - joinPublicGroup:completion:
 
(EMGroup *_Nullable) - applyJoinPublicGroup:message:error:
 
(void) - requestToJoinPublicGroup:message:completion:
 
(EMError *) - acceptJoinApplication:applicant:
 
(void) - approveJoinGroupRequest:sender:completion:
 
(EMError *) - declineJoinApplication:applicant:reason:
 
(void) - declineJoinGroupRequest:sender:reason:completion:
 
(EMGroup *_Nullable) - acceptInvitationFromGroup:inviter:error:
 
(void) - acceptInvitationFromGroup:inviter:completion:
 
(EMError *) - declineInvitationFromGroup:inviter:reason:
 
(void) - declineGroupInvitation:inviter:reason:completion:
 
(void) - getJoinedGroupsFromServerWithPage:pageSize:needMemberCount:needRole:completion:
 
(EMError *) - ignoreGroupPush:ignore:
 
(void) - updatePushServiceForGroup:isPushEnabled:completion:
 
(EMError *) - ignoreGroupsPush:ignore:
 
(void) - updatePushServiceForGroups:isPushEnabled:completion:
 
(void) - setMemberAttribute:userId:attributes:completion:
 
(void) - fetchMemberAttribute:userId:completion:
 
(void) - fetchMembersAttributes:userIds:keys:completion:
 
(void) - getJoinedGroupsFromServerWithPage:pageSize:completion:
 

详细描述

@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该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。

◆ acceptInvitationFromGroup:inviter:error:

- (EMGroup *_Nullable) acceptInvitationFromGroup: (NSString *_Nonnull)  aGroupId
inviter: (NSString *_Nonnull)  aUsername
error: (EMError **_Nullable)  pError 
required

接受入群邀请。

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

参数
groupId接受的群组 ID。
aUsername邀请者。
pError错误信息。
返回
接受的群组实例。

◆ acceptJoinApplication:applicant:

- (EMError *) acceptJoinApplication: (NSString *_Nonnull)  aGroupId
applicant: (NSString *_Nonnull)  aUsername 
required

批准入群申请。

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

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

参数
aGroupId所申请的群组 ID。
aUsername申请人。
返回
错误信息。

◆ 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该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。

◆ addAdmin:toGroup:error:

- (EMGroup *_Nullable) addAdmin: (NSString *_Nonnull)  aAdmin
toGroup: (NSString *_Nonnull)  aGroupId
error: (EMError **_Nullable)  pError 
required

添加群组管理员。

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

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

参数
aAdmin要添加的群组管理员。
aGroupId群组 ID。
pError错误信息。
返回
返回群组实例。

◆ 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该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。

◆ addOccupants:toGroup:welcomeMessage:error:

- (EMGroup *_Nullable) addOccupants: (NSArray< NSString * > *_Nonnull)  aOccupants
toGroup: (NSString *_Nonnull)  aGroupId
welcomeMessage: (NSString *_Nullable)  aWelcomeMessage
error: (EMError **_Nullable)  pError 
required

邀请用户加入群组。

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

参数
aOccupants被邀请的用户名列表。
aGroupId群组 ID。
aWelcomeMessage欢迎信息。
pError错误信息。
返回
群组实例。失败返回空值。

◆ 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该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。

◆ addWhiteListMembers:fromGroup:error:

- (EMGroup *_Nullable) addWhiteListMembers: (NSArray< NSString * > *_Nonnull)  aMembers
fromGroup: (NSString *_Nonnull)  aGroupId
error: (EMError **_Nullable)  pError 
required

添加白名单。

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

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

参数
aMuteMembers要添加的成员列表。
aGroupId群组 ID。
pError错误信息。
返回
群组实例。

◆ applyJoinPublicGroup:message:error:

- (EMGroup *_Nullable) applyJoinPublicGroup: (NSString *_Nonnull)  aGroupId
message: (NSString *_Nullable)  aMessage
error: (EMError **_Nullable)  pError 
required

申请加入一个需批准的公开群组,群类型应该是 EMGroupStylePublicJoinNeedApproval。

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

参数
aGroupId公开群组的 ID。
aMessage请求加入的信息。
pError错误信息。
返回
申请加入的公开群组。

◆ 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该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。

◆ blockGroup:error:

- (EMGroup *_Nullable) blockGroup: (NSString *_Nonnull)  aGroupId
error: (EMError **_Nullable)  pError 
required

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

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

参数
aGroupId要屏蔽的群 ID。
pError错误信息。
返回
群组实例。

◆ 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该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。

◆ blockOccupants:fromGroup:error:

- (EMGroup *_Nullable) blockOccupants: (NSArray< NSString * > *_Nonnull)  aOccupants
fromGroup: (NSString *_Nonnull)  aGroupId
error: (EMError **_Nullable)  pError 
required

加人到群组黑名单。

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

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

参数
aOccupants要加入黑名单的用户。
aGroupId群组 ID。
pError错误信息。
返回
群组实例。

◆ changeDescription:forGroup:error:

- (EMGroup *_Nullable) changeDescription: (NSString *_Nullable)  aDescription
forGroup: (NSString *_Nonnull)  aGroupId
error: (EMError **_Nullable)  pError 
required

更改群组说明信息。

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

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

参数
aDescription说明信息。
aGroupId群组 ID。
pError错误信息。
返回
群组实例。

◆ changeGroupSubject:forGroup:error:

- (EMGroup *_Nullable) changeGroupSubject: (NSString *_Nullable)  aSubject
forGroup: (NSString *_Nonnull)  aGroupId
error: (EMError **_Nullable)  pError 
required

更改群组主题。

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

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

参数
aSubject新主题。
aGroupId群组 ID。
pError错误信息。
返回
群组实例。

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

- (void) createGroupWithSubject: (NSString *_Nullable)  aSubject
description: (NSString *_Nullable)  aDescription
invitees: (NSArray< NSString * > *_Nullable)  aInvitees
message: (NSString *_Nullable)  aMessage
setting: (EMGroupOptions *_Nullable)  aSetting
completion: (void(^)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))  aCompletionBlock 
required

创建群组。

异步方法。

参数
aSubject群组名称。
aDescription群组描述。
aInvitees群组成员,不包括创建者自己。
aMessage加入群组的邀请消息。
aSetting群组属性。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。

◆ createGroupWithSubject:description:invitees:message:setting:error:

- (EMGroup *_Nullable) createGroupWithSubject: (NSString *_Nullable)  aSubject
description: (NSString *_Nullable)  aDescription
invitees: (NSArray< NSString * > *_Nullable)  aInvitees
message: (NSString *_Nullable)  aMessage
setting: (EMGroupOptions *_Nullable)  aSetting
error: (EMError **_Nullable)  pError 
required

创建群组。

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

参数
aSubject群组名称。
aDescription群组描述。
aInvitees群组成员,不包括创建者自己。
aMessage加入群组的邀请消息。
aSetting群组属性。
pError出错信息。
返回
群组实例。

◆ 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该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。

◆ declineInvitationFromGroup:inviter:reason:

- (EMError *) declineInvitationFromGroup: (NSString *_Nonnull)  aGroupId
inviter: (NSString *_Nonnull)  aUsername
reason: (NSString *_Nullable)  aReason 
required

拒绝入群邀请。

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

参数
aGroupId被拒绝的群组 ID。
aUsername邀请人。
aReason拒绝理由。
返回
错误信息。

◆ declineJoinApplication:applicant:reason:

- (EMError *) declineJoinApplication: (NSString *_Nonnull)  aGroupId
applicant: (NSString *_Nonnull)  aUsername
reason: (NSString *_Nullable)  aReason 
required

拒绝入群申请。

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

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

参数
aGroupId被拒绝的群组 ID。
aUsername申请人。
aReason拒绝理由。
返回
错误信息。

◆ 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:

- (EMError *) destroyGroup: (NSString *_Nonnull)  aGroupId
required

解散群组。

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

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

参数
aGroupId群组 ID。
返回
EMError 错误信息。成功返回 nil。

◆ 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该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。

◆ 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 *aAnnouncement, EMError *_Nullable aError))  aCompletionBlock 
required

获取群公告。

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

◆ getGroupAnnouncementWithId:error:

- (NSString *_Nullable) getGroupAnnouncementWithId: (NSString *_Nonnull)  aGroupId
error: (EMError **_Nullable)  pError 
required

获取群公告。

参数
aGroupId群组 ID。
pError错误信息。
返回
群公告。失败返回空值。

◆ 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该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。

◆ getGroupBlacklistFromServerWithId:pageNumber:pageSize:error:

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

获取群组黑名单列表。 这里需要注意的是:

  • 每次调用只返回一页的数据。首次调用传空值,会从最新的第一条开始取;
  • aPageSize 是这次接口调用期望返回的列表数据个数,如当前在最后一页,返回的数据会是 count < aPageSize;
  • 列表页码 aPageNum 是方便服务器分页查询返回,对于数据量未知且很大的情况,分页获取,服务器会根据每次的页数和每次的pagesize 返回数据,直到返回所有数据。

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

参数
aGroupId群组 ID。
aPageNum获取第几页。
aPageSize获取多少条。
pError错误信息。
返回
黑名单列表。

◆ 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该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。

◆ getGroupFileListWithId:pageNumber:pageSize:error:

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

获取群共享文件列表。

参数
aGroupId群组 ID。
aPageNum获取第几页。
aPageSize获取多少条。
pError错误信息。
返回
群共享文件列表。

◆ getGroupMemberListFromServerWithId:cursor:pageSize:completion:

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

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

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

◆ getGroupMemberListFromServerWithId:cursor:pageSize:error:

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

获取群组成员列表。

这里需要注意的是:

  • 每次调用只返回一页的数据。首次调用传空值,会从最新的第一条开始取;
  • aPageSize 是这次接口调用期望返回的列表数据个数,如当前在最后一页,返回的数据会是 count < aPageSize;
  • 列表页码 aPageNum 是方便服务器分页查询返回,对于数据量未知且很大的情况,分页获取,服务器会根据每次的页数和每次的pagesize 返回数据,直到返回所有数据。

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

参数
aGroupId群组 ID。
aCursor游标,首次调用传空。使用场景:第一次传 nil ,然后根据服务器返回的数据,其中有一个字段是 aCursor,保存本地,下次调用接口时,会把更新的aCursor 传入作为获取数据的标志位置。
aPageSize调用接口时,指定期望返回的列表数据个数。
pError错误信息。
返回
列表和游标。

◆ 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该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。

◆ getGroupMuteListFromServerWithId:pageNumber:pageSize:error:

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

获取群组被禁言列表。

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

参数
aGroupId群组 ID。
aPageNum获取第几页。
aPageSize获取多少条。
pError错误信息。
返回
群组被禁言列表。

◆ getGroupSpecificationFromServerWithId:completion:

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

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

异步方法。

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

◆ getGroupSpecificationFromServerWithId:error:

- (EMGroup *_Nullable) getGroupSpecificationFromServerWithId: (NSString *_Nonnull)  aGroupId
error: (EMError **_Nullable)  pError 
required

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

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

参数
aGroupId群组 ID。
pError错误信息。
返回
群组实例。

◆ 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该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。

◆ getGroupSpecificationFromServerWithId:fetchMembers:error:

- (EMGroup *_Nullable) getGroupSpecificationFromServerWithId: (NSString *_Nonnull)  aGroupId
fetchMembers: (BOOL)  fetchMembers
error: (EMError **_Nullable)  pError 
required

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

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

参数
aGroupId群组 ID。
fetchMembers是否获取群组成员,默认最多取 200 人。
pError错误信息。
返回
群组实例。

◆ getGroupsWithoutPushNotification:

- (NSArray *) getGroupsWithoutPushNotification: (3_3_2) 
(3_8_3) 
("Use -IEMPushManager::noPushGroups")  EM_DEPRECATED_IOS 
required

从内存中获取屏蔽了推送的群组 ID 列表。

参数
pError错误信息。
返回
群组 ID 列表。

◆ getGroupWhiteListFromServerWithId:completion:

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

获取群组白名单列表。

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

◆ getGroupWhiteListFromServerWithId:error:

- (NSArray *) getGroupWhiteListFromServerWithId: (NSString *_Nonnull)  aGroupId
error: (EMError **_Nullable)  pError 
required

获取群组白名单列表。

参数
aGroupId群组 ID。
pError错误信息。
返回
群组白名单列表。

◆ getJoinedGroups

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

获取用户所有群组。

返回
群组列表。

◆ getJoinedGroupsCountFromServerWithCompletion:

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

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

异步方法。

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

◆ getJoinedGroupsFromServerWithPage:pageSize:completion:

- (void) getJoinedGroupsFromServerWithPage: (NSInteger)  aPageNum
pageSize: (NSInteger)  aPageSize
completion: ("Use -getJoinedGroupsFromServerWithPage:pageSize:needMemberCount:needRole:error:completion: instead")  __deprecated_msg 
required

按数目从服务器获取自己加入的群组。

已废弃,请用 getJoinedGroupsFromServerWithPage:pageSize:needMemberCount:needRole:error:completion: 代替。

异步方法。

参数
aPageNum获取自己加入群的游标,首次调用传空。
aPageSize期望返回结果的数量, 如果小于 0 则一次返回所有结果。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。

◆ getJoinedGroupsFromServerWithPage:pageSize:error:

- (NSArray< EMGroup * > *_Nullable) getJoinedGroupsFromServerWithPage: (NSInteger)  aPageNum
pageSize: (NSInteger)  aPageSize
error: (EMError **_Nullable)  pError 
required

按数目从服务器获取自己加入的群组。

这里需要注意的是:

  • 每次调用只返回一页的数据。首次调用传空值,会从最新的第一条开始取;
  • aPageSize 是这次接口调用期望返回的列表数据个数,如当前在最后一页,返回的数据会是 count < aPageSize;
  • 列表页码 aPageNum 是方便服务器分页查询返回,对于数据量未知且很大的情况,分页获取,服务器会根据每次的页数和每次的pagesize 返回数据,直到返回所有数据。

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

参数
aPageNum获取自己加入群的游标,首次调用传空。
aPageSize期望返回结果的数量, 如果小于 0 则一次返回所有结果。
pError出错信息。
返回
群组列表。

◆ getJoinedGroupsFromServerWithPage:pageSize:needMemberCount:needRole:completion:

- (void) getJoinedGroupsFromServerWithPage: (NSInteger)  aPageNum
pageSize: (NSInteger)  aPageSize
needMemberCount: (BOOL)  aNeedMemberCount
needRole: (BOOL)  aNeedRole
completion: (void(^)(NSArray< EMGroup * > *_Nullable aList, EMError *_Nullable aError))  aCompletionBlock 
required

从服务器分页获取当前用户加入的群组。

  • 异步方法。
参数
aPageNum当前页码,从 0 开始。该参数设置后,SDK 从指定位置按照用户加入群组的逆序查询。 首次查询设置为 0,SDK 从最新加入的群组开始查询。
aPageSize每次期望获取的社区数量。取值范围为 [1,20]。
aNeedMemberCount是否需要群组成员数。
  • YES:是;
  • NO:否;
aNeedRole是否需要当前用户的角色。
  • YES:是;
  • NO:否;
aCompletionBlock该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。

◆ getPublicGroupsFromServerWithCursor:pageSize:completion:

- (void) getPublicGroupsFromServerWithCursor: (NSString *_Nullable)  aCursor
pageSize: (NSInteger)  aPageSize
completion: (void(^)(EMCursorResult< EMGroup * > *_Nullable aResult, EMError *_Nullable aError))  aCompletionBlock 
required

从服务器获取指定范围内的公开群。

异步方法。

参数
aCursor获取公开群的游标,首次调用传空。
aPageSize期望返回结果的数量, 如果小于 0 则一次返回所有结果。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。

◆ getPublicGroupsFromServerWithCursor:pageSize:error:

- (EMCursorResult< EMGroup * > *_Nullable) getPublicGroupsFromServerWithCursor: (NSString *_Nullable)  aCursor
pageSize: (NSInteger)  aPageSize
error: (EMError **_Nullable)  pError 
required

从服务器获取指定范围内的公开群。

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

参数
aCursor获取公开群的游标,首次调用传空。
aPageSize期望返回结果的数量, 如果小于 0 则一次返回所有结果。
pError出错信息。
返回
获取的公开群结果。

◆ ignoreGroupPush:ignore:

- (EMError *) ignoreGroupPush: (NSString *)  aGroupId
ignore: (3_3_2) 
(3_8_3) 
("Use -IEMPushManager::updatePushServiceForGroups:disablePush:")  EM_DEPRECATED_IOS 
required

屏蔽/取消屏蔽群组消息的推送。

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

已废弃,请用 IEMPushManager::updatePushServiceForGroups:disablePush: 代替。

参数
aGroupId群组 ID。
aIgnore是否屏蔽。
返回
错误信息。

◆ ignoreGroupsPush:ignore:

- (EMError *) ignoreGroupsPush: (NSArray *)  aGroupIDs
ignore: (3_3_2) 
(3_8_3) 
("Use -IEMPushManager::updatePushServiceForGroups:disablePush:")  EM_DEPRECATED_IOS 
required

屏蔽/取消屏蔽群组消息的推送。

已废弃,请用 IEMPushManager::updatePushServiceForGroups:disablePush: 代替。

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

参数
aGroupIDs群组 ID 列表。
aIgnore是否屏蔽。
返回
错误信息。

◆ isMemberInWhiteListFromServerWithGroupId:completion:

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

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

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

◆ isMemberInWhiteListFromServerWithGroupId:error:

- (BOOL) isMemberInWhiteListFromServerWithGroupId: (NSString *_Nonnull)  aGroupId
error: (EMError **_Nullable)  pError 
required

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

参数
aGroupId群组 ID。
pError错误信息。
返回
布尔值。 YES: 在白名单; NO: 不在白名单。

◆ joinPublicGroup:completion:

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

加入一个公开群组,群类型应该是 EMGroupStylePublicOpenJoin。

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

◆ joinPublicGroup:error:

- (EMGroup *_Nullable) joinPublicGroup: (NSString *_Nonnull)  aGroupId
error: (EMError **_Nullable)  pError 
required

加入一个公开群组,群类型应该是 EMGroupStylePublicOpenJoin。

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

参数
aGroupId公开群组的 ID。
pError错误信息。
返回
所加入的公开群组。

◆ leaveGroup:completion:

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

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

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

◆ leaveGroup:error:

- (void) leaveGroup: (NSString *_Nonnull)  aGroupId
error: (EMError **_Nullable)  pError 
required

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

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

参数
aGroupId群组 ID。
pError错误信息。

◆ muteAllMembersFromGroup:completion:

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

设置全员禁言。

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

异步方法。

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

◆ muteAllMembersFromGroup:error:

- (EMGroup *_Nullable) muteAllMembersFromGroup: (NSString *_Nonnull)  aGroupId
error: (EMError **_Nullable)  pError 
required

设置全员禁言。

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

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

参数
aGroupId群组 ID。
pError错误信息。
返回
群组实例。

◆ 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该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。

◆ muteMembers:muteMilliseconds:fromGroup:error:

- (EMGroup *_Nullable) muteMembers: (NSArray< NSString * > *_Nonnull)  aMuteMembers
muteMilliseconds: (NSInteger)  aMuteMilliseconds
fromGroup: (NSString *_Nonnull)  aGroupId
error: (EMError **_Nullable)  pError 
required

将一组成员禁言。

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

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

参数
aMuteMembers要禁言的成员列表。
aMuteMilliseconds禁言时长。
aGroupId群组 ID。
pError错误信息。
返回
返回群组实例。

◆ 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该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。

◆ removeAdmin:fromGroup:error:

- (EMGroup *_Nullable) removeAdmin: (NSString *_Nonnull)  aAdmin
fromGroup: (NSString *_Nonnull)  aGroupId
error: (EMError **_Nullable)  pError 
required

移除群组管理员。

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

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

参数
aAdmin要移除的群组管理员。
aGroupId群组 ID。
pError错误信息。
返回
返回群组实例。

◆ 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该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。

◆ removeGroupSharedFileWithId:sharedFileId:error:

- (EMGroup *_Nullable) removeGroupSharedFileWithId: (NSString *_Nonnull)  aGroupId
sharedFileId: (NSString *_Nonnull)  aSharedFileId
error: (EMError **_Nullable)  pError 
required

删除群共享文件。

参数
aGroupId群组 ID。
aSharedFileId共享文件 ID。
pError错误信息。
返回
群组实例。

◆ 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该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。

◆ removeOccupants:fromGroup:error:

- (EMGroup *_Nullable) removeOccupants: (NSArray< NSString * > *_Nonnull)  aOccupants
fromGroup: (NSString *_Nonnull)  aGroupId
error: (EMError **_Nullable)  pError 
required

将群成员移出群组。

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

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

参数
aOccupants要移出群组的用户列表。
aGroupId群组 ID。
pError错误信息。
返回
群组实例。

◆ 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该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。

◆ removeWhiteListMembers:fromGroup:error:

- (EMGroup *_Nullable) removeWhiteListMembers: (NSArray< NSString * > *_Nonnull)  aMembers
fromGroup: (NSString *_Nonnull)  aGroupId
error: (EMError **_Nullable)  pError 
required

移除白名单。

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

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

参数
aMuteMembers要添加的成员列表。
aGroupId群组 ID。
pError错误信息。
返回
群组实例。

◆ requestToJoinPublicGroup:message:completion:

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

申请加入一个需批准的公开群组,群类型应该是 EMGroupStylePublicJoinNeedApproval。

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

◆ searchPublicGroupWithId:completion:

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

根据群组 ID 搜索公开群。

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

◆ searchPublicGroupWithId:error:

- (EMGroup *_Nullable) searchPublicGroupWithId: (NSString *_Nonnull)  aGroundId
error: (EMError **_Nullable)  pError 
required

根据群组 ID 搜索公开群。

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

参数
aGroundId群组 ID。
pError错误信息。
返回
搜索到的群组␈。

◆ 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该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。

◆ unblockGroup:error:

- (EMGroup *_Nullable) unblockGroup: (NSString *_Nonnull)  aGroupId
error: (EMError **_Nullable)  pError 
required

取消屏蔽群消息

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

参数
aGroupId要取消屏蔽的群组 ID。
pError错误信息。
返回
群组实例。

◆ 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该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。

◆ unblockOccupants:forGroup:error:

- (EMGroup *_Nullable) unblockOccupants: (NSArray< NSString * > *_Nonnull)  aOccupants
forGroup: (NSString *_Nonnull)  aGroupId
error: (EMError **_Nullable)  pError 
required

从群组黑名单中移除。

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

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

参数
aOccupants要从黑名单中移除的用户名列表。
aGroupId群组 ID。
pError错误信息。
返回
群组实例。

◆ unmuteAllMembersFromGroup:completion:

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

解除全员禁言。

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

异步方法。

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

◆ unmuteAllMembersFromGroup:error:

- (EMGroup *_Nullable) unmuteAllMembersFromGroup: (NSString *_Nonnull)  aGroupId
error: (EMError **_Nullable)  pError 
required

解除全员禁言。

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

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

参数
aGroupId群组 ID。
pError错误信息。
返回
群组实例。

◆ 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该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。

◆ unmuteMembers:fromGroup:error:

- (EMGroup *_Nullable) unmuteMembers: (NSArray< NSString * > *_Nonnull)  aMembers
fromGroup: (NSString *_Nonnull)  aGroupId
error: (EMError **_Nullable)  pError 
required

解除禁言。

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

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

参数
aMuteMembers被解除禁言的用户列表。
aGroupId群组 ID。
pError错误信息。
返回
返回群组实例。

◆ 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该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。

◆ updateGroupAnnouncementWithId:announcement:error:

- (EMGroup *_Nullable) updateGroupAnnouncementWithId: (NSString *_Nonnull)  aGroupId
announcement: (NSString *_Nullable)  aAnnouncement
error: (EMError **_Nullable)  pError 
required

修改群公告。

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

参数
aGroupId群组 ID。
aAnnouncement群公告。
pError错误信息。
返回
群组实例。

◆ 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该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。

◆ updateGroupExtWithId:ext:error:

- (EMGroup *_Nullable) updateGroupExtWithId: (NSString *_Nonnull)  aGroupId
ext: (NSString *_Nullable)  aExt
error: (EMError **_Nullable)  pError 
required

修改群扩展信息。

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

参数
aGroupId群组 ID。
aExt扩展信息
pError错误信息。
返回
群组实例。

◆ 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该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。

◆ updateGroupOwner:newOwner:error:

- (EMGroup *_Nullable) updateGroupOwner: (NSString *_Nonnull)  aGroupId
newOwner: (NSString *_Nonnull)  aNewOwner
error: (EMError **_Nullable)  pError 
required

改变群主。

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

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

参数
aGroupId群组 ID。
aNewOwner新群主。
pError错误信息。
返回
返回群组实例。

◆ 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该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。

◆ updatePushServiceForGroup:isPushEnabled:completion:

- (void) updatePushServiceForGroup: (NSString *)  aGroupId
isPushEnabled: (BOOL)  aIsEnable
completion: (3_3_2) 
(3_8_3) 
("Use -IEMPushManager::updatePushServiceForGroups:disablePush:completion:")  EM_DEPRECATED_IOS 
required

屏蔽/取消屏蔽群组消息的推送。

已废弃,请用 IEMPushManager::updatePushServiceForGroups:disablePush:completion: 代替。

参数
aGroupId群组 ID。
aIsEnable是否允许推送。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。

◆ updatePushServiceForGroups:isPushEnabled:completion:

- (void) updatePushServiceForGroups: (NSArray *)  aGroupIDs
isPushEnabled: (BOOL)  aIsEnable
completion: (3_3_2) 
(3_8_3) 
("Use -IEMPushManager::updatePushServiceForGroups:disablePush:completion:")  EM_DEPRECATED_IOS 
required

屏蔽/取消屏蔽群组消息的推送。

已废弃,请用 IEMPushManager::updatePushServiceForGroups:disablePush:completion: 代替。

参数
aGroupIDs群组 ID 列表。
aIsEnable是否允许推送。
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错误信息。
返回
群组实例。

该协议的文档由以下文件生成: