<IEMGroupManager>协议 参考

#import <IEMGroupManager.h>

类 <IEMGroupManager> 继承关系图:

构造函数
(void)	- addDelegate:delegateQueue:
(void)	- removeDelegate:
(NSArray *)	- getJoinedGroups
(NSArray *)	- getGroupsWithoutPushNotification:
(NSArray *)	- getJoinedGroupsFromServerWithPage:pageSize:error:
(void)	- getJoinedGroupsFromServerWithPage:pageSize:completion:
(EMCursorResult *)	- getPublicGroupsFromServerWithCursor:pageSize:error:
(void)	- getPublicGroupsFromServerWithCursor:pageSize:completion:
(EMGroup *)	- searchPublicGroupWithId:error:
(void)	- searchPublicGroupWithId:completion:
(EMGroup *)	- createGroupWithSubject:description:invitees:message:setting:error:
(void)	- createGroupWithSubject:description:invitees:message:setting:completion:
(EMGroup *)	- getGroupSpecificationFromServerWithId:error:
(void)	- getGroupSpecificationFromServerWithId:completion:
(EMCursorResult *)	- getGroupMemberListFromServerWithId:cursor:pageSize:error:
(void)	- getGroupMemberListFromServerWithId:cursor:pageSize:completion:
(NSArray *)	- getGroupBlacklistFromServerWithId:pageNumber:pageSize:error:
(void)	- getGroupBlacklistFromServerWithId:pageNumber:pageSize:completion:
(NSArray *)	- getGroupMuteListFromServerWithId:pageNumber:pageSize:error:
(void)	- getGroupMuteListFromServerWithId:pageNumber:pageSize:completion:
(NSArray *)	- getGroupFileListWithId:pageNumber:pageSize:error:
(void)	- getGroupFileListWithId:pageNumber:pageSize:completion:
(NSString *)	- getGroupAnnouncementWithId:error:
(void)	- getGroupAnnouncementWithId:completion:
(EMGroup *)	- addOccupants:toGroup:welcomeMessage:error:
(void)	- addMembers:toGroup:message:completion:
(EMGroup *)	- removeOccupants:fromGroup:error:
(void)	- removeMembers:fromGroup:completion:
(EMGroup *)	- blockOccupants:fromGroup:error:
(void)	- blockMembers:fromGroup:completion:
(EMGroup *)	- unblockOccupants:forGroup:error:
(void)	- unblockMembers:fromGroup:completion:
(EMGroup *)	- changeGroupSubject:forGroup:error:
(void)	- updateGroupSubject:forGroup:completion:
(EMGroup *)	- changeDescription:forGroup:error:
(void)	- updateDescription:forGroup:completion:
(void)	- leaveGroup:error:
(void)	- leaveGroup:completion:
(EMError *)	- destroyGroup:
(void)	- destroyGroup:finishCompletion:
(EMGroup *)	- blockGroup:error:
(void)	- blockGroup:completion:
(EMGroup *)	- unblockGroup:error:
(void)	- unblockGroup:completion:
(EMGroup *)	- updateGroupOwner:newOwner:error:
(void)	- updateGroupOwner:newOwner:completion:
(EMGroup *)	- addAdmin:toGroup:error:
(void)	- addAdmin:toGroup:completion:
(EMGroup *)	- removeAdmin:fromGroup:error:
(void)	- removeAdmin:fromGroup:completion:
(EMGroup *)	- muteMembers:muteMilliseconds:fromGroup:error:
(void)	- muteMembers:muteMilliseconds:fromGroup:completion:
(EMGroup *)	- unmuteMembers:fromGroup:error:
(void)	- unmuteMembers:fromGroup:completion:
(void)	- uploadGroupSharedFileWithId:filePath:progress:completion:
(void)	- downloadGroupSharedFileWithId:filePath:sharedFileId:progress:completion:
(EMGroup *)	- removeGroupSharedFileWithId:sharedFileId:error:
(void)	- removeGroupSharedFileWithId:sharedFileId:completion:
(EMGroup *)	- updateGroupAnnouncementWithId:announcement:error:
(void)	- updateGroupAnnouncementWithId:announcement:completion:
(EMGroup *)	- updateGroupExtWithId:ext:error:
(void)	- updateGroupExtWithId:ext:completion:
(EMGroup *)	- joinPublicGroup:error:
(void)	- joinPublicGroup:completion:
(EMGroup *)	- applyJoinPublicGroup:message:error:
(void)	- requestToJoinPublicGroup:message:completion:
(EMError *)	- acceptJoinApplication:applicant:
(void)	- approveJoinGroupRequest:sender:completion:
(EMError *)	- declineJoinApplication:applicant:reason:
(void)	- declineJoinGroupRequest:sender:reason:completion:
(EMGroup *)	- acceptInvitationFromGroup:inviter:error:
(void)	- acceptInvitationFromGroup:inviter:completion:
(EMError *)	- declineInvitationFromGroup:inviter:reason:
(void)	- declineGroupInvitation:inviter:reason:completion:
(EMError *)	- ignoreGroupPush:ignore:
(EMError *)	- ignoreGroupsPush:ignore:
(void)	- updatePushServiceForGroup:isPushEnabled:completion:
(void)	- updatePushServiceForGroups:isPushEnabled:completion:
(NSArray *)	- getMyGroupsFromServerWithError:
(void)	- getJoinedGroupsFromServerWithCompletion:
(EMGroup *)	- fetchGroupInfo:includeMembersList:error:
(void)	- getGroupSpecificationFromServerByID:includeMembersList:completion:
(NSArray *)	- fetchGroupBansList:error:
(void)	- getGroupBlackListFromServerByID:completion:
(EMGroup *)	- destroyGroup:error:
(void)	- destroyGroup:completion:
(void)	- addDelegate:
("Use -getJoinedGroups")	- __deprecated_msg
("Use -getJoinedGroups")	- __deprecated_msg
("Use -getGroupsWithoutPushNotification")	- __deprecated_msg
(void)	- asyncGetMyGroupsFromServer:failure:
(void)	- asyncGetPublicGroupsFromServerWithCursor:pageSize:success:failure:
(void)	- asyncSearchPublicGroupWithId:success:failure:
(void)	- asyncCreateGroupWithSubject:description:invitees:message:setting:success:failure:
(void)	- asyncFetchGroupInfo:includeMembersList:success:failure:
(void)	- asyncFetchGroupBansList:success:failure:
(void)	- asyncAddOccupants:toGroup:welcomeMessage:success:failure:
(void)	- asyncRemoveOccupants:fromGroup:success:failure:
(void)	- asyncBlockOccupants:fromGroup:success:failure:
(void)	- asyncUnblockOccupants:forGroup:success:failure:
(void)	- asyncChangeGroupSubject:forGroup:success:failure:
(void)	- asyncChangeDescription:forGroup:success:failure:
(void)	- asyncLeaveGroup:success:failure:
(void)	- asyncDestroyGroup:success:failure:
(void)	- asyncBlockGroup:success:failure:
(void)	- asyncUnblockGroup:success:failure:
(void)	- asyncJoinPublicGroup:success:failure:
(void)	- asyncApplyJoinPublicGroup:message:success:failure:
(void)	- asyncAcceptJoinApplication:applicant:success:failure:
(void)	- asyncDeclineJoinApplication:applicant:reason:success:failure:
(void)	- asyncAcceptInvitationFromGroup:inviter:success:failure:
(void)	- asyncDeclineInvitationFromGroup:inviter:reason:success:failure:
(void)	- asyncIgnoreGroupPush:ignore:success:failure:

详细描述

IEMGroupManager.h 此协议定义了群组相关操作

作者

Hyphenate

版本

3.00

群组相关操作

函数文档

- ("Use -getJoinedGroups") __deprecated_msg

required

获取所有群组，如果内存中不存在，则先从DB加载

返回

群组列表<EMGroup>

- ("Use -getJoinedGroups") __deprecated_msg

required

从数据库加载所有群组，加载后更新内存中的群组列表

返回

群组列表<EMGroup>

- ("Use -getGroupsWithoutPushNotification") __deprecated_msg

required

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

返回

群组ID列表<NSString>

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

required

接受入群邀请

参数

groupId	接受的群组ID
aUsername	邀请者
pError	错误信息
aCompletionBlock	完成的回调

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

required

接受入群邀请

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

参数

groupId	接受的群组ID
aUsername	邀请者
pError	错误信息

返回

接受的群组实例

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

required

批准入群申请, 需要Owner权限

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

参数

aGroupId	所申请的群组ID
aUsername	申请人

返回

错误信息

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

required

添加群组管理员，需要Owner权限

参数

aAdmin	要添加的群组管理员
aGroupId	群ID
aCompletionBlock	完成的回调

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

required

添加群组管理员，需要Owner权限

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

参数

aAdmin	要添加的群组管理员
aGroupId	群ID
pError	错误信息

返回

返回群组实例

- (void) addDelegate: (3_1_0)  (3_2_2)  ("Use -")  EM_DEPRECATED_IOS[IEMGroupManager addDelegate:delegateQueue:]

required

添加回调代理

参数

aDelegate

要添加的代理

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

required

添加回调代理

参数

aDelegate	要添加的代理
aQueue	添加回调代理

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

required

邀请用户加入群组

参数

