From 2cc1957f8ae2f6f62c48fa0a48b36d8d2a73ed9c Mon Sep 17 00:00:00 2001 From: ForteScarlet Date: Sat, 26 Oct 2024 04:07:00 +0000 Subject: [PATCH] deploy: simple-robot/simbot-component-qq-guild@449a595f0ab500a10174815f18e1e0cc42392cd3 --- snapshots/components/qq-guild/index.html | 20 ++++++++----------- .../-create-dms-api/index.html | 2 +- .../-message-send-api/index.html | 2 +- .../get-by-name.html | 2 +- .../resolve-dispatch-serializer.html | 2 +- .../-content-text-decoder/index.html | 2 +- .../-content-text-encoder/index.html | 2 +- 7 files changed, 14 insertions(+), 18 deletions(-) diff --git a/snapshots/components/qq-guild/index.html b/snapshots/components/qq-guild/index.html index 6b26d74a3d..e440d455d1 100644 --- a/snapshots/components/qq-guild/index.html +++ b/snapshots/components/qq-guild/index.html @@ -128,18 +128,14 @@

文档与引导

我们欢迎并期望着您的 反馈协助, 感谢您的贡献与支持!

-

模块引导

-

API模块

-

基于 Ktor 针对 QQ频道API 的基本完整的KMP多平台封装实现, 是一个简单高效轻量级的API实现模块。

-

此模块基本不会提供什么多余的实现,其目标为在提供封装的情况下尽可能地保留原始API的使用手感,不做过多的封装。

-

👉 simbot-component-qq-guild-api 了解更多。

-

标准库模块

-

基于 simbot-component-qq-guild-api 针对bot的"登录"鉴权实现简单高效轻量级的事件订阅功能。

-

此模块在API模块的基础上提供了针对事件相关的功能实现,包括事件订阅的能力。 同样的,其目标为在提供封装的情况下尽可能地保留原始API的使用手感,不做过多的封装。

-

👉 simbot-component-qq-guild-stdlib 了解更多。

-

核心组件模块 ⭐

-

基于 simbot-component-qq-guild-stdlib 对 simbot4核心库 的组件实现, 是一个相对高度封装的模块,并提供simbot4大部分能力,包括事件监听、多组件协同、Spring Boot Starter 等。

-

👉 simbot-component-qq-guild-core 了解更多。

+

概述

+

QQ机器人组件是对 simbot4核心库 的组件实现, 是一个相对高度封装的模块,并提供simbot大部分能力,包括事件监听、多组件协同、Spring Boot Starter 等。

+

👉 simbot-component-qq-guild-core 了解更多~

+

命名说明

+

QQ机器人组件命名为 simbot-component-qq-guild , 因为最早开始QQ并未开放普通个人开发者使用QQ群聊、QQ单聊的功能, 因此此组件当时仅支持QQ频道。 在开放后,其两端可以合并在一起使用,因此QQ群相关的能力才被支持。

+
+

也许未来会更名为 simbot-component-qq ?

+

法欧莉!

如果你想看一看使用QQ频道组件实现的具体作品, 可以前往QQ频道添加亲爱的 法欧莉斯卡雷特 来体验喔~

License

diff --git a/snapshots/components/qq-guild/simbot-component-qq-guild-api/love.forte.simbot.qguild.api.message.direct/-create-dms-api/index.html b/snapshots/components/qq-guild/simbot-component-qq-guild-api/love.forte.simbot.qguild.api.message.direct/-create-dms-api/index.html index 3a73757d1b..2a9c58b6e5 100644 --- a/snapshots/components/qq-guild/simbot-component-qq-guild-api/love.forte.simbot.qguild.api.message.direct/-create-dms-api/index.html +++ b/snapshots/components/qq-guild/simbot-component-qq-guild-api/love.forte.simbot.qguild.api.message.direct/-create-dms-api/index.html @@ -87,7 +87,7 @@

CreateDmsApi

-

创建私信会话

用于机器人和在同一个频道内的成员创建私信会话。

机器人和用户存在共同频道才能创建私信会话。 创建成功后,返回创建成功的频道 id ,子频道 id 和创建时间。

参数

字段名类型描述
recipient_idstring接收者 id
source_guild_idstring源频道 id

