/** * \~chinese * @header IEMGroupManager.h * @abstract 群组相关操作类。 * @author Hyphenate * @version 3.00 * * \~english * @header IEMGroupManager.h * @abstract This protocol defines the group operations. * @author Hyphenate * @version 3.00 */ #import #import "EMCommonDefs.h" #import "EMGroupManagerDelegate.h" #import "EMGroup.h" #import "EMGroupOptions.h" #import "EMCursorResult.h" #import "EMGroupSharedFile.h" /** * \~chinese * 群组相关操作类。 * * \~english * The group operations. */ @protocol IEMGroupManager @required #pragma mark - Delegate /** * \~chinese * 添加回调代理。 * * @param aDelegate 要添加的代理。 * @param aQueue 代理执行的队列，如果是空值，则在主线程。 * * \~english * Adds delegate. * * @param aDelegate The delegate to be added. * @param aQueue (optional) The queue of calling delegate methods. Pass in nil to run on main thread. */ - (void)addDelegate:(id _Nonnull)aDelegate delegateQueue:(dispatch_queue_t _Nullable )aQueue; /** * \~chinese * 移除回调代理。 * * @param aDelegate 要移除的代理。 * * \~english * Removes delegate. * * @param aDelegate The delegate to be removed. */ - (void)removeDelegate:(id _Nonnull)aDelegate; #pragma mark - Get Group /** * \~chinese * 获取用户所有群组。 * * @result 群组列表。 * * \~english * Gets all groups. * * @result The group list. * */ - (NSArray *_Nullable )getJoinedGroups; /** * \~chinese * 从内存中获取屏蔽了推送的群组 ID 列表。 * * @param pError 错误信息。 * * @result 群组 ID 列表。 * \~english * Gets the list of groups which have disabled Apple Push Notification Service. * * @param pError The error information if the method fails: Error. * * @result The group ID list. */ - (NSArray *)getGroupsWithoutPushNotification:(EMError **)pError EM_DEPRECATED_IOS(3_3_2, 3_8_3, "Use -IEMPushManager::noPushGroups"); #pragma mark - Get group from server /** * \~chinese * 按数目从服务器获取自己加入的群组。 * * 这里需要注意的是： * - 每次调用只返回一页的数据。首次调用传空值，会从最新的第一条开始取； * - aPageSize 是这次接口调用期望返回的列表数据个数，如当前在最后一页，返回的数据会是 count < aPageSize； * - 列表页码 aPageNum 是方便服务器分页查询返回，对于数据量未知且很大的情况，分页获取，服务器会根据每次的页数和每次的pagesize 返回数据，直到返回所有数据。 * * 同步方法，会阻塞当前线程。 * * @param aPageNum 获取自己加入群的游标，首次调用传空。 * @param aPageSize 期望返回结果的数量, 如果小于 0 则一次返回所有结果。 * @param pError 出错信息。 * * @result 群组列表。 * * \~english * Gets pagesize number group you joined from the server. * * This is a synchronous method and blocks the current thread. * * @param aPageNum Gets the cursor to join the group. Sets the parameter as nil for the first time. * @param aPageSize The number of results expected to be returned. If <0 then all results will be returned at once * @param pError The error information if the method fails: Error. * * @result The Group list. */ - (NSArray *_Nullable )getJoinedGroupsFromServerWithPage:(NSInteger)aPageNum pageSize:(NSInteger)aPageSize error:(EMError **_Nullable )pError; /** * \~chinese * 从服务器获取指定范围内的公开群。 * * 同步方法，会阻塞当前线程。 * * @param aCursor 获取公开群的游标，首次调用传空。 * @param aPageSize 期望返回结果的数量, 如果小于 0 则一次返回所有结果。 * @param pError 出错信息。 * * @result 获取的公开群结果。 * * \~english * Gets the public groups with the specified range from the server. * * This is a synchronous method and blocks the current thread. * * @param aCursor The cursor to join the group. Sets the parameter as nil for the first time. * @param aPageSize The number of results expected to be returned. If the number is less than 0 then all results will be returned at once. * @param pError The error information if the method fails: Error. * * @result The result. */ - (EMCursorResult *_Nullable)getPublicGroupsFromServerWithCursor:(NSString *_Nullable)aCursor pageSize:(NSInteger)aPageSize error:(EMError **_Nullable)pError; /** * \~chinese * 从服务器获取指定范围内的公开群。 * * 异步方法。 * * @param aCursor 获取公开群的游标，首次调用传空。 * @param aPageSize 期望返回结果的数量, 如果小于 0 则一次返回所有结果。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * * \~english * Gets public groups with the specified range from the server. * * This is an asynchronous method. * * @param aCursor Gets the cursor to join the group. Sets the parameter as nil for the first time. * @param aPageSize The number of results expected to be returned. If the number is less than 0 then all results will be returned at once. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)getPublicGroupsFromServerWithCursor:(NSString *_Nullable)aCursor pageSize:(NSInteger)aPageSize completion:(void (^_Nullable)(EMCursorResult *_Nullable aResult, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 根据群组 ID 搜索公开群。 * * 同步方法，会阻塞当前线程。 * * @param aGroundId 群组 ID。 * @param pError 错误信息。 * * @result 搜索到的群组。 * * \~english * Searches a public group with the group ID. * * This is a synchronous method and blocks the current thread. * * @param aGroundId The group ID. * @param pError The error information if the method fails: Error. * * @result The groups searched. */ - (EMGroup * _Nullable)searchPublicGroupWithId:(NSString *_Nonnull)aGroundId error:(EMError **_Nullable)pError; /** * \~chinese * 根据群组 ID 搜索公开群。 * * @param aGroundId 群组 ID。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * * \~english * Searches public group with group ID. * * @param aGroundId The group ID. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)searchPublicGroupWithId:(NSString *_Nonnull)aGroundId completion:(void (^_Nullable)(EMGroup *aGroup, EMError *_Nullable aError))aCompletionBlock; #pragma mark - Create /** * \~chinese * 创建群组。 * * 同步方法，会阻塞当前线程。 * * @param aSubject 群组名称。 * @param aDescription 群组描述。 * @param aInvitees 群组成员，不包括创建者自己。 * @param aMessage 加入群组的邀请消息。 * @param aSetting 群组属性。 * @param pError 出错信息。 * * @result 群组实例。 * * \~english * Creates a group. * * This is a synchronous method and blocks the current thread. * * @param aSubject The subject of the group. * @param aDescription The description of the group. * @param aInvitees The members of the group. Do not include the creator. * @param aMessage The invitation message. * @param aSetting The group options. * @param pError The error information if the method fails: Error. * * @result The group instance. */ - (EMGroup * _Nullable)createGroupWithSubject:(NSString *_Nullable)aSubject description:(NSString *_Nullable)aDescription invitees:(NSArray * _Nullable)aInvitees message:(NSString *_Nullable)aMessage setting:(EMGroupOptions *_Nullable)aSetting error:(EMError **_Nullable)pError; /** * \~chinese * 创建群组。 * * 异步方法。 * * @param aSubject 群组名称。 * @param aDescription 群组描述。 * @param aInvitees 群组成员，不包括创建者自己。 * @param aMessage 加入群组的邀请消息。 * @param aSetting 群组属性。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * * \~english * Creates a group. * * This is an asynchronous method. * * @param aSubject The subject of the group. * @param aDescription The description of the group. * @param aInvitees The members of the group. Do not include the creator. * @param aMessage The invitation message. * @param aSetting The group options. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)createGroupWithSubject:(NSString *_Nullable)aSubject description:(NSString *_Nullable)aDescription invitees:(NSArray * _Nullable)aInvitees message:(NSString *_Nullable)aMessage setting:(EMGroupOptions *_Nullable)aSetting completion:(void (^_Nullable)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))aCompletionBlock; #pragma mark - Fetch Info /** * \~chinese * 获取群组详情，包含群组 ID, 群组名称，群组描述，群组基本属性，群主，群组管理员。 * * 同步方法，会阻塞当前线程。 * * @param aGroupId 群组 ID。 * @param pError 错误信息。 * * @result 群组实例。 * * \~english * Fetches the group information，including the group ID, name, description，setting, owner and admins. * * This is a synchronous method and blocks the current thread. * * @param aGroupId The group ID. * @param pError The error information if the method fails: Error. * * @result The group instance. */ - (EMGroup * _Nullable)getGroupSpecificationFromServerWithId:(NSString *_Nonnull)aGroupId error:(EMError **_Nullable)pError; /** * \~chinese * 获取群组详情，包含群组 ID，群组名称，群组描述，群组基本属性，群主，群组管理员。 * * 同步方法，会阻塞当前线程。 * * @param aGroupId 群组 ID。 * @param fetchMembers 是否获取群组成员，默认最多取 200 人。 * @param pError 错误信息。 * * @result 群组实例。 * * \~english * Fetches the group specification, including the group ID, name, description, setting, owner, admins. * * This is a synchronous method and blocks the current thread. * * @param aGroupId The group ID. * @param fetchMembers Whether to fetch the group members. The default action fetches at most 200 members. * @param pError The error information if the method fails: Error. * * @result The group instance. */ - (EMGroup * _Nullable)getGroupSpecificationFromServerWithId:(NSString *_Nonnull)aGroupId fetchMembers:(BOOL)fetchMembers error:(EMError **_Nullable)pError; /** * \~chinese * 获取群组详情，包含群组 ID，群组名称，群组描述，群组基本属性，群主，群组管理员。 * * 异步方法。 * * @param aGroupId 群组 ID。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * * \~english * Fetches the group specification, including: ID, name, description, setting, owner, admins. * * This is an asynchronous method. * * @param aGroupId The group ID. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)getGroupSpecificationFromServerWithId:(NSString *_Nonnull)aGroupId completion:(void (^_Nullable)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 获取群组详情，包含群组 ID，群组名称，群组描述，群组基本属性，群主，群组管理员。 * * 异步方法。 * * @param aGroupId 群组 ID。 * @param fetchMembers 是否获取群组成员，默认最多取 200 人数。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * * \~english * Fetches the group specification, including: ID, name, description, setting, owner, admins. * * @param aGroupId The group ID. * @param fetchMembers Whether to fetch the group members. The default action fetches at most 200 members. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)getGroupSpecificationFromServerWithId:(NSString *_Nonnull)aGroupId fetchMembers:(BOOL)fetchMembers completion:(void (^_Nullable)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 获取群组成员列表。 * * 这里需要注意的是： * - 每次调用只返回一页的数据。首次调用传空值，会从最新的第一条开始取； * - aPageSize 是这次接口调用期望返回的列表数据个数，如当前在最后一页，返回的数据会是 count < aPageSize； * - 列表页码 aPageNum 是方便服务器分页查询返回，对于数据量未知且很大的情况，分页获取，服务器会根据每次的页数和每次的pagesize 返回数据，直到返回所有数据。 * * 同步方法，会阻塞当前线程。 * * @param aGroupId 群组 ID。 * @param aCursor 游标，首次调用传空。使用场景：第一次传 nil ，然后根据服务器返回的数据，其中有一个字段是 aCursor，保存本地，下次调用接口时，会把更新的aCursor 传入作为获取数据的标志位置。 * @param aPageSize 调用接口时，指定期望返回的列表数据个数。 * @param pError 错误信息。 * * @result 列表和游标。 * * \~english * Gets the list of group members from the server. * * This is a synchronous method and blocks the current thread. * * @param aGroupId The group ID. * @param aCursor The cursor when joins the group. Sets the parameter as nil for the first time. * @param aPageSize The expect entry number of the list. * @param pError The error information if the method fails: Error. * * @result The list and cursor. * */ - (EMCursorResult *)getGroupMemberListFromServerWithId:(NSString *_Nonnull)aGroupId cursor:(NSString *_Nullable)aCursor pageSize:(NSInteger)aPageSize error:(EMError **_Nullable)pError; /** * \~chinese * 获取群组成员列表。 * 这里需要注意的是： * - 每次调用只返回一页的数据。首次调用传空值，会从最新的第一条开始取； * - aPageSize 是这次接口调用期望返回的列表数据个数，如当前在最后一页，返回的数据会是 count < aPageSize； * - 列表页码 aPageNum 是方便服务器分页查询返回，对于数据量未知且很大的情况，分页获取，服务器会根据每次的页数和每次的pagesize 返回数据，直到返回所有数据。 * * @param aGroupId 群组 ID。 * @param aCursor 游标，首次调用传空。 * @param aPageSize 获取多少条。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * * \~english * Gets the list of group members from the server. * * @param aGroupId The group ID. * @param aCursor The cursor when joins the group. Sets the parameter as nil for the first time. * @param aPageSize The page size. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)getGroupMemberListFromServerWithId:(NSString *_Nonnull)aGroupId cursor:(NSString *_Nullable)aCursor pageSize:(NSInteger)aPageSize completion:(void (^_Nullable)(EMCursorResult *aResult, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 获取群组黑名单列表。 * 这里需要注意的是： * - 每次调用只返回一页的数据。首次调用传空值，会从最新的第一条开始取； * - aPageSize 是这次接口调用期望返回的列表数据个数，如当前在最后一页，返回的数据会是 count < aPageSize； * - 列表页码 aPageNum 是方便服务器分页查询返回，对于数据量未知且很大的情况，分页获取，服务器会根据每次的页数和每次的pagesize 返回数据，直到返回所有数据。 * * 该方法只有群主和管理员才有权限调用。 * * @param aGroupId 群组 ID。 * @param aPageNum 获取第几页。 * @param aPageSize 获取多少条。 * @param pError 错误信息。 * * @result 黑名单列表。 * \~english * Gets the blocklist of group from the server. * * Only the group owner or admin can call this method. * * @param aGroupId The group ID. * @param aPageNum The page number. * @param aPageSize The page size. * @param pError The error information if the method fails: Error. * * @result The blockList of the group. */ - (NSArray * _Nullable)getGroupBlacklistFromServerWithId:(NSString *_Nonnull)aGroupId pageNumber:(NSInteger)aPageNum pageSize:(NSInteger)aPageSize error:(EMError **_Nullable)pError; /** * \~chinese * 获取群组黑名单列表。 * * 该方法只有群主和管理员才有权限调用。 * * @param aGroupId 群组 ID。 * @param aPageNum 获取第几页。 * @param aPageSize 获取多少条。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * * \~english * Gets the group's blocklist. * * Only the group owner or admin can call this method. * * @param aGroupId The group ID. * @param aPageNum The page number. * @param aPageSize The page size. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)getGroupBlacklistFromServerWithId:(NSString *_Nonnull)aGroupId pageNumber:(NSInteger)aPageNum pageSize:(NSInteger)aPageSize completion:(void (^_Nullable)(NSArray * _Nullable aList, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 获取群组被禁言列表。 * * 该方法只有群主和群管理员允许调用。 * * @param aGroupId 群组 ID。 * @param aPageNum 获取第几页。 * @param aPageSize 获取多少条。 * @param pError 错误信息。 * * @result 群组被禁言列表。 * * * \~english * Gets the mutelist of the group from the server. * * Only the group owner or admin can call this method. * * @param aGroupId The group ID. * @param aPageNum The page number. * @param aPageSize The page size. * @param pError The error information if the method fails: Error. * * @result The mutelist of the group. */ - (NSArray * _Nullable)getGroupMuteListFromServerWithId:(NSString *_Nonnull)aGroupId pageNumber:(NSInteger)aPageNum pageSize:(NSInteger)aPageSize error:(EMError **_Nullable)pError; /** * \~chinese * 获取群组被禁言列表。 * * 该方法只有群主和群管理员允许调用。 * * @param aGroupId 群组 ID。 * @param aPageNum 获取第几页。 * @param aPageSize 获取多少条。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * * \~english * Gets the mutelist of the group from the server. * * Only the group owner or admin can call this method. * * @param aGroupId The group ID. * @param aPageNum The page number. * @param aPageSize The page size. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)getGroupMuteListFromServerWithId:(NSString *_Nonnull)aGroupId pageNumber:(NSInteger)aPageNum pageSize:(NSInteger)aPageSize completion:(void (^_Nullable)(NSArray * _Nullable aList, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 获取群组被禁言列表。 * * 该方法只有群主和群管理员允许调用。 * * @param aGroupId 群组 ID。 * @param aPageNum 获取第几页。 * @param aPageSize 获取多少条。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * * \~english * Gets the mutelist of the group from the server. * * Only the group owner or admin can call this method. * * @param aGroupId The group ID. * @param aPageNum The page number. * @param aPageSize The page size. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)fetchGroupMuteListFromServerWithId:(NSString *_Nonnull)aGroupId pageNumber:(NSInteger)aPageNum pageSize:(NSInteger)aPageSize completion:(void (^_Nullable)(NSDictionary *_Nullable aDict, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 获取群共享文件列表。 * * @param aGroupId 群组 ID。 * @param aPageNum 获取第几页。 * @param aPageSize 获取多少条。 * @param pError 错误信息。 * * @result 群共享文件列表。 * * \~english * Gets the share files of group from the server. * * @param aGroupId The group ID. * @param aPageNum The page number. * @param aPageSize The page size. * @param pError The error information if the method fails: Error. * * @result The list of share files of group. */ - (NSArray *_Nullable)getGroupFileListWithId:(NSString *_Nonnull)aGroupId pageNumber:(NSInteger)aPageNum pageSize:(NSInteger)aPageSize error:(EMError **_Nullable)pError; /** * \~chinese * 获取群共享文件列表。 * * 异步方法。 * * @param aGroupId 群组 ID。 * @param aPageNum 获取第几页。 * @param aPageSize 获取多少条。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * \~english * Gets the share files of group from the server. * * This is an asynchronous method. * * @param aGroupId The group ID. * @param aPageNum The page number. * @param aPageSize The page size. * @param aCompletionBlock The completion block, which contains the error message if the method fails. */ - (void)getGroupFileListWithId:(NSString *_Nonnull)aGroupId pageNumber:(NSInteger)aPageNum pageSize:(NSInteger)aPageSize completion:(void (^_Nullable)(NSArray *_Nullable aList, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 获取群组白名单列表。 * * @param aGroupId 群组 ID。 * @param pError 错误信息。 * * @result 群组白名单列表。 * * * \~english * Gets the allowlist of group from the server. * * @param aGroupId The group ID. * @param pError The error information if the method fails: Error. * * @result The allowList of the group. * */ - (NSArray *)getGroupWhiteListFromServerWithId:(NSString *_Nonnull)aGroupId error:(EMError **_Nullable)pError; /** * \~chinese * 获取群组白名单列表。 * * @param aGroupId 群组 ID。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * * \~english * Gets the allowlist of group from the server. * * @param aGroupId The group ID. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)getGroupWhiteListFromServerWithId:(NSString *_Nonnull)aGroupId completion:(void (^_Nullable)(NSArray * _Nullable aList, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 查看自己是否在群组白名单中。 * * @param aGroupId 群组 ID。 * @param pError 错误信息。 * * @result 布尔值。 YES: 在白名单； NO: 不在白名单。 * * * \~english * Gets whether the member is on the allowlist. * * @param aGroupId The group ID. * @param pError The error information if the method fails: Error. * * @result BOOL. YES: in whiteList. NO: not in whiteList. * */ - (BOOL)isMemberInWhiteListFromServerWithGroupId:(NSString *_Nonnull)aGroupId error:(EMError **_Nullable)pError; /** * \~chinese * 查看自己是否在群组白名单中。 * * @param aGroupId 群组 ID。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * * \~english * Gets whether the member is on the allowlist. * * @param aGroupId The group ID. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)isMemberInWhiteListFromServerWithGroupId:(NSString *_Nonnull)aGroupId completion:(void (^_Nullable)(BOOL inWhiteList, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 获取群公告。 * * @param aGroupId 群组 ID。 * @param pError 错误信息。 * * @result 群公告。失败返回空值。 * * \~english * Gets the announcement of group from the server. * * @param aGroupId The group ID. * @param pError The error information if the method fails: Error. * * @result The group Announcement. The SDK will return nil if fails. */ - (NSString *_Nullable)getGroupAnnouncementWithId:(NSString *_Nonnull)aGroupId error:(EMError **_Nullable)pError; /** * \~chinese * 获取群公告。 * * @param aGroupId 群组 ID。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * * \~english * Gets the announcement of group from the server. * * @param aGroupId The group ID. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)getGroupAnnouncementWithId:(NSString *_Nonnull)aGroupId completion:(void (^_Nullable)(NSString *aAnnouncement, EMError *_Nullable aError))aCompletionBlock; #pragma mark - Edit Group /** * \~chinese * 邀请用户加入群组。 * * 同步方法，会阻塞当前线程。 * * @param aOccupants 被邀请的用户名列表。 * @param aGroupId 群组 ID。 * @param aWelcomeMessage 欢迎信息。 * @param pError 错误信息。 * * @result 群组实例。失败返回空值。 * * \~english * Invites users to join a group. * * This is a synchronous method and blocks the current thread. * * @param aOccupants The users who are invited. * @param aGroupId The group ID. * @param aWelcomeMessage The welcome message. * @param pError The error information if the method fails: Error. * * @result The group instance. The SDK will return nil if fails. */ - (EMGroup * _Nullable)addOccupants:(NSArray * _Nonnull)aOccupants toGroup:(NSString *_Nonnull)aGroupId welcomeMessage:(NSString *_Nullable)aWelcomeMessage error:(EMError **_Nullable)pError; /** * \~chinese * 邀请用户加入群组。 * * @param aUsers 被邀请的用户名列表。 * @param aGroupId 群组 ID。 * @param aMessage 欢迎信息。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * * \~english * Invites users to join a group. * * @param aUsers The users who are invited to join the group. * @param aGroupId The group ID. * @param aMessage The welcome message. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)addMembers:(NSArray * _Nonnull)aUsers toGroup:(NSString *_Nonnull)aGroupId message:(NSString *_Nullable)aMessage completion:(void (^_Nullable)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 将群成员移出群组。 * * 该方法只有群主才有权限调用。 * * 同步方法，会阻塞当前线程。 * * @param aOccupants 要移出群组的用户列表。 * @param aGroupId 群组 ID。 * @param pError 错误信息。 * * @result 群组实例。 * * \~english * Removes members from the group. * * Only the group owner can call this method. * * This is a synchronous method and blocks the current thread. * * @param aOccupants The users to be removed from the group. * @param aGroupId The group ID. * @param pError The error information if the method fails: Error. * * @result The group instance. */ - (EMGroup * _Nullable)removeOccupants:(NSArray * _Nonnull)aOccupants fromGroup:(NSString *_Nonnull)aGroupId error:(EMError **_Nullable)pError; /** * \~chinese * 将群成员移出群组。 * * 该方法只有群主才有权限调用。 * * @param aUsers 要移出群组的用户列表。 * @param aGroupId 群组 ID。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * * \~english * Removes members from the group. * * Only the group owner can call this method. * * @param aUsers The members to be removed from the group. * @param aGroupId The group ID. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)removeMembers:(NSArray * _Nonnull)aUsers fromGroup:(NSString *_Nonnull)aGroupId completion:(void (^_Nullable)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 加人到群组黑名单。 * * 该方法只有群主才有权限调用。 * * 同步方法，会阻塞当前线程。 * * @param aOccupants 要加入黑名单的用户。 * @param aGroupId 群组 ID。 * @param pError 错误信息。 * * @result 群组实例。 * * \~english * Adds users to blocklist of the group. * * Only the group owner can call this method. * * This is a synchronous method and blocks the current thread. * * @param aOccupants The users to be added to the blockList. * @param aGroupId The group ID. * @param pError The error information if the method fails: Error. * * @result The group instance. */ - (EMGroup * _Nullable)blockOccupants:(NSArray * _Nonnull)aOccupants fromGroup:(NSString *_Nonnull)aGroupId error:(EMError **_Nullable)pError; /** * \~chinese * 加人到群组黑名单。 * * 该方法只有群主才有权限调用。 * * @param aMembers 要加入黑名单的用户。 * @param aGroupId 群组 ID。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * * \~english * Adds users to blocklist of the group. * * Only the group owner can call this method. * * @param aMembers The users to be added to the blockList. * @param aGroupId The group ID. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)blockMembers:(NSArray * _Nonnull)aMembers fromGroup:(NSString *_Nonnull)aGroupId completion:(void (^_Nullable)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 从群组黑名单中移除。 * * 该方法只有群主才有权限调用。 * * 同步方法，会阻塞当前线程。 * * @param aOccupants 要从黑名单中移除的用户名列表。 * @param aGroupId 群组 ID。 * @param pError 错误信息。 * * @result 群组实例。 * * \~english * Removes users from the blocklist of the group. * * Only the group owner can call this method. * * This is a synchronous method and blocks the current thread. * * @param aOccupants The users to be removed from the blockList. * @param aGroupId The group ID. * @param pError The error information if the method fails: Error. * * @result The group instance. */ - (EMGroup * _Nullable)unblockOccupants:(NSArray * _Nonnull)aOccupants forGroup:(NSString *_Nonnull)aGroupId error:(EMError **_Nullable)pError; /** * \~chinese * 从群组黑名单中移除。 * * 该方法只有群主才有权限调用。 * * @param aMembers 要从黑名单中移除的用户名列表。 * @param aGroupId 群组 ID。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * * \~english * Removes users out of the blocklist of the group. * * Only the group owner can call this method. * * @param aMembers The users to be removed from the blockList. * @param aGroupId The group ID. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)unblockMembers:(NSArray * _Nonnull)aMembers fromGroup:(NSString *_Nonnull)aGroupId completion:(void (^_Nullable)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 更改群组主题。 * * 该方法只有群主才有权限调用。 * * 同步方法，会阻塞当前线程。 * * @param aSubject 新主题。 * @param aGroupId 群组 ID。 * @param pError 错误信息。 * * @result 群组实例。 * * \~english * Changes the subject of the group. * * Only the group owner can call this method. * * This is a synchronous method and blocks the current thread. * * @param aSubject The new subject of the group. * @param aGroupId The group ID. * @param pError The error information if the method fails: Error. * * @result The group instance. */ - (EMGroup * _Nullable)changeGroupSubject:(NSString *_Nullable)aSubject forGroup:(NSString *_Nonnull)aGroupId error:(EMError **_Nullable)pError; /** * \~chinese * 更改群组主题 。 * * 该方法只有群主才有权限调用。 * * @param aSubject 新主题。 * @param aGroupId 群组 ID。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * * \~english * Changes the group subject. * * Only the group owner can call this method. * * @param aSubject The new subject of the group. * @param aGroupId The group ID. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)updateGroupSubject:(NSString *_Nullable)aSubject forGroup:(NSString *_Nonnull)aGroupId completion:(void (^_Nullable)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 更改群组说明信息。 * * 该方法只有群主才有权限调用。 * * 同步方法，会阻塞当前线程。 * * @param aDescription 说明信息。 * @param aGroupId 群组 ID。 * @param pError 错误信息。 * * @result 群组实例。 * * \~english * Changes the group description. * * Only the group owner can call this method. * * This is a synchronous method and blocks the current thread. * * @param aDescription The new group description. * @param aGroupId The group ID. * @param pError The error information if the method fails: Error. * * @result The group instance. */ - (EMGroup * _Nullable)changeDescription:(NSString *_Nullable)aDescription forGroup:(NSString *_Nonnull)aGroupId error:(EMError **_Nullable)pError; /** * \~chinese * 更改群组说明信息。 * * 该方法只有群主才有权限调用。 * * @param aDescription 说明信息。 * @param aGroupId 群组 ID。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * * \~english * Changes the group description. * * Only the group owner can call this method. * * @param aDescription The new group‘s description. * @param aGroupId The group ID. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)updateDescription:(NSString *_Nullable)aDescription forGroup:(NSString *_Nonnull)aGroupId completion:(void (^_Nullable)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 退出群组，群主不能退出群，只能销毁群。 * * 同步方法，会阻塞当前线程。 * * @param aGroupId 群组 ID。 * @param pError 错误信息。 * * * \~english * Leaves a group. The owner can't leave the group, can only destroy the group. * * This is a synchronous method and blocks the current thread. * * @param aGroupId The group ID. * @param pError The error information if the method fails: Error. * */ - (void)leaveGroup:(NSString *_Nonnull)aGroupId error:(EMError **_Nullable)pError; /** * \~chinese * 退出群组，群主不能退出群，只能销毁群。 * * @param aGroupId 群组 ID。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * * \~english * Leaves a group. The owner can't leave the group, can only destroy the group. * * @param aGroupId The group ID. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)leaveGroup:(NSString *_Nonnull)aGroupId completion:(void (^_Nullable)(EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 解散群组。 * * 该方法只有群主才有权限调用。 * * 同步方法，会阻塞当前线程。 * * @param aGroupId 群组 ID。 * * @result EMError 错误信息。成功返回 nil。 * * \~english * Destroys a group. * * Only the group owner can call this method. * * This is a synchronous method and blocks the current thread. * * @param aGroupId The group ID. * * @result The error information if the method fails: Error. The SDK wil return nil if the method succeed. */ - (EMError *)destroyGroup:(NSString *_Nonnull)aGroupId; /** * \~chinese * 解散群组。 * * 该方法只有群主才有权限调用。 * * @param aGroupId 群组 ID。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * \~english * Destroys a group. * * Only the group owner can call this method. * * @param aGroupId The group ID. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)destroyGroup:(NSString *_Nonnull)aGroupId finishCompletion:(void (^_Nullable)(EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 屏蔽群消息，服务器不再发送此群的消息给用户，群主不能屏蔽群消息。 * * 同步方法，会阻塞当前线程。 * * @param aGroupId 要屏蔽的群 ID。 * @param pError 错误信息。 * * @result 群组实例。 * * \~english * Blocks group messages. The server will block the messages from the group. * * The group owner can't block the group's messages. * * This is a synchronous method and blocks the current thread. * * @param aGroupId The group ID. * @param pError The error information if the method fails: Error. * * @result The group instance. */ - (EMGroup * _Nullable)blockGroup:(NSString *_Nonnull)aGroupId error:(EMError **_Nullable)pError; /** * \~chinese * 屏蔽群消息，服务器不再发送此群的消息给用户，群主不能屏蔽群消息。 * * @param aGroupId 要屏蔽的群组 ID。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * \~english * Blocks group messages, so the server blocks the messages from the group. * * The group owner can't block the group's messages. * * @param aGroupId The group ID. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)blockGroup:(NSString *_Nonnull)aGroupId completion:(void (^_Nullable)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 取消屏蔽群消息 * * 同步方法，会阻塞当前线程。 * * @param aGroupId 要取消屏蔽的群组 ID。 * @param pError 错误信息。 * * @result 群组实例。 * * \~english * Unblocks group messages. * * This is a synchronous method and blocks the current thread. * * @param aGroupId The group ID. * @param pError The error information if the method fails: Error. * * @result The group instance. */ - (EMGroup * _Nullable)unblockGroup:(NSString *_Nonnull)aGroupId error:(EMError **_Nullable)pError; /** * \~chinese * 取消屏蔽群消息。 * * @param aGroupId 要取消屏蔽的群组 ID。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * \~english * Unblocks group messages. * * @param aGroupId The group ID. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)unblockGroup:(NSString *_Nonnull)aGroupId completion:(void (^_Nullable)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 改变群主。 * * 该方法只有群主才有权限调用。 * * 同步方法，会阻塞当前线程。 * * @param aGroupId 群组 ID。 * @param aNewOwner 新群主。 * @param pError 错误信息。 * * @result 返回群组实例。 * * \~english * Changes the owner of the group. * * Only the group owner can call this method. * * This is a synchronous method and blocks the current thread. * * @param aGroupId The group ID. * @param aNewOwner The new group owner. * @param pError The error information if the method fails: Error. * * @result The group instance. */ - (EMGroup * _Nullable)updateGroupOwner:(NSString *_Nonnull)aGroupId newOwner:(NSString *_Nonnull)aNewOwner error:(EMError **_Nullable)pError; /** * \~chinese * 改变群主。 * * 该方法只有群主才有权限调用。 * * @param aGroupId 群组 ID。 * @param aNewOwner 新群主。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * * \~english * Changes the owner of the group. * * Only the group owner can call this method. * * @param aGroupId The group ID. * @param aNewOwner The new group owner. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)updateGroupOwner:(NSString *_Nonnull)aGroupId newOwner:(NSString *_Nonnull)aNewOwner completion:(void (^_Nullable)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 添加群组管理员。 * * 该方法只有群主才有权限调用。 * * 同步方法，会阻塞当前线程。 * * @param aAdmin 要添加的群组管理员。 * @param aGroupId 群组 ID。 * @param pError 错误信息。 * @result 返回群组实例。 * * \~english * Adds group admin. * * Only the group owner can call this method. * * This is a synchronous method and blocks the current thread. * * @param aAdmin The admin to be added. * @param aGroupId The group ID. * @param pError The error information if the method fails: Error. * @result The group instance. */ - (EMGroup * _Nullable)addAdmin:(NSString *_Nonnull)aAdmin toGroup:(NSString *_Nonnull)aGroupId error:(EMError **_Nullable)pError; /** * \~chinese * 添加群组管理员。 * * 异步方法。 * * 该方法只有群主才有权限调用。 * * @param aAdmin 要添加的群组管理员。 * @param aGroupId 群组 ID。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * * \~english * Adds group admin. * * This is an asynchronous method. * * Only the group owner can call this method. * * @param aAdmin The admin to be added. * @param aGroupId The group ID. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)addAdmin:(NSString *_Nonnull)aAdmin toGroup:(NSString *_Nonnull)aGroupId completion:(void (^_Nullable)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 移除群组管理员。 * * 该方法只有群主才有权限调用。 * * 同步方法，会阻塞当前线程。 * * @param aAdmin 要移除的群组管理员。 * @param aGroupId 群组 ID。 * @param pError 错误信息。 * * @result 返回群组实例。 * * \~english * Removes a group admin. * * Only the group owner can call this method. * * This is a synchronous method and blocks the current thread. * * @param aAdmin The admin to be removed. * @param aGroupId The group ID. * @param pError The error information if the method fails: Error. * * @result The group instance. */ - (EMGroup * _Nullable)removeAdmin:(NSString *_Nonnull)aAdmin fromGroup:(NSString *_Nonnull)aGroupId error:(EMError **_Nullable)pError; /** * \~chinese * 移除群组管理员。 * * 该方法只有群主才有权限调用。 * * 异步方法。 * * @param aAdmin 要移除的群组管理员。 * @param aGroupId 群组 ID。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * * \~english * Removes the group admin. * * Only the group owner can call this method. * * This is an asynchronous method. * * @param aAdmin The admin to be removed. * @param aGroupId The group ID. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)removeAdmin:(NSString *_Nonnull)aAdmin fromGroup:(NSString *_Nonnull)aGroupId completion:(void (^_Nullable)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 将一组成员禁言。 * * 该方法只有管理员或者群主才有权限调用。 * * 同步方法，会阻塞当前线程。 * * @param aMuteMembers 要禁言的成员列表。 * @param aMuteMilliseconds 禁言时长。 * @param aGroupId 群组 ID。 * @param pError 错误信息。 * * @result 返回群组实例。 * * \~english * Mutes group members. * * Only the chatroom owner or admin can call this method. * * This is a synchronous method and blocks the current thread. * * @param aMuteMembers The list of members to be muted. * @param aMuteMilliseconds The muted time duration in millisecond. * @param aGroupId The group ID. * @param pError The error information if the method fails: Error. * * @result The group instance. */ - (EMGroup * _Nullable)muteMembers:(NSArray * _Nonnull)aMuteMembers muteMilliseconds:(NSInteger)aMuteMilliseconds fromGroup:(NSString *_Nonnull)aGroupId error:(EMError **_Nullable)pError; /** * \~chinese * 将一组成员禁言。 * * 该方法只有管理员或者群主才有权限调用。 * * 异步方法。 * * @param aMuteMembers 要禁言的成员列表。 * @param aMuteMilliseconds 禁言时长。 * @param aGroupId 群组 ID。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * \~english * Mutes group members. * * Only the chatroom owner or admin can call this method. * * This is an asynchronous method. * * @param aMuteMembers The list of mute, type is * @param aMuteMilliseconds Muted time duration in millisecond * @param aGroupId The group ID. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)muteMembers:(NSArray * _Nonnull)aMuteMembers muteMilliseconds:(NSInteger)aMuteMilliseconds fromGroup:(NSString *_Nonnull)aGroupId completion:(void (^_Nullable)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 解除禁言。 * * 该方法只有管理员或者群主才有权限调用。 * * 同步方法，会阻塞当前线程。 * * @param aMuteMembers 被解除禁言的用户列表。 * @param aGroupId 群组 ID。 * @param pError 错误信息。 * * @result 返回群组实例。 * * \~english * Unmutes group members. * * Only the chatroom owner or admin can call this method. * * This is a synchronous method and blocks the current thread. * * @param aMembers The list of members to be unmuted. * @param aGroupId The group ID. * @param pError The error information if the method fails: Error. * * @result The group instance. */ - (EMGroup * _Nullable)unmuteMembers:(NSArray * _Nonnull)aMembers fromGroup:(NSString *_Nonnull)aGroupId error:(EMError **_Nullable)pError; /** * \~chinese * 解除禁言。 * * 该方法只有管理员或者群主才有权限调用。 * * 异步方法。 * * @param aMuteMembers 被解除禁言的用户列表。 * @param aGroupId 群组 ID。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * \~english * Unmutes group members. * * Only the chatroom owner or admin can call this method. * * This is an asynchronous method. * * @param aMembers The list of members to be unmuted. * @param aGroupId The group ID. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)unmuteMembers:(NSArray * _Nonnull)aMembers fromGroup:(NSString *_Nonnull)aGroupId completion:(void (^_Nullable)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 设置全员禁言。 * * 该方法只有管理员或者群主才有权限调用。 * * 同步方法，会阻塞当前线程。 * * @param aGroupId 群组 ID。 * @param pError 错误信息。 * * @result 群组实例。 * * \~english * Mutes all members. * * Only the chatroom owner or admin can call this method. * * This is a synchronous method and blocks the current thread. * * @param aGroupId The group ID. * @param pError The error information if the method fails: Error. * * @result The group instance. */ - (EMGroup * _Nullable)muteAllMembersFromGroup:(NSString *_Nonnull)aGroupId error:(EMError **_Nullable)pError; /** * \~chinese * 设置全员禁言。 * * 该方法只有管理员或者群主才有权限调用。 * * 异步方法。 * * @param aGroupId 群组 ID。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * \~english * mute all members. * * Only the chatroom owner or admin can call this method. * * This is an asynchronous method. * * @param aGroupId The group ID. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)muteAllMembersFromGroup:(NSString *_Nonnull)aGroupId completion:(void(^)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 解除全员禁言。 * * 该方法只有管理员或者群主才有权限调用。 * * 同步方法，会阻塞当前线程。 * * @param aGroupId 群组 ID。 * @param pError 错误信息。 * * @result 群组实例。 * * \~english * Unmutes all members. * * Only the chatroom owner or admin can call this method. * * This is a synchronous method and blocks the current thread. * * @param aGroupId The group ID. * @param pError The error information if the method fails: Error. * * @result The group instance. */ - (EMGroup * _Nullable)unmuteAllMembersFromGroup:(NSString *_Nonnull)aGroupId error:(EMError **_Nullable)pError; /** * \~chinese * 解除全员禁言。 * * 该方法只有管理员或者群主才有权限调用。 * * 异步方法。 * * @param aGroupId 群组 ID。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * \~english * Unmutes all members. * * Only the chatroom owner or admin can call this method. * * This is an asynchronous method. * * @param aGroupId The group ID. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)unmuteAllMembersFromGroup:(NSString *_Nonnull)aGroupId completion:(void(^)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 添加白名单。 * * 该方法只有管理员或者群主才有权限调用。 * * 同步方法，会阻塞当前线程。 * * @param aMuteMembers 要添加的成员列表。 * @param aGroupId 群组 ID。 * @param pError 错误信息。 * * @result 群组实例。 * * \~english * Adds members to the allowlist. * * Only the chatroom owner or admin can call this method. * * This is a synchronous method and blocks the current thread. * * @param aMembers The members to be added to the allowlist. * @param aGroupId The group ID. * @param pError The error information if the method fails: Error. * * @result The group instance. */ - (EMGroup * _Nullable)addWhiteListMembers:(NSArray * _Nonnull)aMembers fromGroup:(NSString *_Nonnull)aGroupId error:(EMError **_Nullable)pError; /** * \~chinese * 添加白名单。 * * 该方法只有管理员或者群主才有权限调用。 * * 异步方法。 * * @param aMembers 要添加的成员列表。 * @param aGroupId 群组 ID。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * \~english * Adds members to the allowlist. * * Only the chatroom owner or admin can call this method. * * @param aMembers The members to be added to the allowlist. * @param aGroupId The group ID. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)addWhiteListMembers:(NSArray * _Nonnull)aMembers fromGroup:(NSString *_Nonnull)aGroupId completion:(void (^_Nullable)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 移除白名单。 * * 该方法只有管理员或者群主才有权限调用。 * * 同步方法，会阻塞当前线程。 * * @param aMuteMembers 要添加的成员列表。 * @param aGroupId 群组 ID。 * @param pError 错误信息。 * * @result 群组实例。 * * \~english * Removes members from the allowlist. * * Only the chatroom owner or admin can call this method. * * This is a synchronous method and blocks the current thread. * * @param aMembers The members to be removed from the allowlist. * @param aGroupId The group ID. * @param pError The error information if the method fails: Error. * * @result The group instance. */ - (EMGroup * _Nullable)removeWhiteListMembers:(NSArray * _Nonnull)aMembers fromGroup:(NSString *_Nonnull)aGroupId error:(EMError **_Nullable)pError; /** * \~chinese * 移除白名单。 * * 异步方法。 * * 该方法只有管理员或者群主才有权限调用。 * * @param aMembers 被移除的列表。 * @param aGroupId 群组 ID。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * \~english * Removes members from the allowlist. * * This is an asynchronous method. * * Only the chatroom owner or admin can call this method. * * @param aMembers The members to be removed from the allowlist. * @param aGroupId The group ID. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)removeWhiteListMembers:(NSArray * _Nonnull)aMembers fromGroup:(NSString *_Nonnull)aGroupId completion:(void (^_Nullable)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 上传群共享文件。 * * @param aGroupId 群组 ID。 * @param aFilePath 文件路径。 * @param pError 错误信息。 * * @result 群组实例。 * * \~english * Uploads the share file of group. * * @param aGroupId The group ID. * @param aFilePath The path of file. * @param pError The error information if the method fails: Error. * * @result The group instance. */ - (void)uploadGroupSharedFileWithId:(NSString *_Nonnull)aGroupId filePath:(NSString* _Nonnull)aFilePath progress:(void (^_Nullable)(int progress))aProgressBlock completion:(void (^_Nullable)(EMGroupSharedFile *_Nullable aSharedFile, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 下载群共享文件。 * * @param aGroupId 群组 ID。 * @param aFilePath 文件路径。 * @param aSharedFileId 共享文件 ID。 * @param aProgressBlock 文件下载进度回调。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * \~english * Downloads the share file of group. * * @param aGroupId The group ID. * @param aFilePath The path of file. * @param aSharedFileId The shared file ID. * @param aProgressBlock The block of attachment upload progress * @param aCompletionBlock The completion block, which contains the error message if the method fails. */ - (void)downloadGroupSharedFileWithId:(NSString *_Nonnull)aGroupId filePath:(NSString *_Nonnull)aFilePath sharedFileId:(NSString *_Nonnull)aSharedFileId progress:(void (^_Nullable)(int progress))aProgressBlock completion:(void (^_Nullable)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 删除群共享文件。 * * @param aGroupId 群组 ID。 * @param aSharedFileId 共享文件 ID。 * @param pError 错误信息。 * * @result 群组实例。 * * \~english * Removes the share file of the group. * * This is a synchronous method and blocks the current thread. * * @param aGroupId The group ID. * @param aSharedFileId The share file ID. * @param pError The error information if the method fails: Error. * * @result The group instance. */ - (EMGroup * _Nullable)removeGroupSharedFileWithId:(NSString *_Nonnull)aGroupId sharedFileId:(NSString *_Nonnull)aSharedFileId error:(EMError **_Nullable)pError; /** * \~chinese * 删除群共享文件。 * * @param aGroupId 群组 ID。 * @param aSharedFileId 共享文件 ID。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * \~english * Removes the share file of group. * * @param aGroupId The group ID. * @param aSharedFileId The share file ID. * @param aCompletionBlock The completion block, which contains the error message if the method fails. */ - (void)removeGroupSharedFileWithId:(NSString *_Nonnull)aGroupId sharedFileId:(NSString *_Nonnull)aSharedFileId completion:(void (^_Nullable)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 修改群公告。 * * 该方法只有管理员或者群主才有权限调用。 * * @param aGroupId 群组 ID。 * @param aAnnouncement 群公告。 * @param pError 错误信息。 * * @result 群组实例。 * * \~english * Updates the announcement of group. * * Only the chatroom owner or admin can call this method. * * This is a synchronous method and blocks the current thread. * * @param aGroupId The group ID. * @param aAnnouncement The announcement of the group. * @param pError The error information if the method fails: Error. * * @result The group instance. */ - (EMGroup * _Nullable)updateGroupAnnouncementWithId:(NSString *_Nonnull)aGroupId announcement:(NSString *_Nullable)aAnnouncement error:(EMError **_Nullable)pError; /** * \~chinese * 修改群公告。 * * 该方法只有管理员或者群主才有权限调用。 * * 异步方法。 * * @param aGroupId 群组 ID。 * @param aAnnouncement 群公告。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * \~english * Updates the announcement of group. * * Only the chatroom owner or admin can call this method. * * This is an asynchronous method. * * @param aGroupId The group ID. * @param aAnnouncement The announcement of the group. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)updateGroupAnnouncementWithId:(NSString *_Nonnull)aGroupId announcement:(NSString *_Nullable)aAnnouncement completion:(void (^_Nullable)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 修改群扩展信息。 * * 该方法只有群主才有权限调用。 * * @param aGroupId 群组 ID。 * @param aExt 扩展信息 * @param pError 错误信息。 * * @result 群组实例。 * * \~english * Updates the extended of the group. * * Only the owner of the group can call this method. * * This is a synchronous method and blocks the current thread. * * @param aGroupId The group ID. * @param aExt The extended information of the group. * @param pError The error information if the method fails: Error. * * @result The group instance. */ - (EMGroup * _Nullable)updateGroupExtWithId:(NSString *_Nonnull)aGroupId ext:(NSString *_Nullable)aExt error:(EMError **_Nullable)pError; /** * \~chinese * 修改群扩展信息。 * * 该方法只有群主才有权限调用。 * * @param aGroupId 群组 ID。 * @param aExt 扩展信息。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * \~english * Updates the extended information of the group. * * Only the group owner can call this method. * * @param aGroupId The group ID. * @param aExt The extended information of the group. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)updateGroupExtWithId:(NSString *_Nonnull)aGroupId ext:(NSString *_Nullable)aExt completion:(void (^_Nullable)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))aCompletionBlock; #pragma mark - Edit Public Group /** * \~chinese * 加入一个公开群组，群类型应该是 EMGroupStylePublicOpenJoin。 * * 同步方法，会阻塞当前线程。 * * @param aGroupId 公开群组的 ID。 * @param pError 错误信息。 * * @result 所加入的公开群组。 * * \~english * Joins a public group. The group style should be EMGroupStylePublicOpenJoin. * * This is a synchronous method and blocks the current thread. * * @param aGroupId The public group ID. * @param pError The error information if the method fails: Error. * * @result The group instance. */ - (EMGroup * _Nullable)joinPublicGroup:(NSString *_Nonnull)aGroupId error:(EMError **_Nullable)pError; /** * \~chinese * 加入一个公开群组，群类型应该是 EMGroupStylePublicOpenJoin。 * * @param aGroupId 公开群组的 ID。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * \~english * Joins a public group. The group style should be EMGroupStylePublicOpenJoin. * * @param aGroupId The public group ID。 * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)joinPublicGroup:(NSString *_Nonnull)aGroupId completion:(void (^_Nullable)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 申请加入一个需批准的公开群组，群类型应该是 EMGroupStylePublicJoinNeedApproval。 * * 同步方法，会阻塞当前线程。 * * @param aGroupId 公开群组的 ID。 * @param aMessage 请求加入的信息。 * @param pError 错误信息。 * * @result 申请加入的公开群组。 * * \~english * The request to join a public group. The group style should be EMGroupStylePublicJoinNeedApproval. * * This is a synchronous method and blocks the current thread. * * @param aGroupId The public group ID。 * @param aMessage The message in the request. * @param pError The error information if the method fails: Error. * * @result The group instance. */ - (EMGroup * _Nullable)applyJoinPublicGroup:(NSString *_Nonnull)aGroupId message:(NSString *_Nullable)aMessage error:(EMError **_Nullable)pError; /** * \~chinese * 申请加入一个需批准的公开群组，群类型应该是 EMGroupStylePublicJoinNeedApproval。 * * @param aGroupId 公开群组的 ID。 * @param aMessage 请求加入的信息。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * * \~english * Requests to join a public group. The group style should be EMGroupStylePublicJoinNeedApproval. * * @param aGroupId The public group ID. * @param aMessage The information in the request. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)requestToJoinPublicGroup:(NSString *_Nonnull)aGroupId message:(NSString *_Nullable)aMessage completion:(void (^_Nullable)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))aCompletionBlock; #pragma mark - Application /** * \~chinese * 批准入群申请。 * * 该方法只有群主才有权限调用。 * * 同步方法，会阻塞当前线程。 * * @param aGroupId 所申请的群组 ID。 * @param aUsername 申请人。 * * @result 错误信息。 * * \~english * Accepts a group request. * * Only the group owner can call this method. * * This is a synchronous method and blocks the current thread. * * @param aGroupId The group ID. * @param aUsername The user who sends the request for join the group. * * @result Error */ - (EMError *)acceptJoinApplication:(NSString *_Nonnull)aGroupId applicant:(NSString *_Nonnull)aUsername; /** * \~chinese * 批准入群申请。 * * 该方法只有群主才有权限调用。 * * 异步方法。 * * @param aGroupId 所申请的群组 ID。 * @param aUsername 申请人。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * * \~english * Approves a group request. * * Only the group owner can call this method. * * This is an asynchronous method. * * @param aGroupId The group ID. * @param aUsername The user who sends the request for join the group. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)approveJoinGroupRequest:(NSString *_Nonnull)aGroupId sender:(NSString *_Nonnull)aUsername completion:(void (^_Nullable)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 拒绝入群申请。 * * 该方法只有群主才有权限调用。 * * 同步方法，会阻塞当前线程。 * * @param aGroupId 被拒绝的群组 ID。 * @param aUsername 申请人。 * @param aReason 拒绝理由。 * * @result 错误信息。 * * \~english * Declines a group request. * * Only the group owner can call this method. * * This is a synchronous method and blocks the current thread. * * @param aGroupId The group ID. * @param aUsername The user who sends the request for join the group. * @param aReason The reason of declining. * * @result Error */ - (EMError *)declineJoinApplication:(NSString *_Nonnull)aGroupId applicant:(NSString *_Nonnull)aUsername reason:(NSString *_Nullable)aReason; /** * \~chinese * 拒绝入群申请。 * * 该方法只有群主才有权限调用。 * * 异步方法。 * * @param aGroupId 被拒绝的群组 ID。 * @param aUsername 申请人。 * @param aReason 拒绝理由。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * * \~english * Declines a group request. * * Only the group owner can call this method. * * This is an asynchronous method. * * @param aGroupId The group ID. * @param aUsername The user who sends the request for join the group. * @param aReason The reason for declining. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)declineJoinGroupRequest:(NSString *_Nonnull)aGroupId sender:(NSString *_Nonnull)aUsername reason:(NSString *_Nullable)aReason completion:(void (^_Nullable)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 接受入群邀请。 * * 同步方法，会阻塞当前线程。 * * @param groupId 接受的群组 ID。 * @param aUsername 邀请者。 * @param pError 错误信息。 * * @result 接受的群组实例。 * * \~english * Accepts a group invitation. * * This is a synchronous method and blocks the current thread. * * @param aGroupId The group ID. * @param aUsername The user who initiates the invitation. * @param pError The error information if the method fails: Error. * * @result The group instance. */ - (EMGroup * _Nullable)acceptInvitationFromGroup:(NSString *_Nonnull)aGroupId inviter:(NSString *_Nonnull)aUsername error:(EMError **_Nullable)pError; /** * \~chinese * 接受入群邀请。 * * 异步方法。 * * @param groupId 接受的群组 ID。 * @param aUsername 邀请者。 * @param pError 错误信息。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * * \~english * Accepts a group invitation. * * This is an asynchronous method. * * @param aGroupId The group ID. * @param aUsername The user who initiates the invitation. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)acceptInvitationFromGroup:(NSString *_Nonnull)aGroupId inviter:(NSString *_Nonnull)aUsername completion:(void (^_Nullable)(EMGroup *_Nullable aGroup, EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 拒绝入群邀请。 * * 同步方法，会阻塞当前线程。 * * @param aGroupId 被拒绝的群组 ID。 * @param aUsername 邀请人。 * @param aReason 拒绝理由。 * * @result 错误信息。 * * \~english * Declines a group invitation. * * This is a synchronous method and blocks the current thread. * * @param aGroupId The group ID. * @param aUsername The user who initiates the invitation. * @param aReason The reason for declining. * * @result The error information if the method fails: Error. */ - (EMError *)declineInvitationFromGroup:(NSString *_Nonnull)aGroupId inviter:(NSString *_Nonnull)aUsername reason:(NSString *_Nullable)aReason; /** * \~chinese * 拒绝入群邀请。 * * 异步方法。 * * @param aGroupId 被拒绝的群组 ID。 * @param aInviter 邀请人。 * @param aReason 拒绝理由。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * * \~english * Declines a group invitation. * * This is an asynchronous method. * * @param aGroupId The group ID. * @param aInviter The user who send the invitation. * @param aReason The reason of declining. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)declineGroupInvitation:(NSString *_Nonnull)aGroupId inviter:(NSString *_Nonnull)aInviter reason:(NSString *_Nullable)aReason completion:(void (^_Nullable)(EMError *_Nullable aError))aCompletionBlock; /** * \~chinese * 从服务器分页获取当前用户加入的群组。 * * * 异步方法。 * * @param aPageNum 当前页码，从 0 开始。该参数设置后，SDK 从指定位置按照用户加入群组的逆序查询。 * 首次查询设置为 0，SDK 从最新加入的群组开始查询。 * @param aPageSize 每次期望获取的社区数量。取值范围为 [1,20]。 * @param aNeedMemberCount 是否需要群组成员数。 * - `YES`：是； * - `NO`：否； * @param aNeedRole 是否需要当前用户的角色。 * - `YES`：是； * - `NO`：否； * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * \~english * Uses the pagination to get the number group that you joined. * This method gets data from the server. * * This is an asynchronous method. * * @param aPageNum The current page number, starting from 0. * After this parameter is set, the SDK gets data from the specified position in the reverse chronological order of when the user joined groups. * At the first method call, if you set this parameter as `0`, the SDK gets data starting from the latest group that the user joined. * @param aPageSize The number of groups that you expect to get on each page. The value range is [1,20]. * @param aNeedMemberCount need member count Whether the number of group members is required. * - `YES`：Yes. * - `NO`：No. * @param aNeedRole need role Whether the role of the current user in the group is required. * - `YES`：Yes. * - `NO`：No. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)getJoinedGroupsFromServerWithPage:(NSInteger)aPageNum pageSize:(NSInteger)aPageSize needMemberCount:(BOOL)aNeedMemberCount needRole:(BOOL)aNeedRole completion:(void (^_Nullable)(NSArray *_Nullable aList, EMError *_Nullable aError))aCompletionBlock; #pragma mark - Apns /** * \~chinese * 屏蔽/取消屏蔽群组消息的推送。 * * 同步方法，会阻塞当前线程。 * * 已废弃，请用 {@link IEMPushManager::updatePushServiceForGroups:disablePush:} 代替。 * * @param aGroupId 群组 ID。 * @param aIgnore 是否屏蔽。 * * @result 错误信息。 * * \~english * Blocks/unblocks group message‘s push notification. * * This is a synchronous method and blocks the current thread. * * Deprecated, please use {@link IEMPushManager::updatePushServiceForGroups:disablePush:} instead. * * @param aGroupId The group ID. * @param aIsIgnore Whether to show or ignore the push notification. * * @result The error information if the method fails: Error. */ - (EMError *)ignoreGroupPush:(NSString *)aGroupId ignore:(BOOL)aIsIgnore EM_DEPRECATED_IOS(3_3_2, 3_8_3, "Use -IEMPushManager::updatePushServiceForGroups:disablePush:"); /** * \~chinese * 屏蔽/取消屏蔽群组消息的推送。 * * 已废弃，请用 {@link IEMPushManager::updatePushServiceForGroups:disablePush:completion:} 代替。 * * @param aGroupId 群组 ID。 * @param aIsEnable 是否允许推送。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * * \~english * Blocks/unblocks the group message‘s push notification. * * Deprecated, please use {@link IEMPushManager::updatePushServiceForGroups:disablePush:completion:} instead. * * @param aGroupId The group ID. * @param aIsEnable Whether to block or unblock the push notification. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)updatePushServiceForGroup:(NSString *)aGroupId isPushEnabled:(BOOL)aIsEnable completion:(void (^)(EMGroup *aGroup, EMError *aError))aCompletionBlock EM_DEPRECATED_IOS(3_3_2, 3_8_3, "Use -IEMPushManager::updatePushServiceForGroups:disablePush:completion:"); /** * \~chinese * 屏蔽/取消屏蔽群组消息的推送。 * * 已废弃，请用 {@link IEMPushManager::updatePushServiceForGroups:disablePush:} 代替。 * * 同步方法，会阻塞当前线程。 * * @param aGroupIDs 群组 ID 列表。 * @param aIgnore 是否屏蔽。 * * @result 错误信息。 * * \~english * Blocks/unblocks the group message‘s push notification. * * Deprecated, please use {@link IEMPushManager::updatePushServiceForGroups:disablePush:} instead. * * This is a synchronous method and blocks the current thread. * * @param aGroupIDs The group ID list. * @param aIsIgnore Whether to show or ignore the push notification. * * @result The error information if the method fails: Error. */ - (EMError *)ignoreGroupsPush:(NSArray *)aGroupIDs ignore:(BOOL)aIsIgnore EM_DEPRECATED_IOS(3_3_2, 3_8_3, "Use -IEMPushManager::updatePushServiceForGroups:disablePush:"); /** * \~chinese * 屏蔽/取消屏蔽群组消息的推送。 * * 已废弃，请用 {@link IEMPushManager::updatePushServiceForGroups:disablePush:completion:} 代替。 * * @param aGroupIDs 群组 ID 列表。 * @param aIsEnable 是否允许推送。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * * \~english * Blocks/unblocks the group message‘s push notification. * * Deprecated, please use {@link IEMPushManager::updatePushServiceForGroups:disablePush:completion:} instead. * * @param aGroupIDs The group ID list. * @param aIsEnable Whether to enable group messages push. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)updatePushServiceForGroups:(NSArray *)aGroupIDs isPushEnabled:(BOOL)aIsEnable completion:(void (^)(NSArray *groups, EMError *aError))aCompletionBlock EM_DEPRECATED_IOS(3_3_2, 3_8_3, "Use -IEMPushManager::updatePushServiceForGroups:disablePush:completion:"); #pragma mark - Group member attributes /** * \~chinese * 设置群成员自定义属性。 * * @param groupId 群组 ID。 * @param userId 要设置自定义属性的群成员的用户 ID。 * @param attributes 要设置的群成员自定义属性的 map，为 key-value 格式。对于一个 key-value 键值对，若 value 设置空字符串即删除该自定义属性。 * @param completion 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * \~english * Sets custom attributes of a group member. * * @param groupId The group ID. * @param userId The user ID of the group member for whom the custom attributes are set. * @param attributes The map of custom attributes in key-value format. In a key-value pair, if the value is set to an empty string, the custom attribute will be deleted. * @param completion The completion block, which contains the error message if the method call fails. */ - (void)setMemberAttribute:(NSString *_Nonnull)groupId userId:(NSString *_Nonnull)userId attributes:(NSDictionary *_Nonnull)attributes completion:(void (^_Nullable)(EMError *_Nullable error))completionBlock; /** * \~chinese * 获取单个群成员所有自定义属性。 * * @param groupId 群组 ID。 * @param userId 要获取的自定义属性的群成员的用户 ID。 * @param completion 该方法完成调用的回调，返回错误 EMError 和获取的属性的 Map。 * - 若该方法调用成功，返回获取的属性的 Map，包含获取的所有键值对，此时 EMError 为空。 * - 如果该方法调用失败，返回调用失败的原因，即 EMError，此时属性的 Map 为空。 * - 若获取的属性的 Map 为空，而且 EMError 也为空，表示该群成员未设置任何属性。 * \~english * Gets all custom attributes of a group member. * * @param groupId The group ID. * @param userId The user ID of the group member whose all custom attributes are retrieved. * @param completion The completion block, which contains the map of all retrieved attributes and the error message (EMError) if the method call fails: * - If the method call succeeds, the SDK returns the map of retrieved custom attributes in key-value pairs. In this case, EMError is empty. * - If the method call fails, the SDK returns the reason for the failure (EMError). In this case, the map of custom attributes is empty. * - If both the map of custom attributes and EMError are empty, no custom attribute is set for the group member. */ - (void)fetchMemberAttribute:(NSString *_Nonnull)groupId userId:(NSString *_Nonnull)userId completion:(void (^ _Nullable)(NSDictionary * _Nullable, EMError * _Nullable))completionBlock; /** * \~chinese * * 根据指定的属性 key 获取多个群成员的自定义属性 * @param groupId 群组 ID。 * @param userIds 要获取自定义属性的群成员的用户 ID 数组。（最多10个，多则报错） * @param keys 要获取自定义属性的 key 的数组。 * @param completion 该方法完成调用的回调，返回错误 EMError 和获取的属性的 Map。 * - 若该方法调用成功，返回获取的属性的 Map，包含获取的所有键值对，此时 EMError 为空。若某个群成员未设置自定义属性，其属性的 Map 为空。 * - 如果该方法调用失败，会包含调用失败的原因，此时属性的 Map 为空。 * - 若获取这些群成员的属性的 Map 为空，而且 EMError 也为空，表示这些群成员未设置任何属性。 * * \~english * Gets custom attributes of multiple group members by attribute key. * * @param groupId The group ID. * @param userIds The array of user IDs of group members whose custom attributes are retrieved.(limitation is ten.More than callback error. ) * @param keys The array of keys of custom attributes to be retrieved. * @param completion The completion block, which contains the map of retrieved attributes and the error message (EMError) if the method call fails. * - If the method call succeeds, the SDK returns the map of retrieved custom attributes in key-value pairs. In this case, EMError is empty. If no custom attribute is set for a group members, the map of custom attribute is empty for this member. * - If the method call fails, the SDK returns the reason for the failure (EMError). In this case, the map of custom attributes is empty for the group members. * - If both the map of custom attributes and EMError are empty, no custom attribute is set for the group members. */ - (void)fetchMembersAttributes:(NSString *_Nonnull)groupId userIds:(NSArray<__kindof NSString *> *_Nonnull)userIds keys:(NSArray<__kindof NSString *> *_Nonnull)keys completion:(void (^_Nullable)(NSDictionary*> *_Nullable attributes, EMError *_Nullable error))completionBlock; #pragma mark - EM_DEPRECATED_IOS 3.8.8 /** * \~chinese * 按数目从服务器获取自己加入的群组。 * * 已废弃，请用 {@link getJoinedGroupsFromServerWithPage:pageSize:needMemberCount:needRole:error:completion:} 代替。 * * 异步方法。 * * @param aPageNum 获取自己加入群的游标，首次调用传空。 * @param aPageSize 期望返回结果的数量, 如果小于 0 则一次返回所有结果。 * @param aCompletionBlock 该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。 * * \~english * Gets the pagesize number group you joined from the server. * * Deprecated, please use {@link getJoinedGroupsFromServerWithPage:pageSize:needMemberCount:needRole:error:completion:} instead. * * This is an asynchronous method. * * @param aPageNum The cursor when joins the group. Sets the parameter as nil for the first time. * @param aPageSize The number of results expected to be returned, if <0 then all results will be returned at once. * @param aCompletionBlock The completion block, which contains the error message if the method fails. * */ - (void)getJoinedGroupsFromServerWithPage:(NSInteger)aPageNum pageSize:(NSInteger)aPageSize completion:(void (^_Nullable)(NSArray *aList, EMError *_Nullable aError))aCompletionBlock __deprecated_msg("Use -getJoinedGroupsFromServerWithPage:pageSize:needMemberCount:needRole:error:completion: instead"); @end