aUsers	被邀请的用户名列表
aGroupId	群组ID
aMessage	欢迎信息
aCompletionBlock	完成的回调

- (EMGroup *) addOccupants: (NSArray *)  aOccupants toGroup: (NSString *)  aGroupId welcomeMessage: (NSString *)  aWelcomeMessage error: (EMError **)  pError

required

邀请用户加入群组

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

参数

aOccupants	被邀请的用户名列表
aGroupId	群组ID
aWelcomeMessage	欢迎信息
pError	错误信息

返回

群组实例, 失败返回nil

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

required

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

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

参数

aGroupId	公开群组的ID
aMessage	请求加入的信息
pError	错误信息

返回

申请加入的公开群组

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

required

批准入群申请, 需要Owner权限

参数

aGroupId	所申请的群组ID
aUsername	申请人
aCompletionBlock	完成的回调

- (void) asyncAcceptInvitationFromGroup: (NSString *)  aGroupId inviter: (NSString *)  aUsername success: (void(^)(EMGroup *aGroup))  aSuccessBlock failure: ("Use -acceptInvitationFromGroup:inviter:completion")  __deprecated_msg

required

接受入群邀请

参数

groupId	接受的群组ID
aUsername	邀请者
pError	错误信息
aSuccessBlock	成功的回调
aFailureBlock	失败的回调

- (void) asyncAcceptJoinApplication: (NSString *)  aGroupId applicant: (NSString *)  aUsername success: (void(^)())  aSuccessBlock failure: ("Use -approveJoinGroupRequest:sender:completion:")  __deprecated_msg

required

批准入群申请, 需要Owner权限

参数

aGroupId	所申请的群组ID
aUsername	申请人
aSuccessBlock	成功的回调
aFailureBlock	失败的回调

- (void) asyncAddOccupants: (NSArray *)  aOccupants toGroup: (NSString *)  aGroupId welcomeMessage: (NSString *)  aWelcomeMessage success: (void(^)(EMGroup *aGroup))  aSuccessBlock failure: ("Use -addMembers:toGroup:message:completion:")  __deprecated_msg

required

邀请用户加入群组

参数

aOccupants	被邀请的用户名列表
aGroupId	群组ID
aWelcomeMessage	欢迎信息
aSuccessBlock	成功的回调
aFailureBlock	失败的回调

- (void) asyncApplyJoinPublicGroup: (NSString *)  aGroupId message: (NSString *)  aMessage success: (void(^)(EMGroup *aGroup))  aSuccessBlock failure: ("Use -requestToJoinPublicGroup:message:completion:")  __deprecated_msg

required

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

参数

aGroupId	公开群组的ID
aMessage	请求加入的信息
aSuccessBlock	成功的回调
aFailureBlock	失败的回调

- (void) asyncBlockGroup: (NSString *)  aGroupId success: (void(^)(EMGroup *aGroup))  aSuccessBlock failure: ("Use -blockGroup:completion:")  __deprecated_msg

required

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

参数

aGroupId	要屏蔽的群ID
aSuccessBlock	成功的回调
aFailureBlock	失败的回调

- (void) asyncBlockOccupants: (NSArray *)  aOccupants fromGroup: (NSString *)  aGroupId success: (void(^)(EMGroup *aGroup))  aSuccessBlock failure: ("Use -blockMembers:fromGroup:completion:")  __deprecated_msg

required

加人到群组黑名单, 需要owner权限

参数

aOccupants	要加入黑名单的用户
aGroupId	群组ID
aSuccessBlock	成功的回调
aFailureBlock	失败的回调

- (void) asyncChangeDescription: (NSString *)  aDescription forGroup: (NSString *)  aGroupId success: (void(^)(EMGroup *aGroup))  aSuccessBlock failure: ("Use -updateDescription:forGroup:completion")  __deprecated_msg

required

更改群组说明信息, 需要owner权限

参数

aDescription	说明信息
aGroupId	群组ID
aSuccessBlock	成功的回调
aFailureBlock	失败的回调

- (void) asyncChangeGroupSubject: (NSString *)  aSubject forGroup: (NSString *)  aGroupId success: (void(^)(EMGroup *aGroup))  aSuccessBlock failure: ("Use -updateGroupSubject:forGroup:completion")  __deprecated_msg

required

更改群组主题, 需要owner权限

参数

aSubject	新主题
aGroupId	群组ID
aSuccessBlock	成功的回调
aFailureBlock	失败的回调

- (void) asyncCreateGroupWithSubject: (NSString *)  aSubject description: (NSString *)  aDescription invitees: (NSArray *)  aInvitees message: (NSString *)  aMessage setting: (EMGroupOptions *)  aSetting success: (void(^)(EMGroup *aGroup))  aSuccessBlock failure: ("Use -createGroupWithSubject:description:invitees:message:setting:completion")  __deprecated_msg

