com.easemob.im.server.api.group

类 GroupApi

java.lang.Object

com.easemob.im.server.api.group.GroupApi

public class GroupApi
extends Object

群API。

构造器概要

构造器

构造器和说明
GroupApi(Context context)

方法概要

限定符和类型	方法和说明
reactor.core.publisher.Mono<Void>	addGroupAdmin(String groupId, String username) 升级群成员为群管理员。
reactor.core.publisher.Mono<Void>	addGroupMember(String groupId, String username) 添加群成员(单个)。
reactor.core.publisher.Mono<Void>	addGroupMembers(String groupId, List<String> usernames) 添加群成员(多个)。
reactor.core.publisher.Mono<Void>	assignGroup(String groupId, String newOwner) 转让群组。
reactor.core.publisher.Mono<String>	createLargePrivateGroup(String owner, String groupName, String description, List<String> members, int maxMembers, boolean canMemberInvite, boolean needApproveToJoin, boolean needInviteConfirm, String custom, boolean needVerify, String avatar) 创建大型私有群。
reactor.core.publisher.Mono<String>	createLargePrivateGroup(String groupId, String owner, String groupName, String description, List<String> members, int maxMembers, boolean canMemberInvite, boolean needApproveToJoin, boolean needInviteConfirm, String custom, boolean needVerify, String avatar) 指定群组ID，创建大型私有群。
reactor.core.publisher.Mono<String>	createLargePublicGroup(String owner, String groupName, String description, List<String> members, int maxMembers, boolean needApproveToJoin, String custom, boolean needVerify, String avatar) 创建大型公开群。
reactor.core.publisher.Mono<String>	createLargePublicGroup(String groupId, String owner, String groupName, String description, List<String> members, int maxMembers, boolean needApproveToJoin, String custom, boolean needVerify, String avatar) 指定群组ID，创建大型公开群。
reactor.core.publisher.Mono<String>	createPrivateGroup(String owner, String groupName, String description, List<String> members, int maxMembers, boolean canMemberInvite) 创建私有群。
reactor.core.publisher.Mono<String>	createPrivateGroup(String owner, String groupName, String description, List<String> members, int maxMembers, boolean canMemberInvite, boolean needApproveToJoin, boolean needInviteConfirm, String custom) 创建私有群。
reactor.core.publisher.Mono<String>	createPrivateGroup(String owner, String groupName, String description, List<String> members, int maxMembers, boolean canMemberInvite, boolean needApproveToJoin, boolean needInviteConfirm, String custom, boolean needVerify, String avatar) 创建私有群。
reactor.core.publisher.Mono<String>	createPrivateGroup(String owner, String groupName, String description, List<String> members, int maxMembers, boolean canMemberInvite, String custom) 创建私有群。
reactor.core.publisher.Mono<String>	createPrivateGroup(String groupId, String owner, String groupName, String description, List<String> members, int maxMembers, boolean canMemberInvite, boolean needApproveToJoin, boolean needInviteConfirm, String custom, boolean needVerify, String avatar) 指定群组ID，创建私有群。
reactor.core.publisher.Mono<String>	createPublicGroup(String owner, String groupName, String description, List<String> members, int maxMembers, boolean needApproveToJoin) 创建公开群。
reactor.core.publisher.Mono<String>	createPublicGroup(String owner, String groupName, String description, List<String> members, int maxMembers, boolean needApproveToJoin, String custom) 创建公开群。
reactor.core.publisher.Mono<String>	createPublicGroup(String owner, String groupName, String description, List<String> members, int maxMembers, boolean needApproveToJoin, String custom, boolean needVerify, String avatar) 创建公开群。
reactor.core.publisher.Mono<String>	createPublicGroup(String groupId, String owner, String groupName, String description, List<String> members, int maxMembers, boolean needApproveToJoin, String custom, boolean needVerify, String avatar) 指定群组ID，创建公开群。
reactor.core.publisher.Mono<Void>	destroyGroup(String groupId) 注销群。
reactor.core.publisher.Mono<Boolean>	disableGroup(String groupId) 封禁群组 封禁指定的群组。
reactor.core.publisher.Mono<Boolean>	enableGroup(String groupId) 解禁群组 解除对指定群组的封禁。
reactor.core.publisher.Mono<EMGroup>	getGroup(String groupId) 获取群详情。
reactor.core.publisher.Mono<String>	getGroupAnnouncement(String groupId) 获取群公告。
reactor.core.publisher.Mono<List<EMGroup>>	getGroupList(List<String> groupIdList) 获取多个群详情。
reactor.core.publisher.Flux<String>	listAllGroupMembers(String groupId) 获取群全部成员，不包括群组的 Owner。
reactor.core.publisher.Flux<String>	listAllGroupMembers(String groupId, String sort) 获取群全部成员，不包括群组的 Owner。
reactor.core.publisher.Flux<Map<String,String>>	listAllGroupMembersIncludeOwner(String groupId, String sort) 获取群全部成员，包括群组的 Owner。
reactor.core.publisher.Flux<String>	listAllGroups() 获取全部群列表。
reactor.core.publisher.Flux<GroupResource>	listAllGroupsWithInfo() 获取全部群列表，返回值携带群组信息。
reactor.core.publisher.Flux<String>	listGroupAdmins(String groupId) 获取群全部管理员。
reactor.core.publisher.Mono<EMPage<String>>	listGroupMembers(String groupId, int limit, String cursor) 分页获取群成员。
reactor.core.publisher.Mono<EMPage<String>>	listGroupMembers(String groupId, int limit, String cursor, String sort) 分页获取群成员。
reactor.core.publisher.Mono<List<Map<String,String>>>	listGroupMembersIncludeOwner(String groupId, int pageNum, int pageSize, String sort) 分页获取群组成员列表，包括群组的 Owner。
reactor.core.publisher.Mono<EMPage<String>>	listGroups(int limit, String cursor) 分页获取群列表。
reactor.core.publisher.Flux<String>	listGroupsUserJoined(String username) 获取用户加入的所有群组。
reactor.core.publisher.Flux<JoinGroupResource>	listGroupsUserJoinedWithInfo(String username) 获取用户加入的所有群组，返回值携带群组信息。
reactor.core.publisher.Mono<List<JoinGroupResource>>	listGroupsUserJoinedWithInfo(String username, int pageNum, int pageSize) 分页获取用户加入的所有群组，返回值携带群组信息。
reactor.core.publisher.Mono<EMPage<GroupResource>>	listGroupsWithInfo(int limit, String cursor) 分页获取群列表，返回值携带群组信息。
reactor.core.publisher.Mono<Void>	removeGroupAdmin(String groupId, String username) 降级群管理员为群成员。
reactor.core.publisher.Mono<Void>	removeGroupMember(String groupId, String username) 移除群成员。
reactor.core.publisher.Mono<List<EMRemoveMember>>	removeGroupMembers(String groupId, List<String> usernames) 移除群成员(多个)。
reactor.core.publisher.Mono<Void>	updateGroup(String groupId, Consumer<UpdateGroupRequest> customizer) 修改群详情。
reactor.core.publisher.Mono<Void>	updateGroupAnnouncement(String groupId, String announcement) 更新群公告。
reactor.core.publisher.Mono<Void>	updateGroupOwner(String groupId, String username) 修改群主。
reactor.core.publisher.Mono<Boolean>	userIsJoined(String groupId, String username) 查看指定用户是否已加入群组 API使用示例： EMService service; try { Boolean result = service.group().userIsJoined("groupId", "username").block(); } catch (EMException e) { e.getErrorCode(); e.getMessage(); }

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

