Class Group code

命名空间: Another_Mirai_Native.Abstractions.Models

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

表示群的类，可进行与这个群相关快捷操作

public class Group

继承: object

Group

继承成员: object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

构造函数

Group(IPluginApi, long) code

表示群的类，可进行与这个群相关快捷操作

public Group(IPluginApi pluginApi, long groupId)

参数

pluginApi IPluginApi
groupId long

属性

Id code

群号

public long Id { get; }

属性值

long

方法

ExitGroup() code

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

public bool ExitGroup()

返回值

bool: 操作成功返回 true, 否则返回 false

ExitGroupAsync() code

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

public Task<bool> ExitGroupAsync()

返回值

Task<bool>: 操作成功返回 true, 否则返回 false

GetGroupInfo() code

获取群信息

public GroupInfo? GetGroupInfo()

返回值

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

GetGroupInfoAsync() code

异步获取群信息

public Task<GroupInfo?> GetGroupInfoAsync()

返回值

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

GetGroupMemberInfo(long) code

获取群成员信息

public GroupMemberInfo? GetGroupMemberInfo(long qqId)

参数

qqId long: 目标帐号

返回值

GroupMemberInfo: 获取成功返回 GroupMemberInfo

GetGroupMemberInfoAsync(long) code

异步获取群成员信息

public Task<GroupMemberInfo?> GetGroupMemberInfoAsync(long qqId)

参数

qqId long: 目标帐号

返回值

Task<GroupMemberInfo>: 获取成功返回 GroupMemberInfo

GetGroupMemberList() code

获取群成员列表

public List<GroupMemberInfo> GetGroupMemberList()

返回值

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

GetGroupMemberListAsync() code

异步获取群成员列表

public Task<List<GroupMemberInfo>> GetGroupMemberListAsync()

返回值

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

RemoveAdmin(long) code

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

public bool RemoveAdmin(long qqId)

参数

qqId long: 目标QQ

返回值

bool: 操作成功返回 true, 否则返回 false

RemoveAdminAsync(long) code

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

public Task<bool> RemoveAdminAsync(long qqId)

参数

qqId long: 目标QQ

返回值

Task<bool>: 操作成功返回 true, 否则返回 false

RemoveGroupBanSpeak() code

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

public bool RemoveGroupBanSpeak()

返回值

bool: 操作成功返回 true, 否则返回 false

RemoveGroupBanSpeakAsync() code

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

public Task<bool> RemoveGroupBanSpeakAsync()

返回值

Task<bool>: 操作成功返回 true, 否则返回 false

RemoveMemberBan(long) code

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

public bool RemoveMemberBan(long qqId)

参数

qqId long: 目标QQ

返回值

bool: 操作成功返回 true, 否则返回 false

RemoveMemberBanAsync(long) code

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

public Task<bool> RemoveMemberBanAsync(long qqId)

参数

qqId long: 目标QQ

返回值

Task<bool>: 操作成功返回 true, 否则返回 false

SendGroupMessage(string) code

发送群消息

public int SendGroupMessage(string message)

参数

message string: 消息内容

返回值

int: 若发送成功则返回消息ID（根据不同的框架实现，可能会有负数），若发送失败则返回 0

SendGroupMessageAsync(string) code

异步发送群消息

public Task<int> SendGroupMessageAsync(string message)

参数

message string: 消息内容

返回值

Task<int>: 若发送成功则返回消息ID（根据不同的框架实现，可能会有负数），若发送失败则返回 0

SetAdmin(long) code

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

public bool SetAdmin(long qqId)

参数

qqId long: 目标QQ

返回值

bool: 操作成功返回 true, 否则返回 false

SetAdminAsync(long) code

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

public Task<bool> SetAdminAsync(long qqId)

参数

qqId long: 目标QQ

返回值

Task<bool>: 操作成功返回 true, 否则返回 false

SetGroupBanSpeak() code

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

public bool SetGroupBanSpeak()

返回值

bool: 操作成功返回 true, 否则返回 false

SetGroupBanSpeakAsync() code

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

public Task<bool> SetGroupBanSpeakAsync()

返回值

Task<bool>: 操作成功返回 true, 否则返回 false

SetMemberBan(long, TimeSpan) code

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

public bool SetMemberBan(long qqId, TimeSpan time)

参数

qqId long: 目标QQ
time TimeSpan: 禁言时长 (范围: 1秒 ~ 30天)

返回值

bool: 操作成功返回 true, 否则返回 false

SetMemberBanAsync(long, TimeSpan) code

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

public Task<bool> SetMemberBanAsync(long qqId, TimeSpan time)

参数

qqId long: 目标QQ
time TimeSpan: 禁言时长 (范围: 1秒 ~ 30天)

返回值

Task<bool>: 操作成功返回 true, 否则返回 false

SetMemberCard(long, string) code

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

public bool SetMemberCard(long qqId, string newName)

参数

qqId long: 目标QQ
newName string: 新名称

返回值

bool: 操作成功返回 true, 否则返回 false

SetMemberCardAsync(long, string) code

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

public Task<bool> SetMemberCardAsync(long qqId, string newName)

参数

qqId long: 目标QQ
newName string: 新名称

返回值

Task<bool>: 操作成功返回 true, 否则返回 false

SetMemberTitle(long, string) code

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

public bool SetMemberTitle(long qqId, string newTitle)

参数

qqId long: 目标QQ
newTitle string: 新头衔

返回值

bool

SetMemberTitleAsync(long, string) code

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

public Task<bool> SetMemberTitleAsync(long qqId, string newTitle)

参数

qqId long: 目标QQ
newTitle string: 新头衔

返回值

Task<bool>: 操作成功返回 true, 否则返回 false