app/dev/api/message/on.html

40 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.message.on | 轻雪机器人</title>
<meta name="description" content="一个综合性的机器人应用及管理框架">
<meta name="generator" content="VitePress v1.3.4">
<link rel="preload stylesheet" href="/assets/style.CwisGQeI.css" as="style">
<script type="module" src="/assets/app.DQOuPfSI.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.DB99WgmP.js">
<link rel="modulepreload" href="/assets/chunks/framework.C4_mTacX.js">
<link rel="modulepreload" href="/assets/dev_api_message_on.md.CApMkdr1.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-5047c77d><!--[--><!--]--><!--[--><span tabindex="-1" data-v-5ffb6bc3></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-5ffb6bc3> Skip to content </a><!--]--><!----><header class="VPNav" data-v-5047c77d data-v-3aff48bd><div class="VPNavBar has-sidebar top" data-v-3aff48bd data-v-6db865c9><div class="wrapper" data-v-6db865c9><div class="container" data-v-6db865c9><div class="title" data-v-6db865c9><div class="VPNavBarTitle has-sidebar" data-v-6db865c9 data-v-d1e2cfaa><a class="title" href="/" data-v-d1e2cfaa><!--[--><!--]--><!--[--><!--[--><!--[--><img class="VPImage dark logo" src="/liteyuki-dark.svg" alt="LiteyukiBot Logo" data-v-e2df84be><!--]--><!--[--><img class="VPImage light logo" src="/liteyuki.svg" alt="LiteyukiBot Logo" data-v-e2df84be><!--]--><!--]--><!--]--><span data-v-d1e2cfaa>轻雪机器人</span><!--[--><!--]--></a></div></div><div class="content" data-v-6db865c9><div class="content-body" data-v-6db865c9><!--[--><!--]--><div class="VPNavBarSearch search" data-v-6db865c9><!--[--><!----><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-6db865c9 data-v-dc270a69><span id="main-nav-aria-label" class="visually-hidden" data-v-dc270a69> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/deploy/install.html" tabindex="0" data-v-dc270a69 data-v-2a328df5><!--[--><span data-v-2a328df5>部署</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/usage/basic.html" tabindex="0" data-v-dc270a69 data-v-2a328df5><!--[--><span data-v-2a328df5>使用</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/store/resource.html" tabindex="0" data-v-dc270a69 data-v-2a328df5><!--[--><span data-v-2a328df5>扩展</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/dev/guide.html" tabindex="0" data-v-dc270a69 data-v-2a328df5><!--[--><span data-v-2a328df5>开发</span><!--]--></a><!--]--><!--]--></nav><div class="VPFlyout VPNavBarTranslations translations" data-v-6db865c9 data-v-1cf30254 data-v-062a5734><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="语言" data-v-062a5734><span class="text" data-v-062a5734><span class="vpi-languages option-icon" data-v-062a5734></span><!----><span class="vpi-chevron-down text-icon" data-v-062a5734></span></span></button><div class="menu" data-v-062a5734><div class="VPMenu" data-v-062a5734 data-v-ce2cf657><!----><!--[--><!--[--><div class="items" data-v-1cf30254><p class="title" data-v-1cf30254>简体中文</p><!--[--><div class="VPMenuLink" data-v-1cf30254 data-v-01a82388><a class="VPLink link" href="/en/dev/api/message/on.html" data-v-01a82388><!--[-->English<!--]--></a></div><!--]--></div><!--]--><!--]--></div></div></div><div class="VPNavBarAppearance appearance" data-v-6db865c9 data-v-06e253f6><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title="深色模式" aria-checked="false" data-v-06e253f6 data-v-d86ee44f data-v-be0da757><span class="check" data-v-be0da757><span class="icon" data-v-be0da757><!--[--><span class="vpi-sun sun" data-v-d86ee44f></span><span class="vpi-moon moon" data-v-d86ee44f></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-6db865c9 data-v-489228c3 data-v-ca9cff1c><!--[--><a class="VPSocialLink no-icon" href="https://github.com/LiteyukiStudio/LiteyukiBot" aria-label="github" target="_blank" rel="noopener" data-v-ca9cff1c data-v-99aaa61b><span class="vpi-social-github" /></a><a class="VPSocialLink no-icon" href="
<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/message/on.py#L50" 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/message/on.py#L57" 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-1c9751e9 data-v-655c432b><!--[--><!--]--><div class="edit-info" data-v-655c432b><div class="edit-link" data-v-655c432b><a class="VPLink link vp-external-link-icon no-icon edit-link-button" href="https://github.com/LiteyukiStudio/LiteyukiBot/tree/main/liteyuki/message/on.py" target="_blank" rel="noreferrer" data-v-655c432b><!--[--><span class="vpi-square-pen edit-link-icon" data-v-655c432b></span> 在 GitHub 上编辑此页<!--]--></a></div><!----></div><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-655c432b><span class="visually-hidden" id="doc-footer-aria-label" data-v-655c432b>Pager</span><div class="pager" data-v-655c432b><a class="VPLink link pager-link prev" href="/dev/api/message/matcher.html" data-v-655c432b><!--[--><span class="desc" data-v-655c432b>上一页</span><span class="title" data-v-655c432b>liteyuki.message.matcher</span><!--]--></a></div><div class="pager" data-v-655c432b><a class="VPLink link pager-link next" href="/dev/api/message/rule.html" data-v-655c432b><!--[--><span class="desc" data-v-655c432b>下一页</span><span class="title" data-v-655c432b>liteyuki.message.rule</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><footer class="VPFooter has-sidebar" data-v-5047c77d data-v-1a52749f><div class="container" data-v-1a52749f><p class="message" data-v-1a52749f>文档由 <a href="https://vitepress.dev/">VitePress</a> 构建 | API引用由 <a href="https://github.com/LiteyukiStudio/litedoc">litedoc</a> 生成</p><p class="copyright" data-v-1a52749f>Copyright (C) 2020-2024 LiteyukiStudio. All Rights Reserved</p></div></footer><!--[--><!--]--></div></div>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"deploy_config.md\":\"BBoJ_SVs\",\"deploy_fandq.md\":\"D3AaSKzf\",\"deploy_install.md\":\"DMcLeaSP\",\"dev_api_bot_index.md\":\"CygawBD3\",\"dev_api_bot_lifespan.md\":\"DBf_PC3G\",\"dev_api_comm_channel.md\":\"B_Q8RkLg\",\"dev_api_comm_event.md\":\"Dkw9vL8j\",\"dev_api_comm_index.md\":\"BubSUNVe\",\"dev_api_comm_rpc.md\":\"ZF5gW_b7\",\"dev_api_comm_socks_channel.md\":\"D0z-3box\",\"dev_api_comm_storage.md\":\"DlCQ-bAW\",\"dev_api_config.md\":\"BWciqFj4\",\"dev_api_core_index.md\":\"B0E7Phf1\",\"dev_api_core_manager.md\":\"B3hq0Rpu\",\"dev_api_dev_index.md\":\"Chgr0inF\",\"dev_api_dev_observer.md\":\"DXfnQgLO\",\"dev_api_dev_plugin.md\":\"Cops7KZu\",\"dev_api_exception.md\":\"Bo7F9S9r\",\"dev_api_index.md\":\"mhROT_CR\",\"dev_api_log.md\":\"B0RBm2Ui\",\"dev_api_message_event.md\":\"DyDwsc6d\",\"dev_api_message_index.md\":\"Ox32xQC5\",\"dev_api_message_matcher.md\":\"DVuQfqJD\",\"dev_api_message_on.md\":\"CApMkdr1\",\"dev_api_message_rule.md\":\"DtsqYM0_\",\"dev_api_message_session.md\":\"Dvgy6WBS\",\"dev_api_mkdoc.md\":\"BQNdAtbl\",\"dev_api_plugin_index.md\":\"DyFjlTCa\",\"dev_api_plugin_load.md\":\"CqVkk0P5\",\"dev_api_plugin_manager.md\":\"WWoouVFL\",\"dev_api_plugin_model.md\":\"BmVr2u82\",\"dev_api_plugins_index.md\":\"kWwCXP54\",\"dev_api_plugins_liteecho.md\":\"sryx6SuS\",\"dev_api_plugins_plugin_loader_index.md\":\"DVvGETw-\",\"dev_api_utils.md\":\"wryzX8vr\",\"dev_comm.md\":\"cMJIV6AK\",\"dev_guide.md\":\"DrF3uLFc\",\"dev_lyfunc.md\":\"D4LU5X67\",\"dev_plugin.md\":\"phZolwS6\",\"dev_resource.md\":\"CiEukBtC\",\"en_deploy_config.md\":\"DdMT5vqs\",\"en_deploy_fandq.md\":\"BKc7kj27\",\"en_deploy_install.md\":\"C00Sx2cS\",\"en_dev_api_bot_index.md\":\"C4r8HhEl\",\"en_dev_api_bot_lifespan.md\":\"B-nofctY\",\"en_dev_api_comm_channel.md\":\"VoA9irwY\",\"en_dev_api_comm_event.md\":\"Crpo-bJ4\",\"en_dev_api_comm_index.md\":\"BghEev94\",\"en_dev_api_comm_rpc.md\":\"DKVp72_P\",\"en_dev_api_comm_socks_channel.md\":\"B8_s4Hv_\",\"en_dev_api_comm_storage.md\":\"WX6gT40z\",\"en_dev_api_config.md\":\"CRNFMcJd\",\"en_dev_api_core_index.md\":\"NuGEgKq2\",\"en_dev_api_core_manager.md\":\"D7QE1GyX\",\"en_dev_api_dev_index.md\":\"UZwSl7RN\",\"en_dev_api_dev_observer.md\":\"DAh-d3XU\",\"en_dev_api_dev_plugin.md\":\"ByOqvpeD\",\"en_dev_api_exception.md\":\"HPP9FBE6\",\"en_dev_api_index.md\":\"Bem5oMXv\",\"en_dev_api_log.md\":\"t5U3-0Tg\",\"en_dev_api_message_event.md\":\"C6I96y2L\",\"en_dev_api_message_index.md\":\"CTleW7FS\",\"en_dev_api_message_matcher.md\":\"CtCEbUVJ\",\"en_dev_api_message_on.md\":\"DOPTBR4O\",\"en_dev_api_message_rule.md\":\"BBaFECzV\",\"en_dev_api_message_session.md\":\"BJvZrFxU\",\"en_dev_api_mkdoc.md\":\"B0odpxJC\",\"en_dev_api_plugin_index.md\":\"ibr3u-4e\",\"en_dev_api_plugin_load.md\":\"BqElTQmm\",\"en_dev_api_plugin_manager.md\":\"LGDmEnuh\",\"en_dev_api_plugin_model.md\":\"C8mVVzkp\",\"en_dev_api_plugins_index.md\":\"CBJItUz2\",\"en_dev_api_plugins_liteecho.md\":\"BkpA_Gke\",\"en_dev_api_plugins_plugin_loader_index.md\":\"cG7vDNwD\",\"en_dev_api_utils.md\":\"DKuaapxu\",\"en_dev_comm.md\":\"DWySVBZ2\",\"en_dev_guide.md\":\"DgjQ_yt-\",\"en_dev_lyfunc.md\":\"BhYjNK3N\",\"en_dev_plugin.md\":\"CKzO3RVR\",\"en_dev_resource.md\":\"Q8AwzAyN\",\"en_index.md\":\"DS37TlOH\",\"en_store_plugin.md\":\"C0UyBVv2\",\"en_store_resource.md\":\"Ci-LBCav\",\"en_usage_agreement.md\":\"vFfahjeR\",\"en_usage_basic.md\":\"DVpsBy5w\",\"en_usage_extra.md\":\"DU-WQhbO\",\"index.md\":\"Dl11pd1E\",\"store_plugin.md\":\"BhQadjel\",\"store_resource.md\":\"CgUrr2wJ\",\"usage_agreement.md\":\"BYijSUyJ\",\"usage_basic.md\":\"CS9J19pD\",\"usage_extra.md\":\"CPLcG44C\"}");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\
</body>
</html>