required

创建群组

参数

aSubject	群组名称
aDescription	群组描述
aInvitees	群组成员（不包括创建者自己）
aMessage	邀请消息
aSetting	群组属性
aSuccessBlock	The callback block of success
aFailureBlock	The callback block of failure

- (void) asyncDeclineInvitationFromGroup: (NSString *)  aGroupId inviter: (NSString *)  aUsername reason: (NSString *)  aReason success: (void(^)())  aSuccessBlock failure: ("Use -declineGroupInvitation:inviter:reason:completion:")  __deprecated_msg

required

拒绝入群邀请

参数

aGroupId	被拒绝的群组ID
aUsername	邀请人
aReason	拒绝理由
aSuccessBlock	成功的回调
aFailureBlock	失败的回调

- (void) asyncDeclineJoinApplication: (NSString *)  aGroupId applicant: (NSString *)  aUsername reason: (NSString *)  aReason success: (void(^)())  aSuccessBlock failure: ("Use -declineJoinGroupRequest:sender:reason:completion:")  __deprecated_msg

required

拒绝入群申请, 需要Owner权限

参数

aGroupId	被拒绝的群组ID
aUsername	申请人
aReason	拒绝理由
aSuccessBlock	成功的回调
aFailureBlock	失败的回调

- (void) asyncDestroyGroup: (NSString *)  aGroupId success: (void(^)(EMGroup *aGroup))  aSuccessBlock failure: ("Use -destroyGroup:completion")  __deprecated_msg

required

解散群组, 需要owner权限

参数

aGroupId	群组ID
aSuccessBlock	成功的回调
aFailureBlock	失败的回调

- (void) asyncFetchGroupBansList: (NSString *)  aGroupId success: (void(^)(NSArray *aList))  aSuccessBlock failure: ("Use -getGroupBlackListFromServerByID:completion:")  __deprecated_msg

required

获取群组黑名单列表, 需要owner权限

参数

aGroupId	群组ID
aSuccessBlock	成功的回调
aFailureBlock	失败的回调

- (void) asyncFetchGroupInfo: (NSString *)  aGroupId includeMembersList: (BOOL)  aIncludeMembersList success: (void(^)(EMGroup *aGroup))  aSuccessBlock failure: ("Use -getGroupSpecificationFromServerByID:includeMembersList:completion:")  __deprecated_msg

required

获取群组详情

参数

aGroupId	群组ID
aIncludeMembersList	是否获取成员列表
aSuccessBlock	成功的回调
aFailureBlock	失败的回调

- (void) asyncGetMyGroupsFromServer: (void(^)(NSArray *aList))  aSuccessBlock failure: ("Use -getJoinedGroupsFromServerWithCompletion:")  __deprecated_msg

required

从服务器获取用户所有的群组，成功后更新DB和内存中的群组列表

参数

aSuccessBlock	成功的回调
aFailureBlock	失败的回调

- (void) asyncGetPublicGroupsFromServerWithCursor: (NSString *)  aCursor pageSize: (NSInteger)  aPageSize success: (void(^)(EMCursorResult *aCursor))  aSuccessBlock failure: ("Use -getPublicGroupsFromServerWithCursor:pageSize:completion:")  __deprecated_msg

required

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

参数

aCursor	获取公开群的cursor，首次调用传空
aPageSize	期望返回结果的数量, 如果 < 0 则一次返回所有结果
aSuccessBlock	成功的回调
aFailureBlock	失败的回调

- (void) asyncIgnoreGroupPush: (NSString *)  aGroupId ignore: (BOOL)  aIsIgnore success: (void(^)())  aSuccessBlock failure: ("Use -updatePushServiceForGroup:isPushEnabled:completion:")  __deprecated_msg

required

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

参数

aGroupId	群组ID
aIgnore	是否屏蔽
aSuccessBlock	成功的回调
aFailureBlock	失败的回调

- (void) asyncJoinPublicGroup: (NSString *)  aGroupId success: (void(^)(EMGroup *aGroup))  aSuccessBlock failure: ("Use -joinPublicGroup:completion")  __deprecated_msg

required

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

参数

aGroupId	公开群组的ID
aSuccessBlock	成功的回调
aFailureBlock	失败的回调

- (void) asyncLeaveGroup: (NSString *)  aGroupId success: (void(^)(EMGroup *aGroup))  aSuccessBlock failure: ("Use -leaveGroup:completion")  __deprecated_msg

required

退出群组，owner不能退出群，只能销毁群

参数

aGroupId	群组ID
aSuccessBlock	成功的回调
aFailureBlock	失败的回调