Author

ForteScarlet

+

创建私信会话

用于机器人和在同一个频道内的成员创建私信会话。

机器人和用户存在共同频道才能创建私信会话。 创建成功后,返回创建成功的频道 id ,子频道 id 和创建时间。

参数

字段名类型描述
recipient_idstring接收者 id
source_guild_idstring源频道 id

Author

ForteScarlet

diff --git a/snapshots/components/qq-guild/simbot-component-qq-guild-api/love.forte.simbot.qguild.api.message/-message-send-api/index.html b/snapshots/components/qq-guild/simbot-component-qq-guild-api/love.forte.simbot.qguild.api.message/-message-send-api/index.html index 78224b3ceb..76a6e5ddb0 100644 --- a/snapshots/components/qq-guild/simbot-component-qq-guild-api/love.forte.simbot.qguild.api.message/-message-send-api/index.html +++ b/snapshots/components/qq-guild/simbot-component-qq-guild-api/love.forte.simbot.qguild.api.message/-message-send-api/index.html @@ -87,7 +87,7 @@

MessageSendApi

-

发送消息

用于向 channel_id 指定的子频道发送消息。

  • 要求操作人在该子频道具有 发送消息 的权限。

  • 主动消息在频道主或管理设置了情况下,按设置的数量进行限频。在未设置的情况遵循如下限制:

    • 主动推送消息,默认每天往每个子频道可推送的消息数是 20 条,超过会被限制。

    • 主动推送消息在每个频道中,每天可以往 2 个子频道推送消息。超过后会被限制。

  • 不论主动消息还是被动消息,在一个子频道中,每 1s 只能发送 5 条消息。

  • 被动回复消息有效期为 5 分钟。超时会报错。

  • 发送消息接口要求机器人接口需要连接到 websocket 上保持在线状态

  • 有关主动消息审核,可以通过 Intents 中审核事件 MESSAGE_AUDIT 返回 MessageAudited 对象获取结果。


主动消息与被动消息

  • 主动消息:发送消息时,未填充 msg_id/event_id 字段的消息。

  • 被动消息:发送消息时,填充了 msg_id/event_id 字段的消息。msg_idevent_id 两个字段任意填一个即为被动消息。 接口使用此 msg_id/event_id 拉取用户的消息或事件,同时判断用户消息或事件的发送时间,如果超过被动消息回复时效,将会不允许发送该消息。

更多参考 文档

发送 ARK 模板消息

通过指定 ark 字段发送模板消息。

  • 要求操作人在该子频道具有发送消息和 对应 ARK 模板 的权限。

  • 调用前需要先申请消息模板,这一步会得到一个模板 id,在请求时填在 ark.template_id 上。

  • 发送成功之后,会触发一个创建消息的事件。

  • 可用模板参考可用模板

更多参考 文档

发送引用消息

  • 只支持引用机器人自己发送到的消息以及用户@机器人产生的消息。

  • 发送成功之后,会触发一个创建消息的事件。

不能单独发送引用消息,引用消息需要和其他消息类型组合发送,参数请见发送消息

更多参考 文档

发送含有消息按钮组件的消息

通过指定 keyboard 字段发送带按钮的消息,支持 keyboard 模版自定义 keyboard 两种请求格式。

  • 要求操作人在该子频道具有 发送消息对应消息按钮组件 的权限。

  • 请求参数 keyboard 模版自定义 keyboard 只能单一传值。

  • keyboard 模版

    • 调用前需要先申请消息按钮组件模板,这一步会得到一个模板 id,在请求时填在 keyboard 字段上。

    • 申请消息按钮组件模板需要提供响应的 json,具体格式参考 InlineKeyboard

  • markdown 消息支持消息按钮。

更多参考 文档

内嵌格式

利用 content 字段发送内嵌格式的消息。

  • 内嵌格式仅在 content 中会生效,在 ArkEmbed 中不生效。

  • 为了区分是文本还是内嵌格式,消息抄送和发送会对消息内容进行相关的转义。

转义内容

源字符转义后
&&
<&lt;
>&gt;

可参考使用 ContentTextDecoderContentTextEncoder

消息审核

其中推送、回复消息的 code 错误码 304023304024 会在 响应数据包 data 中返回 MessageAudit 审核消息的信息

