Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
ForteScarlet committed Aug 9, 2024
1 parent 66d6107 commit 1c20d36
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,36 @@ <h2 class="">Inherited functions</h2>
</div>
</div>
</div>
<a data-name="-784830413%2FFunctions%2F542815419" anchor-label="allToList" id="-784830413%2FFunctions%2F542815419" data-filterable-set=":simbot-component-onebot-v11:simbot-component-onebot-v11-core:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":simbot-component-onebot-v11:simbot-component-onebot-v11-core:dokkaHtmlPartial/commonMain" data-filterable-set=":simbot-component-onebot-v11:simbot-component-onebot-v11-core:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="index.html#1145596470%2FFunctions%2F542815419"><span>all</span><wbr><span>To</span><wbr><span><span>List</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-784830413%2FFunctions%2F542815419"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":simbot-component-onebot-v11:simbot-component-onebot-v11-core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">fun </span><a href="index.html#1145596470%2FFunctions%2F542815419"><span class="token function">allToList</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><a href="https://docs.simbot.forte.love/main-v4/simbot-api/love.forte.simbot.bot/-bot/index.html">Bot</a><span class="token operator">&gt;</span></div><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">fun </span><a href="index.html#389901597%2FFunctions%2F542815419"><span class="token function">allToList</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">id<span class="token operator">: </span><a href="https://docs.simbot.forte.love/main-v4/simbot-common-core/love.forte.simbot.common.id/-i-d/index.html">ID</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><a href="https://docs.simbot.forte.love/main-v4/simbot-api/love.forte.simbot.bot/-bot/index.html">Bot</a><span class="token operator">&gt;</span></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="1236475187%2FFunctions%2F542815419" anchor-label="allToStreamable" id="1236475187%2FFunctions%2F542815419" data-filterable-set=":simbot-component-onebot-v11:simbot-component-onebot-v11-core:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":simbot-component-onebot-v11:simbot-component-onebot-v11-core:dokkaHtmlPartial/commonMain" data-filterable-set=":simbot-component-onebot-v11:simbot-component-onebot-v11-core:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="index.html#-1333701574%2FFunctions%2F542815419"><span>all</span><wbr><span>To</span><wbr><span><span>Streamable</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1236475187%2FFunctions%2F542815419"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":simbot-component-onebot-v11:simbot-component-onebot-v11-core:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">fun </span><a href="index.html#-1333701574%2FFunctions%2F542815419"><span class="token function">allToStreamable</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://docs.simbot.forte.love/main-v4/simbot-common-streamable/love.forte.simbot.common.streamable/-streamable/index.html">Streamable</a><span class="token operator">&lt;</span><a href="https://docs.simbot.forte.love/main-v4/simbot-api/love.forte.simbot.bot/-bot/index.html">Bot</a><span class="token operator">&gt;</span></div><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">fun </span><a href="index.html#1814296609%2FFunctions%2F542815419"><span class="token function">allToStreamable</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">id<span class="token operator">: </span><a href="https://docs.simbot.forte.love/main-v4/simbot-common-core/love.forte.simbot.common.id/-i-d/index.html">ID</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://docs.simbot.forte.love/main-v4/simbot-common-streamable/love.forte.simbot.common.streamable/-streamable/index.html">Streamable</a><span class="token operator">&lt;</span><a href="https://docs.simbot.forte.love/main-v4/simbot-api/love.forte.simbot.bot/-bot/index.html">Bot</a><span class="token operator">&gt;</span></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-259601690%2FFunctions%2F542815419" anchor-label="cancel" id="-259601690%2FFunctions%2F542815419" data-filterable-set=":simbot-component-onebot-v11:simbot-component-onebot-v11-core:dokkaHtmlPartial/commonMain"></a>
<div class="table-row" data-filterable-current=":simbot-component-onebot-v11:simbot-component-onebot-v11-core:dokkaHtmlPartial/commonMain" data-filterable-set=":simbot-component-onebot-v11:simbot-component-onebot-v11-core:dokkaHtmlPartial/commonMain">
<div class="main-subrow keyValue ">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
<div class="breadcrumbs"><a href="../../index.html">simbot-component-onebot-v11-event</a><span class="delimiter">/</span><a href="../index.html">love.forte.simbot.component.onebot.v11.event</a><span class="delimiter">/</span><span class="current">RawEvent</span></div>
<div class="cover ">
<h1 class="cover"><span>Raw</span><wbr><span><span>Event</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-onebot-v11:simbot-component-onebot-v11-event:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">interface </span><a href="index.html">RawEvent</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/simple-robot/simbot-component-onebot/tree/dev/main/simbot-component-onebot-v11/simbot-component-onebot-v11-event/src//commonMain/kotlin/love/forte/simbot/component/onebot/v11/event/RawEvent.kt#L66">source</a>)</span></span></div><p class="paragraph">OneBot11的<a href="https://github.com/botuniverse/onebot-11/tree/master/event">事件</a></p><p class="paragraph">这是 OneBot11 原始的事件对象结构体的定义,不是对simbot Event的实现,它的所有最终具体实现类均为普通的不可变数据类。</p><h2 class="">实例化与兼容性</h2><p class="paragraph">此原始事件类型是用于序列化交互的数据类,它应当仅通过反序列化被构建,不建议直接使用它们的构造方式进行构建, 也不保证它们的构造对外具有二进制兼容性。</p><h2 class="">基本描述</h2><blockquote class="quotation"><p class="paragraph">下述内容来自OneBot11文档。</p></blockquote><p class="paragraph">事件是用户需要从 OneBot 被动接收的数据,有以下几个大类:</p><ul><li><p class="paragraph">消息事件,包括私聊消息、群消息等</p></li><li><p class="paragraph">通知事件,包括群成员变动、好友变动等</p></li><li><p class="paragraph">请求事件,包括加群请求、加好友请求等</p></li><li><p class="paragraph">元事件,包括 OneBot 生命周期、心跳等</p></li></ul><p class="paragraph">在所有能够推送事件的通信方式中(HTTP POST、正向和反向 WebSocket),事件都以 JSON 格式表示。</p><h3 class="">内容字段</h3><p class="paragraph">每个事件都有 <code class="lang-kotlin">time</code><code class="lang-kotlin">self_id</code><code class="lang-kotlin">post_type</code> 字段,如下:</p><table><thead><tr><th>字段名</th><th>数据类型</th><th>说明</th></tr></thead><tbody><tr><td><code class="org.jetbrains.dokka.pages.commenttable@158d33fa lang-kotlin">time</code></td><td>number (int64)</td><td>事件发生的时间戳</td></tr><tr><td><code class="org.jetbrains.dokka.pages.commenttable@158d33fa lang-kotlin">self_id</code></td><td>number (int64)</td><td>收到事件的机器人 QQ 号</td></tr><tr><td><code class="org.jetbrains.dokka.pages.commenttable@158d33fa lang-kotlin">post_type</code></td><td>string</td><td>事件类型</td></tr></tbody></table><p class="paragraph">其中 <code class="lang-kotlin">post_type</code> 不同字段值表示的事件类型对应如下:</p><ul><li><p class="paragraph"><code class="lang-kotlin">message</code>:消息事件</p></li><li><p class="paragraph"><code class="lang-kotlin">notice</code>:通知事件</p></li><li><p class="paragraph"><code class="lang-kotlin">request</code>:请求事件</p></li><li><p class="paragraph"><code class="lang-kotlin">meta_event</code>:元事件</p></li></ul><span class="kdoc-tag"><h4 class="">Author</h4><p class="paragraph">ForteScarlet</p></span><h4 class="">Inheritors</h4><div class="table"><div class="table-row" data-filterable-current=":simbot-component-onebot-v11:simbot-component-onebot-v11-event:dokkaHtmlPartial/commonMain" data-filterable-set=":simbot-component-onebot-v11:simbot-component-onebot-v11-event:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-unknown-event/index.html">UnknownEvent</a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":simbot-component-onebot-v11:simbot-component-onebot-v11-event:dokkaHtmlPartial/commonMain" data-filterable-set=":simbot-component-onebot-v11:simbot-component-onebot-v11-event:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../../love.forte.simbot.component.onebot.v11.event.message/-raw-message-event/index.html">RawMessageEvent</a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":simbot-component-onebot-v11:simbot-component-onebot-v11-event:dokkaHtmlPartial/commonMain" data-filterable-set=":simbot-component-onebot-v11:simbot-component-onebot-v11-event:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../../love.forte.simbot.component.onebot.v11.event.meta/-raw-meta-event/index.html">RawMetaEvent</a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":simbot-component-onebot-v11:simbot-component-onebot-v11-event:dokkaHtmlPartial/commonMain" data-filterable-set=":simbot-component-onebot-v11:simbot-component-onebot-v11-event:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../../love.forte.simbot.component.onebot.v11.event.notice/-raw-notice-event/index.html">RawNoticeEvent</a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":simbot-component-onebot-v11:simbot-component-onebot-v11-event:dokkaHtmlPartial/commonMain" data-filterable-set=":simbot-component-onebot-v11:simbot-component-onebot-v11-event:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../../love.forte.simbot.component.onebot.v11.event.request/-raw-request-event/index.html">RawRequestEvent</a></div></span></div><div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":simbot-component-onebot-v11:simbot-component-onebot-v11-event:dokkaHtmlPartial/commonMain"><div class="symbol monospace"><span class="token keyword">interface </span><a href="index.html">RawEvent</a><span class="clearfix"><span class="floating-right">(<a href="https://github.com/simple-robot/simbot-component-onebot/tree/dev/main/simbot-component-onebot-v11/simbot-component-onebot-v11-event/src//commonMain/kotlin/love/forte/simbot/component/onebot/v11/event/RawEvent.kt#L66">source</a>)</span></span></div><p class="paragraph">OneBot11的<a href="https://github.com/botuniverse/onebot-11/tree/master/event">事件</a></p><p class="paragraph">这是 OneBot11 原始的事件对象结构体的定义,不是对simbot Event的实现,它的所有最终具体实现类均为普通的不可变数据类。</p><h2 class="">实例化与兼容性</h2><p class="paragraph">此原始事件类型是用于序列化交互的数据类,它应当仅通过反序列化被构建,不建议直接使用它们的构造方式进行构建, 也不保证它们的构造对外具有二进制兼容性。</p><h2 class="">基本描述</h2><blockquote class="quotation"><p class="paragraph">下述内容来自OneBot11文档。</p></blockquote><p class="paragraph">事件是用户需要从 OneBot 被动接收的数据,有以下几个大类:</p><ul><li><p class="paragraph">消息事件,包括私聊消息、群消息等</p></li><li><p class="paragraph">通知事件,包括群成员变动、好友变动等</p></li><li><p class="paragraph">请求事件,包括加群请求、加好友请求等</p></li><li><p class="paragraph">元事件,包括 OneBot 生命周期、心跳等</p></li></ul><p class="paragraph">在所有能够推送事件的通信方式中(HTTP POST、正向和反向 WebSocket),事件都以 JSON 格式表示。</p><h3 class="">内容字段</h3><p class="paragraph">每个事件都有 <code class="lang-kotlin">time</code><code class="lang-kotlin">self_id</code><code class="lang-kotlin">post_type</code> 字段,如下:</p><table><thead><tr><th>字段名</th><th>数据类型</th><th>说明</th></tr></thead><tbody><tr><td><code class="org.jetbrains.dokka.pages.commenttable@2d8cbda9 lang-kotlin">time</code></td><td>number (int64)</td><td>事件发生的时间戳</td></tr><tr><td><code class="org.jetbrains.dokka.pages.commenttable@2d8cbda9 lang-kotlin">self_id</code></td><td>number (int64)</td><td>收到事件的机器人 QQ 号</td></tr><tr><td><code class="org.jetbrains.dokka.pages.commenttable@2d8cbda9 lang-kotlin">post_type</code></td><td>string</td><td>事件类型</td></tr></tbody></table><p class="paragraph">其中 <code class="lang-kotlin">post_type</code> 不同字段值表示的事件类型对应如下:</p><ul><li><p class="paragraph"><code class="lang-kotlin">message</code>:消息事件</p></li><li><p class="paragraph"><code class="lang-kotlin">notice</code>:通知事件</p></li><li><p class="paragraph"><code class="lang-kotlin">request</code>:请求事件</p></li><li><p class="paragraph"><code class="lang-kotlin">meta_event</code>:元事件</p></li></ul><span class="kdoc-tag"><h4 class="">Author</h4><p class="paragraph">ForteScarlet</p></span><h4 class="">Inheritors</h4><div class="table"><div class="table-row" data-filterable-current=":simbot-component-onebot-v11:simbot-component-onebot-v11-event:dokkaHtmlPartial/commonMain" data-filterable-set=":simbot-component-onebot-v11:simbot-component-onebot-v11-event:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../-unknown-event/index.html">UnknownEvent</a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":simbot-component-onebot-v11:simbot-component-onebot-v11-event:dokkaHtmlPartial/commonMain" data-filterable-set=":simbot-component-onebot-v11:simbot-component-onebot-v11-event:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../../love.forte.simbot.component.onebot.v11.event.message/-raw-message-event/index.html">RawMessageEvent</a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":simbot-component-onebot-v11:simbot-component-onebot-v11-event:dokkaHtmlPartial/commonMain" data-filterable-set=":simbot-component-onebot-v11:simbot-component-onebot-v11-event:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../../love.forte.simbot.component.onebot.v11.event.meta/-raw-meta-event/index.html">RawMetaEvent</a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":simbot-component-onebot-v11:simbot-component-onebot-v11-event:dokkaHtmlPartial/commonMain" data-filterable-set=":simbot-component-onebot-v11:simbot-component-onebot-v11-event:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../../love.forte.simbot.component.onebot.v11.event.notice/-raw-notice-event/index.html">RawNoticeEvent</a></div></span></div><div></div></div></div><div class="table-row" data-filterable-current=":simbot-component-onebot-v11:simbot-component-onebot-v11-event:dokkaHtmlPartial/commonMain" data-filterable-set=":simbot-component-onebot-v11:simbot-component-onebot-v11-event:dokkaHtmlPartial/commonMain"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><a href="../../love.forte.simbot.component.onebot.v11.event.request/-raw-request-event/index.html">RawRequestEvent</a></div></span></div><div></div></div></div></div></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></div>
Expand Down
Loading

0 comments on commit 1c20d36

Please sign in to comment.