# 类: Group [(返回目录)](https://docs.rainybot.dev/api) **继承自:** [GroupAPI](https://docs.rainybot.dev/api/groupapi) RainyBot的群组类，通常代表一个对应实例，实现了用于与群组进行交互的各类功能 ## 描述 这是RainyBot的群组类，通常代表一个对应实例，实现了用于与群组进行交互的各类功能\ 绝大部分与群聊直接相关的操作都可以通过此类来进行 ## 方法 * static [Group](https://docs.rainybot.dev/api/group) **init (** [int](https://docs.godotengine.org/en/latest/classes/class_int.html) group\_id **)** 手动构造一个Group类的实例，用于主动进行与群组的交互时使用 需要传入群聊的ID(群号)作为参数，以便进行各类操作 *** * static [Group](https://docs.rainybot.dev/api/group) **init\_meta (** [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html) dic **)** 通过机器人协议后端的元数据字典构造一个Group类的实例，仅当你知道自己在做什么时才使用 *** * [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html) **get\_metadata ( )** 获取实例中的元数据字典，仅当你知道自己在做什么时才使用 *** * void **set\_metadata (** [Dictionary](https://docs.godotengine.org/en/latest/classes/class_dictionary.html) dic **)** 使用指定字典覆盖实例中的元数据字典，仅当你知道自己在做什么时才使用 *** * [String](https://docs.godotengine.org/en/latest/classes/class_string.html) **get\_name ( )** 获取群聊实例的名称(群名称)，若为手动构造的实例，将始终返回空字符串 *** * [int](https://docs.godotengine.org/en/latest/classes/class_int.html) **get\_id ( )** 获取群聊实例的ID(群号) *** * [int](https://docs.godotengine.org/en/latest/classes/class_int.html) **get\_bot\_permission ( )** 获取机器人在群聊实例中的权限，若为手动构造的实例，将始终返回0 权限列表请参见GroupMember类中的Permission枚举 *** * [String](https://docs.godotengine.org/en/latest/classes/class_string.html) **get\_avatar\_url ( )** 获取群聊实例对应的群头像的图像链接，通常为jpg格式 *** * [GroupMember](https://docs.rainybot.dev/api/groupmember) **get\_member (** [int](https://docs.godotengine.org/en/latest/classes/class_int.html) member\_id, [float](https://docs.godotengine.org/en/latest/classes/class_float.html) timeout=-INF **)** 获取群聊实例中指定成员ID的GroupMember实例，需要配合await关键字使用 可以通过指定timeout参数来自定义获取请求结果的超时时间，若不指定则默认将使用配置文件中设置的超时时间 *** * [GroupMemberList](https://docs.rainybot.dev/api/groupmemberlist) **get\_member\_list (** [float](https://docs.godotengine.org/en/latest/classes/class_float.html) timeout=-INF **)** 获取群聊实例中所有成员列表的GroupMemberList实例，需要配合await关键字使用 可以通过指定timeout参数来自定义获取请求结果的超时时间，若不指定则默认将使用配置文件中设置的超时时间 *** * [MemberProfile](https://docs.rainybot.dev/api/memberprofile) **get\_member\_profile (** [int](https://docs.godotengine.org/en/latest/classes/class_int.html) member\_id, [float](https://docs.godotengine.org/en/latest/classes/class_float.html) timeout=-INF **)** 获取群聊实例中指定成员ID相关资料的MemberProfile实例，需要配合await关键字使用 可以通过指定timeout参数来自定义获取请求结果的超时时间，若不指定则默认将使用配置文件中设置的超时时间 *** * [BotRequestResult](https://docs.rainybot.dev/api/botrequestresult) **toggle\_mute\_all (** [bool](https://docs.godotengine.org/en/latest/classes/class_bool.html) enabled, [float](https://docs.godotengine.org/en/latest/classes/class_float.html) timeout=-INF **)** 用于切换群聊实例的全员禁言状态，所需的参数为是否启用全员禁言 配合await关键字可返回一个BotRequestResult类的实例，便于判断执行状态 可以通过指定timeout参数来自定义获取请求结果的超时时间，若不指定则默认将使用配置文件中设置的超时时间 *** * [GroupConfig](https://docs.rainybot.dev/api/groupconfig) **get\_group\_config (** [float](https://docs.godotengine.org/en/latest/classes/class_float.html) timeout=-INF **)** 用于获取与群聊实例的各类配置相关的GroupConfig实例，需要配合await关键字使用 可以通过指定timeout参数来自定义获取请求结果的超时时间，若不指定则默认将使用配置文件中设置的超时时间 *** * [BotRequestResult](https://docs.rainybot.dev/api/botrequestresult) **set\_group\_config (** [GroupConfig](https://docs.rainybot.dev/api/groupconfig) config, [float](https://docs.godotengine.org/en/latest/classes/class_float.html) timeout=-INF **)** 用于将群聊实例的各类配置替换为指定的GroupConfig实例中的配置 配合await关键字可返回一个BotRequestResult类的实例，便于判断执行状态 可以通过指定timeout参数来自定义获取请求结果的超时时间，若不指定则默认将使用配置文件中设置的超时时间 *** * [BotRequestResult](https://docs.rainybot.dev/api/botrequestresult) **send\_message (** [Variant](https://docs.godotengine.org/en/latest/classes/class_variant.html) msg, [int](https://docs.godotengine.org/en/latest/classes/class_int.html) quote\_msgid=-1, [float](https://docs.godotengine.org/en/latest/classes/class_float.html) timeout=-INF **)** 用于向群聊实例发送消息，同时可指定一个需要引用回复的消息ID 配合await关键字可返回一个BotRequestResult类的实例，便于判断执行状态 传入的第一个参数可以是以下类型: * 字符串(将自动构造为文本消息实例，解析其中的BotCode，并将其作为消息链中的唯一消息实例发送) * 单个消息实例(将其作为消息链中的唯一消息实例发送) * 消息链实例(将其内容复制并发送) * 包含以上三种类型实例的数组(将按照上方规则将数组中的实例依次合并添加至一个消息链并发送) 可以通过指定timeout参数来自定义获取请求结果的超时时间，若不指定则默认将使用配置文件中设置的超时时间 *** * [BotRequestResult](https://docs.rainybot.dev/api/botrequestresult) **send\_nudge (** [int](https://docs.godotengine.org/en/latest/classes/class_int.html) member\_id, [float](https://docs.godotengine.org/en/latest/classes/class_float.html) timeout=-INF **)** 用于在群聊实例中向指定的成员ID发送一个戳一戳消息 配合await关键字可返回一个BotRequestResult类的实例，便于判断执行状态 可以通过指定timeout参数来自定义获取请求结果的超时时间，若不指定则默认将使用配置文件中设置的超时时间 *** * [GroupAnnounceInfoList](https://docs.rainybot.dev/api/groupannounceinfolist) **publish\_announce (** [GroupAnnounce](https://docs.rainybot.dev/api/groupannounce) announce, [float](https://docs.godotengine.org/en/latest/classes/class_float.html) timeout=-INF **)** 用于在群聊实例中发布一个指定的群公告实例，群公告实例的相关用法请参见\[GroupAnnounce]类文档 配合await关键字可返回一个包含了已发布的群公告的\[GroupAnnounceInfoList]类实例，以便于进行后续操作 可以通过指定timeout参数来自定义获取请求结果的超时时间，若不指定则默认将使用配置文件中设置的超时时间 *** * [BotRequestResult](https://docs.rainybot.dev/api/botrequestresult) **delete\_announce (** [int](https://docs.godotengine.org/en/latest/classes/class_int.html) announce\_id, [float](https://docs.godotengine.org/en/latest/classes/class_float.html) timeout=-INF **)** 用于在群聊实例中删除一个指定ID的群公告 配合await关键字可返回一个BotRequestResult类的实例，便于判断执行状态 可以通过指定timeout参数来自定义获取请求结果的超时时间，若不指定则默认将使用配置文件中设置的超时时间 *** * [GroupAnnounceInfoList](https://docs.rainybot.dev/api/groupannounceinfolist) **get\_announce\_list (** [int](https://docs.godotengine.org/en/latest/classes/class_int.html) page\_num=0, [int](https://docs.godotengine.org/en/latest/classes/class_int.html) per\_page\_size=10, [float](https://docs.godotengine.org/en/latest/classes/class_float.html) timeout=-INF **)** 用于获取在群聊实例中的群公告的列表，可指定页码，以及每页将包含的群公告的数量，将返回一个\[GroupAnnounceInfoList]类的实例 此函数必须配合await关键字进行使用，否则将会发生错误，且无法获取相关的信息 可以通过指定timeout参数来自定义获取请求结果的超时时间，若不指定则默认将使用配置文件中设置的超时时间 *** * [BotRequestResult](https://docs.rainybot.dev/api/botrequestresult) **quit (** [float](https://docs.godotengine.org/en/latest/classes/class_float.html) timeout=-INF **)** 用于让机器人主动退出群聊实例所对应的群聊 配合await关键字可返回一个BotRequestResult类的实例，便于判断执行状态 可以通过指定timeout参数来自定义获取请求结果的超时时间，若不指定则默认将使用配置文件中设置的超时时间 *** * [BotRequestResult](https://docs.rainybot.dev/api/botrequestresult) **set\_essence\_message (** [int](https://docs.godotengine.org/en/latest/classes/class_int.html) msg\_id, [float](https://docs.godotengine.org/en/latest/classes/class_float.html) timeout=-INF **)** 用于在群聊实例中将指定ID的消息设置为精华消息 配合await关键字可返回一个BotRequestResult类的实例，便于判断执行状态 可以通过指定timeout参数来自定义获取请求结果的超时时间，若不指定则默认将使用配置文件中设置的超时时间 *** * [BotRequestResult](https://docs.rainybot.dev/api/botrequestresult) **recall\_message (** [int](https://docs.godotengine.org/en/latest/classes/class_int.html) msg\_id, [float](https://docs.godotengine.org/en/latest/classes/class_float.html) timeout=-INF **)** 用于在群聊实例中将指定ID的消息撤回，机器人需要为管理员或群主才可撤回他人消息 配合await关键字可返回一个BotRequestResult类的实例，便于判断执行状态 可以通过指定timeout参数来自定义获取请求结果的超时时间，若不指定则默认将使用配置文件中设置的超时时间 *** * [CacheMessage](https://docs.rainybot.dev/api/cachemessage) **get\_cache\_message (** [int](https://docs.godotengine.org/en/latest/classes/class_int.html) msg\_id, [float](https://docs.godotengine.org/en/latest/classes/class_float.html) timeout=-INF **)** 用于在群聊实例中获取指定ID的本地缓存消息，将返回一个\[CacheMessage]类的实例 此函数必须配合await关键字进行使用，否则将会发生错误，且无法获取相关的信息 可以通过指定timeout参数来自定义获取请求结果的超时时间，若不指定则默认将使用配置文件中设置的超时时间 ***