- (void) asyncRemoveOccupants: (NSArray *)  aOccupants fromGroup: (NSString *)  aGroupId success: (void(^)(EMGroup *aGroup))  aSuccessBlock failure: ("Use -removeMembers:fromGroup:completion:")  __deprecated_msg

required

将群成员移出群组, 需要owner权限

参数

aOccupants	要移出群组的用户列表
aGroupId	群组ID
aSuccessBlock	成功的回调
aFailureBlock	失败的回调

- (void) asyncSearchPublicGroupWithId: (NSString *)  aGroundId success: (void(^)(EMGroup *aGroup))  aSuccessBlock failure: ("Use -searchPublicGroupWithId:completion:")  __deprecated_msg

required

根据群ID搜索公开群

参数

aGroundId	群组id
aSuccessBlock	成功的回调
aFailureBlock	失败的回调

- (void) asyncUnblockGroup: (NSString *)  aGroupId success: (void(^)(EMGroup *aGroup))  aSuccessBlock failure: ("Use -unblockGroup:completion")  __deprecated_msg

required

取消屏蔽群消息

参数

aGroupId	要取消屏蔽的群ID
aSuccessBlock	成功的回调
aFailureBlock	失败的回调

- (void) asyncUnblockOccupants: (NSArray *)  aOccupants forGroup: (NSString *)  aGroupId success: (void(^)(EMGroup *aGroup))  aSuccessBlock failure: ("Use -unblockMembers:fromGroup:completion:")  __deprecated_msg

required

从群组黑名单中减人, 需要owner权限

参数

aOccupants	要从黑名单中移除的用户名列表
aGroupId	群组ID
aSuccessBlock	成功的回调
aFailureBlock	失败的回调

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

required

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

参数

aGroupId	要屏蔽的群ID
aCompletionBlock	完成的回调

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

required

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

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

参数

aGroupId	要屏蔽的群ID
pError	错误信息

返回

群组实例

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

required

加人到群组黑名单, 需要owner权限

参数

aMembers	要加入黑名单的用户
aGroupId	群组ID
aCompletionBlock	完成的回调

- (EMGroup *) blockOccupants: (NSArray *)  aOccupants fromGroup: (NSString *)  aGroupId error: (EMError **)  pError

required

加人到群组黑名单, 需要owner权限

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

参数

aOccupants	要加入黑名单的用户
aGroupId	群组ID
pError	错误信息

返回

群组实例

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

required

更改群组说明信息, 需要owner权限

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

参数

aDescription	说明信息
aGroupId	群组ID
pError	错误信息

返回

群组对象

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

required

更改群组主题, 需要owner权限

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

参数

aSubject	新主题
aGroupId	群组ID
pError	错误信息

返回

群组对象

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

required

创建群组

参数

aSubject	群组名称
aDescription	群组描述
aInvitees	群组成员（不包括创建者自己）
aMessage	邀请消息
aSetting	群组属性
aCompletionBlock	完成的回调

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

required

创建群组

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

参数

aSubject	群组名称
aDescription	群组描述
aInvitees	群组成员（不包括创建者自己）
aMessage	邀请消息
aSetting	群组属性
pError	出错信息

返回

创建的群组

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

required

拒绝入群邀请

参数

aGroupId	被拒绝的群组ID
aInviter	邀请人
aReason	拒绝理由
aCompletionBlock	完成的回调

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

required

拒绝入群邀请

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

参数

aGroupId	被拒绝的群组ID
aUsername	邀请人
aReason	拒绝理由

返回

错误信息

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

required

拒绝入群申请, 需要Owner权限

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

参数

aGroupId	被拒绝的群组ID
aUsername	申请人
aReason	拒绝理由

返回

错误信息

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

required

拒绝入群申请, 需要Owner权限

参数

aGroupId	被拒绝的群组ID
aUsername	申请人
aReason	拒绝理由
aCompletionBlock	完成的回调

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

required

解散群组, 需要owner权限

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

参数

aGroupId

群组ID

返回

错误信息, 成功返回nil

- (void) destroyGroup: (NSString *)  aGroupId completion: (3_1_0)  (3_3_0)  ("Use -")  EM_DEPRECATED_IOS[IEMGroupManager destroyGroup:finishCompletion:]

required

解散群组, 需要owner权限

参数

aGroupId	群组ID
aCompletionBlock	完成的回调

- (EMGroup *) destroyGroup: (NSString *)  aGroupId error: (3_1_0)  (3_3_0)  ("Use -")  EM_DEPRECATED_IOS[IEMGroupManager destroyGroup:]

required

解散群组, 需要owner权限

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

参数

aGroupId	群组ID
pError	错误信息

返回

销毁的群组实例, 失败返回nil

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