GroupApi

public GroupApi(Context context)

方法详细资料

createPublicGroup

public reactor.core.publisher.Mono<String> createPublicGroup(String owner,
                                                             String groupName,
                                                             String description,
                                                             List<String> members,
                                                             int maxMembers,
                                                             boolean needApproveToJoin)

创建公开群。

需要注意的是，目前公开群不允许成员邀请其他用户加入。如果要允许，可以用修改群API设置:

API使用示例：

 
 EMService service;
 List<String> members = new ArrayList<>();
 members.add("userA");
 try {
     String groupId = service.group().createPublicGroup("owner", "groupName", "description", members, 200, true).block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

owner - 群主的用户名

groupName - 群名，最大长度为 128 字符

description - 群介绍，最大长度为 512 字符

members - 初始群成员的用户名列表

maxMembers - 群最大成员数

needApproveToJoin - 新成员加入需要管理员审批

返回:

群id或错误

另请参阅:

创建群

createPublicGroup

public reactor.core.publisher.Mono<String> createPublicGroup(String owner,
                                                             String groupName,
                                                             String description,
                                                             List<String> members,
                                                             int maxMembers,
                                                             boolean needApproveToJoin,
                                                             String custom)

创建公开群。

需要注意的是，目前公开群不允许成员邀请其他用户加入。如果要允许，可以用修改群API设置:

API使用示例：

 
 EMService service;
 List<String> members = new ArrayList<>();
 members.add("userA");
 try {
     String groupId = service.group().createPublicGroup("owner", "groupName", "description", members, 200, true, "custom").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

 EMService service;
 try {
     // 修改群组API，允许成员邀请其他用户加入
     service.group().updateSetting("group-id", settings -> settings.memberCanInvite(true)).block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

owner - 群主的用户名

groupName - 群名，最大长度为 128 字符

description - 群介绍，最大长度为 512 字符

members - 初始群成员的用户名列表

maxMembers - 群最大成员数

needApproveToJoin - 新成员加入需要管理员审批

custom - 群组扩展信息，例如可以给群组添加业务相关的标记，最大长度为 1024 字符

返回:

群id或错误

另请参阅:

创建群

createPublicGroup

public reactor.core.publisher.Mono<String> createPublicGroup(String owner,
                                                             String groupName,
                                                             String description,
                                                             List<String> members,
                                                             int maxMembers,
                                                             boolean needApproveToJoin,
                                                             String custom,
                                                             boolean needVerify,
                                                             String avatar)

创建公开群。

需要注意的是，目前公开群不允许成员邀请其他用户加入。如果要允许，可以用修改群API设置:

API使用示例：

 
 EMService service;
 List<String> members = new ArrayList<>();
 members.add("userA");
 try {
     String groupId = service.group().createPublicGroup("owner", "groupName", "description", members, 200, true, "custom", true, "http://localhost:8080/image.png").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

 EMService service;
 try {
     // 修改群组API，允许成员邀请其他用户加入
     service.group().updateSetting("group-id", settings -> settings.memberCanInvite(true)).block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

owner - 群主的用户名

groupName - 群名，最大长度为 128 字符

description - 群介绍，最大长度为 512 字符

members - 初始群成员的用户名列表

maxMembers - 群最大成员数

needApproveToJoin - 新成员加入需要管理员审批

custom - 群组扩展信息，例如可以给群组添加业务相关的标记，最大长度为 1024 字符

needVerify - 是否审核群名称（付费功能，需联系商务开通）

avatar - 群组头像的 URL，最大长度为 1024 字符。

返回:

群id或错误

另请参阅:

创建群

createLargePublicGroup

public reactor.core.publisher.Mono<String> createLargePublicGroup(String owner,
                                                                  String groupName,
                                                                  String description,
                                                                  List<String> members,
                                                                  int maxMembers,
                                                                  boolean needApproveToJoin,
                                                                  String custom,
                                                                  boolean needVerify,
                                                                  String avatar)

创建大型公开群。

大型群，群成员总数超过 3000。大型群不支持离线推送。如需默认创建大型群，请联系环信商务。

需要注意的是，目前公开群不允许成员邀请其他用户加入。如果要允许，可以用修改群API设置:

API使用示例：

 
 EMService service;
 List<String> members = new ArrayList<>();
 members.add("userA");
 try {
     String groupId = service.group().createLargePublicGroup("owner", "groupName", "description", , members, 200, true, "custom", true, "http://localhost:8080/image.png").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

 EMService service;
 try {
     // 修改群组API，允许成员邀请其他用户加入
     service.group().updateSetting("group-id", settings -> settings.memberCanInvite(true)).block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

owner - 群主的用户名

groupName - 群名，最大长度为 128 字符

description - 群介绍，最大长度为 512 字符

members - 初始群成员的用户名列表

maxMembers - 群最大成员数

needApproveToJoin - 新成员加入需要管理员审批

custom - 群组扩展信息，例如可以给群组添加业务相关的标记，最大长度为 1024 字符

needVerify - 是否审核群名称（付费功能，需联系商务开通）

avatar - 群组头像的 URL，最大长度为 1024 字符。

返回:

群id或错误

另请参阅:

创建群

createPublicGroup

public reactor.core.publisher.Mono<String> createPublicGroup(String groupId,
                                                             String owner,
                                                             String groupName,
                                                             String description,
                                                             List<String> members,
                                                             int maxMembers,
                                                             boolean needApproveToJoin,
                                                             String custom,
                                                             boolean needVerify,
                                                             String avatar)

指定群组ID，创建公开群。 需要联系商务开通此功能才可以使用。

需要注意的是，目前公开群不允许成员邀请其他用户加入。如果要允许，可以用修改群API设置:

API使用示例：

 
 EMService service;
 List<String> members = new ArrayList<>();
 members.add("userA");
 try {
     String groupId = service.group().createPublicGroup("groupId", "owner", "groupName", "description", members, 200, true, "custom", true, "http://localhost:8080/image.png").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

 EMService service;
 try {
     // 修改群组API，允许成员邀请其他用户加入
     service.group().updateSetting("group-id", settings -> settings.memberCanInvite(true)).block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

groupId - 群组id

owner - 群主的用户名

groupName - 群名，最大长度为 128 字符

description - 群介绍，最大长度为 512 字符

members - 初始群成员的用户名列表

maxMembers - 群最大成员数

needApproveToJoin - 新成员加入需要管理员审批

custom - 群组扩展信息，例如可以给群组添加业务相关的标记，最大长度为 1024 字符

needVerify - 是否审核群名称（付费功能，需联系商务开通）

avatar - 群组头像的 URL，最大长度为 1024 字符

返回:

群id或错误

另请参阅:

创建群

createLargePublicGroup

public reactor.core.publisher.Mono<String> createLargePublicGroup(String groupId,
                                                                  String owner,
                                                                  String groupName,
                                                                  String description,
                                                                  List<String> members,
                                                                  int maxMembers,
                                                                  boolean needApproveToJoin,
                                                                  String custom,
                                                                  boolean needVerify,
                                                                  String avatar)

指定群组ID，创建大型公开群。 需要联系商务开通此功能才可以使用。

大型群，群成员总数超过 3000。大型群不支持离线推送。如需默认创建大型群，请联系环信商务。

需要注意的是，目前公开群不允许成员邀请其他用户加入。如果要允许，可以用修改群API设置:

API使用示例：

 
 EMService service;
 List<String> members = new ArrayList<>();
 members.add("userA");
 try {
     String groupId = service.group().createLargePublicGroup("groupId", "owner", "groupName", "description", members, 200, true, "custom", true, "http://localhost:8080/image.png").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

 EMService service;
 try {
     // 修改群组API，允许成员邀请其他用户加入
     service.group().updateSetting("group-id", settings -> settings.memberCanInvite(true)).block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

groupId - 群组id

owner - 群主的用户名

groupName - 群名，最大长度为 128 字符

description - 群介绍，最大长度为 512 字符

members - 初始群成员的用户名列表

maxMembers - 群最大成员数

needApproveToJoin - 新成员加入需要管理员审批

custom - 群组扩展信息，例如可以给群组添加业务相关的标记，最大长度为 1024 字符

needVerify - 是否审核群名称（付费功能，需联系商务开通）

avatar - 群组头像的 URL，最大长度为 1024 字符

返回:

群id或错误

另请参阅:

创建群

createPrivateGroup

public reactor.core.publisher.Mono<String> createPrivateGroup(String owner,
                                                              String groupName,
                                                              String description,
                                                              List<String> members,
                                                              int maxMembers,
                                                              boolean canMemberInvite)

创建私有群。

API使用示例：

 
 EMService service;
 List<String> members = new ArrayList<>();
 members.add("userA");
 try {
     String groupId = service.group().privateGroup("owner", "groupName", "description", members, 200, true).block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

owner - 群主的用户名

groupName - 群名，最大长度为 128 字符

description - 群介绍，最大长度为 512 字符

members - 初始群成员的用户名列表

maxMembers - 群最大成员数

canMemberInvite - 普通群成员是否允许邀请新用户入群

返回:

群id或错误

另请参阅:

创建群

createPrivateGroup

public reactor.core.publisher.Mono<String> createPrivateGroup(String owner,
                                                              String groupName,
                                                              String description,
                                                              List<String> members,
                                                              int maxMembers,
                                                              boolean canMemberInvite,
                                                              String custom)

创建私有群。

API使用示例：

 
 EMService service;
 List<String> members = new ArrayList<>();
 members.add("userA");
 try {
     String groupId = service.group().privateGroup("owner", "groupName", "description", members, 200, true, "custom").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

owner - 群主的用户名

groupName - 群名，最大长度为 128 字符

description - 群介绍，最大长度为 512 字符

members - 初始群成员的用户名列表

maxMembers - 群最大成员数

canMemberInvite - 普通群成员是否允许邀请新用户入群

custom - 群组扩展信息，例如可以给群组添加业务相关的标记，最大长度为 1024 字符

返回:

群id或错误

另请参阅:

创建群

createPrivateGroup

public reactor.core.publisher.Mono<String> createPrivateGroup(String owner,
                                                              String groupName,
                                                              String description,
                                                              List<String> members,
                                                              int maxMembers,
                                                              boolean canMemberInvite,
                                                              boolean needApproveToJoin,
                                                              boolean needInviteConfirm,
                                                              String custom)

创建私有群。

API使用示例：

 
 EMService service;
 List<String> members = new ArrayList<>();
 members.add("userA");
 try {
     String groupId = service.group().privateGroup("owner", "groupName", "description", members, 200, true, true, true, "custom").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

owner - 群主的用户名

groupName - 群名，最大长度为 128 字符

description - 群介绍，最大长度为 512 字符

members - 初始群成员的用户名列表

maxMembers - 群最大成员数

canMemberInvite - 普通群成员是否允许邀请新用户入群

needInviteConfirm - 邀请加群，受邀用户是否需要确认

needApproveToJoin - 新成员加入是否需要管理员审批

custom - 群组扩展信息，例如可以给群组添加业务相关的标记，最大长度为 1024 字符

返回:

群id或错误

另请参阅:

创建群

createPrivateGroup

public reactor.core.publisher.Mono<String> createPrivateGroup(String owner,
                                                              String groupName,
                                                              String description,
                                                              List<String> members,
                                                              int maxMembers,
                                                              boolean canMemberInvite,
                                                              boolean needApproveToJoin,
                                                              boolean needInviteConfirm,
                                                              String custom,
                                                              boolean needVerify,
                                                              String avatar)

创建私有群。

API使用示例：

 
 EMService service;
 List<String> members = new ArrayList<>();
 members.add("userA");
 try {
     String groupId = service.group().privateGroup("owner", "groupName", "description", members, 200, true, true, true, "custom", true, "http://localhost:8080/image.png").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

owner - 群主的用户名

groupName - 群名，最大长度为 128 字符

description - 群介绍，最大长度为 512 字符

members - 初始群成员的用户名列表

maxMembers - 群最大成员数

canMemberInvite - 普通群成员是否允许邀请新用户入群

needInviteConfirm - 邀请加群，受邀用户是否需要确认

needApproveToJoin - 新成员加入是否需要管理员审批

custom - 群组扩展信息，例如可以给群组添加业务相关的标记，最大长度为 1024 字符

needVerify - 是否审核群名称（付费功能，需联系商务开通）

avatar - 群组头像的 URL，最大长度为 1024 字符

返回:

群id或错误

另请参阅:

创建群

createLargePrivateGroup

public reactor.core.publisher.Mono<String> createLargePrivateGroup(String owner,
                                                                   String groupName,
                                                                   String description,
                                                                   List<String> members,
                                                                   int maxMembers,
                                                                   boolean canMemberInvite,
                                                                   boolean needApproveToJoin,
                                                                   boolean needInviteConfirm,
                                                                   String custom,
                                                                   boolean needVerify,
                                                                   String avatar)

创建大型私有群。

大型群，群成员总数超过 3000。大型群不支持离线推送。如需默认创建大型群，请联系环信商务。

API使用示例：

 
 EMService service;
 List<String> members = new ArrayList<>();
 members.add("userA");
 try {
     String groupId = service.group().createLargePrivateGroup("owner", "groupName", "description", members, 200, true, true, true, "custom", true, "http://localhost:8080/image.png").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

owner - 群主的用户名

groupName - 群名，最大长度为 128 字符

description - 群介绍，最大长度为 512 字符

members - 初始群成员的用户名列表

maxMembers - 群最大成员数

canMemberInvite - 普通群成员是否允许邀请新用户入群

needInviteConfirm - 邀请加群，受邀用户是否需要确认

needApproveToJoin - 新成员加入是否需要管理员审批

custom - 群组扩展信息，例如可以给群组添加业务相关的标记，最大长度为 1024 字符

needVerify - 是否审核群名称（付费功能，需联系商务开通）

avatar - 群组头像的 URL，最大长度为 1024 字符

返回:

群id或错误

另请参阅:

创建群

createPrivateGroup

public reactor.core.publisher.Mono<String> createPrivateGroup(String groupId,
                                                              String owner,
                                                              String groupName,
                                                              String description,
                                                              List<String> members,
                                                              int maxMembers,
                                                              boolean canMemberInvite,
                                                              boolean needApproveToJoin,
                                                              boolean needInviteConfirm,
                                                              String custom,
                                                              boolean needVerify,
                                                              String avatar)

指定群组ID，创建私有群。 需要联系商务开通此功能才可以使用。

API使用示例：

 
 EMService service;
 List<String> members = new ArrayList<>();
 members.add("userA");
 try {
     String groupId = service.group().privateGroup("groupId", "owner", "groupName", "description", members, 200, true, true, true, "custom", true, "http://localhost:8080/image.png").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

groupId - 群组ID

owner - 群主的用户名

groupName - 群名，最大长度为 128 字符

description - 群介绍，最大长度为 512 字符

members - 初始群成员的用户名列表

maxMembers - 群最大成员数

canMemberInvite - 普通群成员是否允许邀请新用户入群

needInviteConfirm - 邀请加群，受邀用户是否需要确认

needApproveToJoin - 新成员加入是否需要管理员审批

custom - 群组扩展信息，例如可以给群组添加业务相关的标记，最大长度为 1024 字符

needVerify - 是否审核群名称（付费功能，需联系商务开通）

avatar - 群组头像的 URL，最大长度为 1024 字符

返回:

群id或错误

另请参阅:

创建群

createLargePrivateGroup

public reactor.core.publisher.Mono<String> createLargePrivateGroup(String groupId,
                                                                   String owner,
                                                                   String groupName,
                                                                   String description,
                                                                   List<String> members,
                                                                   int maxMembers,
                                                                   boolean canMemberInvite,
                                                                   boolean needApproveToJoin,
                                                                   boolean needInviteConfirm,
                                                                   String custom,
                                                                   boolean needVerify,
                                                                   String avatar)

指定群组ID，创建大型私有群。 需要联系商务开通此功能才可以使用。

大型群，群成员总数超过 3000。大型群不支持离线推送。如需默认创建大型群，请联系环信商务。

API使用示例：

 
 EMService service;
 List<String> members = new ArrayList<>();
 members.add("userA");
 try {
     String groupId = service.group().createLargePrivateGroup("groupId", "owner", "groupName", "description", members, 200, true, true, true, "custom", true, "http://localhost:8080/image.png").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

groupId - 群组ID

owner - 群主的用户名

groupName - 群名，最大长度为 128 字符

description - 群介绍，最大长度为 512 字符

members - 初始群成员的用户名列表

maxMembers - 群最大成员数

canMemberInvite - 普通群成员是否允许邀请新用户入群

needInviteConfirm - 邀请加群，受邀用户是否需要确认

needApproveToJoin - 新成员加入是否需要管理员审批

custom - 群组扩展信息，例如可以给群组添加业务相关的标记，最大长度为 1024 字符

needVerify - 是否审核群名称（付费功能，需联系商务开通）

avatar - 群组头像的 URL，最大长度为 1024 字符

返回:

群id或错误

另请参阅:

创建群

destroyGroup

public reactor.core.publisher.Mono<Void> destroyGroup(String groupId)

注销群。

请谨慎使用。

API使用示例：

 
 EMService service;
 try {
     String groupId = service.group().destroyGroup("groupId").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

groupId - 群id

返回:

成功或错误

listAllGroups

public reactor.core.publisher.Flux<String> listAllGroups()

获取全部群列表。

API使用示例：

 
 EMService service;
 try {
     List<String> groups = service.group().listAllGroups().collectList().block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

返回:

每个群id或错误

另请参阅:

获取群列表

listAllGroupsWithInfo

public reactor.core.publisher.Flux<GroupResource> listAllGroupsWithInfo()

获取全部群列表，返回值携带群组信息。

API使用示例：

 
 EMService service;
 try {
     List<GroupResource> groups = service.group().listAllGroupsWithInfo().collectList().block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

返回:

每个群组或错误

另请参阅:

获取群列表

listGroups

public reactor.core.publisher.Mono<EMPage<String>> listGroups(int limit,
                                                              String cursor)

分页获取群列表。

初次调用时，cursor 传 null。之后的调用，cursor 传上次返回的值。

API使用示例：

 EMPage<String> page = null;
 try {
     page = service.group().listGroups(10, null).block();
     List<String> groupIds = page.getValues();
     System.out.println("群组列表:" + groupIds);
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }

 // ... do something with the groupIds ...
 if (page != null) {
      String cursor = page.getCursor();
      // cursor == null indicates the end of the list
      while (cursor != null) {
          try {
              page = service.group().listGroups(10, cursor).block();
              System.out.println("群组列表:" + page.getValues());
              // ... do something to the groupIds ...
              cursor = page.getCursor();
          } catch (EMException e) {
              e.getErrorCode();
              e.getMessage();
          }
      }
 }
 

参数:

limit - 每次取回多少个群id

cursor - 上次返回的cursor

返回:

群列表响应或错误

另请参阅:

EMPage, 获取群列表

listGroupsWithInfo

public reactor.core.publisher.Mono<EMPage<GroupResource>> listGroupsWithInfo(int limit,
                                                                             String cursor)

分页获取群列表，返回值携带群组信息。

初次调用时，cursor 传 null。之后的调用，cursor 传上次返回的值。

API使用示例：

 EMPage<GroupResource> page = null;
 try {
     page = service.group().listGroupsWithInfo(10, null).block();
     List<GroupResource> groupIds = page.getValues();
     System.out.println("群组列表:" + groupIds);
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }

 // ... do something with the groupIds ...
 if (page != null) {
      String cursor = page.getCursor();
      // cursor == null indicates the end of the list
      while (cursor != null) {
          try {
              page = service.group().listGroupsWithInfo(10, cursor).block();
              System.out.println("群组列表:" + page.getValues());
              // ... do something to the groupIds ...
              cursor = page.getCursor();
          } catch (EMException e) {
              e.getErrorCode();
              e.getMessage();
          }
      }
 }
 

参数:

limit - 每次取回多少个群组

cursor - 上次返回的cursor

返回:

群列表响应或错误

另请参阅:

EMPage, 获取群列表

listGroupsUserJoined

public reactor.core.publisher.Flux<String> listGroupsUserJoined(String username)

获取用户加入的所有群组。

API使用示例：

 
 EMService service;
 try {
     List<String> groups = service.group().listGroupsUserJoined("username").collectList().block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

username - the username

返回:

A Flux which emits EMGroup on successful.

listGroupsUserJoinedWithInfo

public reactor.core.publisher.Flux<JoinGroupResource> listGroupsUserJoinedWithInfo(String username)

获取用户加入的所有群组，返回值携带群组信息。

API使用示例：

 
 EMService service;
 try {
     List<JoinGroupResource> groups = service.group().listGroupsUserJoined("username").collectList().block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

username - the username

返回:

A Flux which emits EMGroup on successful.

listGroupsUserJoinedWithInfo

public reactor.core.publisher.Mono<List<JoinGroupResource>> listGroupsUserJoinedWithInfo(String username,
                                                                                         int pageNum,
                                                                                         int pageSize)

分页获取用户加入的所有群组，返回值携带群组信息。

初次调用时，cursor 传 null。之后的调用，cursor 传上次返回的值。

API使用示例：

 try {
     List<JoinGroupResource> groupResources = service.group().listGroupsUserJoinedWithInfo("username", 1, 10).block();
     if (groupResources != null && groupResources.size() > 0) {
          groupResources.forEach(groupResource -> {
          System.out.println("groupId : " + groupResource.getGroupId());
          System.out.println("groupName : " + groupResource.getGroupName());
      });
     }
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

username - the username

pageNum - 当前页码

pageSize - 每页获取已加入的群组数量

返回:

群列表响应或错误

getGroup

public reactor.core.publisher.Mono<EMGroup> getGroup(String groupId)

获取群详情。

API使用示例：

 
 EMService service;
 try {
     EMGroup group = service.group().getGroup("groupId").block();
     String groupName = group.getName();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

groupId - 群id

返回:

群详情或错误

另请参阅:

获取群详情

getGroupList

public reactor.core.publisher.Mono<List<EMGroup>> getGroupList(List<String> groupIdList)

获取多个群详情。

API使用示例：

 
 EMService service;
 try {
     List<String> groupIdList = new ArrayList<>();
     groupIdList.add("193100825821185");
     groupIdList.add("193100825821186");

     List<EMGroup> groupList = service.group().getGroupList(groupIdList).block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

groupIdList - 群id列表

返回:

群详情或错误

另请参阅:

获取群详情

updateGroup

public reactor.core.publisher.Mono<Void> updateGroup(String groupId,
                                                     Consumer<UpdateGroupRequest> customizer)

修改群详情。

支持修改的参数见GroupSettingsUpdateRequest

API使用示例：

比如，更新群最大成员数：

 EMService service;
 try {
     service.group().updateGroup("1", settings -> settings.maxMembers(100)).block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

groupId - 群id

customizer - 请求定制器

返回:

成功或错误

另请参阅:

UpdateGroupRequest, 修改群详情

updateGroupOwner

public reactor.core.publisher.Mono<Void> updateGroupOwner(String groupId,
                                                          String username)

修改群主。新群主需要已经是群成员，否则会报错EMForbiddenException。

API使用示例：

 
 EMService service;
 try {
     service.group().updateGroupOwner("groupId", "username").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

groupId - 群id

username - 新群主的用户名

返回:

成功或错误

另请参阅:

修改群主

getGroupAnnouncement

public reactor.core.publisher.Mono<String> getGroupAnnouncement(String groupId)

获取群公告。

API使用示例：

 
 EMService service;
 try {
     String groupAnnouncement = service.group().getGroupAnnouncement("groupId").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

groupId - 群id

返回:

群公告或错误

另请参阅:

获取群公告

updateGroupAnnouncement

public reactor.core.publisher.Mono<Void> updateGroupAnnouncement(String groupId,
                                                                 String announcement)

更新群公告。

API使用示例：

 
 EMService service;
 try {
     service.group().updateGroupAnnouncement("groupId", "announcement").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

groupId - 群id

announcement - 群公告

返回:

成功或错误

另请参阅:

更新群公告

listAllGroupMembers

public reactor.core.publisher.Flux<String> listAllGroupMembers(String groupId)

获取群全部成员，不包括群组的 Owner。

API使用示例：

 
 EMService service;
 try {
     List<String> members = service.group().listAllGroupMembers("groupId").collectList().block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

groupId - 群id

返回:

每个群成员或错误

另请参阅:

获取群成员

listAllGroupMembers

public reactor.core.publisher.Flux<String> listAllGroupMembers(String groupId,
                                                               String sort)

获取群全部成员，不包括群组的 Owner。

API使用示例：

 
 EMService service;
 try {
     List<String> members = service.group().listAllGroupMembers("groupId", "asc").collectList().block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

groupId - 群id

sort - 群成员排序方法 asc:根据加入顺序升序排序 desc:根据加入顺序降序排序

返回:

每个群成员或错误

另请参阅:

获取群成员

listAllGroupMembersIncludeOwner

public reactor.core.publisher.Flux<Map<String,String>> listAllGroupMembersIncludeOwner(String groupId,
                                                                                       String sort)

获取群全部成员，包括群组的 Owner。

API使用示例：

 
 EMService service;
 try {
     List<Map<String, String>> members = service.group().listAllGroupMembersIncludeOwner("groupId", "asc").collectList().block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

groupId - 群id

sort - asc:根据加入顺序升序排序 desc:根据加入顺序降序排序

返回:

每个群成员或错误

另请参阅:

获取群成员

listGroupMembersIncludeOwner

public reactor.core.publisher.Mono<List<Map<String,String>>> listGroupMembersIncludeOwner(String groupId,
                                                                                          int pageNum,
                                                                                          int pageSize,
                                                                                          String sort)

分页获取群组成员列表，包括群组的 Owner。

API使用示例：

 
 EMService service;
 EMPage<String> page = null;
 try {
     List<Map<String, String>> members = service.room().listGroupMembersIncludeOwner(groupId, 1, 10, asc).block();
     System.out.println("群组成员列表:" + members);
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }

参数:

groupId - 群组id

pageNum - 当前页码。默认从第 1 页开始获取

pageSize - 每页期望返回的群组成员数量。取值范围为[1,100]。默认为 10。

sort - asc:根据加入顺序升序排序 desc:根据加入顺序降序排序

返回:

获取聊天室成员响应或错误

另请参阅:

获取群成员

listGroupMembers

public reactor.core.publisher.Mono<EMPage<String>> listGroupMembers(String groupId,
                                                                    int limit,
                                                                    String cursor)

分页获取群成员。

API使用示例：

首次调用时，cursor 传 null。之后每次调用，cursor 传上次返回的值。

比如：

 EMService service;
 EMPage<String> page = null;
 try {
     page = service.group().listGroupMembers(groupId, 1, null).block();
     List<String> members = page.getValues();
     System.out.println("群组成员列表:" + members);
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }

 // ... do something to the members ...
 if (page != null) {
      String cursor = page.getCursor();
      while (cursor != null) {
              try {
              page = service.group().listGroupMembers(groupId, 1, cursor).block();
              System.out.println("群组成员列表:" + page.getValues());
              // ... do something to the members ...
              cursor = page.getCursor();
          } catch (EMException e) {
              e.getErrorCode();
              e.getMessage();
          }
      }
 }
 

参数:

groupId - 群id

limit - 返回多少群成员id

cursor - 开始位置

返回:

获取群成员响应或错误

另请参阅:

GroupMemberListResponse, 获取群成员

listGroupMembers

public reactor.core.publisher.Mono<EMPage<String>> listGroupMembers(String groupId,
                                                                    int limit,
                                                                    String cursor,
                                                                    String sort)

分页获取群成员。

API使用示例：

首次调用时，cursor 传 null。之后每次调用，cursor 传上次返回的值。

比如：

 EMService service;
 EMPage<String> page = null;
 try {
     page = service.group().listGroupMembers(groupId, 1, null, "asc").block();
     List<String> members = page.getValues();
     System.out.println("群组成员列表:" + members);
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }

 // ... do something to the members ...
 if (page != null) {
      String cursor = page.getCursor();
      while (cursor != null) {
              try {
              page = service.group().listGroupMembers(groupId, 1, cursor, "asc").block();
              System.out.println("群组成员列表:" + page.getValues());
              // ... do something to the members ...
              cursor = page.getCursor();
          } catch (EMException e) {
              e.getErrorCode();
              e.getMessage();
          }
      }
 }
 

参数:

groupId - 群id

limit - 返回多少群成员id

cursor - 开始位置

sort - 群成员排序方法 asc:根据加入顺序升序排序 desc:根据加入顺序降序排序

返回:

获取群成员响应或错误

另请参阅:

GroupMemberListResponse, 获取群成员

addGroupMember

public reactor.core.publisher.Mono<Void> addGroupMember(String groupId,
                                                        String username)

添加群成员(单个)。

API使用示例：

 
 EMService service;
 try {
     service.group().addGroupMember("groupId", "username").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

groupId - 群id

username - 要添加的用户的用户名

返回:

成功或错误

另请参阅:

添加群成员

addGroupMembers

public reactor.core.publisher.Mono<Void> addGroupMembers(String groupId,
                                                         List<String> usernames)

添加群成员(多个)。

API使用示例：

 
 EMService service;
 try {
     List<String> members = new ArrayList<>();
     members.add("member1");
     members.add("member2");

     service.group().addGroupMembers("groupId", members).block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

groupId - 群id

usernames - 要添加的用户的用户名列表

返回:

成功或错误

另请参阅:

添加群成员(多个)

removeGroupMember

public reactor.core.publisher.Mono<Void> removeGroupMember(String groupId,
                                                           String username)

移除群成员。

API使用示例：

 
 EMService service;
 try {
     service.group().removeGroupMember("groupId", "username").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

groupId - 群id

username - 要移除的用户的用户名

返回:

成功或错误

另请参阅:

移除群成员

removeGroupMembers

public reactor.core.publisher.Mono<List<EMRemoveMember>> removeGroupMembers(String groupId,
                                                                            List<String> usernames)

移除群成员(多个)。

API使用示例：

 
 EMService service;
 try {
     List<String> members = new ArrayList<>();
     members.add("member1");
     members.add("member2");

     List<EMRemoveMember> removeMembers = service.group().removeGroupMembers("groupId", members).block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

groupId - 群id

usernames - 要移除的用户的用户名列表

返回:

EMRemoveMember或错误

另请参阅:

移除群成员(多个)

listGroupAdmins

public reactor.core.publisher.Flux<String> listGroupAdmins(String groupId)

获取群全部管理员。

API使用示例：

 
 EMService service;
 try {
     List<String> admins = service.group().listGroupAdmins("groupId").collectList().block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

groupId - 群id

返回:

每个管理员或错误

另请参阅:

获取群管理员

addGroupAdmin

public reactor.core.publisher.Mono<Void> addGroupAdmin(String groupId,
                                                       String username)

升级群成员为群管理员。

API使用示例：

 
 EMService service;
 try {
     service.group().addGroupAdmin("groupId", "username").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

groupId - 群id

username - 被升级的群成员的用户名

返回:

成功或错误

另请参阅:

升级群成员

removeGroupAdmin

public reactor.core.publisher.Mono<Void> removeGroupAdmin(String groupId,
                                                          String username)

降级群管理员为群成员。

API使用示例：

 
 EMService service;
 try {
     service.group().removeGroupAdmin("groupId", "username").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

groupId - 群id

username - 被降级的群管理员的用户名

返回:

成功或错误

另请参阅:

降级群管理员

assignGroup

public reactor.core.publisher.Mono<Void> assignGroup(String groupId,
                                                     String newOwner)

转让群组。

API使用示例：

 
 EMService service;
 try {
     service.group().assignGroup("groupId", "newOwner").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

groupId - 群id

newOwner - 被转让群组的用户名

返回:

成功或错误

另请参阅:

转让群组

userIsJoined

public reactor.core.publisher.Mono<Boolean> userIsJoined(String groupId,
                                                         String username)

查看指定用户是否已加入群组

API使用示例：

 
 EMService service;
 try {
     Boolean result = service.group().userIsJoined("groupId", "username").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

groupId - 群组id

username - 需要查看的用户名

返回:

是否已加入群组

另请参阅:

查看指定用户是否已加入群组

disableGroup

public reactor.core.publisher.Mono<Boolean> disableGroup(String groupId)

封禁群组

封禁指定的群组。例如，群成员经常在群中发送违规消息，可以调用该 API 对该群进行封禁。 群组被封禁后，群中任何成员均无法在群组以及该群组下的子区中发送和接收消息，也无法进行群组和子区管理操作。

API使用示例：

 
 EMService service;
 try {
     Boolean result = service.group().disableGroup("groupId").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

groupId - 群组id

返回:

封禁群组结果

另请参阅:

封禁群组

enableGroup

public reactor.core.publisher.Mono<Boolean> enableGroup(String groupId)

解禁群组

解除对指定群组的封禁。群组解禁后，群成员可以在该群组以及该群组下的子区中发送和接收消息并进行群组和子区管理相关操作。

API使用示例：

 
 EMService service;
 try {
     Boolean result = service.group().enableGroup("groupId").block();
 } catch (EMException e) {
     e.getErrorCode();
     e.getMessage();
 }
 

参数:

groupId - 群组id

返回:

解禁群组结果

另请参阅:

解禁群组