mirror of
https://github.com/LiteyukiStudio/LiteyukiBot.git
synced 2024-11-28 20:54:50 +08:00
2 lines
21 KiB
JavaScript
2 lines
21 KiB
JavaScript
import{_ as a,c as s,a7 as t,o as i}from"./chunks/framework.Z6UMW4JZ.js";const c=JSON.parse('{"title":"liteyuki.session.models","description":"","frontmatter":{"title":"liteyuki.session.models"},"headers":[],"relativePath":"dev/api/session/models.md","filePath":"zh/dev/api/session/models.md","lastUpdated":null}'),n={name:"dev/api/session/models.md"};function r(o,e,l,h,d,k){return i(),s("div",null,e[0]||(e[0]=[t('<h1 id="模块-liteyuki-session-models" tabindex="-1"><strong>模块</strong> <code>liteyuki.session.models</code> <a class="header-anchor" href="#模块-liteyuki-session-models" aria-label="Permalink to "**模块** `liteyuki.session.models`""></a></h1><p>本模块使用了<a href="https://github.com/RF-Tar-Railt/nonebot-plugin-uninfo" target="_blank" rel="noreferrer">nonebot-plugin-uninfo</a>的部分模型定义 MIT License</p><p>Copyright (c) 2024 RF-Tar-Railt</p><p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p><p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p><p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p><h3 id="class-scenetype-int-enum" tabindex="-1"><em><strong>class</strong></em> <code>SceneType(int, Enum)</code> <a class="header-anchor" href="#class-scenetype-int-enum" aria-label="Permalink to "***class*** `SceneType(int, Enum)`""></a></h3><h4 id="attr-private-0" tabindex="-1"><em><strong>attr</strong></em> <code>PRIVATE = 0</code> <a class="header-anchor" href="#attr-private-0" aria-label="Permalink to "***attr*** `PRIVATE = 0`""></a></h4><h4 id="attr-group-1" tabindex="-1"><em><strong>attr</strong></em> <code>GROUP = 1</code> <a class="header-anchor" href="#attr-group-1" aria-label="Permalink to "***attr*** `GROUP = 1`""></a></h4><h4 id="attr-guild-2" tabindex="-1"><em><strong>attr</strong></em> <code>GUILD = 2</code> <a class="header-anchor" href="#attr-guild-2" aria-label="Permalink to "***attr*** `GUILD = 2`""></a></h4><h4 id="attr-channel-text-3" tabindex="-1"><em><strong>attr</strong></em> <code>CHANNEL_TEXT = 3</code> <a class="header-anchor" href="#attr-channel-text-3" aria-label="Permalink to "***attr*** `CHANNEL_TEXT = 3`""></a></h4><h4 id="attr-channel-category-4" tabindex="-1"><em><strong>attr</strong></em> <code>CHANNEL_CATEGORY = 4</code> <a class="header-anchor" href="#attr-channel-category-4" aria-label="Permalink to "***attr*** `CHANNEL_CATEGORY = 4`""></a></h4><h4 id="attr-channel-voice-5" tabindex="-1"><em><strong>attr</strong></em> <code>CHANNEL_VOICE = 5</code> <a class="header-anchor" href="#attr-channel-voice-5" aria-label="Permalink to "***attr*** `CHANNEL_VOICE = 5`""></a></h4><h3 id="class-user-basemodel" tabindex="-1"><em><strong>class</strong></em> <code>User(BaseModel)</code> <a class="header-anchor" href="#class-user-basemodel" aria-label="Permalink to "***class*** `User(BaseModel)`""></a></h3><h4 id="attr-id-str-no-default" tabindex="-1"><em><strong>attr</strong></em> <code>id: str = NO_DEFAULT</code> <a class="header-anchor" href="#attr-id-str-no-default" aria-label="Permalink to "***attr*** `id: str = NO_DEFAULT`""></a></h4><h4 id="attr-name-str-none-none" tabindex="-1"><em><strong>attr</strong></em> <code>name: str | None = None</code> <a class="header-anchor" href="#attr-name-str-none-none" aria-label="Permalink to "***attr*** `name: str | None = None`""></a></h4><h4 id="attr-nick-str-none-none" tabindex="-1"><em><strong>attr</strong></em> <code>nick: str | None = None</code> <a class="header-anchor" href="#attr-nick-str-none-none" aria-label="Permalink to "***attr*** `nick: str | None = None`""></a></h4><h4 id="attr-avatar-str-none-none" tabindex="-1"><em><strong>attr</strong></em> <code>avatar: str | None = None</code> <a class="header-anchor" href="#attr-avatar-str-none-none" aria-label="Permalink to "***attr*** `avatar: str | None = None`""></a></h4><h4 id="attr-gender-str-none-none" tabindex="-1"><em><strong>attr</strong></em> <code>gender: str | None = None</code> <a class="header-anchor" href="#attr-gender-str-none-none" aria-label="Permalink to "***attr*** `gender: str | None = None`""></a></h4><h3 id="class-scene-basemodel" tabindex="-1"><em><strong>class</strong></em> <code>Scene(BaseModel)</code> <a class="header-anchor" href="#class-scene-basemodel" aria-label="Permalink to "***class*** `Scene(BaseModel)`""></a></h3><h4 id="attr-id-str-no-default-1" tabindex="-1"><em><strong>attr</strong></em> <code>id: str = NO_DEFAULT</code> <a class="header-anchor" href="#attr-id-str-no-default-1" aria-label="Permalink to "***attr*** `id: str = NO_DEFAULT`""></a></h4><h4 id="attr-type-scenetype-no-default" tabindex="-1"><em><strong>attr</strong></em> <code>type: SceneType = NO_DEFAULT</code> <a class="header-anchor" href="#attr-type-scenetype-no-default" aria-label="Permalink to "***attr*** `type: SceneType = NO_DEFAULT`""></a></h4><h4 id="attr-name-str-none-none-1" tabindex="-1"><em><strong>attr</strong></em> <code>name: str | None = None</code> <a class="header-anchor" href="#attr-name-str-none-none-1" aria-label="Permalink to "***attr*** `name: str | None = None`""></a></h4><h4 id="attr-avatar-str-none-none-1" tabindex="-1"><em><strong>attr</strong></em> <code>avatar: str | None = None</code> <a class="header-anchor" href="#attr-avatar-str-none-none-1" aria-label="Permalink to "***attr*** `avatar: str | None = None`""></a></h4><h4 id="attr-parent-scene-none-none" tabindex="-1"><em><strong>attr</strong></em> <code>parent: 'Scene | None' = None</code> <a class="header-anchor" href="#attr-parent-scene-none-none" aria-label="Permalink to "***attr*** `parent: 'Scene | None' = None`""></a></h4><h3 id="class-role-basemodel" tabindex="-1"><em><strong>class</strong></em> <code>Role(BaseModel)</code> <a class="header-anchor" href="#class-role-basemodel" aria-label="Permalink to "***class*** `Role(BaseModel)`""></a></h3><h4 id="attr-id-str-no-default-2" tabindex="-1"><em><strong>attr</strong></em> <code>id: str = NO_DEFAULT</code> <a class="header-anchor" href="#attr-id-str-no-default-2" aria-label="Permalink to "***attr*** `id: str = NO_DEFAULT`""></a></h4><h4 id="attr-level-int-none-none" tabindex="-1"><em><strong>attr</strong></em> <code>level: int | None = None</code> <a class="header-anchor" href="#attr-level-int-none-none" aria-label="Permalink to "***attr*** `level: int | None = None`""></a></h4><h4 id="attr-name-str-none-none-2" tabindex="-1"><em><strong>attr</strong></em> <code>name: str | None = None</code> <a class="header-anchor" href="#attr-name-str-none-none-2" aria-label="Permalink to "***attr*** `name: str | None = None`""></a></h4><h3 id="class-member-basemodel" tabindex="-1"><em><strong>class</strong></em> <code>Member(BaseModel)</code> <a class="header-anchor" href="#class-member-basemodel" aria-label="Permalink to "***class*** `Member(BaseModel)`""></a></h3><h4 id="attr-user-user-no-default" tabindex="-1"><em><strong>attr</strong></em> <code>user: User = NO_DEFAULT</code> <a class="header-anchor" href="#attr-user-user-no-default" aria-label="Permalink to "***attr*** `user: User = NO_DEFAULT`""></a></h4><h4 id="attr-nickname-str-none-none" tabindex="-1"><em><strong>attr</strong></em> <code>nickname: str | None = None</code> <a class="header-anchor" href="#attr-nickname-str-none-none" aria-label="Permalink to "***attr*** `nickname: str | None = None`""></a></h4><h4 id="attr-role-role-none-none" tabindex="-1"><em><strong>attr</strong></em> <code>role: Role | None = None</code> <a class="header-anchor" href="#attr-role-role-none-none" aria-label="Permalink to "***attr*** `role: Role | None = None`""></a></h4><h4 id="attr-mute-bool-none-none" tabindex="-1"><em><strong>attr</strong></em> <code>mute: bool | None = None</code> <a class="header-anchor" href="#attr-mute-bool-none-none" aria-label="Permalink to "***attr*** `mute: bool | None = None`""></a></h4><h4 id="attr-joined-at-datetime-none-none" tabindex="-1"><em><strong>attr</strong></em> <code>joined_at: datetime | None = None</code> <a class="header-anchor" href="#attr-joined-at-datetime-none-none" aria-label="Permalink to "***attr*** `joined_at: datetime | None = None`""></a></h4><h3 id="class-session-basemodel" tabindex="-1"><em><strong>class</strong></em> <code>Session(BaseModel)</code> <a class="header-anchor" href="#class-session-basemodel" aria-label="Permalink to "***class*** `Session(BaseModel)`""></a></h3><hr><p><a href="https://docs.python.org/3/library/functions.html#property" target="_blank" rel="noreferrer"><code>@property</code></a></p><h4 id="func-session-id-self" tabindex="-1"><em><strong>func</strong></em> <code>session_id(self)</code> <a class="header-anchor" href="#func-session-id-self" aria-label="Permalink to "***func*** `session_id(self)`""></a></h4><details><summary><b>源代码</b> 或 <a href="https://github.com/LiteyukiStudio/LiteyukiBot/tree/main/liteyuki/session/models.py#L122" 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:#6F42C1;--shiki-dark:#B392F0;">@</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">property</span></span>\n<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">def</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> session_id</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(self):</span></span>\n<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> if</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> self</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">.scope </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">==</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> SceneType.</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">PRIVATE</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">:</span></span>\n<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> f</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">{self</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">.scope</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">}</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">:</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">{self</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">.user.id</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">}</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'</span></span>\n<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> elif</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> self</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">.scope </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">in</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (SceneType.</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">GROUP</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, SceneType.</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">GUILD</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, SceneType.</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">CHANNEL_TEXT</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, SceneType.</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">CHANNEL_VOICE</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, SceneType.</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">CHANNEL_CATEGORY</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">):</span></span>\n<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> f</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">{self</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">.scope</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">}</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">:</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">{self</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">.scene.id</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">}</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'</span></span>\n<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> else</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">:</span></span>\n<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> raise</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> ValueError</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'Invalid SceneType'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)</span></span></code></pre></div></details><hr><p><a href="https://docs.python.org/3/library/functions.html#property" target="_blank" rel="noreferrer"><code>@property</code></a></p><h4 id="func-target-id-self" tabindex="-1"><em><strong>func</strong></em> <code>target_id(self)</code> <a class="header-anchor" href="#func-target-id-self" aria-label="Permalink to "***func*** `target_id(self)`""></a></h4><details><summary><b>源代码</b> 或 <a href="https://github.com/LiteyukiStudio/LiteyukiBot/tree/main/liteyuki/session/models.py#L137" 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:#6F42C1;--shiki-dark:#B392F0;">@</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">property</span></span>\n<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">def</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> target_id</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(self):</span></span>\n<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> if</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> self</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">.scope </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">==</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> SceneType.</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">PRIVATE</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">:</span></span>\n<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> f</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">{self</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">.scope</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">}</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">:</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">{self</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">.user.id</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">}</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'</span></span>\n<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> elif</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> self</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">.scope </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">in</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (SceneType.</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">GROUP</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, SceneType.</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">GUILD</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, SceneType.</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">CHANNEL_TEXT</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, SceneType.</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">CHANNEL_VOICE</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, SceneType.</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">CHANNEL_CATEGORY</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">):</span></span>\n<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> f</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">{self</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">.scope</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">}</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">:</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">{self</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">.scene.id</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">}</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">:</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">{self</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">.user.id</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">}</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'</span></span></code></pre></div></details><h4 id="attr-self-id-str-no-default" tabindex="-1"><em><strong>attr</strong></em> <code>self_id: str = NO_DEFAULT</code> <a class="header-anchor" href="#attr-self-id-str-no-default" aria-label="Permalink to "***attr*** `self_id: str = NO_DEFAULT`""></a></h4><h4 id="attr-adapter-str-no-default" tabindex="-1"><em><strong>attr</strong></em> <code>adapter: str = NO_DEFAULT</code> <a class="header-anchor" href="#attr-adapter-str-no-default" aria-label="Permalink to "***attr*** `adapter: str = NO_DEFAULT`""></a></h4><h4 id="attr-scope-str-no-default" tabindex="-1"><em><strong>attr</strong></em> <code>scope: str = NO_DEFAULT</code> <a class="header-anchor" href="#attr-scope-str-no-default" aria-label="Permalink to "***attr*** `scope: str = NO_DEFAULT`""></a></h4><h4 id="attr-scene-scene-no-default" tabindex="-1"><em><strong>attr</strong></em> <code>scene: Scene = NO_DEFAULT</code> <a class="header-anchor" href="#attr-scene-scene-no-default" aria-label="Permalink to "***attr*** `scene: Scene = NO_DEFAULT`""></a></h4><h4 id="attr-user-user-no-default-1" tabindex="-1"><em><strong>attr</strong></em> <code>user: User = NO_DEFAULT</code> <a class="header-anchor" href="#attr-user-user-no-default-1" aria-label="Permalink to "***attr*** `user: User = NO_DEFAULT`""></a></h4><h4 id="attr-member-member-none-none" tabindex="-1"><em><strong>attr</strong></em> <code>member: 'Member | None' = None</code> <a class="header-anchor" href="#attr-member-member-none-none" aria-label="Permalink to "***attr*** `member: 'Member | None' = None`""></a></h4><h4 id="attr-operator-member-none-none" tabindex="-1"><em><strong>attr</strong></em> <code>operator: 'Member | None' = None</code> <a class="header-anchor" href="#attr-operator-member-none-none" aria-label="Permalink to "***attr*** `operator: 'Member | None' = None`""></a></h4>',51)]))}const g=a(n,[["render",r]]);export{c as __pageData,g as default};
|