required

解散群组, 需要owner权限

参数

aGroupId	群组ID
aCompletionBlock	完成的回调

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

required

下载群共享文件

参数

aGroupId	群ID
aFilePath	文件路径
aSharedFileId	共享文件ID
aProgressBlock	文件下载进度回调block
aCompletionBlock	完成回调block

- (NSArray *) fetchGroupBansList: (NSString *)  aGroupId error: (3_1_0)  (3_3_0)  ("Use -")  EM_DEPRECATED_IOS[IEMGroupManager getGroupBlacklistFromServerWithId:pageNumber:pageSize:error:]

required

获取群组黑名单列表, 需要owner权限

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

参数

aGroupId	群组ID
pError	错误信息

返回

群组黑名单列表<NSString>

- (EMGroup *) fetchGroupInfo: (NSString *)  aGroupId includeMembersList: (BOOL)  aIncludeMembersList error: (3_1_0)  (3_3_0)  ("Use -")  EM_DEPRECATED_IOS[IEMGroupManager getGroupSpecificationFromServerWithId:error:]

required

获取群组详情

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

参数

aGroupId	群组ID
aIncludeMembersList	是否获取成员列表，为YES时，返回200个成员
pError	错误信息

返回

群组

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

required

获取群公告

参数

aGroupId	群组ID
aCompletionBlock	完成的回调

- (NSString *) getGroupAnnouncementWithId: (NSString *)  aGroupId error: (EMError **)  pError

required

获取群公告

参数

aGroupId	群组ID
pError	错误信息

返回

群声明, 失败返回nil

- (void) getGroupBlackListFromServerByID: (NSString *)  aGroupId completion: (3_1_0)  (3_3_0)  ("Use -")  EM_DEPRECATED_IOS[IEMGroupManager getGroupBlacklistFromServerWithId:pageNumber:pageSize:completion:]

required

获取群组黑名单列表, 需要owner权限

参数

aGroupId	群组ID
aCompletionBlock	完成的回调

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

required

获取群组黑名单列表, 需要owner/admin权限

参数

aGroupId	群组ID
aPageNum	获取第几页
aPageSize	获取多少条
aCompletionBlock	完成的回调

- (NSArray *) getGroupBlacklistFromServerWithId: (NSString *)  aGroupId pageNumber: (NSInteger)  aPageNum pageSize: (NSInteger)  aPageSize error: (EMError **)  pError

required

获取群组黑名单列表, 需要owner/admin权限

参数

aGroupId	群组ID
aPageNum	获取第几页
aPageSize	获取多少条
pError	错误信息

- (void) getGroupFileListWithId: (NSString *)  aGroupId pageNumber: (NSInteger)  aPageNum pageSize: (NSInteger)  aPageSize completion: (void(^)(NSArray *aList, EMError *aError))  aCompletionBlock

required

获取群共享文件列表

参数

aGroupId	群组ID
aPageNum	获取第几页
aPageSize	获取多少条
aCompletionBlock	完成的回调

- (NSArray *) getGroupFileListWithId: (NSString *)  aGroupId pageNumber: (NSInteger)  aPageNum pageSize: (NSInteger)  aPageSize error: (EMError **)  pError

required

获取群共享文件列表

参数

aGroupId	群组ID
aPageNum	获取第几页
aPageSize	获取多少条
pError	错误信息

返回

群共享文件列表

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

required

获取群组成员列表

参数

aGroupId	群组ID
aCursor	游标，首次调用传空
aPageSize	获取多少条
aCompletionBlock	完成的回调

- (EMCursorResult *) getGroupMemberListFromServerWithId: (NSString *)  aGroupId cursor: (NSString *)  aCursor pageSize: (NSInteger)  aPageSize error: (EMError **)  pError

required

获取群组成员列表

参数

aGroupId	群组ID
aCursor	游标，，首次调用传空
aPageSize	获取多少条
pError	错误信息

返回

列表和游标

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

required

获取群组被禁言列表

参数

aGroupId	群组ID
aPageNum	获取第几页
aPageSize	获取多少条
aCompletionBlock	完成的回调

- (NSArray *) getGroupMuteListFromServerWithId: (NSString *)  aGroupId pageNumber: (NSInteger)  aPageNum pageSize: (NSInteger)  aPageSize error: (EMError **)  pError

required

获取群组被禁言列表

参数

aGroupId	群组ID
aPageNum	获取第几页
aPageSize	获取多少条
pError	错误信息

- (void) getGroupSpecificationFromServerByID: (NSString *)  aGroupID includeMembersList: (BOOL)  aIncludeMembersList completion: (3_1_0)  (3_3_0)  ("Use -")  EM_DEPRECATED_IOS[IEMGroupManager getGroupSpecificationFromServerWithId:completion:]