当响应结果为上述错误码时,请求实体对象结果的API时会抛出 MessageAuditedException 异常并携带相关的对象信息。

详见文档 发送消息 中的相关描述以及 MessageAuditedException 的文档描述。


更多参考 文档

Author

ForteScarlet

Throws

+

发送消息

用于向 channel_id 指定的子频道发送消息。

  • 要求操作人在该子频道具有 发送消息 的权限。

  • 主动消息在频道主或管理设置了情况下,按设置的数量进行限频。在未设置的情况遵循如下限制:

    • 主动推送消息,默认每天往每个子频道可推送的消息数是 20 条,超过会被限制。

    • 主动推送消息在每个频道中,每天可以往 2 个子频道推送消息。超过后会被限制。

  • 不论主动消息还是被动消息,在一个子频道中,每 1s 只能发送 5 条消息。

  • 被动回复消息有效期为 5 分钟。超时会报错。

  • 发送消息接口要求机器人接口需要连接到 websocket 上保持在线状态

  • 有关主动消息审核,可以通过 Intents 中审核事件 MESSAGE_AUDIT 返回 MessageAudited 对象获取结果。


主动消息与被动消息

  • 主动消息:发送消息时,未填充 msg_id/event_id 字段的消息。

  • 被动消息:发送消息时,填充了 msg_id/event_id 字段的消息。msg_idevent_id 两个字段任意填一个即为被动消息。 接口使用此 msg_id/event_id 拉取用户的消息或事件,同时判断用户消息或事件的发送时间,如果超过被动消息回复时效,将会不允许发送该消息。

更多参考 文档

发送 ARK 模板消息

通过指定 ark 字段发送模板消息。

  • 要求操作人在该子频道具有发送消息和 对应 ARK 模板 的权限。

  • 调用前需要先申请消息模板,这一步会得到一个模板 id,在请求时填在 ark.template_id 上。

  • 发送成功之后,会触发一个创建消息的事件。

  • 可用模板参考可用模板

更多参考 文档

发送引用消息

  • 只支持引用机器人自己发送到的消息以及用户@机器人产生的消息。

  • 发送成功之后,会触发一个创建消息的事件。

不能单独发送引用消息,引用消息需要和其他消息类型组合发送,参数请见发送消息

更多参考 文档

发送含有消息按钮组件的消息

通过指定 keyboard 字段发送带按钮的消息,支持 keyboard 模版自定义 keyboard 两种请求格式。

  • 要求操作人在该子频道具有 发送消息对应消息按钮组件 的权限。

  • 请求参数 keyboard 模版自定义 keyboard 只能单一传值。

  • keyboard 模版

    • 调用前需要先申请消息按钮组件模板,这一步会得到一个模板 id,在请求时填在 keyboard 字段上。

    • 申请消息按钮组件模板需要提供响应的 json,具体格式参考 InlineKeyboard

  • markdown 消息支持消息按钮。

更多参考 文档

内嵌格式

利用 content 字段发送内嵌格式的消息。

  • 内嵌格式仅在 content 中会生效,在 ArkEmbed 中不生效。

  • 为了区分是文本还是内嵌格式,消息抄送和发送会对消息内容进行相关的转义。

转义内容

源字符转义后
&&amp;
<&lt;
>&gt;

可参考使用 ContentTextDecoderContentTextEncoder

消息审核

其中推送、回复消息的 code 错误码 304023304024 会在 响应数据包 data 中返回 MessageAudit 审核消息的信息

当响应结果为上述错误码时,请求实体对象结果的API时会抛出 MessageAuditedException 异常并携带相关的对象信息。

详见文档 发送消息 中的相关描述以及 MessageAuditedException 的文档描述。


更多参考 文档

Author

ForteScarlet

Throws

diff --git a/snapshots/components/qq-guild/simbot-component-qq-guild-api/love.forte.simbot.qguild.event/-event-intents-aggregation/get-by-name.html b/snapshots/components/qq-guild/simbot-component-qq-guild-api/love.forte.simbot.qguild.event/-event-intents-aggregation/get-by-name.html index 99dd102966..1558feffcd 100644 --- a/snapshots/components/qq-guild/simbot-component-qq-guild-api/love.forte.simbot.qguild.event/-event-intents-aggregation/get-by-name.html +++ b/snapshots/components/qq-guild/simbot-component-qq-guild-api/love.forte.simbot.qguild.event/-event-intents-aggregation/get-by-name.html @@ -87,7 +87,7 @@

