Package io.github.doocs.im.core

Class Group

java.lang.Object

io.github.doocs.im.core.Group

public class Group
extends Object

群组管理

Since:

2021/7/31 20:45

Author:

bingo

Constructor Summary

Constructors

Constructor	Description
Group(ImClient imClient)

Method Summary

Modifier and Type	Method	Description
AddGroupMemberResult	addGroupMember(AddGroupMemberRequest addGroupMemberRequest)	增加群成员
ChangeGroupOwnerResult	changeGroupOwner(ChangeGroupOwnerRequest changeGroupOwnerRequest)	转让群主
ClearGroupAttrResult	clearGroupAttr(ClearGroupAttrRequest clearGroupAttrRequest)	清空群自定义属性
CreateGroupResult	createGroup(CreateGroupRequest createGroupRequest)	创建群组
DeleteGroupMemberResult	deleteGroupMember(DeleteGroupMemberRequest deleteGroupMemberRequest)	删除群成员
DeleteGroupMsgBySenderResult	deleteGroupMsgBySender(DeleteGroupMsgBySenderRequest deleteGroupMsgBySenderRequest)	撤回指定用户发送的消息
DestroyGroupResult	destroyGroup(DestroyGroupRequest destroyGroupRequest)	解散群组
ForbidSendMsgResult	forbidSendMsg(ForbidSendMsgRequest forbidSendMsgRequest)	批量禁言和取消禁言
GetAppIdGroupListResult	getAppIdGroupList(GetAppIdGroupListRequest getAppIdGroupListRequest)	获取 App 中的所有群组
GetGroupAttrResult	getGroupAttr(GetGroupAttrRequest getGroupAttrRequest)	获取群自定义属性
GetGroupInfoResult	getGroupInfo(GetGroupInfoRequest getGroupInfoRequest)	获取群详细资料
GetGroupMemberInfoResult	getGroupMemberInfo(GetGroupMemberInfoRequest getGroupMemberInfoRequest)	获取群成员详细资料
GetGroupShuttedUinResult	getGroupShuttedUin(GetGroupShuttedUinRequest getGroupShuttedUinRequest)	获取被禁言群成员列表
GetJoinGroupListResult	getJoinGroupList(GetJoinedGroupListRequest getJoinedGroupListRequest)	获取用户所加入的群组
GetOnlineMemberNumResult	getOnlineMemberNum(GetOnlineMemberNumRequest getOnlineMemberNumRequest)	获取直播群在线人数
GetRoleInGroupResult	getRoleInGroup(GetRoleInGroupRequest getRoleInGroupRequest)	查询用户在群组中的身份
GroupMsgGetSimpleResult	groupMsgGetSimple(GroupMsgGetSimpleRequest groupMsgGetSimpleRequest)	拉取群历史消息
GroupMsgRecallResult	groupMsgRecall(GroupMsgRecallRequest groupMsgRecallRequest)	撤回群消息
ImportGroupResult	importGroup(ImportGroupRequest importGroupRequest)	导入群基础资料
ImportGroupMemberResult	importGroupMember(ImportGroupMemberRequest importGroupMemberRequest)	导入群成员
ImportGroupMsgResult	importGroupMsg(ImportGroupMsgRequest importGroupMsgRequest)	导入群消息
ModifyGroupAttrResult	modifyGroupAttr(ModifyGroupAttrRequest modifyGroupAttrRequest)	修改群自定义属性
ModifyGroupBaseInfoResult	modifyGroupBaseInfo(ModifyGroupBaseInfoRequest modifyGroupBaseInfoRequest)	修改群基础资料
ModifyGroupMemberInfoResult	modifyGroupMemberInfo(ModifyGroupMemberInfoRequest modifyGroupMemberInfoRequest)	修改群成员资料
SendGroupMsgResult	sendGroupMsg(SendGroupMsgRequest sendGroupMsgRequest)	在群组中发送普通消息
SendGroupSystemNotificationResult	sendGroupSystemNotification(SendGroupSystemNotificationRequest sendGroupSystemNotificationRequest)	在群组中发送系统消息
SetGroupAttrResult	setGroupAttr(SetGroupAttrRequest setGroupAttrRequest)	重置群自定义属性
SetUnreadMsgNumResult	setUnreadMsgNum(SetUnreadMsgNumRequest setUnreadMsgNumRequest)	设置成员未读消息计数

Methods inherited from class java.lang.Object

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

Constructor Details

Group

public Group(ImClient imClient)

Method Details

getAppIdGroupList

public GetAppIdGroupListResult getAppIdGroupList(GetAppIdGroupListRequest getAppIdGroupListRequest)
                                          throws IOException

获取 App 中的所有群组

Parameters:

getAppIdGroupListRequest - 请求参数

Returns:

结果

Throws:

IOException - 异常

createGroup

public CreateGroupResult createGroup(CreateGroupRequest createGroupRequest)
                              throws IOException

创建群组

Parameters:

createGroupRequest - 请求参数

Returns:

结果

Throws:

IOException - 异常

getGroupInfo

public GetGroupInfoResult getGroupInfo(GetGroupInfoRequest getGroupInfoRequest)
                                throws IOException

获取群详细资料

Parameters:

getGroupInfoRequest - 请求参数

Returns:

结果

Throws:

IOException - 异常

getGroupMemberInfo

public GetGroupMemberInfoResult getGroupMemberInfo(GetGroupMemberInfoRequest getGroupMemberInfoRequest)
                                            throws IOException

获取群成员详细资料

Parameters:

getGroupMemberInfoRequest - 请求参数

Returns:

结果

Throws:

IOException - 异常

modifyGroupBaseInfo

public ModifyGroupBaseInfoResult modifyGroupBaseInfo(ModifyGroupBaseInfoRequest modifyGroupBaseInfoRequest)
                                              throws IOException

修改群基础资料

Parameters:

modifyGroupBaseInfoRequest - 请求参数

Returns:

结果

Throws:

IOException - 异常

addGroupMember

public AddGroupMemberResult addGroupMember(AddGroupMemberRequest addGroupMemberRequest)
                                    throws IOException

增加群成员

Parameters:

addGroupMemberRequest - 请求参数

Returns:

结果

Throws:

IOException - 异常

deleteGroupMember

public DeleteGroupMemberResult deleteGroupMember(DeleteGroupMemberRequest deleteGroupMemberRequest)
                                          throws IOException

删除群成员

Parameters:

deleteGroupMemberRequest - 请求参数

Returns:

结果

Throws:

IOException - 异常

modifyGroupMemberInfo

public ModifyGroupMemberInfoResult modifyGroupMemberInfo(ModifyGroupMemberInfoRequest modifyGroupMemberInfoRequest)
                                                  throws IOException

修改群成员资料

Parameters:

modifyGroupMemberInfoRequest - 请求参数

Returns:

结果

Throws:

IOException - 异常

destroyGroup

public DestroyGroupResult destroyGroup(DestroyGroupRequest destroyGroupRequest)
                                throws IOException

解散群组

Parameters:

destroyGroupRequest - 请求参数

Returns:

结果

Throws:

IOException - 异常

getJoinGroupList

public GetJoinGroupListResult getJoinGroupList(GetJoinedGroupListRequest getJoinedGroupListRequest)
                                        throws IOException

获取用户所加入的群组

Parameters:

getJoinedGroupListRequest - 请求参数

Returns:

结果

Throws:

IOException - 异常

getRoleInGroup

public GetRoleInGroupResult getRoleInGroup(GetRoleInGroupRequest getRoleInGroupRequest)
                                    throws IOException

查询用户在群组中的身份

Parameters:

getRoleInGroupRequest - 请求参数

Returns:

结果

Throws:

IOException - 异常

forbidSendMsg

public ForbidSendMsgResult forbidSendMsg(ForbidSendMsgRequest forbidSendMsgRequest)
                                  throws IOException

批量禁言和取消禁言

Parameters:

forbidSendMsgRequest - 请求参数

Returns:

结果

Throws:

IOException - 异常

getGroupShuttedUin

public GetGroupShuttedUinResult getGroupShuttedUin(GetGroupShuttedUinRequest getGroupShuttedUinRequest)
                                            throws IOException

获取被禁言群成员列表

Parameters:

getGroupShuttedUinRequest - 请求参数

Returns:

结果

Throws:

IOException - 异常

sendGroupMsg

public SendGroupMsgResult sendGroupMsg(SendGroupMsgRequest sendGroupMsgRequest)
                                throws IOException

在群组中发送普通消息

Parameters:

sendGroupMsgRequest - 请求参数