required

获取群组详情

参数

aGroupId	群组ID
aIncludeMembersList	是否获取成员列表，为YES时，返回200个成员
aCompletionBlock	完成的回调

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

required

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

参数

aGroupId	群组ID
aCompletionBlock	完成的回调

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

required

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

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

参数

aGroupId	群组ID
pError	错误信息

返回

群组

- (NSArray *) getGroupsWithoutPushNotification: (EMError **)  pError

required

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

参数

pError

错误信息

- (NSArray *) getJoinedGroups

required

获取用户所有群组

返回

群组列表<EMGroup>

- (void) getJoinedGroupsFromServerWithCompletion: (3_1_0)  (3_3_0)  ("Use -")  EM_DEPRECATED_IOS[IEMGroupManager getJoinedGroupsFromServerWithPage:pageSize:completion:]

required

从服务器获取用户所有的群组，成功后更新DB和内存中的群组列表

参数

aCompletionBlock

完成的回调

- (void) getJoinedGroupsFromServerWithPage: (NSInteger)  aPageNum pageSize: (NSInteger)  aPageSize completion: (void(^)(NSArray *aList, EMError *aError))  aCompletionBlock

required

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

参数

aPageNum	获取自己加入群的cursor，首次调用传空
aPageSize	期望返回结果的数量, 如果 < 0 则一次返回所有结果
aCompletionBlock	完成的回调

- (NSArray *) getJoinedGroupsFromServerWithPage: (NSInteger)  aPageNum pageSize: (NSInteger)  aPageSize error: (EMError **)  pError

required

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

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

参数

aPageNum	获取自己加入群的cursor，首次调用传空
aPageSize	期望返回结果的数量, 如果 < 0 则一次返回所有结果
pError	出错信息

返回

群组列表<EMGroup>

- (NSArray *) getMyGroupsFromServerWithError: (3_1_0)  (3_3_0)  ("Use -")  EM_DEPRECATED_IOS[IEMGroupManager getJoinedGroupsFromServerWithPage:pageSize:error:]

required

从服务器获取用户所有的群组，成功后更新DB和内存中的群组列表

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

参数

pError

错误信息

返回

群组列表<EMGroup>

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

required

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

参数

aCursor	获取公开群的cursor，首次调用传空
aPageSize	期望返回结果的数量, 如果 < 0 则一次返回所有结果
aCompletionBlock	完成的回调

- (EMCursorResult *) getPublicGroupsFromServerWithCursor: (NSString *)  aCursor pageSize: (NSInteger)  aPageSize error: (EMError **)  pError

required

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

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

参数

aCursor	获取公开群的cursor，首次调用传空
aPageSize	期望返回结果的数量, 如果 < 0 则一次返回所有结果
pError	出错信息

返回

获取的公开群结果

- (EMError *) ignoreGroupPush: (NSString *)  aGroupId ignore: (BOOL)  aIsIgnore

required

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

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

参数

aGroupId	群组ID
aIgnore	是否屏蔽

返回

错误信息

- (EMError *) ignoreGroupsPush: (NSArray *)  aGroupIDs ignore: (BOOL)  aIsIgnore

required

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

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

参数

aGroupIDs	群组ID列表
aIgnore	是否屏蔽

返回

错误信息

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

required

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

参数

aGroupId	公开群组的ID
aCompletionBlock	完成的回调

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

required

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

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

参数

aGroupId	公开群组的ID
pError	错误信息

返回

所加入的公开群组

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

required

退出群组，owner不能退出群，只能销毁群

参数

aGroupId	群组ID
aCompletionBlock	完成的回调

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

required

退出群组，owner不能退出群，只能销毁群

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

参数

aGroupId	群组ID
pError	错误信息

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

required

将一组成员禁言，需要Owner / Admin权限

参数

aMuteMembers	要禁言的成员列表<NSString>
aMuteMilliseconds	禁言时长
aGroupId	群ID
aCompletionBlock	完成的回调

- (EMGroup *) muteMembers: (NSArray *)  aMuteMembers muteMilliseconds: (NSInteger)  aMuteMilliseconds fromGroup: (NSString *)  aGroupId error: (EMError **)  pError

required

将一组成员禁言，需要Owner / Admin权限

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

参数

aMuteMembers	要禁言的成员列表<NSString>
aMuteMilliseconds	禁言时长
aGroupId	群ID
pError	错误信息

返回

返回群组实例

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

required

移除群组管理员，需要Owner权限

参数

aAdmin	要移除的群组管理员
aGroupId	群ID
aCompletionBlock	完成的回调

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

required

移除群组管理员，需要Owner权限

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

参数

