#import <IEMGroupManager.h>
@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 |
解散群组。
该方法只有群主才有权限调用。
同步方法,会阻塞当前线程。
- 参数
-
- 返回
- 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 | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
◆ 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 列表。
- 参数
-
- 返回
- 群组 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 |
◆ getJoinedGroupsFromServerWithPage:pageSize:completion:
- (void) getJoinedGroupsFromServerWithPage: |
|
(NSInteger) |
aPageNum |
pageSize: |
|
(NSInteger) |
aPageSize |
completion: |
|
("Use -getJoinedGroupsFromServerWithPage:pageSize:needMemberCount:needRole:error:completion: instead") |
__deprecated_msg |
|
|
| |
|
required |
◆ 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 | 是否需要群组成员数。
|
aNeedRole | 是否需要当前用户的角色。
|
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:
◆ ignoreGroupsPush:ignore:
◆ 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 |
◆ 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 | 错误信息。 |
- 返回
- 搜索到的群组␈。
◆ 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:
◆ updatePushServiceForGroups:isPushEnabled:completion:
◆ 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 | 错误信息。 |
- 返回
- 群组实例。
该协议的文档由以下文件生成: