Interface IGroupApi code

命名空间: Another_Mirai_Native.Abstractions.Services

程序集: Another-Mirai-Native.Abstractions.dll

提供用于管理群组操作的抽象，包括成员管理、群组信息检索以及在群组上下文中的管理操作。

public interface IGroupApi

方法

BanGroup(long, bool) code

全群禁言/解除全群禁言；要求当前账号必须是群主或管理员，且不能对群主或自己进行此操作

bool BanGroup(long groupId, bool enable)

参数

groupId long: 操作的群号
enable bool: true 表示开启全群禁言；false 表示解除全群禁言

返回值

bool: 操作是否成功

BanGroupAsync(long, bool) code

异步全群禁言/解除全群禁言；要求当前账号必须是群主或管理员，且不能对群主或自己进行此操作

Task<bool> BanGroupAsync(long groupId, bool enable)

参数

groupId long: 操作的群号
enable bool: true 表示开启全群禁言；false 表示解除全群禁言

返回值

Task<bool>: 操作是否成功

BanMember(long, long, long) code

禁言/解除禁言群成员；要求当前账号必须是群主或管理员，且不能对群主或自己进行此操作

bool BanMember(long groupId, long qq, long duration)

参数

groupId long: 操作的群号
qq long: 操作的目标群成员
duration long: 禁言时长（秒）；当值为 0 时，表示解除此人的禁言

返回值

bool: 操作是否成功

BanMemberAsync(long, long, long) code

异步禁言/解除禁言群成员；要求当前账号必须是群主或管理员，且不能对群主或自己进行此操作

Task<bool> BanMemberAsync(long groupId, long qq, long duration)

参数

groupId long: 操作的群号
qq long: 操作的目标群成员
duration long: 禁言时长（秒）；当值为 0 时，表示解除此人的禁言

返回值

Task<bool>: 操作是否成功

GetGroupInfo(long) code

通过群号获取群信息

GroupInfo? GetGroupInfo(long groupId)

参数

groupId long: 期望获取群消息的群号

返回值

GroupInfo: 获取成功则返回 GroupInfo 对象，否则会返回 null

GetGroupInfoAsync(long) code

异步通过群号获取群信息

Task<GroupInfo?> GetGroupInfoAsync(long groupId)

参数

groupId long: 期望获取群消息的群号

返回值

Task<GroupInfo>: 获取成功则返回 GroupInfo 对象，否则会返回 null

GetGroupList() code

获取当前登录账号已加入的群列表

List<GroupInfo> GetGroupList()

返回值

List<GroupInfo>: 获取成功则返回 GroupMemberInfo 数组

GetGroupListAsync() code

异步获取当前登录账号已加入的群列表

Task<List<GroupInfo>> GetGroupListAsync()

返回值

Task<List<GroupInfo>>: 获取成功则返回 GroupMemberInfo 数组

GetGroupMemberInfo(long, long) code

获取群成员信息

GroupMemberInfo? GetGroupMemberInfo(long groupId, long qq)

参数

groupId long: 目标成员所在群
qq long: 目标成员QQ

返回值

GroupMemberInfo: 获取成功则返回 GroupMemberInfo 信息对象，否则会返回 null

GetGroupMemberInfoAsync(long, long) code

异步获取群成员信息

Task<GroupMemberInfo?> GetGroupMemberInfoAsync(long groupId, long qq)

参数

groupId long: 目标成员所在群
qq long: 目标成员QQ

返回值

Task<GroupMemberInfo>: 获取成功则返回 GroupMemberInfo 信息对象，否则会返回 null

GetGroupMembers(long) code

获取某个群的成员列表，成员较多时会耗时较长

List<GroupMemberInfo> GetGroupMembers(long groupId)

参数

groupId long: 查询群的群号

返回值

List<GroupMemberInfo>: 获取成功则返回 GroupMemberInfo 数组

GetGroupMembersAsync(long) code

异步获取某个群的成员列表，成员较多时会耗时较长

Task<List<GroupMemberInfo>> GetGroupMembersAsync(long groupId)

参数

groupId long: 查询群的群号

返回值

Task<List<GroupMemberInfo>>: 获取成功则返回 GroupMemberInfo 数组

Kick(long, long, bool) code

将群成员从某个群移除；要求当前账号必须是群主或管理员，且不能对群主或自己进行此操作

bool Kick(long groupId, long qq, bool rejectAddRequest = false)

参数

groupId long: 操作的群号
qq long: 操作的群成员QQ
rejectAddRequest bool: 拒绝后续入群

返回值

bool: 操作是否成功

KickAsync(long, long, bool) code

异步将群成员从某个群移除；要求当前账号必须是群主或管理员，且不能对群主或自己进行此操作

Task<bool> KickAsync(long groupId, long qq, bool rejectAddRequest = false)

参数

groupId long: 操作的群号
qq long: 操作的群成员QQ
rejectAddRequest bool: 拒绝后续入群

返回值

Task<bool>: 操作是否成功

Leave(long) code

使当前账号退出某个群；当账号为群主时，此操作将解散群；

bool Leave(long groupId)

参数

groupId long: 将要离开的群号

返回值

bool: 操作是否成功

LeaveAsync(long) code

异步使当前账号退出某个群；当账号为群主时，此操作将解散群；

Task<bool> LeaveAsync(long groupId)

参数

groupId long: 将要离开的群号

返回值

Task<bool>: 操作是否成功

SetAdmin(long, long, bool) code

将群成员设置为管理员或取消管理员；要求当前账号必须是群主，且不能对群主或自己进行此操作

bool SetAdmin(long groupId, long qq, bool isAdmin)

参数

groupId long: 操作的群号
qq long: 操作的群成员QQ
isAdmin bool: true 表示设置为管理员；false 表示解除管理员

返回值

bool: 操作是否成功

SetAdminAsync(long, long, bool) code

异步将群成员设置为管理员或取消管理员；要求当前账号必须是群主，且不能对群主或自己进行此操作

Task<bool> SetAdminAsync(long groupId, long qq, bool isAdmin)

参数

groupId long: 操作的群号
qq long: 操作的群成员QQ
isAdmin bool: true 表示设置为管理员；false 表示解除管理员

返回值

Task<bool>: 操作是否成功

SetGroupAddRequest(string, bool, string) code

处理群添加请求

bool SetGroupAddRequest(string flag, bool accept, string refuseReason = "")

参数

flag string: 框架内部标记添加请求的标志
accept bool: 是否接受
refuseReason string: 若不接受时传递的拒绝理由

返回值

bool: 操作是否成功

SetGroupAddRequestAsync(string, bool, string) code

异步处理群添加请求

Task<bool> SetGroupAddRequestAsync(string flag, bool accept, string refuseReason = "")

参数

flag string: 框架内部标记添加请求的标志
accept bool: 是否接受
refuseReason string: 若不接受时传递的拒绝理由

返回值

Task<bool>: 操作是否成功

SetGroupInviteRequest(string, bool, string) code

处理受群邀请请求

bool SetGroupInviteRequest(string flag, bool accept, string refuseReason = "")

参数

flag string: 框架内部标记添加请求的标志
accept bool: 是否接受
refuseReason string: 若不接受时传递的拒绝理由

返回值

bool: 操作是否成功

SetGroupInviteRequestAsync(string, bool, string) code

异步处理受群邀请请求

Task<bool> SetGroupInviteRequestAsync(string flag, bool accept, string refuseReason = "")

参数

flag string: 框架内部标记添加请求的标志
accept bool: 是否接受
refuseReason string: 若不接受时传递的拒绝理由

返回值

Task<bool>: 操作是否成功

SetMemberCard(long, long, string) code

设置某个群成员显示的名片；要求当前账号必须是群主或管理员

bool SetMemberCard(long groupId, long qq, string card)

参数

groupId long: 操作的群号
qq long: 操作的群成员QQ
card string: 将要设置的名片，不可为空

返回值

bool: 操作是否成功

SetMemberCardAsync(long, long, string) code

异步设置某个群成员显示的名片；要求当前账号必须是群主或管理员

Task<bool> SetMemberCardAsync(long groupId, long qq, string card)

参数

groupId long: 操作的群号
qq long: 操作的群成员QQ
card string: 将要设置的名片，不可为空

返回值

Task<bool>: 操作是否成功

SetMemberTitle(long, long, string) code

设置某个群成员显示的头衔；要求当前账号必须是群主

bool SetMemberTitle(long groupId, long qq, string title)

参数

groupId long: 操作的群号
qq long: 操作的群成员QQ
title string: 将要设置的头衔，不可为空

返回值

bool: 操作是否成功

SetMemberTitleAsync(long, long, string) code

异步设置某个群成员显示的头衔；要求当前账号必须是群主

Task<bool> SetMemberTitleAsync(long groupId, long qq, string title)

参数

groupId long: 操作的群号
qq long: 操作的群成员QQ
title string: 将要设置的头衔，不可为空

返回值

Task<bool>: 操作是否成功