aAdmin	要移除的群组管理员
aGroupId	群ID
pError	错误信息

返回

返回群组实例

- (void) removeDelegate: (id)  aDelegate

required

移除回调代理

参数

aDelegate

要移除的代理

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

required

删除群共享文件

参数

aGroupId	群ID
aSharedFileId	共享文件ID
aCompletionBlock	完成的回调

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

required

删除群共享文件

参数

aGroupId	群ID
aSharedFileId	共享文件ID
pError	错误信息

返回

群实例

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

required

将群成员移出群组, 需要owner权限

参数

aUsers	要移出群组的用户列表
aGroupId	群组ID
aCompletionBlock	完成的回调

- (EMGroup *) removeOccupants: (NSArray *)  aOccupants fromGroup: (NSString *)  aGroupId error: (EMError **)  pError

required

将群成员移出群组, 需要owner权限

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

参数

aOccupants	要移出群组的用户列表
aGroupId	群组ID
pError	错误信息

返回

群组实例

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

required

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

参数

aGroupId	公开群组的ID
aMessage	请求加入的信息
aCompletionBlock	完成的回调

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

required

根据群ID搜索公开群

参数

aGroundId	群组id
aCompletionBlock	完成的回调

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

required

根据群ID搜索公开群

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

参数

aGroundId	群组id
pError	错误信息

返回

搜索到的群组

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

required

取消屏蔽群消息

参数

aGroupId	要取消屏蔽的群ID
aCompletionBlock	完成的回调

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

required

取消屏蔽群消息

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

参数

aGroupId	要取消屏蔽的群ID
pError	错误信息

返回

返回群组实例

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

required

从群组黑名单中减人, 需要owner权限

参数

aMembers	要从黑名单中移除的用户名列表
aGroupId	群组ID
aCompletionBlock	完成的回调

- (EMGroup *) unblockOccupants: (NSArray *)  aOccupants forGroup: (NSString *)  aGroupId error: (EMError **)  pError

required

从群组黑名单中减人, 需要owner权限

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

参数

aOccupants	要从黑名单中移除的用户名列表
aGroupId	群组ID
pError	错误信息

返回

群组对象

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

required

解除禁言，需要Owner / Admin权限

参数

aMuteMembers	被解除的列表<NSString>
aGroupId	群ID
aCompletionBlock	完成的回调

- (EMGroup *) unmuteMembers: (NSArray *)  aMembers fromGroup: (NSString *)  aGroupId error: (EMError **)  pError

required

解除禁言，需要Owner / Admin权限

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

参数

aMuteMembers	被解除的列表<NSString>
aGroupId	群ID
pError	错误信息

返回

返回群组实例

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

required

更改群组说明信息, 需要owner权限

参数

aDescription	说明信息
aGroupId	群组ID
aCompletionBlock	完成的回调

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

required

修改群公告，需要Owner / Admin权限

参数

aGroupId	群ID
aAnnouncement	群公告
aCompletionBlock	完成的回调

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

required

修改群公告，需要Owner / Admin权限

参数

aGroupId	群ID
aAnnouncement	群公告
pError	错误信息

返回

群实例

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

required

修改群扩展信息，需要Owner权限

参数

aGroupId	群ID
aExt	扩展信息
aCompletionBlock	完成的回调

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

required

修改群扩展信息，需要Owner权限

参数

aGroupId	群ID
aExt	扩展信息
pError	错误信息

返回

群实例

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

required

改变群主，需要Owner权限

参数

aGroupId	群ID
aNewOwner	新群主
aCompletionBlock	完成的回调

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

required

改变群主，需要Owner权限

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

参数

aGroupId	群ID
aNewOwner	新群主
pError	错误信息

返回

返回群组实例

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

required

更改群组主题, 需要owner权限

参数

aSubject	新主题
aGroupId	群组ID
aCompletionBlock	完成的回调

- (void) updatePushServiceForGroup: (NSString *)  aGroupId isPushEnabled: (BOOL)  aIsEnable completion: (void(^)(EMGroup *aGroup, EMError *aError))  aCompletionBlock

required

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

参数

aGroupId	群组ID
aIsEnable	是否允许推送
aCompletionBlock	完成的回调

- (void) updatePushServiceForGroups: (NSArray *)  aGroupIDs isPushEnabled: (BOOL)  aIsEnable completion: (void(^)(NSArray *groups, EMError *aError))  aCompletionBlock

required

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

参数

aGroupIDs	群组ID列表
aIsEnable	是否允许推送
aCompletionBlock	完成的回调

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

required

上传群共享文件

参数

aGroupId	群ID
aFilePath	文件路径
pError	错误信息

返回

群实例

---

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

• Hyphenate.framework/Headers/IEMGroupManager.h