getByName

-
@JvmName(name = "getByName")
fun getByName(name: String): Intents

使用简单的字符串名称来获取一个对应的 EventIntents 子类型的 intents 值, 字符串名称与这个类型的简单类型相关:类名的名称,以及对应的snack(下滑线)格式。 名称支持开头大写、小写的驼峰格式以及对应的全大写、小写的snack格式,但大小写仍然是敏感的。

名称类型
"AudioAction", "audioAction", "AUDIO_ACTION", "audio_action"AudioAction
"AudioOrLiveChannelMember", "audioOrLiveChannelMember", "AUDIO_OR_LIVE_CHANNEL_MEMBER", "audio_or_live_channel_member"AudioOrLiveChannelMember
"DirectMessage", "directMessage", "DIRECT_MESSAGE", "direct_message"DirectMessage
"ForumsEvent", "forumsEvent", "FORUMS_EVENT", "forums_event"ForumsEvent
"GroupAndC2CEvent", "groupAndC2CEvent", "GROUP_AND_C2C_EVENT", "group_and_c2c_event"GroupAndC2CEvent
"GuildMembers", "guildMembers", "GUILD_MEMBERS", "guild_members"GuildMembers
"GuildMessageReactions", "guildMessageReactions", "GUILD_MESSAGE_REACTIONS", "guild_message_reactions"GuildMessageReactions
"GuildMessages", "guildMessages", "GUILD_MESSAGES", "guild_messages"GuildMessages
"Guilds", "guilds", "GUILDS"Guilds
"Interaction", "interaction", "INTERACTION"Interaction
"MessageAudit", "messageAudit", "MESSAGE_AUDIT", "message_audit"MessageAudit
"OpenForumsEvent", "openForumsEvent", "OPEN_FORUMS_EVENT", "open_forums_event"OpenForumsEvent
"PublicGuildMessages", "publicGuildMessages", "PUBLIC_GUILD_MESSAGES", "public_guild_messages"PublicGuildMessages
+
@JvmName(name = "getByName")
fun getByName(name: String): Intents

使用简单的字符串名称来获取一个对应的 EventIntents 子类型的 intents 值, 字符串名称与这个类型的简单类型相关:类名的名称,以及对应的snack(下滑线)格式。 名称支持开头大写、小写的驼峰格式以及对应的全大写、小写的snack格式,但大小写仍然是敏感的。

名称类型
"AudioAction", "audioAction", "AUDIO_ACTION", "audio_action"AudioAction
"AudioOrLiveChannelMember", "audioOrLiveChannelMember", "AUDIO_OR_LIVE_CHANNEL_MEMBER", "audio_or_live_channel_member"AudioOrLiveChannelMember
"DirectMessage", "directMessage", "DIRECT_MESSAGE", "direct_message"DirectMessage
"ForumsEvent", "forumsEvent", "FORUMS_EVENT", "forums_event"ForumsEvent
"GroupAndC2CEvent", "groupAndC2CEvent", "GROUP_AND_C2C_EVENT", "group_and_c2c_event"GroupAndC2CEvent
"GuildMembers", "guildMembers", "GUILD_MEMBERS", "guild_members"GuildMembers
"GuildMessageReactions", "guildMessageReactions", "GUILD_MESSAGE_REACTIONS", "guild_message_reactions"GuildMessageReactions
"GuildMessages", "guildMessages", "GUILD_MESSAGES", "guild_messages"GuildMessages
"Guilds", "guilds", "GUILDS"Guilds
"Interaction", "interaction", "INTERACTION"Interaction
"MessageAudit", "messageAudit", "MESSAGE_AUDIT", "message_audit"MessageAudit
"OpenForumsEvent", "openForumsEvent", "OPEN_FORUMS_EVENT", "open_forums_event"OpenForumsEvent
"PublicGuildMessages", "publicGuildMessages", "PUBLIC_GUILD_MESSAGES", "public_guild_messages"PublicGuildMessages