Returns:

结果

Throws:

IOException - 异常

sendGroupSystemNotification

public SendGroupSystemNotificationResult sendGroupSystemNotification(SendGroupSystemNotificationRequest sendGroupSystemNotificationRequest)
                                                              throws IOException

在群组中发送系统消息

Parameters:

sendGroupSystemNotificationRequest - 请求参数

Returns:

结果

Throws:

IOException - 异常

changeGroupOwner

public ChangeGroupOwnerResult changeGroupOwner(ChangeGroupOwnerRequest changeGroupOwnerRequest)
                                        throws IOException

转让群主

Parameters:

changeGroupOwnerRequest - 请求参数

Returns:

结果

Throws:

IOException - 异常

groupMsgRecall

public GroupMsgRecallResult groupMsgRecall(GroupMsgRecallRequest groupMsgRecallRequest)
                                    throws IOException

撤回群消息

Parameters:

groupMsgRecallRequest - 请求参数

Returns:

结果

Throws:

IOException - 异常

importGroup

public ImportGroupResult importGroup(ImportGroupRequest importGroupRequest)
                              throws IOException

导入群基础资料

Parameters:

importGroupRequest - 请求参数

Returns:

结果

Throws:

IOException - 异常

importGroupMsg

public ImportGroupMsgResult importGroupMsg(ImportGroupMsgRequest importGroupMsgRequest)
                                    throws IOException

导入群消息

Parameters:

importGroupMsgRequest - 请求参数

Returns:

结果

Throws:

IOException - 异常

importGroupMember

public ImportGroupMemberResult importGroupMember(ImportGroupMemberRequest importGroupMemberRequest)
                                          throws IOException

导入群成员

Parameters:

importGroupMemberRequest - 请求参数

Returns:

结果

Throws:

IOException - 异常

setUnreadMsgNum

public SetUnreadMsgNumResult setUnreadMsgNum(SetUnreadMsgNumRequest setUnreadMsgNumRequest)
                                      throws IOException

设置成员未读消息计数

Parameters:

setUnreadMsgNumRequest - 请求参数

Returns:

结果

Throws:

IOException - 异常

deleteGroupMsgBySender

public DeleteGroupMsgBySenderResult deleteGroupMsgBySender(DeleteGroupMsgBySenderRequest deleteGroupMsgBySenderRequest)
                                                    throws IOException

撤回指定用户发送的消息

Parameters:

deleteGroupMsgBySenderRequest - 请求参数

Returns:

结果

Throws:

IOException - 异常

groupMsgGetSimple

public GroupMsgGetSimpleResult groupMsgGetSimple(GroupMsgGetSimpleRequest groupMsgGetSimpleRequest)
                                          throws IOException

拉取群历史消息

Parameters:

groupMsgGetSimpleRequest - 请求参数

Returns:

结果

Throws:

IOException - 异常

getOnlineMemberNum

public GetOnlineMemberNumResult getOnlineMemberNum(GetOnlineMemberNumRequest getOnlineMemberNumRequest)
                                            throws IOException

获取直播群在线人数

Parameters:

getOnlineMemberNumRequest - 请求参数

Returns:

结果

Throws:

IOException - 异常

getGroupAttr

public GetGroupAttrResult getGroupAttr(GetGroupAttrRequest getGroupAttrRequest)
                                throws IOException

获取群自定义属性

Parameters:

getGroupAttrRequest - 请求参数

Returns:

结果

Throws:

IOException - 异常

modifyGroupAttr

public ModifyGroupAttrResult modifyGroupAttr(ModifyGroupAttrRequest modifyGroupAttrRequest)
                                      throws IOException

修改群自定义属性

Parameters:

modifyGroupAttrRequest - 请求参数

Returns:

结果

Throws:

IOException - 异常

clearGroupAttr

public ClearGroupAttrResult clearGroupAttr(ClearGroupAttrRequest clearGroupAttrRequest)
                                    throws IOException

清空群自定义属性

Parameters:

clearGroupAttrRequest - 请求参数

Returns:

结果

Throws:

IOException - 异常

setGroupAttr

public SetGroupAttrResult setGroupAttr(SetGroupAttrRequest setGroupAttrRequest)
                                throws IOException

重置群自定义属性

Parameters:

setGroupAttrRequest - 请求参数

Returns:

结果

Throws:

IOException - 异常