app/dev/api/session/on.html

41 lines
58 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html lang="zh-Hans" dir="ltr">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>liteyuki.session.on | 轻雪机器人</title>
<meta name="description" content="一个综合性的机器人应用及管理框架">
<meta name="generator" content="VitePress v1.5.0">
<link rel="preload stylesheet" href="/assets/style.BfN3dudV.css" as="style">
<link rel="preload stylesheet" href="/vp-icons.css" as="style">
<script type="module" src="/assets/app.b7VqzLdQ.js"></script>
<link rel="preload" href="/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
<link rel="modulepreload" href="/assets/chunks/theme.CSD71KFr.js">
<link rel="modulepreload" href="/assets/chunks/framework.Z6UMW4JZ.js">
<link rel="modulepreload" href="/assets/dev_api_session_on.md.mdi0h2yr.lean.js">
<link rel="icon" type="image/x-icon" href="favicon.ico">
<link rel="stylesheet" href="https://fonts.font.im/css?family=Cousine:400,400i,700,700i|Poppins:100,100i,200,200i,300,300i,400,400i,500,500i,600,600i,700,700i,800,800i,900,900i">
<script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
</head>
<body>
<div id="app"><div class="Layout" data-v-2391887b data-v-23f2dbb5><!--[--><!--]--><!--[--><span tabindex="-1" data-v-98f7e91e></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-98f7e91e> Skip to content </a><!--]--><!----><header class="VPNav" data-v-23f2dbb5 data-v-429592cd><div class="VPNavBar" data-v-429592cd data-v-10635b05><div class="wrapper" data-v-10635b05><div class="container" data-v-10635b05><div class="title" data-v-10635b05><div class="VPNavBarTitle has-sidebar" data-v-10635b05 data-v-c02215d3><a class="title" href="/" data-v-c02215d3><!--[--><!--]--><!--[--><!--[--><!--[--><img class="VPImage dark logo" src="/liteyuki-dark.svg" alt="LiteyukiBot Logo" data-v-2d9b5d5a><!--]--><!--[--><img class="VPImage light logo" src="/liteyuki.svg" alt="LiteyukiBot Logo" data-v-2d9b5d5a><!--]--><!--]--><!--]--><span data-v-c02215d3>轻雪机器人</span><!--[--><!--]--></a></div></div><div class="content" data-v-10635b05><div class="content-body" data-v-10635b05><!--[--><!--]--><div class="VPNavBarSearch search" data-v-10635b05><!--[--><!----><div id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="打开搜索框"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">搜索文档</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-10635b05 data-v-c770cea4><span id="main-nav-aria-label" class="visually-hidden" data-v-c770cea4> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/deploy/install.html" tabindex="0" data-v-c770cea4 data-v-585d7f08><!--[--><span data-v-585d7f08>部署</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/usage/basic.html" tabindex="0" data-v-c770cea4 data-v-585d7f08><!--[--><span data-v-585d7f08>使用</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/store/resource.html" tabindex="0" data-v-c770cea4 data-v-585d7f08><!--[--><span data-v-585d7f08>扩展</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/dev/guide.html" tabindex="0" data-v-c770cea4 data-v-585d7f08><!--[--><span data-v-585d7f08>开发</span><!--]--></a><!--]--><!--]--></nav><div class="VPFlyout VPNavBarTranslations translations" data-v-10635b05 data-v-ea07652c data-v-00df721d><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="语言" data-v-00df721d><span class="text" data-v-00df721d><span class="vpi-languages option-icon" data-v-00df721d></span><!----><span class="vpi-chevron-down text-icon" data-v-00df721d></span></span></button><div class="menu" data-v-00df721d><div class="VPMenu" data-v-00df721d data-v-464b5fd9><!----><!--[--><!--[--><div class="items" data-v-ea07652c><p class="title" data-v-ea07652c>简体中文</p><!--[--><div class="VPMenuLink" data-v-ea07652c data-v-a5f22fa3><a class="VPLink link" href="/en/dev/api/session/on.html" data-v-a5f22fa3><!--[--><span data-v-a5f22fa3>English</span><!--]--></a></div><!--]--></div><!--]--><!--]--></div></div></div><div class="VPNavBarAppearance appearance" data-v-10635b05 data-v-728194a1><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-728194a1 data-v-e93e4f13 data-v-bbaa0fff><span class="check" data-v-bbaa0fff><span class="icon" data-v-bbaa0fff><!--[--><span class="vpi-sun sun" data-v-e93e4f13></span><span class="vpi-moon moon" data-v-e93e4f13></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-10635b05 data-v-a6a40077 data-v-2b2d05f2><!--[--><a class="VPSocialLink no-icon" href="https://github.com/LiteyukiStudio/LiteyukiBot" aria-label="github" target="_blank" rel="noopener" data-v-2b2d05f2 data-v-d27afe3a><span class="vpi-social-github"></span></a><a class="VPSocialLink no-icon" hre
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> for</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> i, m </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">in</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> enumerate</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(_matcher_list):</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> if</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> m.priority </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">&lt;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> matcher.priority:</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> _matcher_list.insert(i, matcher)</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> break</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> else</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">:</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> _matcher_list.append(matcher)</span></span></code></pre></div></details><hr><h3 id="func-on-message-rule-rule-empty-rule-priority-int-0-block-bool-false-matcher" tabindex="-1"><em><strong>func</strong></em> <code>on_message(rule: Rule = empty_rule, priority: int = 0, block: bool = False) -&gt; Matcher</code> <a class="header-anchor" href="#func-on-message-rule-rule-empty-rule-priority-int-0-block-bool-false-matcher" aria-label="Permalink to &quot;***func*** `on_message(rule: Rule = empty_rule, priority: int = 0, block: bool = False) -&gt; Matcher`&quot;"></a></h3><details><summary><b>源代码</b><a href="https://github.com/LiteyukiStudio/LiteyukiBot/tree/main/liteyuki/session/on.py#L30" target="_blank">在GitHub上查看</a></summary><div class="language-python vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">python</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">def</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> on_message</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(rule: Rule</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">empty_rule, priority: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">int</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">0</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, block: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">bool</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">False</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) -&gt; Matcher:</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> matcher </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> Matcher(rule, priority, block)</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> add_matcher(matcher)</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> matcher</span></span></code></pre></div></details><hr><h3 id="func-on-keywords-keywords-list-str-rule-empty-rule-priority-int-0-block-bool-false-matcher" tabindex="-1"><em><strong>func</strong></em> <code>on_keywords(keywords: list[str], rule = empty_rule, priority: int = 0, block: bool = False) -&gt; Matcher</code> <a class="header-anchor" href="#func-on-keywords-keywords-list-str-rule-empty-rule-priority-int-0-block-bool-false-matcher" aria-label="Permalink to &quot;***func*** `on_keywords(keywords: list[str], rule = empty_rule, priority: int = 0, block: bool = False) -&gt; Matcher`&quot;"></a></h3><details><summary><b>源代码</b><a href="https://github.com/LiteyukiStudio/LiteyukiBot/tree/main/liteyuki/session/on.py#L37" target="_blank">在GitHub上查看</a></summary><div class="language-python vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">python</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">def</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> on_keywords</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(keywords: list[</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">str</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">], rule</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">empty_rule, priority: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">int</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">0</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, block: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">bool</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">False</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) -&gt; Matcher:</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> @Rule</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> async</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> def</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> on_keywords_rule</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(event: MessageEvent):</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> any</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">((keyword </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">in</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> event.raw_message </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">for</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> keyword </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">in</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> keywords))</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> on_message(on_keywords_rule </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">&amp;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> rule, priority, block)</span></span></code></pre></div></details></div></div></main><footer class="VPDocFooter" data-v-d6b08857 data-v-91eea559><!--[--><!--]--><div class="edit-info" data-v-91eea559><div class="edit-link" data-v-91eea559><a class="VPLink link vp-external-link-icon no-icon edit-link-button" href="https://github.com/LiteyukiStudio/LiteyukiBot/tree/main/liteyuki/session/on.py" target="_blank" rel="noreferrer" data-v-91eea559><!--[--><span class="vpi-square-pen edit-link-icon" data-v-91eea559></span> 在 GitHub 上编辑此页<!--]--></a></div><!----></div><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-91eea559><span class="visually-hidden" id="doc-footer-aria-label" data-v-91eea559>Pager</span><div class="pager" data-v-91eea559><a class="VPLink link pager-link prev" href="/dev/api/session/models.html" data-v-91eea559><!--[--><span class="desc" data-v-91eea559>上一页</span><span class="title" data-v-91eea559>liteyuki.session.models</span><!--]--></a></div><div class="pager" data-v-91eea559><a class="VPLink link pager-link next" href="/dev/api/session/rule.html" data-v-91eea559><!--[--><span class="desc" data-v-91eea559>下一页</span><span class="title" data-v-91eea559>liteyuki.session.rule</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><footer class="VPFooter has-sidebar" data-v-23f2dbb5 data-v-a2f9475f><div class="container" data-v-a2f9475f><p class="message" data-v-a2f9475f>文档由 <a href="https://vitepress.dev/">VitePress</a> 构建 | API引用由 <a href="https://github.com/LiteyukiStudio/litedoc">litedoc</a> 生成</p><p class="copyright" data-v-a2f9475f>Copyright (C) 2020-2024 LiteyukiStudio. All Rights Reserved</p></div></footer><!--[--><!--]--></div></div>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"deploy_config.md\":\"DXDUh0IQ\",\"deploy_fandq.md\":\"WJVBpMIc\",\"deploy_install.md\":\"xQ7_cYmn\",\"dev_api_bot_index.md\":\"BBSYa412\",\"dev_api_bot_lifespan.md\":\"DIiUoNQr\",\"dev_api_comm_channel.md\":\"DfvNcb-v\",\"dev_api_comm_event.md\":\"D22ZPMRO\",\"dev_api_comm_index.md\":\"4xQqkPaL\",\"dev_api_comm_storage.md\":\"BQi3vT-6\",\"dev_api_config.md\":\"DakK5wgv\",\"dev_api_core_index.md\":\"DDI0LXZQ\",\"dev_api_core_manager.md\":\"mhcXWvCp\",\"dev_api_dev_index.md\":\"CsugCBSr\",\"dev_api_dev_observer.md\":\"CynjhkUR\",\"dev_api_dev_plugin.md\":\"DDM2McYa\",\"dev_api_exception.md\":\"DOgHxE0z\",\"dev_api_index.md\":\"D52Y-HJX\",\"dev_api_log.md\":\"BybOhf50\",\"dev_api_plugin_index.md\":\"DZxV6Tb_\",\"dev_api_plugin_load.md\":\"CoagWwmx\",\"dev_api_plugin_manager.md\":\"CnP65Tni\",\"dev_api_plugin_model.md\":\"BcoMNcwb\",\"dev_api_plugins_index.md\":\"Z4Rsdm03\",\"dev_api_plugins_liteecho.md\":\"N_eRUAPO\",\"dev_api_plugins_plugin_loader_index.md\":\"DWsFMHho\",\"dev_api_session_event.md\":\"BVxh2ZPO\",\"dev_api_session_index.md\":\"6yQBWgJr\",\"dev_api_session_matcher.md\":\"DgoYweUQ\",\"dev_api_session_message_segments.md\":\"DivW-Wd9\",\"dev_api_session_models.md\":\"Bgk7-MSv\",\"dev_api_session_on.md\":\"mdi0h2yr\",\"dev_api_session_rule.md\":\"CDnQtWE_\",\"dev_api_utils.md\":\"eMkV5aFU\",\"dev_best_practices.md\":\"cQgckalO\",\"dev_comm.md\":\"CdHIX3qu\",\"dev_guide.md\":\"CozEFyl6\",\"dev_lyfunc.md\":\"BFnTpiJ5\",\"dev_plugin.md\":\"fh6MoH8y\",\"dev_resource.md\":\"DMvQfaDn\",\"en_deploy_config.md\":\"C9aWRG-M\",\"en_deploy_fandq.md\":\"Cy9C9qw5\",\"en_deploy_install.md\":\"7tdrs7_X\",\"en_dev_api_bot_index.md\":\"D-dQtyQd\",\"en_dev_api_bot_lifespan.md\":\"BhXMIeK8\",\"en_dev_api_comm_channel.md\":\"9o4TsTD5\",\"en_dev_api_comm_event.md\":\"B6Ewcgsc\",\"en_dev_api_comm_index.md\":\"D5APenBy\",\"en_dev_api_comm_storage.md\":\"iLOczApS\",\"en_dev_api_config.md\":\"CztCBMac\",\"en_dev_api_core_index.md\":\"B0Enriow\",\"en_dev_api_core_manager.md\":\"BxSjacF3\",\"en_dev_api_dev_index.md\":\"C5EYx4Z-\",\"en_dev_api_dev_observer.md\":\"BQeg5dYN\",\"en_dev_api_dev_plugin.md\":\"BdeVORHv\",\"en_dev_api_exception.md\":\"1T6ATWif\",\"en_dev_api_index.md\":\"DXW2vEc5\",\"en_dev_api_log.md\":\"DI2PEAHZ\",\"en_dev_api_plugin_index.md\":\"DmyyE7_n\",\"en_dev_api_plugin_load.md\":\"Czs4uISw\",\"en_dev_api_plugin_manager.md\":\"COXJrHdK\",\"en_dev_api_plugin_model.md\":\"B6LpR1IQ\",\"en_dev_api_plugins_index.md\":\"lmozQLWq\",\"en_dev_api_plugins_liteecho.md\":\"yC9zAc3N\",\"en_dev_api_plugins_plugin_loader_index.md\":\"eXb8XUQw\",\"en_dev_api_session_event.md\":\"BL-c2pAQ\",\"en_dev_api_session_index.md\":\"Dy7UwvCr\",\"en_dev_api_session_matcher.md\":\"CRLHKgvR\",\"en_dev_api_session_message_segments.md\":\"2Y-Kb9rZ\",\"en_dev_api_session_models.md\":\"hBDe-9Eh\",\"en_dev_api_session_on.md\":\"CErI_ukT\",\"en_dev_api_session_rule.md\":\"Ba-MhC1J\",\"en_dev_api_utils.md\":\"CH7CaLlN\",\"en_dev_best_practices.md\":\"WpEKWBu2\",\"en_dev_comm.md\":\"O0Kndndk\",\"en_dev_guide.md\":\"985_uRl1\",\"en_dev_lyfunc.md\":\"BY5uYuEV\",\"en_dev_plugin.md\":\"BRQN74vy\",\"en_dev_resource.md\":\"BiYlUcxZ\",\"en_index.md\":\"DfdhMtWK\",\"en_store_plugin.md\":\"CvMn7nSM\",\"en_store_resource.md\":\"D47fjjFS\",\"en_usage_agreement.md\":\"DkWD4ht6\",\"en_usage_basic.md\":\"CANHEyeb\",\"en_usage_extra.md\":\"BFSmukTP\",\"index.md\":\"CkybII2w\",\"store_plugin.md\":\"D_dm7knu\",\"store_resource.md\":\"BShx39x7\",\"usage_agreement.md\":\"BP3_fXyC\",\"usage_basic.md\":\"Boduij81\",\"usage_extra.md\":\"B8D17azU\"}");function deserializeFunctions(r){return Array.isArray(r)?r.map(deserializeFunctions):typeof r=="object"&&r!==null?Object.keys(r).reduce((t,n)=>(t[n]=deserializeFunctions(r[n]),t),{}):typeof r=="string"&&r.startsWith("_vp-fn_")?new Function(`return ${r.slice(7)}`)():r};window.__VP_SITE_DATA__=deserializeFunctions(JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"VitePress\",\"description\":\"A VitePress site\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\
</body>
</html>