Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
ForteScarlet committed Oct 26, 2024
1 parent d0bede1 commit 2cc1957
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 18 deletions.
20 changes: 8 additions & 12 deletions snapshots/components/qq-guild/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -128,18 +128,14 @@ <h2 class="">文档与引导</h2>
</ul>

<p class="paragraph">我们欢迎并期望着您的 <a href="https://github.com/simple-robot/simbot-component-qq-guild/issues">反馈</a><a href="https://github.com/simple-robot/simbot-component-qq-guild/pulls">协助</a>, 感谢您的贡献与支持!</p>
<h2 class="">模块引导</h2>
<h3 class="">API模块</h3>
<p class="paragraph">基于 <code class="lang-kotlin">Ktor</code> 针对 <a href="https://bot.q.qq.com/wiki/develop/api/">QQ频道API</a> 的基本完整的<a href="https://kotlinlang.org/docs/multiplatform.html">KMP</a>多平台封装实现, 是一个简单高效轻量级的API实现模块。</p>
<p class="paragraph">此模块基本不会提供什么多余的实现,其目标为在提供封装的情况下尽可能地保留原始API的使用手感,不做过多的封装。</p>
<p class="paragraph">👉 simbot-component-qq-guild-api 了解更多。</p>
<h3 class="">标准库模块</h3>
<p class="paragraph">基于 simbot-component-qq-guild-api 针对bot的&quot;登录&quot;鉴权实现简单高效轻量级的事件订阅功能。</p>
<p class="paragraph">此模块在API模块的基础上提供了针对事件相关的功能实现,包括事件订阅的能力。 同样的,其目标为在提供封装的情况下尽可能地保留原始API的使用手感,不做过多的封装。</p>
<p class="paragraph">👉 simbot-component-qq-guild-stdlib 了解更多。</p>
<h3 class="">核心组件模块 ⭐</h3>
<p class="paragraph">基于 simbot-component-qq-guild-stdlib 对 <a href="https://github.com/simple-robot/simpler-robot">simbot4核心库</a> 的组件实现, 是一个相对高度封装的模块,并提供simbot4大部分能力,包括事件监听、多组件协同、Spring Boot Starter 等。</p>
<p class="paragraph">👉 simbot-component-qq-guild-core 了解更多。</p>
<h2 class="">概述</h2>
<p class="paragraph">QQ机器人组件是对 <a href="https://github.com/simple-robot/simpler-robot">simbot4核心库</a> 的组件实现, 是一个相对高度封装的模块,并提供simbot大部分能力,包括事件监听、多组件协同、Spring Boot Starter 等。</p>
<p class="paragraph">👉 simbot-component-qq-guild-core 了解更多~</p>
<h2 class="">命名说明</h2>
<p class="paragraph">QQ机器人组件命名为 <code class="lang-kotlin">simbot-component-qq-guild</code> , 因为最早开始QQ并未开放普通个人开发者使用QQ群聊、QQ单聊的功能, 因此此组件当时仅支持QQ频道。 在开放后,其两端可以合并在一起使用,因此QQ群相关的能力才被支持。</p>
<blockquote class="quotation">
<p class="paragraph">也许未来会更名为 <code class="lang-kotlin">simbot-component-qq</code> ?</p>
</blockquote>
<h2 class="">法欧莉!</h2>
<p class="paragraph">如果你想看一看使用QQ频道组件实现的具体作品, 可以前往QQ频道添加亲爱的 <a href="https://qun.qq.com/qunpro/robot/share?robot_appid=101986850">法欧莉斯卡雷特</a> 来体验喔~</p>
<h2 class="">License</h2>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@
<div class="breadcrumbs"><a href="../../index.html">simbot-component-qq-guild-api</a><span class="delimiter">/</span><a href="../index.html">love.forte.simbot.qguild.api.message.direct</a><span class="delimiter">/</span><span class="current">CreateDmsApi</span></div>
<div class="cover ">
<h1 class="cover"><span>Create</span><wbr><span>Dms</span><wbr><span><span>Api</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":simbot-component-qq-guild-api:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="index.html">CreateDmsApi</a> : <a href="../../love.forte.simbot.qguild.api/-post-q-q-guild-api/index.html">PostQQGuildApi</a><span class="token operator">&lt;</span><a href="../../love.forte.simbot.qguild.model/-direct-message-session/index.html">DirectMessageSession</a><span class="token operator">&gt; </span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/simple-robot/simbot-component-qq-guild/tree/main/simbot-component-qq-guild-api/src//commonMain/kotlin/love/forte/simbot/qguild/api/message/direct/CreateDmsApi.kt#L45">source</a>)</span></span></div><p class="paragraph"><a href="https://bot.q.qq.com/wiki/develop/api/openapi/dms/post_dms.html">创建私信会话</a></p><p class="paragraph">用于机器人和在同一个频道内的成员创建私信会话。</p><p class="paragraph">机器人和用户存在共同频道才能创建私信会话。 创建成功后,返回创建成功的频道 <code class="lang-kotlin">id</code> ,子频道 <code class="lang-kotlin">id</code> 和创建时间。</p><h2 class="">参数</h2><table><thead><tr><th>字段名</th><th>类型</th><th>描述</th></tr></thead><tbody><tr><td><code class="org.jetbrains.dokka.pages.commenttable@44a2824f lang-kotlin">recipient_id</code></td><td><code class="org.jetbrains.dokka.pages.commenttable@44a2824f lang-kotlin">string</code></td><td>接收者 id</td></tr><tr><td><code class="org.jetbrains.dokka.pages.commenttable@44a2824f lang-kotlin">source_guild_id</code></td><td><code class="org.jetbrains.dokka.pages.commenttable@44a2824f lang-kotlin">string</code></td><td>源频道 id</td></tr></tbody></table><span class="kdoc-tag"><h4 class="">Author</h4><p class="paragraph">ForteScarlet</p></span></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":simbot-component-qq-guild-api:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="index.html">CreateDmsApi</a> : <a href="../../love.forte.simbot.qguild.api/-post-q-q-guild-api/index.html">PostQQGuildApi</a><span class="token operator">&lt;</span><a href="../../love.forte.simbot.qguild.model/-direct-message-session/index.html">DirectMessageSession</a><span class="token operator">&gt; </span><span class="clearfix"><span class="floating-right">(<a href="https://github.com/simple-robot/simbot-component-qq-guild/tree/main/simbot-component-qq-guild-api/src//commonMain/kotlin/love/forte/simbot/qguild/api/message/direct/CreateDmsApi.kt#L45">source</a>)</span></span></div><p class="paragraph"><a href="https://bot.q.qq.com/wiki/develop/api/openapi/dms/post_dms.html">创建私信会话</a></p><p class="paragraph">用于机器人和在同一个频道内的成员创建私信会话。</p><p class="paragraph">机器人和用户存在共同频道才能创建私信会话。 创建成功后,返回创建成功的频道 <code class="lang-kotlin">id</code> ,子频道 <code class="lang-kotlin">id</code> 和创建时间。</p><h2 class="">参数</h2><table><thead><tr><th>字段名</th><th>类型</th><th>描述</th></tr></thead><tbody><tr><td><code class="org.jetbrains.dokka.pages.commenttable@7088883d lang-kotlin">recipient_id</code></td><td><code class="org.jetbrains.dokka.pages.commenttable@7088883d lang-kotlin">string</code></td><td>接收者 id</td></tr><tr><td><code class="org.jetbrains.dokka.pages.commenttable@7088883d lang-kotlin">source_guild_id</code></td><td><code class="org.jetbrains.dokka.pages.commenttable@7088883d lang-kotlin">string</code></td><td>源频道 id</td></tr></tbody></table><span class="kdoc-tag"><h4 class="">Author</h4><p class="paragraph">ForteScarlet</p></span></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button><button class="section-tab" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION,EXTENSION_PROPERTY,EXTENSION_FUNCTION">Members &amp; Extensions</button></div>
Expand Down

Large diffs are not rendered by default.

Loading

0 comments on commit 2cc1957

Please sign in to comment.