|
|
<!doctype html>
|
|
|
<html class="no-js" lang="en" data-content_root="./">
|
|
|
<head><meta charset="utf-8"/>
|
|
|
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
|
|
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
|
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" />
|
|
|
|
|
|
<!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 -->
|
|
|
<title>mipac documentation</title>
|
|
|
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
|
|
|
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=135e06be" />
|
|
|
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=36a5483c" />
|
|
|
<link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=19846ea3" />
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<style>
|
|
|
body {
|
|
|
--color-code-background: #f8f8f8;
|
|
|
--color-code-foreground: black;
|
|
|
|
|
|
}
|
|
|
@media not print {
|
|
|
body[data-theme="dark"] {
|
|
|
--color-code-background: #202020;
|
|
|
--color-code-foreground: #d0d0d0;
|
|
|
|
|
|
}
|
|
|
@media (prefers-color-scheme: dark) {
|
|
|
body:not([data-theme="light"]) {
|
|
|
--color-code-background: #202020;
|
|
|
--color-code-foreground: #d0d0d0;
|
|
|
|
|
|
}
|
|
|
}
|
|
|
}
|
|
|
</style></head>
|
|
|
<body>
|
|
|
|
|
|
<script>
|
|
|
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
|
|
</script>
|
|
|
|
|
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
|
|
<symbol id="svg-toc" viewBox="0 0 24 24">
|
|
|
<title>Contents</title>
|
|
|
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
|
|
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
|
|
</svg>
|
|
|
</symbol>
|
|
|
<symbol id="svg-menu" viewBox="0 0 24 24">
|
|
|
<title>Menu</title>
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
|
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
|
|
<line x1="3" y1="12" x2="21" y2="12"></line>
|
|
|
<line x1="3" y1="6" x2="21" y2="6"></line>
|
|
|
<line x1="3" y1="18" x2="21" y2="18"></line>
|
|
|
</svg>
|
|
|
</symbol>
|
|
|
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
|
|
<title>Expand</title>
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
|
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
|
|
<polyline points="9 18 15 12 9 6"></polyline>
|
|
|
</svg>
|
|
|
</symbol>
|
|
|
<symbol id="svg-sun" viewBox="0 0 24 24">
|
|
|
<title>Light mode</title>
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
|
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
|
|
<circle cx="12" cy="12" r="5"></circle>
|
|
|
<line x1="12" y1="1" x2="12" y2="3"></line>
|
|
|
<line x1="12" y1="21" x2="12" y2="23"></line>
|
|
|
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
|
|
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
|
|
<line x1="1" y1="12" x2="3" y2="12"></line>
|
|
|
<line x1="21" y1="12" x2="23" y2="12"></line>
|
|
|
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
|
|
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
|
|
</svg>
|
|
|
</symbol>
|
|
|
<symbol id="svg-moon" viewBox="0 0 24 24">
|
|
|
<title>Dark mode</title>
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
|
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
|
|
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
|
|
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
|
|
</svg>
|
|
|
</symbol>
|
|
|
<symbol id="svg-sun-half" viewBox="0 0 24 24">
|
|
|
<title>Auto light/dark mode</title>
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
|
|
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
|
|
|
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
|
|
|
<circle cx="12" cy="12" r="9" />
|
|
|
<path d="M13 12h5" />
|
|
|
<path d="M13 15h4" />
|
|
|
<path d="M13 18h1" />
|
|
|
<path d="M13 9h4" />
|
|
|
<path d="M13 6h1" />
|
|
|
</svg>
|
|
|
</symbol>
|
|
|
</svg>
|
|
|
|
|
|
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
|
|
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
|
|
<label class="overlay sidebar-overlay" for="__navigation">
|
|
|
<div class="visually-hidden">Hide navigation sidebar</div>
|
|
|
</label>
|
|
|
<label class="overlay toc-overlay" for="__toc">
|
|
|
<div class="visually-hidden">Hide table of contents sidebar</div>
|
|
|
</label>
|
|
|
|
|
|
|
|
|
|
|
|
<div class="page">
|
|
|
<header class="mobile-header">
|
|
|
<div class="header-left">
|
|
|
<label class="nav-overlay-icon" for="__navigation">
|
|
|
<div class="visually-hidden">Toggle site navigation sidebar</div>
|
|
|
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
|
|
</label>
|
|
|
</div>
|
|
|
<div class="header-center">
|
|
|
<a href="#"><div class="brand">mipac documentation</div></a>
|
|
|
</div>
|
|
|
<div class="header-right">
|
|
|
<div class="theme-toggle-container theme-toggle-header">
|
|
|
<button class="theme-toggle">
|
|
|
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
|
|
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
|
|
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
|
|
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
|
|
</button>
|
|
|
</div>
|
|
|
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
|
|
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
|
|
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
|
|
</label>
|
|
|
</div>
|
|
|
</header>
|
|
|
<aside class="sidebar-drawer">
|
|
|
<div class="sidebar-container">
|
|
|
|
|
|
<div class="sidebar-sticky"><a class="sidebar-brand" href="#">
|
|
|
|
|
|
|
|
|
|
|
|
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
|
|
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
|
|
<input type="hidden" name="check_keywords" value="yes">
|
|
|
<input type="hidden" name="area" value="default">
|
|
|
</form>
|
|
|
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
|
|
|
|
|
</div>
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
</aside>
|
|
|
<div class="main">
|
|
|
<div class="content">
|
|
|
<div class="article-container">
|
|
|
<a href="#" class="back-to-top muted-link">
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
|
|
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
|
|
</svg>
|
|
|
<span>Back to top</span>
|
|
|
</a>
|
|
|
<div class="content-icon-container">
|
|
|
|
|
|
<div class="theme-toggle-container theme-toggle-content">
|
|
|
<button class="theme-toggle">
|
|
|
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
|
|
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
|
|
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
|
|
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
|
|
</button>
|
|
|
</div>
|
|
|
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
|
|
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
|
|
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
|
|
</label>
|
|
|
</div>
|
|
|
<article role="main">
|
|
|
<section id="api-reference">
|
|
|
<h1>API Reference<a class="headerlink" href="#api-reference" title="Link to this heading">#</a></h1>
|
|
|
<section id="misskey-models">
|
|
|
<h2>Misskey Models<a class="headerlink" href="#misskey-models" title="Link to this heading">#</a></h2>
|
|
|
<section id="blocking">
|
|
|
<h3>Blocking<a class="headerlink" href="#blocking" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.blocking.Blocking"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Attributes</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.blocking.Blocking.api">api</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.blocking.Blocking.blockee">blockee</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.blocking.Blocking.blockee_id">blockee_id</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.blocking.Blocking.created_at">created_at</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.blocking.Blocking.id">id</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.blocking.Blocking">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.blocking.</span></span><span class="sig-name descname"><span class="pre">Blocking</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raw_blocking</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.blocking.IBlocking" title="mipac.types.blocking.IBlocking"><span class="pre">IBlocking</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.blocking.Blocking" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.blocking.Blocking.api">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">api</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#mipac.manager.blocking.ClientBlockingManager" title="mipac.manager.blocking.ClientBlockingManager"><span class="pre">ClientBlockingManager</span></a></em><a class="headerlink" href="#mipac.models.blocking.Blocking.api" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>ブロック対象に対するAPIを利用するためのManager</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>ブロック対象に対するAPIを利用するためのManager</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p><a class="reference internal" href="#mipac.manager.blocking.ClientBlockingManager" title="mipac.manager.blocking.ClientBlockingManager">ClientBlockingManager</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.blocking.Blocking.blockee">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">blockee</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#mipac.models.user.UserDetailedNotMe" title="mipac.models.user.UserDetailedNotMe"><span class="pre">UserDetailedNotMe</span></a></em><a class="headerlink" href="#mipac.models.blocking.Blocking.blockee" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>ブロック対象のユーザー情報</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>ブロック対象のユーザー情報</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p><a class="reference internal" href="#mipac.models.user.UserDetailedNotMe" title="mipac.models.user.UserDetailedNotMe">UserDetailedNotMe</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.blocking.Blocking.blockee_id">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">blockee_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mipac.models.blocking.Blocking.blockee_id" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>ブロック対象のユーザーID</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>ブロック対象のユーザーID</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>str</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.blocking.Blocking.created_at">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created_at</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#mipac.models.blocking.Blocking.created_at" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>ブロックした日時</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>ブロックした日時</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>datetime</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.blocking.Blocking.id">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mipac.models.blocking.Blocking.id" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>ブロックID</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>ブロックID</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>str</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="invitecode">
|
|
|
<h3>InviteCode<a class="headerlink" href="#invitecode" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.invite.InviteCode"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.invite.InviteCode">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.invite.</span></span><span class="sig-name descname"><span class="pre">InviteCode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_invite_code</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.invite.IInviteCode" title="mipac.types.invite.IInviteCode"><span class="pre">IInviteCode</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.invite.InviteCode" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="invitelimit">
|
|
|
<h3>InviteLimit<a class="headerlink" href="#invitelimit" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.invite.InviteLimit"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.invite.InviteLimit">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.invite.</span></span><span class="sig-name descname"><span class="pre">InviteLimit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_invite_limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.invite.IInviteLimit" title="mipac.types.invite.IInviteLimit"><span class="pre">IInviteLimit</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.invite.InviteLimit" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="gallerypost">
|
|
|
<h3>GalleryPost<a class="headerlink" href="#gallerypost" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.gallery.GalleryPost"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.gallery.GalleryPost">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.gallery.</span></span><span class="sig-name descname"><span class="pre">GalleryPost</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_gallery</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.gallery.IGalleryPost" title="mipac.types.gallery.IGalleryPost"><span class="pre">IGalleryPost</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.gallery.GalleryPost" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="muteduser">
|
|
|
<h3>MutedUser<a class="headerlink" href="#muteduser" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.mute.MutedUser"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.mute.MutedUser">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.mute.</span></span><span class="sig-name descname"><span class="pre">MutedUser</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_mute_user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.mute.IMutedUser" title="mipac.types.mute.IMutedUser"><span class="pre">IMutedUser</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.mute.MutedUser" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="followrequest">
|
|
|
<h3>FollowRequest<a class="headerlink" href="#followrequest" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.follow.FollowRequest"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.follow.FollowRequest">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.follow.</span></span><span class="sig-name descname"><span class="pre">FollowRequest</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">follow_request</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.follow.IFollowRequest" title="mipac.types.follow.IFollowRequest"><span class="pre">IFollowRequest</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.follow.FollowRequest" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="announcement">
|
|
|
<h3>Announcement<a class="headerlink" href="#announcement" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.announcement.Announcement"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.announcement.Announcement">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.announcement.</span></span><span class="sig-name descname"><span class="pre">Announcement</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">announcement</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.announcement.IAnnouncement" title="mipac.types.announcement.IAnnouncement"><span class="pre">IAnnouncement</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.announcement.Announcement" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="announcementdetailed">
|
|
|
<h3>AnnouncementDetailed<a class="headerlink" href="#announcementdetailed" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.announcement.AnnouncementDetailed"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Attributes</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.announcement.AnnouncementDetailed.reads">reads</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.announcement.AnnouncementDetailed">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.announcement.</span></span><span class="sig-name descname"><span class="pre">AnnouncementDetailed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_announcement</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.announcement.IAnnouncementDetailed" title="mipac.types.announcement.IAnnouncementDetailed"><span class="pre">IAnnouncementDetailed</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.announcement.AnnouncementDetailed" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.announcement.AnnouncementDetailed.reads">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">reads</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#mipac.models.announcement.AnnouncementDetailed.reads" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Returns the number of reads of the announcement.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="header">
|
|
|
<h3>Header<a class="headerlink" href="#header" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.note.Header"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Header">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.note.</span></span><span class="sig-name descname"><span class="pre">Header</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.note.Header" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="note">
|
|
|
<h3>Note<a class="headerlink" href="#note" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.note.Note"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Attributes</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.api">api</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.author">author</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.channel">channel</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.channel_id">channel_id</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.clipped_count">clipped_count</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.content">content</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.created_at">created_at</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.cw">cw</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.deleted_at">deleted_at</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.emojis">emojis</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.file_ids">file_ids</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.files">files</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.id">id</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.is_hidden">is_hidden</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.local_only">local_only</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.mentions">mentions</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.my_reaction">my_reaction</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.poll">poll</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.reaction_acceptance">reaction_acceptance</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.reaction_and_user_pair_cache">reaction_and_user_pair_cache</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.reactions">reactions</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.renote">renote</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.renote_count">renote_count</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.renote_id">renote_id</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.replies_count">replies_count</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.reply">reply</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.reply_id">reply_id</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.tags">tags</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.text">text</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.uri">uri</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.url">url</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.user">user</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.user_id">user_id</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.visibility">visibility</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.Note.visible_user_ids">visible_user_ids</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.note.</span></span><span class="sig-name descname"><span class="pre">Note</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_note</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.note.INote" title="mipac.types.note.INote"><span class="pre">INote</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.note.Note" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Noteモデル</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>note</strong> (<a class="reference internal" href="#mipac.types.note.INote" title="mipac.types.note.INote"><em>INote</em></a>) – The raw data of the note</p></li>
|
|
|
<li><p><strong>client</strong> (<a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><em>ClientManager</em></a>) – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.api">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">api</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#mipac.manager.note.ClientNoteManager" title="mipac.manager.note.ClientNoteManager"><span class="pre">ClientNoteManager</span></a></em><a class="headerlink" href="#mipac.models.note.Note.api" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note api</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note api</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p><a class="reference internal" href="#mipac.manager.note.ClientNoteManager" title="mipac.manager.note.ClientNoteManager">ClientNoteManager</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.author">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">author</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#mipac.models.lite.user.PartialUser" title="mipac.models.lite.user.PartialUser"><span class="pre">PartialUser</span></a></em><a class="headerlink" href="#mipac.models.note.Note.author" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note author</p>
|
|
|
<div class="deprecated">
|
|
|
<p><span class="versionmodified deprecated">Deprecated since version 0.6.0: </span>Use <a class="reference internal" href="#mipac.models.note.Note.user" title="mipac.models.note.Note.user"><code class="xref py py-meth docutils literal notranslate"><span class="pre">mipac.models.note.Note.user()</span></code></a> instead.</p>
|
|
|
</div>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note author</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p><a class="reference internal" href="#mipac.models.lite.user.PartialUser" title="mipac.models.lite.user.PartialUser">PartialUser</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.channel">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">channel</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#mipac.models.note.NoteChannel" title="mipac.models.note.NoteChannel"><span class="pre">NoteChannel</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.note.Note.channel" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note channel</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note channel</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p><a class="reference internal" href="#mipac.models.note.NoteChannel" title="mipac.models.note.NoteChannel">NoteChannel</a> | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.channel_id">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">channel_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.note.Note.channel_id" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note channelId</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note channelId</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>str | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.clipped_count">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">clipped_count</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.note.Note.clipped_count" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note clippedCount</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note clippedCount</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>int | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.content">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">content</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.note.Note.content" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note content</p>
|
|
|
<div class="deprecated">
|
|
|
<p><span class="versionmodified deprecated">Deprecated since version 0.6.0: </span>Use <a class="reference internal" href="#mipac.models.note.Note.text" title="mipac.models.note.Note.text"><code class="xref py py-meth docutils literal notranslate"><span class="pre">mipac.models.note.Note.text()</span></code></a> instead.</p>
|
|
|
</div>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note content</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>str | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.created_at">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created_at</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#mipac.models.note.Note.created_at" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note createdAt</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note createdAt</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>datetime</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.cw">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cw</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.note.Note.cw" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note cw</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note cw</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>str | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.deleted_at">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">deleted_at</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.note.Note.deleted_at" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note deletedAt</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note deletedAt</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>datetime | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.emojis">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">emojis</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#mipac.models.note.Note.emojis" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note emojis</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note emojis</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>dict[str, str]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.file_ids">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">file_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#mipac.models.note.Note.file_ids" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note fileIds</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note fileIds</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>list[str]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.files">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">files</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File"><span class="pre">File</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#mipac.models.note.Note.files" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note files</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note files</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>list[<a class="reference internal" href="#mipac.types.drive.IFile" title="mipac.types.drive.IFile">IFile</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.id">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mipac.models.note.Note.id" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note id</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note id</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>str</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.is_hidden">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">is_hidden</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.note.Note.is_hidden" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note isHidden</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note isHidden</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>bool | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.local_only">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">local_only</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#mipac.models.note.Note.local_only" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note localOnly</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note localOnly</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.mentions">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">mentions</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#mipac.models.note.Note.mentions" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note mentions</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note mentions</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>list[str]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.my_reaction">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">my_reaction</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.note.Note.my_reaction" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note myReaction</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note myReaction</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>str | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.poll">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">poll</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#mipac.models.poll.Poll" title="mipac.models.poll.Poll"><span class="pre">Poll</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.note.Note.poll" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note poll</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note poll</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p><a class="reference internal" href="#mipac.types.poll.IPoll" title="mipac.types.poll.IPoll">IPoll</a> | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.reaction_acceptance">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">reaction_acceptance</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="pre">None</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'likeOnly'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'likeOnlyForRemote'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'nonSensitiveOnly'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'nonSensitiveOnlyForLocalLikeOnlyForRemote'</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#mipac.models.note.Note.reaction_acceptance" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note reactionAcceptance</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note reactionAcceptance</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>IReactionAcceptance</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.reaction_and_user_pair_cache">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">reaction_and_user_pair_cache</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.lite.user.PartialUser" title="mipac.models.lite.user.PartialUser"><span class="pre">PartialUser</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#mipac.models.note.Note.reaction_and_user_pair_cache" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note reactionAndUserPairCache</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note reactionAndUserPairCache</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>dict[str, list[<a class="reference internal" href="#mipac.models.lite.user.PartialUser" title="mipac.models.lite.user.PartialUser">PartialUser</a>]]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.reactions">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">reactions</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#mipac.models.note.Note.reactions" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note reactions</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note reactions</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>dict[str, int]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.renote">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">renote</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.note.Note.renote" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note renote</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note renote</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a> | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.renote_count">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">renote_count</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#mipac.models.note.Note.renote_count" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note renoteCount</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note renoteCount</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>int</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.renote_id">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">renote_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.note.Note.renote_id" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note renoteId</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note renoteId</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>str | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.replies_count">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">replies_count</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#mipac.models.note.Note.replies_count" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note repliesCount</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note repliesCount</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>int</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.reply">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">reply</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.note.Note.reply" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note reply</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note reply</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a> | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.reply_id">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">reply_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.note.Note.reply_id" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note replyId</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note replyId</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>str | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.tags">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tags</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#mipac.models.note.Note.tags" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note tags</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note tags</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>list[str] | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.text">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">text</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.note.Note.text" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note text</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note text</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>str | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.uri">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uri</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.note.Note.uri" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note uri</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note uri</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>str</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.url">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">url</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.note.Note.url" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note url</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note url</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>str</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.user">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">user</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#mipac.models.lite.user.PartialUser" title="mipac.models.lite.user.PartialUser"><span class="pre">PartialUser</span></a></em><a class="headerlink" href="#mipac.models.note.Note.user" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note author</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note user</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p><a class="reference internal" href="#mipac.models.lite.user.PartialUser" title="mipac.models.lite.user.PartialUser">PartialUser</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.user_id">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">user_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mipac.models.note.Note.user_id" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note userId</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note userId</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>str</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.visibility">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">visibility</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'public'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'home'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'followers'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'specified'</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#mipac.models.note.Note.visibility" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note visibility</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note visibility</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>INoteVisibility</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.Note.visible_user_ids">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">visible_user_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#mipac.models.note.Note.visible_user_ids" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note visibleUserIds</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note visibleUserIds</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>list[str] | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="notechannel">
|
|
|
<h3>NoteChannel<a class="headerlink" href="#notechannel" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.note.NoteChannel"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Attributes</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.NoteChannel.allow_renote_to_external">allow_renote_to_external</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.NoteChannel.color">color</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.NoteChannel.id">id</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.NoteChannel.is_sensitive">is_sensitive</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.NoteChannel.name">name</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.NoteChannel.user_id">user_id</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.NoteChannel">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.note.</span></span><span class="sig-name descname"><span class="pre">NoteChannel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_note_channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.note.INoteChannel" title="mipac.types.note.INoteChannel"><span class="pre">INoteChannel</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.note.NoteChannel" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.NoteChannel.allow_renote_to_external">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">allow_renote_to_external</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#mipac.models.note.NoteChannel.allow_renote_to_external" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note channelAllowRenoteToExternal</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note channelAllowRenoteToExternal</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.NoteChannel.color">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">color</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mipac.models.note.NoteChannel.color" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note channelColor</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note channelColor</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>str</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.NoteChannel.id">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mipac.models.note.NoteChannel.id" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note channelId</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note channelId</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>str</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.NoteChannel.is_sensitive">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">is_sensitive</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#mipac.models.note.NoteChannel.is_sensitive" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note channelIsSensitive</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note channelIsSensitive</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.NoteChannel.name">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mipac.models.note.NoteChannel.name" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note channelName</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note channelName</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>str</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.NoteChannel.user_id">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">user_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.note.NoteChannel.user_id" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note channelUserId</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note channelUserId</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>str | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="notedeleted">
|
|
|
<h3>NoteDeleted<a class="headerlink" href="#notedeleted" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.note.NoteDeleted"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.NoteDeleted">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.note.</span></span><span class="sig-name descname"><span class="pre">NoteDeleted</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.note.INoteUpdated" title="mipac.types.note.INoteUpdated"><span class="pre">INoteUpdated</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.types.note.INoteUpdatedDelete" title="mipac.types.note.INoteUpdatedDelete"><span class="pre">INoteUpdatedDelete</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.note.NoteDeleted" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="notereaction">
|
|
|
<h3>NoteReaction<a class="headerlink" href="#notereaction" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.note.NoteReaction"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Attributes</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.NoteReaction.created_at">created_at</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.NoteReaction.id">id</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.NoteReaction.type">type</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.note.NoteReaction.user">user</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.NoteReaction">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.note.</span></span><span class="sig-name descname"><span class="pre">NoteReaction</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_reaction</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.note.INoteReaction" title="mipac.types.note.INoteReaction"><span class="pre">INoteReaction</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.note.NoteReaction" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.NoteReaction.created_at">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created_at</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.note.NoteReaction.created_at" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note createdAt</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note createdAt</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>datetime | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.NoteReaction.id">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.note.NoteReaction.id" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note reactionId</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note reactionId</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>str | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.NoteReaction.type">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.note.NoteReaction.type" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>reaction type</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>reaction type</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>str | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.NoteReaction.user">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">user</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#mipac.models.lite.user.PartialUser" title="mipac.models.lite.user.PartialUser"><span class="pre">PartialUser</span></a></em><a class="headerlink" href="#mipac.models.note.NoteReaction.user" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>note user</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>note user</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p><a class="reference internal" href="#mipac.models.lite.user.PartialUser" title="mipac.models.lite.user.PartialUser">PartialUser</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="notestate">
|
|
|
<h3>NoteState<a class="headerlink" href="#notestate" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.note.NoteState"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.NoteState">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.note.</span></span><span class="sig-name descname"><span class="pre">NoteState</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.note.INoteState" title="mipac.types.note.INoteState"><span class="pre">INoteState</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.note.NoteState" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="notetranslateresult">
|
|
|
<h3>NoteTranslateResult<a class="headerlink" href="#notetranslateresult" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.note.NoteTranslateResult"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.note.NoteTranslateResult">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.note.</span></span><span class="sig-name descname"><span class="pre">NoteTranslateResult</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">translate_result</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.note.INoteTranslateResult" title="mipac.types.note.INoteTranslateResult"><span class="pre">INoteTranslateResult</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.note.NoteTranslateResult" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>translate_result</strong> (<a class="reference internal" href="#mipac.types.note.INoteTranslateResult" title="mipac.types.note.INoteTranslateResult"><em>INoteTranslateResult</em></a>) – The raw data of the note translate result</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="notification">
|
|
|
<h3>Notification<a class="headerlink" href="#notification" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.notification.Notification"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.notification.Notification">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.notification.</span></span><span class="sig-name descname"><span class="pre">Notification</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">notification</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.notification.INotification" title="mipac.types.notification.INotification"><span class="pre">INotification</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.notification.Notification" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="notificationachievement">
|
|
|
<h3>NotificationAchievement<a class="headerlink" href="#notificationachievement" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.notification.NotificationAchievement"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.notification.NotificationAchievement">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.notification.</span></span><span class="sig-name descname"><span class="pre">NotificationAchievement</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">notification</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.notification.IAchievementNf" title="mipac.types.notification.IAchievementNf"><span class="pre">IAchievementNf</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.notification.NotificationAchievement" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="notificationfollow">
|
|
|
<h3>NotificationFollow<a class="headerlink" href="#notificationfollow" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.notification.NotificationFollow"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.notification.NotificationFollow">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.notification.</span></span><span class="sig-name descname"><span class="pre">NotificationFollow</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">notification</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.notification.IUserNf" title="mipac.types.notification.IUserNf"><span class="pre">IUserNf</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.notification.NotificationFollow" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="notificationfollowrequest">
|
|
|
<h3>NotificationFollowRequest<a class="headerlink" href="#notificationfollowrequest" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.notification.NotificationFollowRequest"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.notification.NotificationFollowRequest">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.notification.</span></span><span class="sig-name descname"><span class="pre">NotificationFollowRequest</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">notification</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.notification.IUserNf" title="mipac.types.notification.IUserNf"><span class="pre">IUserNf</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.notification.NotificationFollowRequest" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="notificationnote">
|
|
|
<h3>NotificationNote<a class="headerlink" href="#notificationnote" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.notification.NotificationNote"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.notification.NotificationNote">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.notification.</span></span><span class="sig-name descname"><span class="pre">NotificationNote</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">notification</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.notification.INoteNf" title="mipac.types.notification.INoteNf"><span class="pre">INoteNf</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.notification.NotificationNote" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="notificationpollend">
|
|
|
<h3>NotificationPollEnd<a class="headerlink" href="#notificationpollend" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.notification.NotificationPollEnd"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.notification.NotificationPollEnd">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.notification.</span></span><span class="sig-name descname"><span class="pre">NotificationPollEnd</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">notification</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.notification.IPollEndNf" title="mipac.types.notification.IPollEndNf"><span class="pre">IPollEndNf</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.notification.NotificationPollEnd" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="notificationreaction">
|
|
|
<h3>NotificationReaction<a class="headerlink" href="#notificationreaction" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.notification.NotificationReaction"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.notification.NotificationReaction">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.notification.</span></span><span class="sig-name descname"><span class="pre">NotificationReaction</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reaction</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.notification.IReactionNf" title="mipac.types.notification.IReactionNf"><span class="pre">IReactionNf</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.notification.NotificationReaction" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="customemoji">
|
|
|
<h3>CustomEmoji<a class="headerlink" href="#customemoji" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.emoji.CustomEmoji"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.emoji.CustomEmoji">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.emoji.</span></span><span class="sig-name descname"><span class="pre">CustomEmoji</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">emoji</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.emoji.ICustomEmoji" title="mipac.types.emoji.ICustomEmoji"><span class="pre">ICustomEmoji</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.emoji.CustomEmoji" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="emojidetailed">
|
|
|
<h3>EmojiDetailed<a class="headerlink" href="#emojidetailed" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.emoji.EmojiDetailed"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.emoji.EmojiDetailed">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.emoji.</span></span><span class="sig-name descname"><span class="pre">EmojiDetailed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_emoji_detailed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.emoji.IEmojiDetailed" title="mipac.types.emoji.IEmojiDetailed"><span class="pre">IEmojiDetailed</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.emoji.EmojiDetailed" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="emojisimple">
|
|
|
<h3>EmojiSimple<a class="headerlink" href="#emojisimple" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.emoji.EmojiSimple"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.emoji.EmojiSimple">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.emoji.</span></span><span class="sig-name descname"><span class="pre">EmojiSimple</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_emoji_simple</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.emoji.IEmojiSimple" title="mipac.types.emoji.IEmojiSimple"><span class="pre">IEmojiSimple</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.emoji.EmojiSimple" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clip">
|
|
|
<h3>Clip<a class="headerlink" href="#clip" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.clip.Clip"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Attributes</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.clip.Clip.created_at">created_at</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.clip.Clip.description">description</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.clip.Clip.favorited_count">favorited_count</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.clip.Clip.id">id</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.clip.Clip.is_favorited">is_favorited</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.clip.Clip.is_public">is_public</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.clip.Clip.last_clipped_at">last_clipped_at</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.clip.Clip.name">name</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.clip.Clip.user">user</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.clip.Clip.user_id">user_id</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.clip.Clip">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.clip.</span></span><span class="sig-name descname"><span class="pre">Clip</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_clip</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.clip.IClip" title="mipac.types.clip.IClip"><span class="pre">IClip</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.clip.Clip" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.clip.Clip.created_at">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created_at</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mipac.models.clip.Clip.created_at" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>The time the clip was created</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.clip.Clip.description">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.clip.Clip.description" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>The clip description</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.clip.Clip.favorited_count">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">favorited_count</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#mipac.models.clip.Clip.favorited_count" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>The number of times the clip has been favorited</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.clip.Clip.id">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mipac.models.clip.Clip.id" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>The clip id</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.clip.Clip.is_favorited">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">is_favorited</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#mipac.models.clip.Clip.is_favorited" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Whether the clip is favorited</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.clip.Clip.is_public">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">is_public</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#mipac.models.clip.Clip.is_public" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Whether the clip is public</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.clip.Clip.last_clipped_at">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">last_clipped_at</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mipac.models.clip.Clip.last_clipped_at" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>The last time the clip was clipped</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.clip.Clip.name">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mipac.models.clip.Clip.name" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>The clip name</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.clip.Clip.user">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">user</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#mipac.models.lite.user.PartialUser" title="mipac.models.lite.user.PartialUser"><span class="pre">PartialUser</span></a></em><a class="headerlink" href="#mipac.models.clip.Clip.user" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>The user who created the clip</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.clip.Clip.user_id">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">user_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mipac.models.clip.Clip.user_id" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>The user id who created the clip</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="partialreaction">
|
|
|
<h3>PartialReaction<a class="headerlink" href="#partialreaction" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.reaction.PartialReaction"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.reaction.PartialReaction">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.reaction.</span></span><span class="sig-name descname"><span class="pre">PartialReaction</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reaction</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.note.INoteUpdated" title="mipac.types.note.INoteUpdated"><span class="pre">INoteUpdated</span></a><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.types.note.INoteUpdatedReaction" title="mipac.types.note.INoteUpdatedReaction"><span class="pre">INoteUpdatedReaction</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.reaction.PartialReaction" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="channel">
|
|
|
<h3>Channel<a class="headerlink" href="#channel" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.channel.Channel"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Attributes</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.channel.Channel.allow_renote_to_external">allow_renote_to_external</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.channel.Channel.api">api</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.channel.Channel.banner_url">banner_url</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.channel.Channel.color">color</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.channel.Channel.created_at">created_at</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.channel.Channel.description">description</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.channel.Channel.id">id</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.channel.Channel.is_archived">is_archived</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.channel.Channel.is_favorited">is_favorited</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.channel.Channel.is_following">is_following</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.channel.Channel.is_sensitive">is_sensitive</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.channel.Channel.last_noted_at">last_noted_at</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.channel.Channel.name">name</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.channel.Channel.notes_count">notes_count</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.channel.Channel.pinned_note_ids">pinned_note_ids</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.channel.Channel.pinned_notes">pinned_notes</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.channel.Channel.user_id">user_id</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.channel.Channel.users_count">users_count</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.channel.Channel">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.channel.</span></span><span class="sig-name descname"><span class="pre">Channel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_channel</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.channel.IChannel" title="mipac.types.channel.IChannel"><span class="pre">IChannel</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.channel.Channel" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.channel.Channel.allow_renote_to_external">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">allow_renote_to_external</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#mipac.models.channel.Channel.allow_renote_to_external" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>外部へのリノートを許可するかどうか</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.channel.Channel.api">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">api</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#mipac.manager.channel.ClientChannelManager" title="mipac.manager.channel.ClientChannelManager"><span class="pre">ClientChannelManager</span></a></em><a class="headerlink" href="#mipac.models.channel.Channel.api" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>チャンネルに関するAPIを利用するためのクライアント</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.manager.channel.ClientChannelManager" title="mipac.manager.channel.ClientChannelManager">ClientChannelManager</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.channel.Channel.banner_url">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">banner_url</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.channel.Channel.banner_url" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>チャンネルのバナー画像URL</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>str | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.channel.Channel.color">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">color</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mipac.models.channel.Channel.color" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>チャンネルの色</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>str</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.channel.Channel.created_at">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">created_at</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#mipac.models.channel.Channel.created_at" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>チャンネルが作成された日時</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>datetime</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.channel.Channel.description">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.channel.Channel.description" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>チャンネルの説明</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>str | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.channel.Channel.id">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mipac.models.channel.Channel.id" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>チャンネルID</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>str</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.channel.Channel.is_archived">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">is_archived</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#mipac.models.channel.Channel.is_archived" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>チャンネルがアーカイブされているかどうか</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.channel.Channel.is_favorited">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">is_favorited</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.channel.Channel.is_favorited" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>自身がお気に入り登録しているかどうか</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.channel.Channel.is_following">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">is_following</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.channel.Channel.is_following" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>自身がフォローしているかどうか</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.channel.Channel.is_sensitive">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">is_sensitive</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#mipac.models.channel.Channel.is_sensitive" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>チャンネルがセンシティブかどうか</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.channel.Channel.last_noted_at">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">last_noted_at</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.channel.Channel.last_noted_at" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>チャンネルに最後にノートが投稿された日時</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>datetime | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.channel.Channel.name">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mipac.models.channel.Channel.name" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>チャンネル名</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>str</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.channel.Channel.notes_count">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">notes_count</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#mipac.models.channel.Channel.notes_count" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>チャンネル内のノート数</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>int</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.channel.Channel.pinned_note_ids">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">pinned_note_ids</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#mipac.models.channel.Channel.pinned_note_ids" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>ピン留めされているノートのIDのリスト</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[str]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.channel.Channel.pinned_notes">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">pinned_notes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#mipac.models.channel.Channel.pinned_notes" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>ピン留めされているノートのリスト</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.channel.Channel.user_id">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">user_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.channel.Channel.user_id" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>チャンネルを作成したユーザーのID</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>str | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.channel.Channel.users_count">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">users_count</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#mipac.models.channel.Channel.users_count" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>チャンネルに参加しているユーザー数</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>int</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="indexstat">
|
|
|
<h3>IndexStat<a class="headerlink" href="#indexstat" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.admin.IndexStat"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.admin.IndexStat">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.admin.</span></span><span class="sig-name descname"><span class="pre">IndexStat</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">index_stat</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.admin.IIndexStat" title="mipac.types.admin.IIndexStat"><span class="pre">IIndexStat</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.admin.IndexStat" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="moderationlog">
|
|
|
<h3>ModerationLog<a class="headerlink" href="#moderationlog" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.admin.ModerationLog"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.admin.ModerationLog">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.admin.</span></span><span class="sig-name descname"><span class="pre">ModerationLog</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">moderation_log</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.admin.IModerationLog" title="mipac.types.admin.IModerationLog"><span class="pre">IModerationLog</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.admin.ModerationLog" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="serverinfo">
|
|
|
<h3>ServerInfo<a class="headerlink" href="#serverinfo" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.admin.ServerInfo"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.admin.ServerInfo">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.admin.</span></span><span class="sig-name descname"><span class="pre">ServerInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">server_info</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.admin.IServerInfo" title="mipac.types.admin.IServerInfo"><span class="pre">IServerInfo</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.admin.ServerInfo" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="serverinfocpu">
|
|
|
<h3>ServerInfoCpu<a class="headerlink" href="#serverinfocpu" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.admin.ServerInfoCpu"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.admin.ServerInfoCpu">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.admin.</span></span><span class="sig-name descname"><span class="pre">ServerInfoCpu</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">server_info_cpu</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.admin.IServerInfoCpu" title="mipac.types.admin.IServerInfoCpu"><span class="pre">IServerInfoCpu</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.admin.ServerInfoCpu" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="serverinfofs">
|
|
|
<h3>ServerInfoFs<a class="headerlink" href="#serverinfofs" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.admin.ServerInfoFs"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.admin.ServerInfoFs">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.admin.</span></span><span class="sig-name descname"><span class="pre">ServerInfoFs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">server_info_fs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.admin.IServerInfoFs" title="mipac.types.admin.IServerInfoFs"><span class="pre">IServerInfoFs</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.admin.ServerInfoFs" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="serverinfomem">
|
|
|
<h3>ServerInfoMem<a class="headerlink" href="#serverinfomem" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.admin.ServerInfoMem"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.admin.ServerInfoMem">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.admin.</span></span><span class="sig-name descname"><span class="pre">ServerInfoMem</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">server_info_mem</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.admin.IServerInfoMem" title="mipac.types.admin.IServerInfoMem"><span class="pre">IServerInfoMem</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.admin.ServerInfoMem" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="serverinfonet">
|
|
|
<h3>ServerInfoNet<a class="headerlink" href="#serverinfonet" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.admin.ServerInfoNet"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.admin.ServerInfoNet">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.admin.</span></span><span class="sig-name descname"><span class="pre">ServerInfoNet</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">server_info_net</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.admin.IServerInfoNet" title="mipac.types.admin.IServerInfoNet"><span class="pre">IServerInfoNet</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.admin.ServerInfoNet" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="userip">
|
|
|
<h3>UserIP<a class="headerlink" href="#userip" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.admin.UserIP"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.admin.UserIP">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.admin.</span></span><span class="sig-name descname"><span class="pre">UserIP</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_ip</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.admin.IUserIP" title="mipac.types.admin.IUserIP"><span class="pre">IUserIP</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.admin.UserIP" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="usernameavailable">
|
|
|
<h3>UsernameAvailable<a class="headerlink" href="#usernameavailable" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.username.UsernameAvailable"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.username.UsernameAvailable">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.username.</span></span><span class="sig-name descname"><span class="pre">UsernameAvailable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_username_available</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.username.IUsernameAvailable" title="mipac.types.username.IUsernameAvailable"><span class="pre">IUsernameAvailable</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.username.UsernameAvailable" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="activeuserschart">
|
|
|
<h3>ActiveUsersChart<a class="headerlink" href="#activeuserschart" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.chart.ActiveUsersChart"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.chart.ActiveUsersChart">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.chart.</span></span><span class="sig-name descname"><span class="pre">ActiveUsersChart</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.chart.IActiveUsersChart" title="mipac.types.chart.IActiveUsersChart"><span class="pre">IActiveUsersChart</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.chart.ActiveUsersChart" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="drivechart">
|
|
|
<h3>DriveChart<a class="headerlink" href="#drivechart" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.chart.DriveChart"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.chart.DriveChart">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.chart.</span></span><span class="sig-name descname"><span class="pre">DriveChart</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.chart.IDriveChart" title="mipac.types.chart.IDriveChart"><span class="pre">IDriveChart</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.chart.DriveChart" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="drivelocalchart">
|
|
|
<h3>DriveLocalChart<a class="headerlink" href="#drivelocalchart" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.chart.DriveLocalChart"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.chart.DriveLocalChart">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.chart.</span></span><span class="sig-name descname"><span class="pre">DriveLocalChart</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.chart.IDriveLocalChart" title="mipac.types.chart.IDriveLocalChart"><span class="pre">IDriveLocalChart</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.chart.DriveLocalChart" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="driveremotechart">
|
|
|
<h3>DriveRemoteChart<a class="headerlink" href="#driveremotechart" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.chart.DriveRemoteChart"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.chart.DriveRemoteChart">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.chart.</span></span><span class="sig-name descname"><span class="pre">DriveRemoteChart</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.chart.IDriveRemoteChart" title="mipac.types.chart.IDriveRemoteChart"><span class="pre">IDriveRemoteChart</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.chart.DriveRemoteChart" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="drivestatus">
|
|
|
<h3>DriveStatus<a class="headerlink" href="#drivestatus" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.drive.DriveStatus"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Attributes</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.drive.DriveStatus.capacity">capacity</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.drive.DriveStatus.usage">usage</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.drive.DriveStatus">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.drive.</span></span><span class="sig-name descname"><span class="pre">DriveStatus</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_drive_status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.drive.IDriveStatus" title="mipac.types.drive.IDriveStatus"><span class="pre">IDriveStatus</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.drive.DriveStatus" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.drive.DriveStatus.capacity">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">capacity</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#mipac.models.drive.DriveStatus.capacity" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Total capacity of the drive in bytes</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>Total capacity of the drive in bytes</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>int</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.drive.DriveStatus.usage">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">usage</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#mipac.models.drive.DriveStatus.usage" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Total usage of the drive in bytes</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>Total usage of the drive in bytes</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>int</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="file">
|
|
|
<h3>File<a class="headerlink" href="#file" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.drive.File"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.drive.File">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.drive.</span></span><span class="sig-name descname"><span class="pre">File</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.drive.IFile" title="mipac.types.drive.IFile"><span class="pre">IFile</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.drive.File" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="fileproperties">
|
|
|
<h3>FileProperties<a class="headerlink" href="#fileproperties" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.drive.FileProperties"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.drive.FileProperties">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.drive.</span></span><span class="sig-name descname"><span class="pre">FileProperties</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_properties</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.drive.IFileProperties" title="mipac.types.drive.IFileProperties"><span class="pre">IFileProperties</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.drive.FileProperties" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="folder">
|
|
|
<h3>Folder<a class="headerlink" href="#folder" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.drive.Folder"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.drive.Folder">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.drive.</span></span><span class="sig-name descname"><span class="pre">Folder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_folder</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.drive.IFolder" title="mipac.types.drive.IFolder"><span class="pre">IFolder</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.drive.Folder" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="antenna">
|
|
|
<h3>Antenna<a class="headerlink" href="#antenna" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.antenna.Antenna"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.antenna.Antenna">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.antenna.</span></span><span class="sig-name descname"><span class="pre">Antenna</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">antenna</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.antenna.IAntenna" title="mipac.types.antenna.IAntenna"><span class="pre">IAntenna</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.antenna.Antenna" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="ad">
|
|
|
<h3>Ad<a class="headerlink" href="#ad" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.ad.Ad"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.ad.Ad">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.ad.</span></span><span class="sig-name descname"><span class="pre">Ad</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ad_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.ads.IAd" title="mipac.types.ads.IAd"><span class="pre">IAd</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.ad.Ad" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="federationinstance">
|
|
|
<h3>FederationInstance<a class="headerlink" href="#federationinstance" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.instance.FederationInstance"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.instance.FederationInstance">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.instance.</span></span><span class="sig-name descname"><span class="pre">FederationInstance</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">instance</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.instance.IFederationInstance" title="mipac.types.instance.IFederationInstance"><span class="pre">IFederationInstance</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.instance.FederationInstance" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="mipoll">
|
|
|
<h3>MiPoll<a class="headerlink" href="#mipoll" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.poll.MiPoll"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.poll.MiPoll">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.poll.</span></span><span class="sig-name descname"><span class="pre">MiPoll</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">poll</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.poll.ICreatePoll" title="mipac.types.poll.ICreatePoll"><span class="pre">ICreatePoll</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.poll.MiPoll" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="poll">
|
|
|
<h3>Poll<a class="headerlink" href="#poll" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.poll.Poll"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.poll.Poll">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.poll.</span></span><span class="sig-name descname"><span class="pre">Poll</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">poll</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.poll.IPoll" title="mipac.types.poll.IPoll"><span class="pre">IPoll</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.poll.Poll" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="pollchoice">
|
|
|
<h3>PollChoice<a class="headerlink" href="#pollchoice" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.poll.PollChoice"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.poll.PollChoice">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.poll.</span></span><span class="sig-name descname"><span class="pre">PollChoice</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">choice</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.poll.IPollChoice" title="mipac.types.poll.IPollChoice"><span class="pre">IPollChoice</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.poll.PollChoice" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="merole">
|
|
|
<h3>MeRole<a class="headerlink" href="#merole" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.roles.MeRole"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.roles.MeRole">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.roles.</span></span><span class="sig-name descname"><span class="pre">MeRole</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.roles.IMeRole" title="mipac.types.roles.IMeRole"><span class="pre">IMeRole</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.roles.MeRole" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="role">
|
|
|
<h3>Role<a class="headerlink" href="#role" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.roles.Role"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.roles.Role">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.roles.</span></span><span class="sig-name descname"><span class="pre">Role</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">role_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.roles.IRole" title="mipac.types.roles.IRole"><span class="pre">IRole</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.roles.Role" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="rolepolicies">
|
|
|
<h3>RolePolicies<a class="headerlink" href="#rolepolicies" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.roles.RolePolicies"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.roles.RolePolicies">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.roles.</span></span><span class="sig-name descname"><span class="pre">RolePolicies</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">role_policies_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.roles.IRolePolicies" title="mipac.types.roles.IRolePolicies"><span class="pre">IRolePolicies</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.roles.RolePolicies" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="roleuser">
|
|
|
<h3>RoleUser<a class="headerlink" href="#roleuser" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.roles.RoleUser"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.roles.RoleUser">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.roles.</span></span><span class="sig-name descname"><span class="pre">RoleUser</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">role_user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.roles.IRoleUser" title="mipac.types.roles.IRoleUser"><span class="pre">IRoleUser</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.roles.RoleUser" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="packed-user">
|
|
|
<h3>packed_user<a class="headerlink" href="#packed-user" title="Link to this heading">#</a></h3>
|
|
|
<dl class="py function">
|
|
|
<dt class="sig sig-object py" id="mipac.models.user.packed_user">
|
|
|
<span class="sig-prename descclassname"><span class="pre">mipac.models.user.</span></span><span class="sig-name descname"><span class="pre">packed_user</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">IUser</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.user.UserDetailedNotMe" title="mipac.models.user.UserDetailedNotMe"><span class="pre">UserDetailedNotMe</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#mipac.models.user.MeDetailed" title="mipac.models.user.MeDetailed"><span class="pre">MeDetailed</span></a></span></span><a class="headerlink" href="#mipac.models.user.packed_user" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="achievement">
|
|
|
<h3>Achievement<a class="headerlink" href="#achievement" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.user.Achievement"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.user.Achievement">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.user.</span></span><span class="sig-name descname"><span class="pre">Achievement</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">detail</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.user.IAchievement" title="mipac.types.user.IAchievement"><span class="pre">IAchievement</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.user.Achievement" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="followcommon">
|
|
|
<h3>FollowCommon<a class="headerlink" href="#followcommon" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.user.FollowCommon"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.user.FollowCommon">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.user.</span></span><span class="sig-name descname"><span class="pre">FollowCommon</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_follow</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">FFC</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.user.FollowCommon" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="follower">
|
|
|
<h3>Follower<a class="headerlink" href="#follower" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.user.Follower"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.user.Follower">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.user.</span></span><span class="sig-name descname"><span class="pre">Follower</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_follow</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.follow.IFederationFollower" title="mipac.types.follow.IFederationFollower"><span class="pre">IFederationFollower</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.user.Follower" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="following">
|
|
|
<h3>Following<a class="headerlink" href="#following" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.user.Following"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.user.Following">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.user.</span></span><span class="sig-name descname"><span class="pre">Following</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_following</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.follow.IFederationFollowing" title="mipac.types.follow.IFederationFollowing"><span class="pre">IFederationFollowing</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.user.Following" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="frequentlyreplieduser">
|
|
|
<h3>FrequentlyRepliedUser<a class="headerlink" href="#frequentlyreplieduser" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.user.FrequentlyRepliedUser"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.user.FrequentlyRepliedUser">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.user.</span></span><span class="sig-name descname"><span class="pre">FrequentlyRepliedUser</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_frequently_replied_user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.user.GetFrequentlyRepliedUsersResponse" title="mipac.types.user.GetFrequentlyRepliedUsersResponse"><span class="pre">GetFrequentlyRepliedUsersResponse</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.user.FrequentlyRepliedUser" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="medetailed">
|
|
|
<h3>MeDetailed<a class="headerlink" href="#medetailed" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.user.MeDetailed"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.user.MeDetailed">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.user.</span></span><span class="sig-name descname"><span class="pre">MeDetailed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.user.IMeDetailedSchema" title="mipac.types.user.IMeDetailedSchema"><span class="pre">IMeDetailedSchema</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.user.MeDetailed" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="medetailedonly">
|
|
|
<h3>MeDetailedOnly<a class="headerlink" href="#medetailedonly" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.user.MeDetailedOnly"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.user.MeDetailedOnly">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.user.</span></span><span class="sig-name descname"><span class="pre">MeDetailedOnly</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.user.IMeDetailedOnlySchema" title="mipac.types.user.IMeDetailedOnlySchema"><span class="pre">IMeDetailedOnlySchema</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.user.MeDetailedOnly" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="userdetailednotme">
|
|
|
<h3>UserDetailedNotMe<a class="headerlink" href="#userdetailednotme" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.user.UserDetailedNotMe"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.user.UserDetailedNotMe">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.user.</span></span><span class="sig-name descname"><span class="pre">UserDetailedNotMe</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.user.UserDetailedNotMe" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="userdetailednotmeonly">
|
|
|
<h3>UserDetailedNotMeOnly<a class="headerlink" href="#userdetailednotmeonly" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.user.UserDetailedNotMeOnly"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.user.UserDetailedNotMeOnly">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.user.</span></span><span class="sig-name descname"><span class="pre">UserDetailedNotMeOnly</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.user.IUserDetailedNotMeOnlySchema" title="mipac.types.user.IUserDetailedNotMeOnlySchema"><span class="pre">IUserDetailedNotMeOnlySchema</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.user.UserDetailedNotMeOnly" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="userfield">
|
|
|
<h3>UserField<a class="headerlink" href="#userfield" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.user.UserField"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.user.UserField">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.user.</span></span><span class="sig-name descname"><span class="pre">UserField</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_user_field</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.user.IUserField" title="mipac.types.user.IUserField"><span class="pre">IUserField</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.user.UserField" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="userlist">
|
|
|
<h3>UserList<a class="headerlink" href="#userlist" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.user.UserList"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.user.UserList">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.user.</span></span><span class="sig-name descname"><span class="pre">UserList</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_user_list</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.user.IUserList" title="mipac.types.user.IUserList"><span class="pre">IUserList</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.user.UserList" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="userlistmembership">
|
|
|
<h3>UserListMembership<a class="headerlink" href="#userlistmembership" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.user.UserListMembership"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.user.UserListMembership">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.user.</span></span><span class="sig-name descname"><span class="pre">UserListMembership</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_user_list_membership</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.user.IUserListMembership" title="mipac.types.user.IUserListMembership"><span class="pre">IUserListMembership</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.user.UserListMembership" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="adminmeta">
|
|
|
<h3>AdminMeta<a class="headerlink" href="#adminmeta" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.meta.AdminMeta"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.meta.AdminMeta">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.meta.</span></span><span class="sig-name descname"><span class="pre">AdminMeta</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_meta</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.meta.IAdminMeta" title="mipac.types.meta.IAdminMeta"><span class="pre">IAdminMeta</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.meta.AdminMeta" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="features">
|
|
|
<h3>Features<a class="headerlink" href="#features" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.meta.Features"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.meta.Features">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.meta.</span></span><span class="sig-name descname"><span class="pre">Features</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_features</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.meta.IFeatures" title="mipac.types.meta.IFeatures"><span class="pre">IFeatures</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.meta.Features" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="meta">
|
|
|
<h3>Meta<a class="headerlink" href="#meta" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.meta.Meta"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.meta.Meta">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.meta.</span></span><span class="sig-name descname"><span class="pre">Meta</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">instance_metadata</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.meta.IMeta" title="mipac.types.meta.IMeta"><span class="pre">IMeta</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.meta.Meta" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="partialcustomemoji">
|
|
|
<h3>PartialCustomEmoji<a class="headerlink" href="#partialcustomemoji" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.lite.emoji.PartialCustomEmoji"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.emoji.PartialCustomEmoji">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.lite.emoji.</span></span><span class="sig-name descname"><span class="pre">PartialCustomEmoji</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">emoji</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.emoji.ICustomEmojiLite" title="mipac.types.emoji.ICustomEmojiLite"><span class="pre">ICustomEmojiLite</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.lite.emoji.PartialCustomEmoji" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="partialrole">
|
|
|
<h3>PartialRole<a class="headerlink" href="#partialrole" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.lite.role.PartialRole"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.role.PartialRole">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.lite.role.</span></span><span class="sig-name descname"><span class="pre">PartialRole</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">role_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.lite.role.PartialRole" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="partialad">
|
|
|
<h3>PartialAd<a class="headerlink" href="#partialad" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.lite.ad.PartialAd"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.ad.PartialAd">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.lite.ad.</span></span><span class="sig-name descname"><span class="pre">PartialAd</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_ad</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.lite.ad.PartialAd" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="liteinstance">
|
|
|
<h3>LiteInstance<a class="headerlink" href="#liteinstance" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.lite.instance.LiteInstance"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.instance.LiteInstance">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.lite.instance.</span></span><span class="sig-name descname"><span class="pre">LiteInstance</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">instance</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.instance.IInstanceLite" title="mipac.types.instance.IInstanceLite"><span class="pre">IInstanceLite</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.lite.instance.LiteInstance" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="avatardecoration">
|
|
|
<h3>AvatarDecoration<a class="headerlink" href="#avatardecoration" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.lite.user.AvatarDecoration"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Attributes</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.lite.user.AvatarDecoration.angle">angle</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.lite.user.AvatarDecoration.flip_h">flip_h</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.lite.user.AvatarDecoration.id">id</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.lite.user.AvatarDecoration.offset_x">offset_x</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.lite.user.AvatarDecoration.offset_y">offset_y</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.lite.user.AvatarDecoration.url">url</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.user.AvatarDecoration">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.lite.user.</span></span><span class="sig-name descname"><span class="pre">AvatarDecoration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_avatar_decoration</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.user.IAvatarDecoration" title="mipac.types.user.IAvatarDecoration"><span class="pre">IAvatarDecoration</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.lite.user.AvatarDecoration" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.user.AvatarDecoration.angle">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">angle</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.lite.user.AvatarDecoration.angle" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Returns the angle of the avatar decoration.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>The angle of the avatar decoration.</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>int | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.user.AvatarDecoration.flip_h">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">flip_h</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.lite.user.AvatarDecoration.flip_h" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Returns whether the avatar decoration is flipped horizontally.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>Whether the avatar decoration is flipped horizontally.</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>bool | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.user.AvatarDecoration.id">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mipac.models.lite.user.AvatarDecoration.id" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Returns the id of the avatar decoration.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>The id of the avatar decoration.</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>str</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.user.AvatarDecoration.offset_x">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">offset_x</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.lite.user.AvatarDecoration.offset_x" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Returns the x offset of the avatar decoration.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>The x offset of the avatar decoration.</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>int | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.user.AvatarDecoration.offset_y">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">offset_y</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.lite.user.AvatarDecoration.offset_y" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Returns the y offset of the avatar decoration.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>The y offset of the avatar decoration.</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>int | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.user.AvatarDecoration.url">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">url</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mipac.models.lite.user.AvatarDecoration.url" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Returns the url of the avatar decoration.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>The url of the avatar decoration.</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>str</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="badgerole">
|
|
|
<h3>BadgeRole<a class="headerlink" href="#badgerole" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.lite.user.BadgeRole"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Attributes</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.lite.user.BadgeRole.display_order">display_order</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.lite.user.BadgeRole.icon_url">icon_url</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.lite.user.BadgeRole.name">name</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.user.BadgeRole">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.lite.user.</span></span><span class="sig-name descname"><span class="pre">BadgeRole</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.lite.user.BadgeRole" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.user.BadgeRole.display_order">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">display_order</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#mipac.models.lite.user.BadgeRole.display_order" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Returns the display order of the badge role.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>The display order of the badge role.</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>int</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.user.BadgeRole.icon_url">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">icon_url</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.lite.user.BadgeRole.icon_url" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Returns the icon url of the badge role.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>The icon url of the badge role.</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>str | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.user.BadgeRole.name">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mipac.models.lite.user.BadgeRole.name" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Returns the name of the badge role.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>The name of the badge role.</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>str</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="partialuser">
|
|
|
<h3>PartialUser<a class="headerlink" href="#partialuser" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.lite.user.PartialUser"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Attributes</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.lite.user.PartialUser.api">api</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.lite.user.PartialUser.avatar_blurhash">avatar_blurhash</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.lite.user.PartialUser.avatar_decoration">avatar_decoration</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.lite.user.PartialUser.avatar_url">avatar_url</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.lite.user.PartialUser.badge_roles">badge_roles</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.lite.user.PartialUser.emojis">emojis</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.lite.user.PartialUser.host">host</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.lite.user.PartialUser.id">id</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.lite.user.PartialUser.instance">instance</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.lite.user.PartialUser.is_bot">is_bot</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.lite.user.PartialUser.is_cat">is_cat</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.lite.user.PartialUser.name">name</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.lite.user.PartialUser.online_status">online_status</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.lite.user.PartialUser.username">username</a></li></ul>
|
|
|
</div><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="method">
|
|
|
def</span><a class="reference internal" href="#mipac.models.lite.user.PartialUser.nickname">nickname</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.user.PartialUser">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.lite.user.</span></span><span class="sig-name descname"><span class="pre">PartialUser</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">PU</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.lite.user.PartialUser" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.user.PartialUser.api">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">api</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#mipac.manager.user.ClientUserManager" title="mipac.manager.user.ClientUserManager"><span class="pre">ClientUserManager</span></a></em><a class="headerlink" href="#mipac.models.lite.user.PartialUser.api" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Returns the user manager instance.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>The user manager instance</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p><a class="reference internal" href="#mipac.manager.user.ClientUserManager" title="mipac.manager.user.ClientUserManager">ClientUserManager</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.user.PartialUser.avatar_blurhash">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">avatar_blurhash</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.lite.user.PartialUser.avatar_blurhash" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Returns the avatar blurhash of the user.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>The avatar blurhash of the user.</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>str | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.user.PartialUser.avatar_decoration">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">avatar_decoration</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.lite.user.AvatarDecoration" title="mipac.models.lite.user.AvatarDecoration"><span class="pre">AvatarDecoration</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#mipac.models.lite.user.PartialUser.avatar_decoration" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Returns the avatar decoration of the user.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>The avatar decoration of the user.</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>list[<a class="reference internal" href="#mipac.models.lite.user.AvatarDecoration" title="mipac.models.lite.user.AvatarDecoration">AvatarDecoration</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.user.PartialUser.avatar_url">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">avatar_url</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.lite.user.PartialUser.avatar_url" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Returns the avatar url of the user.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>The avatar url of the user.</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>str | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.user.PartialUser.badge_roles">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">badge_roles</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.lite.user.BadgeRole" title="mipac.models.lite.user.BadgeRole"><span class="pre">BadgeRole</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.lite.user.PartialUser.badge_roles" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Returns the badge roles of the user.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>The badge roles of the user.</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>list[<a class="reference internal" href="#mipac.models.lite.user.BadgeRole" title="mipac.models.lite.user.BadgeRole">BadgeRole</a>] | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.user.PartialUser.emojis">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">emojis</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#mipac.models.lite.user.PartialUser.emojis" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Returns the emojis of the user.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>The emojis of the user.</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>dict[str, str]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.user.PartialUser.host">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">host</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.lite.user.PartialUser.host" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Returns the host of the user.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>The host of the user.</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>str | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.user.PartialUser.id">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mipac.models.lite.user.PartialUser.id" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Returns the id of the user.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.user.PartialUser.instance">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">instance</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#mipac.models.lite.instance.LiteInstance" title="mipac.models.lite.instance.LiteInstance"><span class="pre">LiteInstance</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.lite.user.PartialUser.instance" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Returns the instance of the user.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>The instance of the user.</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p><a class="reference internal" href="#mipac.models.lite.instance.LiteInstance" title="mipac.models.lite.instance.LiteInstance">LiteInstance</a> | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.user.PartialUser.is_bot">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">is_bot</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.lite.user.PartialUser.is_bot" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Returns whether the user is a bot.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>Whether the user is a bot.</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>bool | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.user.PartialUser.is_cat">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">is_cat</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.lite.user.PartialUser.is_cat" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Returns whether the user is a cat.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>Whether the user is a cat.</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>bool | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.user.PartialUser.name">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#mipac.models.lite.user.PartialUser.name" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Returns the nickname of the user.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>The nickname of the user.</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>str | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py attribute">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.user.PartialUser.nickname">
|
|
|
<span class="sig-name descname"><span class="pre">nickname</span></span><a class="headerlink" href="#mipac.models.lite.user.PartialUser.nickname" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Returns the nickname of the user.</p>
|
|
|
<div class="deprecated">
|
|
|
<p><span class="versionmodified deprecated">Deprecated since version 0.6.0: </span>Use <a class="reference internal" href="#mipac.models.lite.user.PartialUser.name" title="mipac.models.lite.user.PartialUser.name"><code class="xref py py-meth docutils literal notranslate"><span class="pre">mipac.models.lite.user.PartialUser.name()</span></code></a> instead.</p>
|
|
|
</div>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>The nickname of the user.</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>str | None</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.user.PartialUser.online_status">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">online_status</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'online'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'active'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'offline'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'unknown'</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#mipac.models.lite.user.PartialUser.online_status" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Returns the online status of the user.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>The online status of the user.</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>IUserOnlineStatus</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.user.PartialUser.username">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">username</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#mipac.models.lite.user.PartialUser.username" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Returns the username of the user.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>The username of the user.</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>str</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="partialmeta">
|
|
|
<h3>PartialMeta<a class="headerlink" href="#partialmeta" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.lite.meta.PartialMeta"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.meta.PartialMeta">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.lite.meta.</span></span><span class="sig-name descname"><span class="pre">PartialMeta</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_meta</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">T</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.lite.meta.PartialMeta" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="policies">
|
|
|
<h3>Policies<a class="headerlink" href="#policies" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.models.lite.meta.Policies"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Attributes</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.lite.meta.Policies.can_edit_note">can_edit_note</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.lite.meta.Policies.can_hide_ads">can_hide_ads</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.lite.meta.Policies.can_invite">can_invite</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.lite.meta.Policies.can_manage_custom_emojis">can_manage_custom_emojis</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.lite.meta.Policies.can_public_note">can_public_note</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.lite.meta.Policies.can_search_notes">can_search_notes</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.lite.meta.Policies.can_use_translator">can_use_translator</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.lite.meta.Policies.gtl_available">gtl_available</a></li><li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.models.lite.meta.Policies.ltl_available">ltl_available</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.meta.Policies">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.models.lite.meta.</span></span><span class="sig-name descname"><span class="pre">Policies</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">raw_policies</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.meta.IPolicies" title="mipac.types.meta.IPolicies"><span class="pre">IPolicies</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.models.lite.meta.Policies" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.meta.Policies.can_edit_note">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">can_edit_note</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#mipac.models.lite.meta.Policies.can_edit_note" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Whether you can edit a note</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.meta.Policies.can_hide_ads">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">can_hide_ads</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#mipac.models.lite.meta.Policies.can_hide_ads" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Whether you can hide ads</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.meta.Policies.can_invite">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">can_invite</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#mipac.models.lite.meta.Policies.can_invite" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Whether you can invite</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.meta.Policies.can_manage_custom_emojis">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">can_manage_custom_emojis</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#mipac.models.lite.meta.Policies.can_manage_custom_emojis" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Whether you can manage custom emojis</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.meta.Policies.can_public_note">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">can_public_note</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#mipac.models.lite.meta.Policies.can_public_note" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Whether you can post a public note</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.meta.Policies.can_search_notes">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">can_search_notes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#mipac.models.lite.meta.Policies.can_search_notes" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Whether you can search note</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.meta.Policies.can_use_translator">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">can_use_translator</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#mipac.models.lite.meta.Policies.can_use_translator" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Whether you can use translator</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.meta.Policies.gtl_available">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">gtl_available</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#mipac.models.lite.meta.Policies.gtl_available" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Whether GTL is effective</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.models.lite.meta.Policies.ltl_available">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ltl_available</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#mipac.models.lite.meta.Policies.ltl_available" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Whether LTL is effective</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
</section>
|
|
|
<section id="managers">
|
|
|
<h2>Managers<a class="headerlink" href="#managers" title="Link to this heading">#</a></h2>
|
|
|
<section id="blockingmanager">
|
|
|
<h3>BlockingManager<a class="headerlink" href="#blockingmanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.blocking.BlockingManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.blocking.BlockingManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.blocking.</span></span><span class="sig-name descname"><span class="pre">BlockingManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.blocking.BlockingManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientblockingmanager">
|
|
|
<h3>ClientBlockingManager<a class="headerlink" href="#clientblockingmanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.blocking.ClientBlockingManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.blocking.ClientBlockingManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.blocking.</span></span><span class="sig-name descname"><span class="pre">ClientBlockingManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.blocking.ClientBlockingManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientinvitemanager">
|
|
|
<h3>ClientInviteManager<a class="headerlink" href="#clientinvitemanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.invite.ClientInviteManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.invite.ClientInviteManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.invite.</span></span><span class="sig-name descname"><span class="pre">ClientInviteManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">invite_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.invite.ClientInviteManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="invitemanager">
|
|
|
<h3>InviteManager<a class="headerlink" href="#invitemanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.invite.InviteManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.invite.InviteManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.invite.</span></span><span class="sig-name descname"><span class="pre">InviteManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.invite.InviteManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="followmanager">
|
|
|
<h3>FollowManager<a class="headerlink" href="#followmanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.follow.FollowManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.follow.FollowManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.follow.</span></span><span class="sig-name descname"><span class="pre">FollowManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.follow.FollowManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="followrequestmanager">
|
|
|
<h3>FollowRequestManager<a class="headerlink" href="#followrequestmanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.follow.FollowRequestManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.follow.FollowRequestManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.follow.</span></span><span class="sig-name descname"><span class="pre">FollowRequestManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.follow.FollowRequestManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientnotemanager">
|
|
|
<h3>ClientNoteManager<a class="headerlink" href="#clientnotemanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.note.ClientNoteManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.note.ClientNoteManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.note.</span></span><span class="sig-name descname"><span class="pre">ClientNoteManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.note.ClientNoteManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="notemanager">
|
|
|
<h3>NoteManager<a class="headerlink" href="#notemanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.note.NoteManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.note.NoteManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.note.</span></span><span class="sig-name descname"><span class="pre">NoteManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.note.NoteManager" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>User behavior for notes</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="emojimanager">
|
|
|
<h3>EmojiManager<a class="headerlink" href="#emojimanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.emoji.EmojiManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.emoji.EmojiManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.emoji.</span></span><span class="sig-name descname"><span class="pre">EmojiManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.emoji.EmojiManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientclipmanager">
|
|
|
<h3>ClientClipManager<a class="headerlink" href="#clientclipmanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.clip.ClientClipManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.clip.ClientClipManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.clip.</span></span><span class="sig-name descname"><span class="pre">ClientClipManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">clip_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.clip.ClientClipManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clipmanager">
|
|
|
<h3>ClipManager<a class="headerlink" href="#clipmanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.clip.ClipManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.clip.ClipManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.clip.</span></span><span class="sig-name descname"><span class="pre">ClipManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.clip.ClipManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="federationmanager">
|
|
|
<h3>FederationManager<a class="headerlink" href="#federationmanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.federation.FederationManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.federation.FederationManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.federation.</span></span><span class="sig-name descname"><span class="pre">FederationManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.federation.FederationManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientreactionmanager">
|
|
|
<h3>ClientReactionManager<a class="headerlink" href="#clientreactionmanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.reaction.ClientReactionManager"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Attributes</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.manager.reaction.ClientReactionManager.action">action</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.reaction.ClientReactionManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.reaction.</span></span><span class="sig-name descname"><span class="pre">ClientReactionManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.reaction.ClientReactionManager" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.reaction.ClientReactionManager.action">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">action</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#mipac.actions.reaction.ClientReactionActions" title="mipac.actions.reaction.ClientReactionActions"><span class="pre">ClientReactionActions</span></a></em><a class="headerlink" href="#mipac.manager.reaction.ClientReactionManager.action" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>リアクションに関するアクション</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>Reactionに対するアクションを行うクラス</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p><a class="reference internal" href="#mipac.actions.reaction.ClientReactionActions" title="mipac.actions.reaction.ClientReactionActions">ClientReactionActions</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="reactionmanager">
|
|
|
<h3>ReactionManager<a class="headerlink" href="#reactionmanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.reaction.ReactionManager"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Attributes</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.manager.reaction.ReactionManager.action">action</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.reaction.ReactionManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.reaction.</span></span><span class="sig-name descname"><span class="pre">ReactionManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.reaction.ReactionManager" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.reaction.ReactionManager.action">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">action</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#mipac.actions.reaction.ReactionActions" title="mipac.actions.reaction.ReactionActions"><span class="pre">ReactionActions</span></a></em><a class="headerlink" href="#mipac.manager.reaction.ReactionManager.action" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>リアクションに関するアクション</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>Reactionに対するアクションを行うクラス</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p><a class="reference internal" href="#mipac.actions.reaction.ReactionActions" title="mipac.actions.reaction.ReactionActions">ReactionActions</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="channelmanager">
|
|
|
<h3>ChannelManager<a class="headerlink" href="#channelmanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.channel.ChannelManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.channel.ChannelManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.channel.</span></span><span class="sig-name descname"><span class="pre">ChannelManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.channel.ChannelManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientchannelmanager">
|
|
|
<h3>ClientChannelManager<a class="headerlink" href="#clientchannelmanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.channel.ClientChannelManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.channel.ClientChannelManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.channel.</span></span><span class="sig-name descname"><span class="pre">ClientChannelManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.channel.ClientChannelManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="rolemanager">
|
|
|
<h3>RoleManager<a class="headerlink" href="#rolemanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.role.RoleManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.role.RoleManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.role.</span></span><span class="sig-name descname"><span class="pre">RoleManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.role.RoleManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="usernamemanager">
|
|
|
<h3>UsernameManager<a class="headerlink" href="#usernamemanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.username.UsernameManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.username.UsernameManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.username.</span></span><span class="sig-name descname"><span class="pre">UsernameManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.username.UsernameManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="chartmanager">
|
|
|
<h3>ChartManager<a class="headerlink" href="#chartmanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.chart.ChartManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.chart.ChartManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.chart.</span></span><span class="sig-name descname"><span class="pre">ChartManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.chart.ChartManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="antennamanager">
|
|
|
<h3>AntennaManager<a class="headerlink" href="#antennamanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.antenna.AntennaManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.antenna.AntennaManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.antenna.</span></span><span class="sig-name descname"><span class="pre">AntennaManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.antenna.AntennaManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientantennamanager">
|
|
|
<h3>ClientAntennaManager<a class="headerlink" href="#clientantennamanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.antenna.ClientAntennaManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.antenna.ClientAntennaManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.antenna.</span></span><span class="sig-name descname"><span class="pre">ClientAntennaManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">antenna_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.antenna.ClientAntennaManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="pagesmanager">
|
|
|
<h3>PagesManager<a class="headerlink" href="#pagesmanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.page.PagesManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.page.PagesManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.page.</span></span><span class="sig-name descname"><span class="pre">PagesManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.page.PagesManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientpollmanager">
|
|
|
<h3>ClientPollManager<a class="headerlink" href="#clientpollmanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.poll.ClientPollManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.poll.ClientPollManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.poll.</span></span><span class="sig-name descname"><span class="pre">ClientPollManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.poll.ClientPollManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="pollmanager">
|
|
|
<h3>PollManager<a class="headerlink" href="#pollmanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.poll.PollManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.poll.PollManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.poll.</span></span><span class="sig-name descname"><span class="pre">PollManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.poll.PollManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="mymanager">
|
|
|
<h3>MyManager<a class="headerlink" href="#mymanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.my.MyManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.my.MyManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.my.</span></span><span class="sig-name descname"><span class="pre">MyManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.my.MyManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientfavoritemanager">
|
|
|
<h3>ClientFavoriteManager<a class="headerlink" href="#clientfavoritemanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.favorite.ClientFavoriteManager"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Attributes</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.manager.favorite.ClientFavoriteManager.action">action</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.favorite.ClientFavoriteManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.favorite.</span></span><span class="sig-name descname"><span class="pre">ClientFavoriteManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.favorite.ClientFavoriteManager" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.favorite.ClientFavoriteManager.action">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">action</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#mipac.actions.favorite.ClientFavoriteActions" title="mipac.actions.favorite.ClientFavoriteActions"><span class="pre">ClientFavoriteActions</span></a></em><a class="headerlink" href="#mipac.manager.favorite.ClientFavoriteManager.action" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>お気に入りに関するアクション</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>お気に入りに対するアクションを行うクラス</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p><a class="reference internal" href="#mipac.actions.favorite.ClientFavoriteActions" title="mipac.actions.favorite.ClientFavoriteActions">ClientFavoriteActions</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="favoritemanager">
|
|
|
<h3>FavoriteManager<a class="headerlink" href="#favoritemanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.favorite.FavoriteManager"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Attributes</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<a class="reference internal" href="#mipac.manager.favorite.FavoriteManager.action">action</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.favorite.FavoriteManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.favorite.</span></span><span class="sig-name descname"><span class="pre">FavoriteManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.favorite.FavoriteManager" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py property">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.favorite.FavoriteManager.action">
|
|
|
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">action</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#mipac.actions.favorite.FavoriteActions" title="mipac.actions.favorite.FavoriteActions"><span class="pre">FavoriteActions</span></a></em><a class="headerlink" href="#mipac.manager.favorite.FavoriteManager.action" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>お気に入りに関するアクション</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>お気に入りに対するアクションを行うクラス</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p><a class="reference internal" href="#mipac.actions.reaction.ReactionActions" title="mipac.actions.reaction.ReactionActions">ReactionActions</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientusermanager">
|
|
|
<h3>ClientUserManager<a class="headerlink" href="#clientusermanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.user.ClientUserManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.user.ClientUserManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.user.</span></span><span class="sig-name descname"><span class="pre">ClientUserManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.models.lite.user.PartialUser" title="mipac.models.lite.user.PartialUser"><span class="pre">PartialUser</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.user.ClientUserManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="usermanager">
|
|
|
<h3>UserManager<a class="headerlink" href="#usermanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.user.UserManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.user.UserManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.user.</span></span><span class="sig-name descname"><span class="pre">UserManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.user.UserManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientmanager">
|
|
|
<h3>ClientManager<a class="headerlink" href="#clientmanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.client.ClientManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.client.ClientManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.client.</span></span><span class="sig-name descname"><span class="pre">ClientManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.config.Config" title="mipac.config.Config"><span class="pre">Config</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.client.ClientManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientmutemanager">
|
|
|
<h3>ClientMuteManager<a class="headerlink" href="#clientmutemanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.users.mute.ClientMuteManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.users.mute.ClientMuteManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.users.mute.</span></span><span class="sig-name descname"><span class="pre">ClientMuteManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.users.mute.ClientMuteManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="mutemanager">
|
|
|
<h3>MuteManager<a class="headerlink" href="#mutemanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.users.mute.MuteManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.users.mute.MuteManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.users.mute.</span></span><span class="sig-name descname"><span class="pre">MuteManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.users.mute.MuteManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientpartialuserlistmanager">
|
|
|
<h3>ClientPartialUserListManager<a class="headerlink" href="#clientpartialuserlistmanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.users.list.ClientPartialUserListManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.users.list.ClientPartialUserListManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.users.list.</span></span><span class="sig-name descname"><span class="pre">ClientPartialUserListManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.users.list.ClientPartialUserListManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientuserlistmanager">
|
|
|
<h3>ClientUserListManager<a class="headerlink" href="#clientuserlistmanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.users.list.ClientUserListManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.users.list.ClientUserListManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.users.list.</span></span><span class="sig-name descname"><span class="pre">ClientUserListManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">list_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.users.list.ClientUserListManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="userlistmanager">
|
|
|
<h3>UserListManager<a class="headerlink" href="#userlistmanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.users.list.UserListManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.users.list.UserListManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.users.list.</span></span><span class="sig-name descname"><span class="pre">UserListManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.users.list.UserListManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="admininvitemanager">
|
|
|
<h3>AdminInviteManager<a class="headerlink" href="#admininvitemanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.admins.invite.AdminInviteManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.admins.invite.AdminInviteManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.admins.invite.</span></span><span class="sig-name descname"><span class="pre">AdminInviteManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.admins.invite.AdminInviteManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="adminannouncementmanager">
|
|
|
<h3>AdminAnnouncementManager<a class="headerlink" href="#adminannouncementmanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.admins.announcement.AdminAnnouncementManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.admins.announcement.AdminAnnouncementManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.admins.announcement.</span></span><span class="sig-name descname"><span class="pre">AdminAnnouncementManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.admins.announcement.AdminAnnouncementManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientadminannouncementmanager">
|
|
|
<h3>ClientAdminAnnouncementManager<a class="headerlink" href="#clientadminannouncementmanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.admins.announcement.ClientAdminAnnouncementManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.admins.announcement.ClientAdminAnnouncementManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.admins.announcement.</span></span><span class="sig-name descname"><span class="pre">ClientAdminAnnouncementManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">announce_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.admins.announcement.ClientAdminAnnouncementManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="adminemojimanager">
|
|
|
<h3>AdminEmojiManager<a class="headerlink" href="#adminemojimanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.admins.emoji.AdminEmojiManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.admins.emoji.AdminEmojiManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.admins.emoji.</span></span><span class="sig-name descname"><span class="pre">AdminEmojiManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.admins.emoji.AdminEmojiManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="adminmanager">
|
|
|
<h3>AdminManager<a class="headerlink" href="#adminmanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.admins.admin.AdminManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.admins.admin.AdminManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.admins.admin.</span></span><span class="sig-name descname"><span class="pre">AdminManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.admins.admin.AdminManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="admindrivemanager">
|
|
|
<h3>AdminDriveManager<a class="headerlink" href="#admindrivemanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.admins.drive.AdminDriveManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.admins.drive.AdminDriveManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.admins.drive.</span></span><span class="sig-name descname"><span class="pre">AdminDriveManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.admins.drive.AdminDriveManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="adminadmanager">
|
|
|
<h3>AdminAdManager<a class="headerlink" href="#adminadmanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.admins.ad.AdminAdManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.admins.ad.AdminAdManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.admins.ad.</span></span><span class="sig-name descname"><span class="pre">AdminAdManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.admins.ad.AdminAdManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientadminadmanager">
|
|
|
<h3>ClientAdminAdManager<a class="headerlink" href="#clientadminadmanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.admins.ad.ClientAdminAdManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.admins.ad.ClientAdminAdManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.admins.ad.</span></span><span class="sig-name descname"><span class="pre">ClientAdminAdManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ad_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.admins.ad.ClientAdminAdManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="adminrolesmanager">
|
|
|
<h3>AdminRolesManager<a class="headerlink" href="#adminrolesmanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.admins.roles.AdminRolesManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.admins.roles.AdminRolesManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.admins.roles.</span></span><span class="sig-name descname"><span class="pre">AdminRolesManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">role_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.admins.roles.AdminRolesManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="adminrolesmodelmanager">
|
|
|
<h3>AdminRolesModelManager<a class="headerlink" href="#adminrolesmodelmanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.admins.roles.AdminRolesModelManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.admins.roles.AdminRolesModelManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.admins.roles.</span></span><span class="sig-name descname"><span class="pre">AdminRolesModelManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">role_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.admins.roles.AdminRolesModelManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="adminusermanager">
|
|
|
<h3>AdminUserManager<a class="headerlink" href="#adminusermanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.admins.user.AdminUserManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.admins.user.AdminUserManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.admins.user.</span></span><span class="sig-name descname"><span class="pre">AdminUserManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.admins.user.AdminUserManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientfoldermanager">
|
|
|
<h3>ClientFolderManager<a class="headerlink" href="#clientfoldermanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.drive.folders.ClientFolderManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.drive.folders.ClientFolderManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.drive.folders.</span></span><span class="sig-name descname"><span class="pre">ClientFolderManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">folder_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.drive.folders.ClientFolderManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="foldermanager">
|
|
|
<h3>FolderManager<a class="headerlink" href="#foldermanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.drive.folders.FolderManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.drive.folders.FolderManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.drive.folders.</span></span><span class="sig-name descname"><span class="pre">FolderManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.drive.folders.FolderManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="drivemanager">
|
|
|
<h3>DriveManager<a class="headerlink" href="#drivemanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.drive.drive.DriveManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.drive.drive.DriveManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.drive.drive.</span></span><span class="sig-name descname"><span class="pre">DriveManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.drive.drive.DriveManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientfilemanager">
|
|
|
<h3>ClientFileManager<a class="headerlink" href="#clientfilemanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.drive.files.ClientFileManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.drive.files.ClientFileManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.drive.files.</span></span><span class="sig-name descname"><span class="pre">ClientFileManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.drive.files.ClientFileManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="drivefilemanager">
|
|
|
<h3>DriveFileManager<a class="headerlink" href="#drivefilemanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.manager.drive.files.DriveFileManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.manager.drive.files.DriveFileManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.manager.drive.files.</span></span><span class="sig-name descname"><span class="pre">DriveFileManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.manager.drive.files.DriveFileManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
</section>
|
|
|
<section id="actions">
|
|
|
<h2>Actions<a class="headerlink" href="#actions" title="Link to this heading">#</a></h2>
|
|
|
<section id="blockingactions">
|
|
|
<h3>BlockingActions<a class="headerlink" href="#blockingactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.blocking.BlockingActions"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.blocking.BlockingActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.blocking.</span></span><span class="sig-name descname"><span class="pre">BlockingActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.blocking.BlockingActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>ブロックアクション
|
|
|
user_idを持たないメソッドのみを持ち、持つものはSharedBlockingActionsに実装する</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientblockingactions">
|
|
|
<h3>ClientBlockingActions<a class="headerlink" href="#clientblockingactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.blocking.ClientBlockingActions"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.blocking.ClientBlockingActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.blocking.</span></span><span class="sig-name descname"><span class="pre">ClientBlockingActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.blocking.ClientBlockingActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>クライアント用のブロックアクション</p>
|
|
|
<p>基本的にoverride以外は行わない</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="sharedblockingactions">
|
|
|
<h3>SharedBlockingActions<a class="headerlink" href="#sharedblockingactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.blocking.SharedBlockingActions"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.blocking.SharedBlockingActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.blocking.</span></span><span class="sig-name descname"><span class="pre">SharedBlockingActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.blocking.SharedBlockingActions" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientinviteactions">
|
|
|
<h3>ClientInviteActions<a class="headerlink" href="#clientinviteactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.invite.ClientInviteActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.invite.ClientInviteActions.delete">delete</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.invite.ClientInviteActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.invite.</span></span><span class="sig-name descname"><span class="pre">ClientInviteActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">invite_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.invite.ClientInviteActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.invite.ClientInviteActions.delete">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">invite_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.invite.ClientInviteActions.delete" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Delete an invite code.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>invite_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>optional</em>) – The invite code to delete, by default None</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Whether the invite code was deleted.</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="inviteactions">
|
|
|
<h3>InviteActions<a class="headerlink" href="#inviteactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.invite.InviteActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.invite.InviteActions.create">create</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="method">
|
|
|
def</span><a class="reference internal" href="#mipac.actions.invite.InviteActions.get_all_list">get_all_list</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.invite.InviteActions.get_limit">get_limit</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.invite.InviteActions.get_list">get_list</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.invite.InviteActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.invite.</span></span><span class="sig-name descname"><span class="pre">InviteActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.invite.InviteActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.invite.InviteActions.create">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.invite.InviteCode" title="mipac.models.invite.InviteCode"><span class="pre">InviteCode</span></a></span></span><a class="headerlink" href="#mipac.actions.invite.InviteActions.create" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Create a new invite code.</p>
|
|
|
<p>Endpoint: <cite>/api/invite/create</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>The invite code created.</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>PartialInviteCode</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.invite.InviteActions.get_all_list">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_all_list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">AsyncGenerator</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.invite.InviteCode" title="mipac.models.invite.InviteCode"><span class="pre">InviteCode</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.invite.InviteActions.get_all_list" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get all invite codes created by you.</p>
|
|
|
<p>Endpoint: <cite>/api/invite/list</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>optional</em>) – The id of the invite code to get since, by default None</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>optional</em>) – The id of the invite code to get until, by default None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>The list of invite codes.</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[PartialInviteCode]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.invite.InviteActions.get_limit">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_limit</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.invite.InviteLimit" title="mipac.models.invite.InviteLimit"><span class="pre">InviteLimit</span></a></span></span><a class="headerlink" href="#mipac.actions.invite.InviteActions.get_limit" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get the number of invite codes you can create.</p>
|
|
|
<p>Endpoint: <cite>/api/invite/limit</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>The number of invite codes you can create.</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>int</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.invite.InviteActions.get_list">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">30</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.invite.InviteCode" title="mipac.models.invite.InviteCode"><span class="pre">InviteCode</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.invite.InviteActions.get_list" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get a list of invitation codes created by you.</p>
|
|
|
<p>Endpoint: <cite>/api/invite/list</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>limit</strong> (<em>int</em><em>, </em><em>optional</em>) – The number of invite codes to get, by default 30</p></li>
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>optional</em>) – The id of the invite code to get since, by default None</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>optional</em>) – The id of the invite code to get until, by default None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>The list of invite codes.</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[PartialInviteCode]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="sharedinviteactions">
|
|
|
<h3>SharedInviteActions<a class="headerlink" href="#sharedinviteactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.invite.SharedInviteActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.invite.SharedInviteActions.delete">delete</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.invite.SharedInviteActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.invite.</span></span><span class="sig-name descname"><span class="pre">SharedInviteActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.invite.SharedInviteActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.invite.SharedInviteActions.delete">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">invite_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.invite.SharedInviteActions.delete" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Delete an invite code.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>invite_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>optional</em>) – The invite code to delete, by default None</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Whether the invite code was deleted.</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="followactions">
|
|
|
<h3>FollowActions<a class="headerlink" href="#followactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.follow.FollowActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.follow.FollowActions.add">add</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.follow.FollowActions.invalidate">invalidate</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.follow.FollowActions.remove">remove</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.follow.FollowActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.follow.</span></span><span class="sig-name descname"><span class="pre">FollowActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.follow.FollowActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.follow.FollowActions.add">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.lite.user.PartialUser" title="mipac.models.lite.user.PartialUser"><span class="pre">PartialUser</span></a></span></span><a class="headerlink" href="#mipac.actions.follow.FollowActions.add" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Follow a user</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>The user that you followed</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>UserLite</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.follow.FollowActions.invalidate">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">invalidate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.lite.user.PartialUser" title="mipac.models.lite.user.PartialUser"><span class="pre">PartialUser</span></a></span></span><a class="headerlink" href="#mipac.actions.follow.FollowActions.invalidate" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Make the user unfollows you</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>The user that followed you</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p><a class="reference internal" href="#mipac.models.lite.user.PartialUser" title="mipac.models.lite.user.PartialUser">PartialUser</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.follow.FollowActions.remove">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.lite.user.PartialUser" title="mipac.models.lite.user.PartialUser"><span class="pre">PartialUser</span></a></span></span><a class="headerlink" href="#mipac.actions.follow.FollowActions.remove" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Unfollow a user</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>The user that you unfollowed</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p><a class="reference internal" href="#mipac.models.lite.user.PartialUser" title="mipac.models.lite.user.PartialUser">PartialUser</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="followrequestactions">
|
|
|
<h3>FollowRequestActions<a class="headerlink" href="#followrequestactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.follow.FollowRequestActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.follow.FollowRequestActions.accept">accept</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.follow.FollowRequestActions.cancel">cancel</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.follow.FollowRequestActions.get_all">get_all</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.follow.FollowRequestActions.reject">reject</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.follow.FollowRequestActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.follow.</span></span><span class="sig-name descname"><span class="pre">FollowRequestActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.follow.FollowRequestActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.follow.FollowRequestActions.accept">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">accept</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.follow.FollowRequestActions.accept" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Accept a follow request</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>user_id</strong> (<em>str</em>) – The user ID to accept</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Whether the request was accepted</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.follow.FollowRequestActions.cancel">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cancel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.lite.user.PartialUser" title="mipac.models.lite.user.PartialUser"><span class="pre">PartialUser</span></a></span></span><a class="headerlink" href="#mipac.actions.follow.FollowRequestActions.cancel" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Cancel a follow request</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>user_id</strong> (<em>str</em>) – The user ID to cancel</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>The user that you canceled to follow</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.lite.user.PartialUser" title="mipac.models.lite.user.PartialUser">PartialUser</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.follow.FollowRequestActions.get_all">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_all</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.follow.FollowRequest" title="mipac.models.follow.FollowRequest"><span class="pre">FollowRequest</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.follow.FollowRequestActions.get_all" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get all follow requests</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>List of follow requests</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>list[<a class="reference internal" href="#mipac.models.follow.FollowRequest" title="mipac.models.follow.FollowRequest">FollowRequest</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.follow.FollowRequestActions.reject">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">reject</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.follow.FollowRequestActions.reject" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Reject a follow request</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>user_id</strong> (<em>str</em>) – The user ID to reject</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Whether the request was rejected</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="create-note-body">
|
|
|
<h3>create_note_body<a class="headerlink" href="#create-note-body" title="Link to this heading">#</a></h3>
|
|
|
<dl class="py function">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.create_note_body">
|
|
|
<span class="sig-prename descclassname"><span class="pre">mipac.actions.note.</span></span><span class="sig-name descname"><span class="pre">create_note_body</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">visibility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'public'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'home'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'followers'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'specified'</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'public'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">visible_user_ids</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cw</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">local_only</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reaction_acceptance</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="pre">None</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'likeOnly'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'likeOnlyForRemote'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'nonSensitiveOnly'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'nonSensitiveOnlyForLocalLikeOnlyForRemote'</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extract_mentions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extract_hashtags</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extract_emojis</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reply_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">renote_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">files</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.file.MiFile" title="mipac.file.MiFile"><span class="pre">MiFile</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File"><span class="pre">File</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">media_ids</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">poll</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.models.poll.MiPoll" title="mipac.models.poll.MiPoll"><span class="pre">MiPoll</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.note.create_note_body" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientnoteactions">
|
|
|
<h3>ClientNoteActions<a class="headerlink" href="#clientnoteactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.note.ClientNoteActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.note.ClientNoteActions.add_clips">add_clips</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.note.ClientNoteActions.create_quote">create_quote</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.note.ClientNoteActions.create_renote">create_renote</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.note.ClientNoteActions.delete">delete</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.note.ClientNoteActions.fetch_children">fetch_children</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.note.ClientNoteActions.fetch_state">fetch_state</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="method">
|
|
|
def</span><a class="reference internal" href="#mipac.actions.note.ClientNoteActions.get_all_children">get_all_children</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="method">
|
|
|
def</span><a class="reference internal" href="#mipac.actions.note.ClientNoteActions.get_all_replies">get_all_replies</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.note.ClientNoteActions.get_clips">get_clips</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.note.ClientNoteActions.get_conversation">get_conversation</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.note.ClientNoteActions.get_renotes">get_renotes</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.note.ClientNoteActions.get_replies">get_replies</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.note.ClientNoteActions.get_state">get_state</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.note.ClientNoteActions.renote">renote</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.note.ClientNoteActions.translate">translate</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.note.ClientNoteActions.un_renote">un_renote</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.ClientNoteActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.note.</span></span><span class="sig-name descname"><span class="pre">ClientNoteActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.note.ClientNoteActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.ClientNoteActions.add_clips">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_clips</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">clip_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.note.ClientNoteActions.add_clips" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Add a note to the clip</p>
|
|
|
<p>Endpoint: <cite>/api/clips/add-note</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>note_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – note id</p></li>
|
|
|
<li><p><strong>clip_id</strong> (<em>str</em>) – clip id</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>success or not</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.ClientNoteActions.create_quote">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_quote</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">content</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">visibility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'public'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'home'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'followers'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'specified'</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'public'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">visible_user_ids</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cw</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">local_only</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reaction_acceptance</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="pre">None</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'likeOnly'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'likeOnlyForRemote'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'nonSensitiveOnly'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'nonSensitiveOnlyForLocalLikeOnlyForRemote'</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extract_mentions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extract_hashtags</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extract_emojis</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">files</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.file.MiFile" title="mipac.file.MiFile"><span class="pre">MiFile</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File"><span class="pre">File</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">poll</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.models.poll.MiPoll" title="mipac.models.poll.MiPoll"><span class="pre">MiPoll</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a></span></span><a class="headerlink" href="#mipac.actions.note.ClientNoteActions.create_quote" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Create a note quote.</p>
|
|
|
<p>Endpoint: <cite>/api/notes/create</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>content</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – text</p></li>
|
|
|
<li><p><strong>visibility</strong> (<em>INoteVisibility</em><em>, </em><em>default='public'</em>) – Disclosure range</p></li>
|
|
|
<li><p><strong>visible_user_ids</strong> (<em>list</em><em>[</em><em>str</em><em>] </em><em>| </em><em>None</em><em>, </em><em>default=None</em>) – List of users to be published</p></li>
|
|
|
<li><p><strong>cw</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Text to be displayed when warning is given</p></li>
|
|
|
<li><p><strong>local_only</strong> (<em>bool</em><em>, </em><em>default=False</em>) – Whether to show only locally or not</p></li>
|
|
|
<li><p><strong>extract_mentions</strong> (<em>bool</em><em>, </em><em>default=True</em>) – Whether to expand the mention</p></li>
|
|
|
<li><p><strong>extract_hashtags</strong> (<em>bool</em><em>, </em><em>default=True</em>) – Whether to expand the hashtag</p></li>
|
|
|
<li><p><strong>extract_emojis</strong> (<em>bool</em><em>, </em><em>default=True</em>) – Whether to expand the emojis</p></li>
|
|
|
<li><p><strong>files</strong> (<em>list</em><em>[</em><a class="reference internal" href="#mipac.file.MiFile" title="mipac.file.MiFile"><em>MiFile</em></a><em> | </em><a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File"><em>File</em></a><em> | </em><em>str</em><em>] </em><em>| </em><em>None</em><em>, </em><em>default=None</em>) – The ID list of files to be attached</p></li>
|
|
|
<li><p><strong>poll</strong> (<a class="reference internal" href="#mipac.models.poll.MiPoll" title="mipac.models.poll.MiPoll"><em>MiPoll</em></a><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Questionnaire to be created</p></li>
|
|
|
<li><p><strong>note_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Note IDs to target for renote and citations</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.ClientNoteActions.create_renote">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_renote</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a></span></span><a class="headerlink" href="#mipac.actions.note.ClientNoteActions.create_renote" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Renote a note</p>
|
|
|
<p>Endpoint: <cite>/api/notes/create</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>note_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – note id</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Renoted note</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.ClientNoteActions.delete">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.note.ClientNoteActions.delete" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Delete a note</p>
|
|
|
<p>Endpoint: <cite>/api/notes/delete</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>note_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – note id</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>success or not</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.ClientNoteActions.fetch_children">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fetch_children</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">100</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">untilId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.note.ClientNoteActions.fetch_children" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get children of the note.
|
|
|
update the cache of the <code class="xref py py-meth docutils literal notranslate"><span class="pre">mipac.actions.note.ClientNoteActions.get_children()</span></code> method</p>
|
|
|
<p>Endpoint: <cite>/api/notes/children</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>limit</strong> (<em>int</em><em>, </em><em>default=100</em>) – limit</p></li>
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Since ID</p></li>
|
|
|
<li><p><strong>untilId</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Until ID</p></li>
|
|
|
<li><p><strong>note_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – note id</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Children of the note</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.ClientNoteActions.fetch_state">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fetch_state</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.note.NoteState" title="mipac.models.note.NoteState"><span class="pre">NoteState</span></a></span></span><a class="headerlink" href="#mipac.actions.note.ClientNoteActions.fetch_state" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get the state of the note.</p>
|
|
|
<p>update the cache of the <a class="reference internal" href="#mipac.actions.note.ClientNoteActions.get_state" title="mipac.actions.note.ClientNoteActions.get_state"><code class="xref py py-meth docutils literal notranslate"><span class="pre">mipac.actions.note.ClientNoteActions.get_state()</span></code></a> method</p>
|
|
|
<p>Endpoint: <cite>/api/notes/state</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>note_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – note id</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Note state</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.note.NoteState" title="mipac.models.note.NoteState">NoteState</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.ClientNoteActions.get_all_children">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_all_children</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">untilId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">AsyncGenerator</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.note.ClientNoteActions.get_all_children" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get all children of the note</p>
|
|
|
<p>Endpoint: <cite>/api/notes/children</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Since ID</p></li>
|
|
|
<li><p><strong>untilId</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Until ID</p></li>
|
|
|
<li><p><strong>note_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – note id</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Children of the note</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>AsyncGenerator[<a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a>, None]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.ClientNoteActions.get_all_replies">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_all_replies</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">AsyncGenerator</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.note.ClientNoteActions.get_all_replies" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get replies to the note</p>
|
|
|
<p>Endpoint: <cite>/api/notes/replies</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – since id</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – until id</p></li>
|
|
|
<li><p><strong>note_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – note id</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>replies</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>AsyncGenerator[<a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a>, None]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.ClientNoteActions.get_clips">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_clips</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.clip.Clip" title="mipac.models.clip.Clip"><span class="pre">Clip</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.note.ClientNoteActions.get_clips" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get the clips of the note</p>
|
|
|
<p>Endpoint: <cite>/api/notes/clips</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>note_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – note id</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Clips of the note</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.clip.Clip" title="mipac.models.clip.Clip">Clip</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.ClientNoteActions.get_conversation">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_conversation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">offset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.note.ClientNoteActions.get_conversation" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get the conversation of the note</p>
|
|
|
<p>Endpoint: <cite>/api/notes/conversation</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>limit</strong> (<em>int</em><em>, </em><em>default=10</em>) – limit</p></li>
|
|
|
<li><p><strong>offset</strong> (<em>int</em><em>, </em><em>default=0</em>) – offset</p></li>
|
|
|
<li><p><strong>note_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – note id</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Notes of the conversation</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.ClientNoteActions.get_renotes">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_renotes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.note.ClientNoteActions.get_renotes" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get renote of the note</p>
|
|
|
<p>Endpoint: <cite>/api/notes/renotes</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>limit</strong> (<em>int</em><em>, </em><em>default=10</em>) – limit</p></li>
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Since ID</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Until ID</p></li>
|
|
|
<li><p><strong>note_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – note id</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Renotes of the note</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.ClientNoteActions.get_replies">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_replies</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.note.ClientNoteActions.get_replies" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get replies to the note</p>
|
|
|
<p>Endpoint: <cite>/api/notes/replies</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – since id</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – until id</p></li>
|
|
|
<li><p><strong>limit</strong> (<em>int</em><em>, </em><em>default=10</em>) – limit</p></li>
|
|
|
<li><p><strong>note_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – note id</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>replies</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.ClientNoteActions.get_state">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_state</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.note.NoteState" title="mipac.models.note.NoteState"><span class="pre">NoteState</span></a></span></span><a class="headerlink" href="#mipac.actions.note.ClientNoteActions.get_state" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get the state of the note</p>
|
|
|
<p>Endpoint: <cite>/api/notes/state</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>note_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – note id</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Note state</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.note.NoteState" title="mipac.models.note.NoteState">NoteState</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.ClientNoteActions.renote">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">renote</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">visibility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'public'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'home'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'followers'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'specified'</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'public'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">visible_user_ids</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cw</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">local_only</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reaction_acceptance</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="pre">None</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'likeOnly'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'likeOnlyForRemote'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'nonSensitiveOnly'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'nonSensitiveOnlyForLocalLikeOnlyForRemote'</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extract_mentions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extract_hashtags</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extract_emojis</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">files</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.file.MiFile" title="mipac.file.MiFile"><span class="pre">MiFile</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File"><span class="pre">File</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">poll</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.models.poll.MiPoll" title="mipac.models.poll.MiPoll"><span class="pre">MiPoll</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">renote_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.note.ClientNoteActions.renote" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Renote a note</p>
|
|
|
<p>Endpoint: <cite>/api/notes/create</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>text</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – text</p></li>
|
|
|
<li><p><strong>visibility</strong> (<em>INoteVisibility</em><em>, </em><em>default='public'</em>) – Disclosure range</p></li>
|
|
|
<li><p><strong>visible_user_ids</strong> (<em>list</em><em>[</em><em>str</em><em>] </em><em>| </em><em>None</em><em>, </em><em>default=None</em>) – List of users to be published</p></li>
|
|
|
<li><p><strong>cw</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Text to be displayed when warning is given</p></li>
|
|
|
<li><p><strong>local_only</strong> (<em>bool</em><em>, </em><em>default=False</em>) – Whether to show only locally or not</p></li>
|
|
|
<li><p><strong>reaction_acceptance</strong> (<em>IReactionAcceptance</em><em>, </em><em>default=None</em>) – Reaction acceptance setting</p></li>
|
|
|
<li><p><strong>extract_mentions</strong> (<em>bool</em><em>, </em><em>default=True</em>) – Whether to expand the mention</p></li>
|
|
|
<li><p><strong>extract_hashtags</strong> (<em>bool</em><em>, </em><em>default=True</em>) – Whether to expand the hashtag</p></li>
|
|
|
<li><p><strong>extract_emojis</strong> (<em>bool</em><em>, </em><em>default=True</em>) – Whether to expand the emojis</p></li>
|
|
|
<li><p><strong>channel_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Channel ID</p></li>
|
|
|
<li><p><strong>files</strong> (<em>list</em><em>[</em><a class="reference internal" href="#mipac.file.MiFile" title="mipac.file.MiFile"><em>MiFile</em></a><em> | </em><a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File"><em>File</em></a><em> | </em><em>str</em><em>] </em><em>| </em><em>None</em><em>, </em><em>default=None</em>) – The ID list of files to be attached</p></li>
|
|
|
<li><p><strong>poll</strong> (<a class="reference internal" href="#mipac.models.poll.MiPoll" title="mipac.models.poll.MiPoll"><em>MiPoll</em></a><em> | </em><em>None</em><em>, </em><em>default=None</em>) – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.ClientNoteActions.translate">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">translate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target_lang</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'en-US'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.note.NoteTranslateResult" title="mipac.models.note.NoteTranslateResult"><span class="pre">NoteTranslateResult</span></a></span></span><a class="headerlink" href="#mipac.actions.note.ClientNoteActions.translate" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Translate a note</p>
|
|
|
<p>Endpoint: <cite>/api/notes/translate</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>note_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Note ID to target for translation</p></li>
|
|
|
<li><p><strong>target_lang</strong> (<em>str</em><em>, </em><em>default='en'</em>) – Target language</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Translated result</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.note.NoteTranslateResult" title="mipac.models.note.NoteTranslateResult">NoteTranslateResult</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.ClientNoteActions.un_renote">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">un_renote</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.note.ClientNoteActions.un_renote" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Releases the note renote for the specified Id</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>note_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>optional</em>) – Target note Id., by default None</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Whether the release was successful</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="noteactions">
|
|
|
<h3>NoteActions<a class="headerlink" href="#noteactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.note.NoteActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.note.NoteActions.fetch">fetch</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.note.NoteActions.get">get</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.note.NoteActions.get_featured">get_featured</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.note.NoteActions.get_global_time_line">get_global_time_line</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.note.NoteActions.get_mentions">get_mentions</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.note.NoteActions.get_time_line">get_time_line</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="method">
|
|
|
def</span><a class="reference internal" href="#mipac.actions.note.NoteActions.send">send</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.NoteActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.note.</span></span><span class="sig-name descname"><span class="pre">NoteActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.note.NoteActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.NoteActions.fetch">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fetch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a></span></span><a class="headerlink" href="#mipac.actions.note.NoteActions.fetch" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get a note.</p>
|
|
|
<p>update the cache of the <a class="reference internal" href="#mipac.actions.note.NoteActions.get" title="mipac.actions.note.NoteActions.get"><code class="xref py py-meth docutils literal notranslate"><span class="pre">mipac.actions.note.NoteActions.get()</span></code></a> method</p>
|
|
|
<p>Endpoint: <cite>/api/notes/show</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>note_id</strong> (<em>str</em>) – note id</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>note</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.NoteActions.get">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a></span></span><a class="headerlink" href="#mipac.actions.note.NoteActions.get" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get a note</p>
|
|
|
<p>Endpoint: <cite>/api/notes/show</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>note_id</strong> (<em>str</em>) – ノートのID</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>取得したノートID</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.NoteActions.get_featured">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_featured</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.note.NoteActions.get_featured" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get featured notes</p>
|
|
|
<p>Endpoint: <cite>/api/notes/featured</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>limit</strong> (<em>int</em><em>, </em><em>default=10</em>) – limit</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Until ID</p></li>
|
|
|
<li><p><strong>channel_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – channel id</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>featured notes</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.NoteActions.get_global_time_line">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_global_time_line</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">with_files</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">with_renotes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">since_date</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_date</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.note.NoteActions.get_global_time_line" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get global timeline</p>
|
|
|
<p>Endpoint: <cite>/api/notes/global-timeline</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>with_files</strong> (<em>bool</em><em>, </em><em>default=False</em>) – Whether to include files</p></li>
|
|
|
<li><p><strong>with_renotes</strong> (<em>bool</em><em>, </em><em>default=True</em>) – Whether to include renote</p></li>
|
|
|
<li><p><strong>limit</strong> (<em>int</em><em>, </em><em>default=10</em>) – limit</p></li>
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Since ID</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Until ID</p></li>
|
|
|
<li><p><strong>since_date</strong> (<em>int</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Since date</p></li>
|
|
|
<li><p><strong>until_date</strong> (<em>int</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Until date</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>global timeline</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.NoteActions.get_mentions">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_mentions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">following</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">visibility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'public'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'home'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'followers'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'specified'</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'public'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.note.NoteActions.get_mentions" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get notes with mentions addressed to you</p>
|
|
|
<p>Endpoint: <cite>/api/notes/mentions</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>following</strong> (<em>bool</em><em>, </em><em>default=False</em>) – Whether to include only users you follow</p></li>
|
|
|
<li><p><strong>limit</strong> (<em>int</em><em>, </em><em>default=10</em>) – limit</p></li>
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Since ID</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Until ID</p></li>
|
|
|
<li><p><strong>visibility</strong> (<em>INoteVisibility</em><em>, </em><em>default='public'</em>) – Disclosure range</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.NoteActions.get_time_line">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_time_line</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">list_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">since_date</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_date</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include_renote_my_notes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">include_local_renotes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">with_renotes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">with_files</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.note.NoteActions.get_time_line" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get the timeline of the specified list</p>
|
|
|
<p>Endpoint: <cite>/api/notes/user-list-timeline</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>list_id</strong> (<em>str</em>) – List ID</p></li>
|
|
|
<li><p><strong>limit</strong> (<em>int</em><em>, </em><em>default=10</em>) – limit</p></li>
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Since ID</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Until ID</p></li>
|
|
|
<li><p><strong>since_date</strong> (<em>int</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Since date</p></li>
|
|
|
<li><p><strong>until_date</strong> (<em>int</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Until date</p></li>
|
|
|
<li><p><strong>include_renote_my_notes</strong> (<em>bool</em><em>, </em><em>default=True</em>) – Whether to include your own renote</p></li>
|
|
|
<li><p><strong>include_local_renotes</strong> (<em>bool</em><em>, </em><em>default=True</em>) – Whether to include local renote</p></li>
|
|
|
<li><p><strong>with_renotes</strong> (<em>bool</em><em>, </em><em>default=True</em>) – Whether to include renote</p></li>
|
|
|
<li><p><strong>with_files</strong> (<em>bool</em><em>, </em><em>default=True</em>) – Whether to include files</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Notes</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.NoteActions.send">
|
|
|
<span class="sig-name descname"><span class="pre">send</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">visibility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'public'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'home'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'followers'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'specified'</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'public'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">visible_user_ids</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cw</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">local_only</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reaction_acceptance</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="pre">None</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'likeOnly'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'likeOnlyForRemote'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'nonSensitiveOnly'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'nonSensitiveOnlyForLocalLikeOnlyForRemote'</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extract_mentions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extract_hashtags</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extract_emojis</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reply_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">renote_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">files</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.file.MiFile" title="mipac.file.MiFile"><span class="pre">MiFile</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File"><span class="pre">File</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">poll</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.models.poll.MiPoll" title="mipac.models.poll.MiPoll"><span class="pre">MiPoll</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a></span></span><a class="headerlink" href="#mipac.actions.note.NoteActions.send" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Send a note</p>
|
|
|
<p>Endpoint: <cite>/api/notes/create</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>text</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – 投稿する内容</p></li>
|
|
|
<li><p><strong>visibility</strong> (<em>INoteVisibility</em><em>, </em><em>optional</em>) – 公開範囲, by default “public”
|
|
|
Enum: “public” “home” “followers” “specified”</p></li>
|
|
|
<li><p><strong>visible_user_ids</strong> (<em>list</em><em>[</em><em>str</em><em>] </em><em>| </em><em>None</em><em>, </em><em>optional</em>) – 公開するユーザー, by default None</p></li>
|
|
|
<li><p><strong>cw</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>optional</em>) – 閲覧注意の文字, by default None</p></li>
|
|
|
<li><p><strong>local_only</strong> (<em>bool</em><em>, </em><em>optional</em>) – ローカルにのみ表示するか, by default False</p></li>
|
|
|
<li><p><strong>reaction_acceptance</strong> (<em>IReactionAcceptance</em><em>, </em><em>optional</em>) – リアクションの受け入れ設定, by default None</p></li>
|
|
|
<li><p><strong>extract_mentions</strong> (<em>bool</em><em>, </em><em>optional</em>) – メンションを展開するか, by default True</p></li>
|
|
|
<li><p><strong>extract_hashtags</strong> (<em>bool</em><em>, </em><em>optional</em>) – ハッシュタグを展開するか, by default True</p></li>
|
|
|
<li><p><strong>extract_emojis</strong> (<em>bool</em><em>, </em><em>optional</em>) – 絵文字を展開するか, by default True</p></li>
|
|
|
<li><p><strong>reply_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>optional</em>) – リプライ先のid, by default None</p></li>
|
|
|
<li><p><strong>renote_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>optional</em>) – リノート先のid, by default None</p></li>
|
|
|
<li><p><strong>channel_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>optional</em>) – チャンネルid, by default None</p></li>
|
|
|
<li><p><strong>files</strong> (<em>list</em><em>[</em><a class="reference internal" href="#mipac.file.MiFile" title="mipac.file.MiFile"><em>MiFile</em></a><em> | </em><a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File"><em>File</em></a><em> | </em><em>str</em><em>]</em><em>, </em><em>optional</em>) – 添付するファイルのリスト, by default None</p></li>
|
|
|
<li><p><strong>poll</strong> (<a class="reference internal" href="#mipac.models.poll.MiPoll" title="mipac.models.poll.MiPoll"><em>MiPoll</em></a><em> | </em><em>None</em><em>, </em><em>optional</em>) – アンケート, by default None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>投稿したノート</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a></p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p><strong>ContentRequired</strong> – [description]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="sharednoteactions">
|
|
|
<h3>SharedNoteActions<a class="headerlink" href="#sharednoteactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.note.SharedNoteActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.note.SharedNoteActions.add_clips">add_clips</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.note.SharedNoteActions.create_quote">create_quote</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.note.SharedNoteActions.create_renote">create_renote</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.note.SharedNoteActions.delete">delete</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.note.SharedNoteActions.fetch_children">fetch_children</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.note.SharedNoteActions.fetch_state">fetch_state</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="method">
|
|
|
def</span><a class="reference internal" href="#mipac.actions.note.SharedNoteActions.get_all_children">get_all_children</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="method">
|
|
|
def</span><a class="reference internal" href="#mipac.actions.note.SharedNoteActions.get_all_replies">get_all_replies</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.note.SharedNoteActions.get_clips">get_clips</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.note.SharedNoteActions.get_conversation">get_conversation</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.note.SharedNoteActions.get_renotes">get_renotes</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.note.SharedNoteActions.get_replies">get_replies</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.note.SharedNoteActions.get_state">get_state</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.note.SharedNoteActions.renote">renote</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.note.SharedNoteActions.translate">translate</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.note.SharedNoteActions.un_renote">un_renote</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.SharedNoteActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.note.</span></span><span class="sig-name descname"><span class="pre">SharedNoteActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.note.SharedNoteActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.SharedNoteActions.add_clips">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_clips</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">clip_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.note.SharedNoteActions.add_clips" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Add a note to the clip</p>
|
|
|
<p>Endpoint: <cite>/api/clips/add-note</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>note_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – note id</p></li>
|
|
|
<li><p><strong>clip_id</strong> (<em>str</em>) – clip id</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>success or not</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.SharedNoteActions.create_quote">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_quote</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">content</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">visibility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'public'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'home'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'followers'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'specified'</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'public'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">visible_user_ids</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cw</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">local_only</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reaction_acceptance</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="pre">None</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'likeOnly'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'likeOnlyForRemote'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'nonSensitiveOnly'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'nonSensitiveOnlyForLocalLikeOnlyForRemote'</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extract_mentions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extract_hashtags</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extract_emojis</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">files</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.file.MiFile" title="mipac.file.MiFile"><span class="pre">MiFile</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File"><span class="pre">File</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">poll</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.models.poll.MiPoll" title="mipac.models.poll.MiPoll"><span class="pre">MiPoll</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a></span></span><a class="headerlink" href="#mipac.actions.note.SharedNoteActions.create_quote" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Create a note quote.</p>
|
|
|
<p>Endpoint: <cite>/api/notes/create</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>content</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – text</p></li>
|
|
|
<li><p><strong>visibility</strong> (<em>INoteVisibility</em><em>, </em><em>default='public'</em>) – Disclosure range</p></li>
|
|
|
<li><p><strong>visible_user_ids</strong> (<em>list</em><em>[</em><em>str</em><em>] </em><em>| </em><em>None</em><em>, </em><em>default=None</em>) – List of users to be published</p></li>
|
|
|
<li><p><strong>cw</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Text to be displayed when warning is given</p></li>
|
|
|
<li><p><strong>local_only</strong> (<em>bool</em><em>, </em><em>default=False</em>) – Whether to show only locally or not</p></li>
|
|
|
<li><p><strong>extract_mentions</strong> (<em>bool</em><em>, </em><em>default=True</em>) – Whether to expand the mention</p></li>
|
|
|
<li><p><strong>extract_hashtags</strong> (<em>bool</em><em>, </em><em>default=True</em>) – Whether to expand the hashtag</p></li>
|
|
|
<li><p><strong>extract_emojis</strong> (<em>bool</em><em>, </em><em>default=True</em>) – Whether to expand the emojis</p></li>
|
|
|
<li><p><strong>files</strong> (<em>list</em><em>[</em><a class="reference internal" href="#mipac.file.MiFile" title="mipac.file.MiFile"><em>MiFile</em></a><em> | </em><a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File"><em>File</em></a><em> | </em><em>str</em><em>] </em><em>| </em><em>None</em><em>, </em><em>default=None</em>) – The ID list of files to be attached</p></li>
|
|
|
<li><p><strong>poll</strong> (<a class="reference internal" href="#mipac.models.poll.MiPoll" title="mipac.models.poll.MiPoll"><em>MiPoll</em></a><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Questionnaire to be created</p></li>
|
|
|
<li><p><strong>note_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Note IDs to target for renote and citations</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.SharedNoteActions.create_renote">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_renote</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a></span></span><a class="headerlink" href="#mipac.actions.note.SharedNoteActions.create_renote" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Renote a note</p>
|
|
|
<p>Endpoint: <cite>/api/notes/create</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>note_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – note id</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Renoted note</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.SharedNoteActions.delete">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.note.SharedNoteActions.delete" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Delete a note</p>
|
|
|
<p>Endpoint: <cite>/api/notes/delete</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>note_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – note id</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>success or not</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.SharedNoteActions.fetch_children">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fetch_children</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">100</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">untilId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.note.SharedNoteActions.fetch_children" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get children of the note.
|
|
|
update the cache of the <code class="xref py py-meth docutils literal notranslate"><span class="pre">mipac.actions.note.ClientNoteActions.get_children()</span></code> method</p>
|
|
|
<p>Endpoint: <cite>/api/notes/children</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>limit</strong> (<em>int</em><em>, </em><em>default=100</em>) – limit</p></li>
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Since ID</p></li>
|
|
|
<li><p><strong>untilId</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Until ID</p></li>
|
|
|
<li><p><strong>note_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – note id</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Children of the note</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.SharedNoteActions.fetch_state">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fetch_state</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.note.NoteState" title="mipac.models.note.NoteState"><span class="pre">NoteState</span></a></span></span><a class="headerlink" href="#mipac.actions.note.SharedNoteActions.fetch_state" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get the state of the note.</p>
|
|
|
<p>update the cache of the <a class="reference internal" href="#mipac.actions.note.ClientNoteActions.get_state" title="mipac.actions.note.ClientNoteActions.get_state"><code class="xref py py-meth docutils literal notranslate"><span class="pre">mipac.actions.note.ClientNoteActions.get_state()</span></code></a> method</p>
|
|
|
<p>Endpoint: <cite>/api/notes/state</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>note_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – note id</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Note state</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.note.NoteState" title="mipac.models.note.NoteState">NoteState</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.SharedNoteActions.get_all_children">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_all_children</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">untilId</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">AsyncGenerator</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.note.SharedNoteActions.get_all_children" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get all children of the note</p>
|
|
|
<p>Endpoint: <cite>/api/notes/children</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Since ID</p></li>
|
|
|
<li><p><strong>untilId</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Until ID</p></li>
|
|
|
<li><p><strong>note_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – note id</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Children of the note</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>AsyncGenerator[<a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a>, None]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.SharedNoteActions.get_all_replies">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_all_replies</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">AsyncGenerator</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.note.SharedNoteActions.get_all_replies" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get replies to the note</p>
|
|
|
<p>Endpoint: <cite>/api/notes/replies</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – since id</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – until id</p></li>
|
|
|
<li><p><strong>note_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – note id</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>replies</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>AsyncGenerator[<a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a>, None]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.SharedNoteActions.get_clips">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_clips</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.clip.Clip" title="mipac.models.clip.Clip"><span class="pre">Clip</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.note.SharedNoteActions.get_clips" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get the clips of the note</p>
|
|
|
<p>Endpoint: <cite>/api/notes/clips</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>note_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – note id</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Clips of the note</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.clip.Clip" title="mipac.models.clip.Clip">Clip</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.SharedNoteActions.get_conversation">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_conversation</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">offset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.note.SharedNoteActions.get_conversation" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get the conversation of the note</p>
|
|
|
<p>Endpoint: <cite>/api/notes/conversation</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>limit</strong> (<em>int</em><em>, </em><em>default=10</em>) – limit</p></li>
|
|
|
<li><p><strong>offset</strong> (<em>int</em><em>, </em><em>default=0</em>) – offset</p></li>
|
|
|
<li><p><strong>note_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – note id</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Notes of the conversation</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.SharedNoteActions.get_renotes">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_renotes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.note.SharedNoteActions.get_renotes" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get renote of the note</p>
|
|
|
<p>Endpoint: <cite>/api/notes/renotes</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>limit</strong> (<em>int</em><em>, </em><em>default=10</em>) – limit</p></li>
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Since ID</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Until ID</p></li>
|
|
|
<li><p><strong>note_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – note id</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Renotes of the note</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.SharedNoteActions.get_replies">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_replies</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.note.SharedNoteActions.get_replies" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get replies to the note</p>
|
|
|
<p>Endpoint: <cite>/api/notes/replies</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – since id</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – until id</p></li>
|
|
|
<li><p><strong>limit</strong> (<em>int</em><em>, </em><em>default=10</em>) – limit</p></li>
|
|
|
<li><p><strong>note_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – note id</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>replies</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.SharedNoteActions.get_state">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_state</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.note.NoteState" title="mipac.models.note.NoteState"><span class="pre">NoteState</span></a></span></span><a class="headerlink" href="#mipac.actions.note.SharedNoteActions.get_state" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get the state of the note</p>
|
|
|
<p>Endpoint: <cite>/api/notes/state</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>note_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – note id</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Note state</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.note.NoteState" title="mipac.models.note.NoteState">NoteState</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.SharedNoteActions.renote">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">renote</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">visibility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'public'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'home'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'followers'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'specified'</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'public'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">visible_user_ids</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cw</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">local_only</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reaction_acceptance</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="pre">None</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'likeOnly'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'likeOnlyForRemote'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'nonSensitiveOnly'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'nonSensitiveOnlyForLocalLikeOnlyForRemote'</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extract_mentions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extract_hashtags</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extract_emojis</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">files</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.file.MiFile" title="mipac.file.MiFile"><span class="pre">MiFile</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File"><span class="pre">File</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">poll</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.models.poll.MiPoll" title="mipac.models.poll.MiPoll"><span class="pre">MiPoll</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">renote_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.note.SharedNoteActions.renote" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Renote a note</p>
|
|
|
<p>Endpoint: <cite>/api/notes/create</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>text</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – text</p></li>
|
|
|
<li><p><strong>visibility</strong> (<em>INoteVisibility</em><em>, </em><em>default='public'</em>) – Disclosure range</p></li>
|
|
|
<li><p><strong>visible_user_ids</strong> (<em>list</em><em>[</em><em>str</em><em>] </em><em>| </em><em>None</em><em>, </em><em>default=None</em>) – List of users to be published</p></li>
|
|
|
<li><p><strong>cw</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Text to be displayed when warning is given</p></li>
|
|
|
<li><p><strong>local_only</strong> (<em>bool</em><em>, </em><em>default=False</em>) – Whether to show only locally or not</p></li>
|
|
|
<li><p><strong>reaction_acceptance</strong> (<em>IReactionAcceptance</em><em>, </em><em>default=None</em>) – Reaction acceptance setting</p></li>
|
|
|
<li><p><strong>extract_mentions</strong> (<em>bool</em><em>, </em><em>default=True</em>) – Whether to expand the mention</p></li>
|
|
|
<li><p><strong>extract_hashtags</strong> (<em>bool</em><em>, </em><em>default=True</em>) – Whether to expand the hashtag</p></li>
|
|
|
<li><p><strong>extract_emojis</strong> (<em>bool</em><em>, </em><em>default=True</em>) – Whether to expand the emojis</p></li>
|
|
|
<li><p><strong>channel_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Channel ID</p></li>
|
|
|
<li><p><strong>files</strong> (<em>list</em><em>[</em><a class="reference internal" href="#mipac.file.MiFile" title="mipac.file.MiFile"><em>MiFile</em></a><em> | </em><a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File"><em>File</em></a><em> | </em><em>str</em><em>] </em><em>| </em><em>None</em><em>, </em><em>default=None</em>) – The ID list of files to be attached</p></li>
|
|
|
<li><p><strong>poll</strong> (<a class="reference internal" href="#mipac.models.poll.MiPoll" title="mipac.models.poll.MiPoll"><em>MiPoll</em></a><em> | </em><em>None</em><em>, </em><em>default=None</em>) – </p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.SharedNoteActions.translate">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">translate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">target_lang</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'en-US'</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.note.NoteTranslateResult" title="mipac.models.note.NoteTranslateResult"><span class="pre">NoteTranslateResult</span></a></span></span><a class="headerlink" href="#mipac.actions.note.SharedNoteActions.translate" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Translate a note</p>
|
|
|
<p>Endpoint: <cite>/api/notes/translate</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>note_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – Note ID to target for translation</p></li>
|
|
|
<li><p><strong>target_lang</strong> (<em>str</em><em>, </em><em>default='en'</em>) – Target language</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Translated result</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.note.NoteTranslateResult" title="mipac.models.note.NoteTranslateResult">NoteTranslateResult</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.note.SharedNoteActions.un_renote">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">un_renote</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.note.SharedNoteActions.un_renote" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Releases the note renote for the specified Id</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>note_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>optional</em>) – Target note Id., by default None</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Whether the release was successful</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="emojiactions">
|
|
|
<h3>EmojiActions<a class="headerlink" href="#emojiactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.emoji.EmojiActions"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.emoji.EmojiActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.emoji.</span></span><span class="sig-name descname"><span class="pre">EmojiActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.emoji.EmojiActions" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientclipactions">
|
|
|
<h3>ClientClipActions<a class="headerlink" href="#clientclipactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.clip.ClientClipActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.clip.ClientClipActions.add_note">add_note</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.clip.ClientClipActions.delete">delete</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="method">
|
|
|
def</span><a class="reference internal" href="#mipac.actions.clip.ClientClipActions.get_notes">get_notes</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.clip.ClientClipActions.remove_note">remove_note</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.clip.ClientClipActions.update">update</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.clip.ClientClipActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.clip.</span></span><span class="sig-name descname"><span class="pre">ClientClipActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">clip_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.clip.ClientClipActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.clip.ClientClipActions.add_note">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_note</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">clip_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.clip.ClientClipActions.add_note" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Add a note to a clip</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>clip_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>optional</em><em>, </em><em>by default None</em>) – The clip id</p></li>
|
|
|
<li><p><strong>note_id</strong> (<em>str</em>) – The note id</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>True if the note was added to the clip, False otherwise</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.clip.ClientClipActions.delete">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">clip_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.clip.ClientClipActions.delete" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Delete a clip</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>clip_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>optional</em><em>, </em><em>by default None</em>) – The clip id</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>True if the clip was deleted, False otherwise</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.clip.ClientClipActions.get_notes">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_notes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">get_all</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">clip_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">AsyncGenerator</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.clip.ClientClipActions.get_notes" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get notes from a clip
|
|
|
:param clip_id: The clip id
|
|
|
:type clip_id: str | None, optional, by default None
|
|
|
:param limit: The number of notes to get
|
|
|
:type limit: int, optional, by default 10
|
|
|
:param since_id: The note id to get notes after
|
|
|
:type since_id: str | None, optional, by default None
|
|
|
:param until_id: The note id to get notes before
|
|
|
:type until_id: str | None, optional, by default None
|
|
|
:param get_all: Whether to get all notes
|
|
|
:type get_all: bool, optional, by default False</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Yields<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><em>AsyncGenerator[Note, None]</em> – The notes</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.clip.ClientClipActions.remove_note">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">remove_note</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">clip_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.clip.ClientClipActions.remove_note" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Remove a note from a clip</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>clip_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>optional</em><em>, </em><em>by default None</em>) – The clip id</p></li>
|
|
|
<li><p><strong>note_id</strong> (<em>str</em>) – The note id</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>True if the note was removed from the clip, False otherwise</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.clip.ClientClipActions.update">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_public</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">clip_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.clip.Clip" title="mipac.models.clip.Clip"><span class="pre">Clip</span></a></span></span><a class="headerlink" href="#mipac.actions.clip.ClientClipActions.update" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Update a clip</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>clip_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>optional</em><em>, </em><em>by default None</em>) – The clip id</p></li>
|
|
|
<li><p><strong>name</strong> (<em>str</em>) – The clip name</p></li>
|
|
|
<li><p><strong>is_public</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether the clip is public, by default None</p></li>
|
|
|
<li><p><strong>description</strong> (<em>str</em><em>, </em><em>optional</em>) – The clip description, by default None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>True if the clip was updated, False otherwise</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clipactions">
|
|
|
<h3>ClipActions<a class="headerlink" href="#clipactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.clip.ClipActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.clip.ClipActions.create">create</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.clip.ClipActions.get">get</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.clip.ClipActions.get_list">get_list</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.clip.ClipActions.get_my_favorites">get_my_favorites</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.clip.ClipActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.clip.</span></span><span class="sig-name descname"><span class="pre">ClipActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.clip.ClipActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.clip.ClipActions.create">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_public</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.clip.Clip" title="mipac.models.clip.Clip"><span class="pre">Clip</span></a></span></span><a class="headerlink" href="#mipac.actions.clip.ClipActions.create" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Create a clip</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>name</strong> (<em>str</em>) – The clip name</p></li>
|
|
|
<li><p><strong>is_public</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether the clip is public, by default False</p></li>
|
|
|
<li><p><strong>description</strong> (<em>str</em><em>, </em><em>optional</em>) – The clip description, by default None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>The created clip</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.clip.Clip" title="mipac.models.clip.Clip">Clip</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.clip.ClipActions.get">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">clip_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.clip.Clip" title="mipac.models.clip.Clip"><span class="pre">Clip</span></a></span></span><a class="headerlink" href="#mipac.actions.clip.ClipActions.get" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get a clip</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>clip_id</strong> (<em>str</em>) – The clip id</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>The clip</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.clip.Clip" title="mipac.models.clip.Clip">Clip</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.clip.ClipActions.get_list">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_list</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.clip.Clip" title="mipac.models.clip.Clip"><span class="pre">Clip</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.clip.ClipActions.get_list" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get my clips</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>The clips</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>list[<a class="reference internal" href="#mipac.models.clip.Clip" title="mipac.models.clip.Clip">Clip</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.clip.ClipActions.get_my_favorites">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_my_favorites</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.clip.ClipActions.get_my_favorites" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get my favorite clips</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>The favorite clips</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>list[<a class="reference internal" href="#mipac.models.clip.Clip" title="mipac.models.clip.Clip">Clip</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="sharedclipactions">
|
|
|
<h3>SharedClipActions<a class="headerlink" href="#sharedclipactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.clip.SharedClipActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.clip.SharedClipActions.add_note">add_note</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.clip.SharedClipActions.delete">delete</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="method">
|
|
|
def</span><a class="reference internal" href="#mipac.actions.clip.SharedClipActions.get_notes">get_notes</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.clip.SharedClipActions.remove_note">remove_note</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.clip.SharedClipActions.update">update</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.clip.SharedClipActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.clip.</span></span><span class="sig-name descname"><span class="pre">SharedClipActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.clip.SharedClipActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.clip.SharedClipActions.add_note">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_note</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">clip_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.clip.SharedClipActions.add_note" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Add a note to a clip</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>clip_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>optional</em><em>, </em><em>by default None</em>) – The clip id</p></li>
|
|
|
<li><p><strong>note_id</strong> (<em>str</em>) – The note id</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>True if the note was added to the clip, False otherwise</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.clip.SharedClipActions.delete">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">clip_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.clip.SharedClipActions.delete" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Delete a clip</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>clip_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>optional</em><em>, </em><em>by default None</em>) – The clip id</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>True if the clip was deleted, False otherwise</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.clip.SharedClipActions.get_notes">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_notes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">get_all</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">clip_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">AsyncGenerator</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.clip.SharedClipActions.get_notes" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get notes from a clip
|
|
|
:param clip_id: The clip id
|
|
|
:type clip_id: str | None, optional, by default None
|
|
|
:param limit: The number of notes to get
|
|
|
:type limit: int, optional, by default 10
|
|
|
:param since_id: The note id to get notes after
|
|
|
:type since_id: str | None, optional, by default None
|
|
|
:param until_id: The note id to get notes before
|
|
|
:type until_id: str | None, optional, by default None
|
|
|
:param get_all: Whether to get all notes
|
|
|
:type get_all: bool, optional, by default False</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Yields<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><em>AsyncGenerator[Note, None]</em> – The notes</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.clip.SharedClipActions.remove_note">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">remove_note</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">clip_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.clip.SharedClipActions.remove_note" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Remove a note from a clip</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>clip_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>optional</em><em>, </em><em>by default None</em>) – The clip id</p></li>
|
|
|
<li><p><strong>note_id</strong> (<em>str</em>) – The note id</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>True if the note was removed from the clip, False otherwise</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.clip.SharedClipActions.update">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_public</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">clip_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.clip.Clip" title="mipac.models.clip.Clip"><span class="pre">Clip</span></a></span></span><a class="headerlink" href="#mipac.actions.clip.SharedClipActions.update" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Update a clip</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>clip_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>optional</em><em>, </em><em>by default None</em>) – The clip id</p></li>
|
|
|
<li><p><strong>name</strong> (<em>str</em>) – The clip name</p></li>
|
|
|
<li><p><strong>is_public</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether the clip is public, by default None</p></li>
|
|
|
<li><p><strong>description</strong> (<em>str</em><em>, </em><em>optional</em>) – The clip description, by default None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>True if the clip was updated, False otherwise</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="federationactions">
|
|
|
<h3>FederationActions<a class="headerlink" href="#federationactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.federation.FederationActions"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.federation.FederationActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.federation.</span></span><span class="sig-name descname"><span class="pre">FederationActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.federation.FederationActions" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientreactionactions">
|
|
|
<h3>ClientReactionActions<a class="headerlink" href="#clientreactionactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.reaction.ClientReactionActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.reaction.ClientReactionActions.add">add</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.reaction.ClientReactionActions.remove">remove</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.reaction.ClientReactionActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.reaction.</span></span><span class="sig-name descname"><span class="pre">ClientReactionActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.reaction.ClientReactionActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.reaction.ClientReactionActions.add">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reaction</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.reaction.ClientReactionActions.add" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Add reaction to note</p>
|
|
|
<p>Endpoint: <cite>/api/notes/reactions/create</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>reaction</strong> (<em>str</em>) – reaction</p></li>
|
|
|
<li><p><strong>note_id</strong> (<em>str</em><em>, </em><em>optional</em>) – note id, by default None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>success or not</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.reaction.ClientReactionActions.remove">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.reaction.ClientReactionActions.remove" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Remove reaction from note</p>
|
|
|
<p>Endpoint: <cite>/api/notes/reactions/delete</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>note_id</strong> (<em>str</em><em>, </em><em>optional</em>) – note id, by default None</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>success or not</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="reactionactions">
|
|
|
<h3>ReactionActions<a class="headerlink" href="#reactionactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.reaction.ReactionActions"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.reaction.ReactionActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.reaction.</span></span><span class="sig-name descname"><span class="pre">ReactionActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.reaction.ReactionActions" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="sharedreactionactions">
|
|
|
<h3>SharedReactionActions<a class="headerlink" href="#sharedreactionactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.reaction.SharedReactionActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.reaction.SharedReactionActions.add">add</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.reaction.SharedReactionActions.remove">remove</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.reaction.SharedReactionActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.reaction.</span></span><span class="sig-name descname"><span class="pre">SharedReactionActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.reaction.SharedReactionActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.reaction.SharedReactionActions.add">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reaction</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.reaction.SharedReactionActions.add" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Add reaction to note</p>
|
|
|
<p>Endpoint: <cite>/api/notes/reactions/create</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>reaction</strong> (<em>str</em>) – reaction</p></li>
|
|
|
<li><p><strong>note_id</strong> (<em>str</em><em>, </em><em>optional</em>) – note id, by default None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>success or not</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.reaction.SharedReactionActions.remove">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.reaction.SharedReactionActions.remove" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Remove reaction from note</p>
|
|
|
<p>Endpoint: <cite>/api/notes/reactions/delete</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>note_id</strong> (<em>str</em><em>, </em><em>optional</em>) – note id, by default None</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>success or not</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="channelactions">
|
|
|
<h3>ChannelActions<a class="headerlink" href="#channelactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.channel.ChannelActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.channel.ChannelActions.create">create</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.channel.ChannelActions.featured">featured</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="method">
|
|
|
def</span><a class="reference internal" href="#mipac.actions.channel.ChannelActions.get_all_followed">get_all_followed</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="method">
|
|
|
def</span><a class="reference internal" href="#mipac.actions.channel.ChannelActions.get_all_owned">get_all_owned</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.channel.ChannelActions.my_favorites">my_favorites</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.channel.ChannelActions.owned">owned</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.channel.ChannelActions.search">search</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.channel.ChannelActions.show">show</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.channel.ChannelActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.channel.</span></span><span class="sig-name descname"><span class="pre">ChannelActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.channel.ChannelActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.channel.ChannelActions.create">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">color</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">banner_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_sensitive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allow_renote_to_external</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.channel.Channel" title="mipac.models.channel.Channel"><span class="pre">Channel</span></a></span></span><a class="headerlink" href="#mipac.actions.channel.ChannelActions.create" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>チャンネルを作成します</p>
|
|
|
<p>Endpoint: <cite>/api/channels/create</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>name</strong> (<em>str</em>) – チャンネル名</p></li>
|
|
|
<li><p><strong>color</strong> (<em>str</em>) – チャンネルの色, default=MISSING</p></li>
|
|
|
<li><p><strong>description</strong> (<em>str</em>) – チャンネルの説明, default=MISSING</p></li>
|
|
|
<li><p><strong>banner_id</strong> (<em>str</em>) – チャンネルのバナーに使用するファイルのID, default=MISSING</p></li>
|
|
|
<li><p><strong>is_sensitive</strong> (<em>bool</em>) – チャンネルがセンシティブかどうか, default=MISSING</p></li>
|
|
|
<li><p><strong>allow_renote_to_external</strong> (<em>bool</em><em>, </em><em>optional</em>) – 外部へのリノートを許可するかどうか, default=MISSING</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>作成したチャンネル</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.channel.Channel" title="mipac.models.channel.Channel">Channel</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.channel.ChannelActions.featured">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">featured</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.channel.Channel" title="mipac.models.channel.Channel"><span class="pre">Channel</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.channel.ChannelActions.featured" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>トレンドのチャンネルを取得します</p>
|
|
|
<p>Endpoint: <cite>/api/channels/featured</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>取得したチャンネルのリスト</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>list[<a class="reference internal" href="#mipac.models.channel.Channel" title="mipac.models.channel.Channel">Channel</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.channel.ChannelActions.get_all_followed">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_all_followed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">5</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">AsyncGenerator</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.channel.Channel" title="mipac.models.channel.Channel"><span class="pre">Channel</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.channel.ChannelActions.get_all_followed" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>フォロー中のすべてのチャンネルを取得します</p>
|
|
|
<p>Endpoint: <cite>/api/channels/followed</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em> | </em><em>None</em>) – 指定したチャンネルIDよりも後のチャンネルを取得します, default=None</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em> | </em><em>None</em>) – 指定したチャンネルIDよりも前のチャンネルを取得します, default=None</p></li>
|
|
|
<li><p><strong>limit</strong> (<em>int</em><em>, </em><em>optional</em>) – 一度に取得するチャンネルの数, default=5</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>取得したフォロー中のチャンネル</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>AsyncGenerator[<a class="reference internal" href="#mipac.models.channel.Channel" title="mipac.models.channel.Channel">Channel</a>, None]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.channel.ChannelActions.get_all_owned">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_all_owned</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">5</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">AsyncGenerator</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.channel.Channel" title="mipac.models.channel.Channel"><span class="pre">Channel</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.channel.ChannelActions.get_all_owned" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>自分が所有しているすべてのチャンネルを取得します</p>
|
|
|
<p>Endpoint: <cite>/api/channels/owned</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em>, </em><em>optional</em>) – 指定したチャンネルIDよりも後のチャンネルを取得します, default=None</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em>, </em><em>optional</em>) – 指定したチャンネルIDよりも前のチャンネルを取得します, default=None</p></li>
|
|
|
<li><p><strong>limit</strong> (<em>int</em><em>, </em><em>optional</em>) – 一度に取得するチャンネルの数, default=5</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>取得した自分が所有しているチャンネル</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>AsyncGenerator[<a class="reference internal" href="#mipac.models.channel.Channel" title="mipac.models.channel.Channel">Channel</a>, None]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.channel.ChannelActions.my_favorites">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">my_favorites</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.channel.Channel" title="mipac.models.channel.Channel"><span class="pre">Channel</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.channel.ChannelActions.my_favorites" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>自分がお気に入りにしているチャンネルを取得します</p>
|
|
|
<p>Endpoint: <cite>/api/channels/myFavorites</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>取得したチャンネルのリスト</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>list[<a class="reference internal" href="#mipac.models.channel.Channel" title="mipac.models.channel.Channel">Channel</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.channel.ChannelActions.owned">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">owned</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">5</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.channel.Channel" title="mipac.models.channel.Channel"><span class="pre">Channel</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.channel.ChannelActions.owned" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>自分が所有しているチャンネル一覧を取得します</p>
|
|
|
<p>Endpoint: <cite>/api/channels/owned</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em>, </em><em>optional</em>) – 指定したチャンネルIDよりも後のチャンネルを取得します, default=None</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em>, </em><em>optional</em>) – 指定したチャンネルIDよりも前のチャンネルを取得します, default=None</p></li>
|
|
|
<li><p><strong>limit</strong> (<em>int</em><em>, </em><em>optional</em>) – 一度に取得するチャンネルの数, default=5</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>取得した自分が所有しているチャンネルのリスト</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.channel.Channel" title="mipac.models.channel.Channel">Channel</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.channel.ChannelActions.search">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">search</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'nameAndDescription'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'nameOnly'</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'nameAndDescription'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">5</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.channel.Channel" title="mipac.models.channel.Channel"><span class="pre">Channel</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.channel.ChannelActions.search" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>チャンネルを検索します</p>
|
|
|
<p>Endpoint: <cite>/api/channels/search</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>query</strong> (<em>str</em>) – 検索するキーワード</p></li>
|
|
|
<li><p><strong>type</strong> (<em>Literal</em><em>[</em><em>"nameAndDescription"</em><em>,</em><em>"nameOnly"</em><em>]</em>) – 検索に用いる形式, default=”nameAndDescription”</p></li>
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em> | </em><em>None</em>) – 指定したIDのチャンネルより後のチャンネルを取得します, default=None</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em>, </em><em>optional</em>) – 指定したIDのチャンネルより前のチャンネルを取得します, default=None</p></li>
|
|
|
<li><p><strong>limit</strong> (<em>int</em><em>, </em><em>optional</em>) – 一度に取得するチャンネルの数, default=5</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>見つかったチャンネルのリスト</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.channel.Channel" title="mipac.models.channel.Channel">Channel</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.channel.ChannelActions.show">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">show</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.channel.Channel" title="mipac.models.channel.Channel"><span class="pre">Channel</span></a></span></span><a class="headerlink" href="#mipac.actions.channel.ChannelActions.show" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>指定したIDのチャンネルを取得します</p>
|
|
|
<p>Endpoint: <cite>/api/channels/show</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>channel_id</strong> (<em>str</em>) – 対象のチャンネルID</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>取得したチャンネル</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.channel.Channel" title="mipac.models.channel.Channel">Channel</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientchannelactions">
|
|
|
<h3>ClientChannelActions<a class="headerlink" href="#clientchannelactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.channel.ClientChannelActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.channel.ClientChannelActions.favorite">favorite</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.channel.ClientChannelActions.follow">follow</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="method">
|
|
|
def</span><a class="reference internal" href="#mipac.actions.channel.ClientChannelActions.get_all_timeline">get_all_timeline</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.channel.ClientChannelActions.send">send</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.channel.ClientChannelActions.timeline">timeline</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.channel.ClientChannelActions.unfavorite">unfavorite</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.channel.ClientChannelActions.unfollow">unfollow</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.channel.ClientChannelActions.update">update</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.channel.ClientChannelActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.channel.</span></span><span class="sig-name descname"><span class="pre">ClientChannelActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.channel.ClientChannelActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.channel.ClientChannelActions.favorite">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">favorite</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.channel.ClientChannelActions.favorite" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>指定したIDのチャンネルをお気に入りにします</p>
|
|
|
<p>Endpoint: <cite>/api/channels/favorite</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>channel_id</strong> (<em>str</em><em> | </em><em>None</em>) – 対象のチャンネルID, default=None</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>お気に入りに追加できたかどうか</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.channel.ClientChannelActions.follow">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">follow</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.channel.ClientChannelActions.follow" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Follow a channel</p>
|
|
|
<p>Endpoint: <cite>/api/channels/follow</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>channel_id</strong> (<em>str</em><em>, </em><em>optional</em>) – ID of the channel, by default None</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Whether the channel is followed</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.channel.ClientChannelActions.get_all_timeline">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_all_timeline</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">since_date</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_date</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">AsyncGenerator</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.channel.ClientChannelActions.get_all_timeline" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>チャンネルのタイムラインを全て取得します</p>
|
|
|
<p>Endpoint: <cite>/api/channels/timeline</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>limit</strong> (<em>int</em>) – 一度に取得する件数, default=10</p></li>
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em> | </em><em>None</em>) – 指定したIDのノートより後のノートを取得します, default=None</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em> | </em><em>None</em>) – 指定したIDのノートより前のノートを取得します, default=None</p></li>
|
|
|
<li><p><strong>since_date</strong> (<em>int</em><em> | </em><em>None</em>) – 指定した日付のノートより後のノートを取得します, default=None</p></li>
|
|
|
<li><p><strong>until_date</strong> (<em>int</em><em> | </em><em>None</em>) – 指定した日付のノートより前のノートを取得します, default=None</p></li>
|
|
|
<li><p><strong>channel_id</strong> (<em>str</em><em> | </em><em>None</em>) – 対象のチャンネルID, default=None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>取得したノートのリスト</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>AsyncGenerator[<a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a>, None]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.channel.ClientChannelActions.send">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">send</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">visibility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'public'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'home'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'followers'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'specified'</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'public'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">visible_user_ids</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cw</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">local_only</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reaction_acceptance</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="pre">None</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'likeOnly'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'likeOnlyForRemote'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'nonSensitiveOnly'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'nonSensitiveOnlyForLocalLikeOnlyForRemote'</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extract_mentions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extract_hashtags</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extract_emojis</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reply_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">renote_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">files</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.file.MiFile" title="mipac.file.MiFile"><span class="pre">MiFile</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File"><span class="pre">File</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">poll</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.models.poll.MiPoll" title="mipac.models.poll.MiPoll"><span class="pre">MiPoll</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a></span></span><a class="headerlink" href="#mipac.actions.channel.ClientChannelActions.send" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Send a note</p>
|
|
|
<p>Endpoint: <cite>/api/notes/create</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>text</strong> (<em>str</em><em>, </em><em>optional</em>) – Text of the note, by default None</p></li>
|
|
|
<li><p><strong>visibility</strong> (<em>INoteVisibility</em><em>, </em><em>optional</em>) – Visibility of the note, by default “public”</p></li>
|
|
|
<li><p><strong>visible_user_ids</strong> (<em>list</em><em>[</em><em>str</em><em>]</em><em>, </em><em>optional</em>) – Visible user IDs, by default None</p></li>
|
|
|
<li><p><strong>cw</strong> (<em>str</em><em>, </em><em>optional</em>) – CW of the note, by default None</p></li>
|
|
|
<li><p><strong>local_only</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether the note is local only, by default False</p></li>
|
|
|
<li><p><strong>reaction_acceptance</strong> (<em>IReactionAcceptance</em><em>, </em><em>optional</em>) – Reaction acceptance of the note, by default None</p></li>
|
|
|
<li><p><strong>extract_mentions</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to extract mentions, by default True</p></li>
|
|
|
<li><p><strong>extract_hashtags</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to extract hashtags, by default True</p></li>
|
|
|
<li><p><strong>extract_emojis</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to extract emojis, by default True</p></li>
|
|
|
<li><p><strong>reply_id</strong> (<em>str</em><em>, </em><em>optional</em>) – Reply ID, by default None</p></li>
|
|
|
<li><p><strong>renote_id</strong> (<em>str</em><em>, </em><em>optional</em>) – Renote ID, by default None</p></li>
|
|
|
<li><p><strong>files</strong> (<em>list</em><em>[</em><a class="reference internal" href="#mipac.file.MiFile" title="mipac.file.MiFile"><em>MiFile</em></a><em> | </em><a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File"><em>File</em></a><em> | </em><em>str</em><em>]</em><em>, </em><em>optional</em>) – Files, by default None</p></li>
|
|
|
<li><p><strong>poll</strong> (<a class="reference internal" href="#mipac.models.poll.MiPoll" title="mipac.models.poll.MiPoll"><em>MiPoll</em></a><em>, </em><em>optional</em>) – Poll, by default None</p></li>
|
|
|
<li><p><strong>channel_id</strong> (<em>str</em><em>, </em><em>optional</em>) – ID of the channel, by default None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Created note</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.channel.ClientChannelActions.timeline">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">timeline</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">since_date</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_date</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.channel.ClientChannelActions.timeline" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>チャンネルのタイムラインを取得します</p>
|
|
|
<p>Endpoint: <cite>/api/channels/timeline</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>limit</strong> (<em>int</em>) – 一度に取得する件数, default=10</p></li>
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em> | </em><em>None</em>) – 指定したIDのノートより後のノートを取得します, default=None</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em> | </em><em>None</em>) – 指定したIDのノートより前のノートを取得します, default=None</p></li>
|
|
|
<li><p><strong>since_date</strong> (<em>int</em><em> | </em><em>None</em>) – 指定した日付のノートより後のノートを取得します, default=None</p></li>
|
|
|
<li><p><strong>until_date</strong> (<em>int</em><em> | </em><em>None</em>) – 指定した日付のノートより前のノートを取得します, default=None</p></li>
|
|
|
<li><p><strong>channel_id</strong> (<em>str</em><em> | </em><em>None</em>) – 対象のチャンネルID, default=None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>取得したノートのリスト</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.channel.ClientChannelActions.unfavorite">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">unfavorite</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.channel.ClientChannelActions.unfavorite" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>指定したIDのチャンネルをお気に入りから外します</p>
|
|
|
<p>Endpoint: <cite>/api/channels/unfavorite</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>channel_id</strong> (<em>str</em><em> | </em><em>None</em>) – 対象のチャンネルID, default=None</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>お気に入りから外せたかどうか</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.channel.ClientChannelActions.unfollow">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">unfollow</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.channel.ClientChannelActions.unfollow" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>指定したIDのチャンネルのフォローを解除します</p>
|
|
|
<p>Endpoint: <cite>/api/channels/unfollow</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>channel_id</strong> (<em>str</em><em> | </em><em>None</em>) – 対象のチャンネルID, default=None</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>フォロー解除に成功したかどうか</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.channel.ClientChannelActions.update">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">banner_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_archived</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pinned_note_ids</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">color</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_sensitive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allow_renote_to_external</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.channel.Channel" title="mipac.models.channel.Channel"><span class="pre">Channel</span></a></span></span><a class="headerlink" href="#mipac.actions.channel.ClientChannelActions.update" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>チャンネルの情報を更新します</p>
|
|
|
<p>Endpoint: <cite>/api/channels/update</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>name</strong> (<em>str</em><em> | </em><em>None</em>) – チャンネル名, default=MISSING</p></li>
|
|
|
<li><p><strong>description</strong> (<em>str</em><em> | </em><em>None</em>) – チャンネルの説明, default=MISSING</p></li>
|
|
|
<li><p><strong>banner_id</strong> (<em>str</em><em> | </em><em>None</em>) – バナー画像のID, default=MISSING</p></li>
|
|
|
<li><p><strong>is_archived</strong> (<em>bool</em><em> | </em><em>None</em>) – チャンネルがアーカイブされているかどうか, default=MISSING</p></li>
|
|
|
<li><p><strong>pinned_note_ids</strong> (<em>list</em><em>[</em><em>str</em><em>] </em><em>| </em><em>None</em>) – ピン留めするノートのIDリスト, default=MISSING</p></li>
|
|
|
<li><p><strong>color</strong> (<em>str</em><em> | </em><em>None</em>) – チャンネルの色, default=MISSING</p></li>
|
|
|
<li><p><strong>is_sensitive</strong> (<em>bool</em><em> | </em><em>None</em>) – チャンネルがセンシティブかどうか, default=MISSING</p></li>
|
|
|
<li><p><strong>allow_renote_to_external</strong> (<em>bool</em><em> | </em><em>None</em>) – 外部へのリノートを許可するかどうか, default=MISSING</p></li>
|
|
|
<li><p><strong>channel_id</strong> (<em>str</em><em> | </em><em>None</em>) – 対象のチャンネルID, default=None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>更新後のチャンネル</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.channel.Channel" title="mipac.models.channel.Channel">Channel</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="sharedchannelactions">
|
|
|
<h3>SharedChannelActions<a class="headerlink" href="#sharedchannelactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.channel.SharedChannelActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.channel.SharedChannelActions.favorite">favorite</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.channel.SharedChannelActions.follow">follow</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="method">
|
|
|
def</span><a class="reference internal" href="#mipac.actions.channel.SharedChannelActions.get_all_timeline">get_all_timeline</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.channel.SharedChannelActions.send">send</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.channel.SharedChannelActions.timeline">timeline</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.channel.SharedChannelActions.unfavorite">unfavorite</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.channel.SharedChannelActions.unfollow">unfollow</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.channel.SharedChannelActions.update">update</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.channel.SharedChannelActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.channel.</span></span><span class="sig-name descname"><span class="pre">SharedChannelActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.channel.SharedChannelActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.channel.SharedChannelActions.favorite">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">favorite</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.channel.SharedChannelActions.favorite" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>指定したIDのチャンネルをお気に入りにします</p>
|
|
|
<p>Endpoint: <cite>/api/channels/favorite</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>channel_id</strong> (<em>str</em><em> | </em><em>None</em>) – 対象のチャンネルID, default=None</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>お気に入りに追加できたかどうか</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.channel.SharedChannelActions.follow">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">follow</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.channel.SharedChannelActions.follow" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Follow a channel</p>
|
|
|
<p>Endpoint: <cite>/api/channels/follow</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>channel_id</strong> (<em>str</em><em>, </em><em>optional</em>) – ID of the channel, by default None</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Whether the channel is followed</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.channel.SharedChannelActions.get_all_timeline">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_all_timeline</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">since_date</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_date</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">AsyncGenerator</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.channel.SharedChannelActions.get_all_timeline" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>チャンネルのタイムラインを全て取得します</p>
|
|
|
<p>Endpoint: <cite>/api/channels/timeline</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>limit</strong> (<em>int</em>) – 一度に取得する件数, default=10</p></li>
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em> | </em><em>None</em>) – 指定したIDのノートより後のノートを取得します, default=None</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em> | </em><em>None</em>) – 指定したIDのノートより前のノートを取得します, default=None</p></li>
|
|
|
<li><p><strong>since_date</strong> (<em>int</em><em> | </em><em>None</em>) – 指定した日付のノートより後のノートを取得します, default=None</p></li>
|
|
|
<li><p><strong>until_date</strong> (<em>int</em><em> | </em><em>None</em>) – 指定した日付のノートより前のノートを取得します, default=None</p></li>
|
|
|
<li><p><strong>channel_id</strong> (<em>str</em><em> | </em><em>None</em>) – 対象のチャンネルID, default=None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>取得したノートのリスト</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>AsyncGenerator[<a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a>, None]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.channel.SharedChannelActions.send">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">send</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">visibility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'public'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'home'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'followers'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'specified'</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'public'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">visible_user_ids</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cw</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">local_only</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reaction_acceptance</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="pre">None</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'likeOnly'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'likeOnlyForRemote'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'nonSensitiveOnly'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'nonSensitiveOnlyForLocalLikeOnlyForRemote'</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extract_mentions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extract_hashtags</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extract_emojis</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reply_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">renote_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">files</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.file.MiFile" title="mipac.file.MiFile"><span class="pre">MiFile</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File"><span class="pre">File</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">poll</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.models.poll.MiPoll" title="mipac.models.poll.MiPoll"><span class="pre">MiPoll</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a></span></span><a class="headerlink" href="#mipac.actions.channel.SharedChannelActions.send" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Send a note</p>
|
|
|
<p>Endpoint: <cite>/api/notes/create</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>text</strong> (<em>str</em><em>, </em><em>optional</em>) – Text of the note, by default None</p></li>
|
|
|
<li><p><strong>visibility</strong> (<em>INoteVisibility</em><em>, </em><em>optional</em>) – Visibility of the note, by default “public”</p></li>
|
|
|
<li><p><strong>visible_user_ids</strong> (<em>list</em><em>[</em><em>str</em><em>]</em><em>, </em><em>optional</em>) – Visible user IDs, by default None</p></li>
|
|
|
<li><p><strong>cw</strong> (<em>str</em><em>, </em><em>optional</em>) – CW of the note, by default None</p></li>
|
|
|
<li><p><strong>local_only</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether the note is local only, by default False</p></li>
|
|
|
<li><p><strong>reaction_acceptance</strong> (<em>IReactionAcceptance</em><em>, </em><em>optional</em>) – Reaction acceptance of the note, by default None</p></li>
|
|
|
<li><p><strong>extract_mentions</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to extract mentions, by default True</p></li>
|
|
|
<li><p><strong>extract_hashtags</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to extract hashtags, by default True</p></li>
|
|
|
<li><p><strong>extract_emojis</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to extract emojis, by default True</p></li>
|
|
|
<li><p><strong>reply_id</strong> (<em>str</em><em>, </em><em>optional</em>) – Reply ID, by default None</p></li>
|
|
|
<li><p><strong>renote_id</strong> (<em>str</em><em>, </em><em>optional</em>) – Renote ID, by default None</p></li>
|
|
|
<li><p><strong>files</strong> (<em>list</em><em>[</em><a class="reference internal" href="#mipac.file.MiFile" title="mipac.file.MiFile"><em>MiFile</em></a><em> | </em><a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File"><em>File</em></a><em> | </em><em>str</em><em>]</em><em>, </em><em>optional</em>) – Files, by default None</p></li>
|
|
|
<li><p><strong>poll</strong> (<a class="reference internal" href="#mipac.models.poll.MiPoll" title="mipac.models.poll.MiPoll"><em>MiPoll</em></a><em>, </em><em>optional</em>) – Poll, by default None</p></li>
|
|
|
<li><p><strong>channel_id</strong> (<em>str</em><em>, </em><em>optional</em>) – ID of the channel, by default None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Created note</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.channel.SharedChannelActions.timeline">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">timeline</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">since_date</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_date</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.channel.SharedChannelActions.timeline" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>チャンネルのタイムラインを取得します</p>
|
|
|
<p>Endpoint: <cite>/api/channels/timeline</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>limit</strong> (<em>int</em>) – 一度に取得する件数, default=10</p></li>
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em> | </em><em>None</em>) – 指定したIDのノートより後のノートを取得します, default=None</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em> | </em><em>None</em>) – 指定したIDのノートより前のノートを取得します, default=None</p></li>
|
|
|
<li><p><strong>since_date</strong> (<em>int</em><em> | </em><em>None</em>) – 指定した日付のノートより後のノートを取得します, default=None</p></li>
|
|
|
<li><p><strong>until_date</strong> (<em>int</em><em> | </em><em>None</em>) – 指定した日付のノートより前のノートを取得します, default=None</p></li>
|
|
|
<li><p><strong>channel_id</strong> (<em>str</em><em> | </em><em>None</em>) – 対象のチャンネルID, default=None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>取得したノートのリスト</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.channel.SharedChannelActions.unfavorite">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">unfavorite</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.channel.SharedChannelActions.unfavorite" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>指定したIDのチャンネルをお気に入りから外します</p>
|
|
|
<p>Endpoint: <cite>/api/channels/unfavorite</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>channel_id</strong> (<em>str</em><em> | </em><em>None</em>) – 対象のチャンネルID, default=None</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>お気に入りから外せたかどうか</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.channel.SharedChannelActions.unfollow">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">unfollow</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.channel.SharedChannelActions.unfollow" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>指定したIDのチャンネルのフォローを解除します</p>
|
|
|
<p>Endpoint: <cite>/api/channels/unfollow</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>channel_id</strong> (<em>str</em><em> | </em><em>None</em>) – 対象のチャンネルID, default=None</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>フォロー解除に成功したかどうか</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.channel.SharedChannelActions.update">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">banner_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_archived</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pinned_note_ids</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">color</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_sensitive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allow_renote_to_external</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">channel_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.channel.Channel" title="mipac.models.channel.Channel"><span class="pre">Channel</span></a></span></span><a class="headerlink" href="#mipac.actions.channel.SharedChannelActions.update" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>チャンネルの情報を更新します</p>
|
|
|
<p>Endpoint: <cite>/api/channels/update</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>name</strong> (<em>str</em><em> | </em><em>None</em>) – チャンネル名, default=MISSING</p></li>
|
|
|
<li><p><strong>description</strong> (<em>str</em><em> | </em><em>None</em>) – チャンネルの説明, default=MISSING</p></li>
|
|
|
<li><p><strong>banner_id</strong> (<em>str</em><em> | </em><em>None</em>) – バナー画像のID, default=MISSING</p></li>
|
|
|
<li><p><strong>is_archived</strong> (<em>bool</em><em> | </em><em>None</em>) – チャンネルがアーカイブされているかどうか, default=MISSING</p></li>
|
|
|
<li><p><strong>pinned_note_ids</strong> (<em>list</em><em>[</em><em>str</em><em>] </em><em>| </em><em>None</em>) – ピン留めするノートのIDリスト, default=MISSING</p></li>
|
|
|
<li><p><strong>color</strong> (<em>str</em><em> | </em><em>None</em>) – チャンネルの色, default=MISSING</p></li>
|
|
|
<li><p><strong>is_sensitive</strong> (<em>bool</em><em> | </em><em>None</em>) – チャンネルがセンシティブかどうか, default=MISSING</p></li>
|
|
|
<li><p><strong>allow_renote_to_external</strong> (<em>bool</em><em> | </em><em>None</em>) – 外部へのリノートを許可するかどうか, default=MISSING</p></li>
|
|
|
<li><p><strong>channel_id</strong> (<em>str</em><em> | </em><em>None</em>) – 対象のチャンネルID, default=None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>更新後のチャンネル</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.channel.Channel" title="mipac.models.channel.Channel">Channel</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="roleactions">
|
|
|
<h3>RoleActions<a class="headerlink" href="#roleactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.role.RoleActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.role.RoleActions.get">get</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.role.RoleActions.get_list">get_list</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="method">
|
|
|
def</span><a class="reference internal" href="#mipac.actions.role.RoleActions.get_notes">get_notes</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="method">
|
|
|
def</span><a class="reference internal" href="#mipac.actions.role.RoleActions.get_users">get_users</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.role.RoleActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.role.</span></span><span class="sig-name descname"><span class="pre">RoleActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.role.RoleActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.role.RoleActions.get">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">role_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.roles.Role" title="mipac.models.roles.Role"><span class="pre">Role</span></a></span></span><a class="headerlink" href="#mipac.actions.role.RoleActions.get" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get a role from the API.
|
|
|
Endpoint: <cite>/api/roles/show</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>role_id</strong> (<em>str</em>) – The ID of the role to get.</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>The role data.</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.roles.Role" title="mipac.models.roles.Role">Role</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.role.RoleActions.get_list">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_list</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.roles.Role" title="mipac.models.roles.Role"><span class="pre">Role</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.role.RoleActions.get_list" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get a list of roles from the API.
|
|
|
Endpoint: <cite>/api/roles/list</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>The role data.</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>list[<a class="reference internal" href="#mipac.models.roles.Role" title="mipac.models.roles.Role">Role</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.role.RoleActions.get_notes">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_notes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">role_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">since_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">get_all</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.role.RoleActions.get_notes" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get notes in a role.
|
|
|
Endpoint: <cite>/api/roles/notes</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>role_id</strong> (<em>str</em>) – The ID of the role to get notes.</p></li>
|
|
|
<li><p><strong>limit</strong> (<em>int</em><em>, </em><em>optional</em>) – The number of notes to get, by default 10</p></li>
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em>, </em><em>optional</em>) – The ID of the note to get notes after, by default None</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em>, </em><em>optional</em>) – The ID of the note to get notes before, by default None</p></li>
|
|
|
<li><p><strong>since_data</strong> (<em>int</em><em>, </em><em>optional</em>) – The timestamp of the note to get notes after, by default None</p></li>
|
|
|
<li><p><strong>until_data</strong> (<em>int</em><em>, </em><em>optional</em>) – The timestamp of the note to get notes before, by default None</p></li>
|
|
|
<li><p><strong>get_all</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to get all notes, by default False</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Yields<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p><em>AsyncGenerator[Note, None]</em> – The note data.</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.role.RoleActions.get_users">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_users</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">role_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">get_all</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">AsyncGenerator</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.roles.MeRole" title="mipac.models.roles.MeRole"><span class="pre">MeRole</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#mipac.models.roles.RoleUser" title="mipac.models.roles.RoleUser"><span class="pre">RoleUser</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.role.RoleActions.get_users" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get users in a role.
|
|
|
Endpoint: <cite>/api/roles/users</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>role_id</strong> (<em>str</em>) – The ID of the role to get users.</p></li>
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em>, </em><em>optional</em>) – The ID of the user to get users after, by default None</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em>, </em><em>optional</em>) – The ID of the user to get users before, by default None</p></li>
|
|
|
<li><p><strong>limit</strong> (<em>int</em><em>, </em><em>optional</em>) – The number of users to get, by default 10</p></li>
|
|
|
<li><p><strong>get_all</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to get all users, by default False</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Yields<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p><em>AsyncGenerator[MeRole | RoleUser, None]</em> – The role user data.</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="usernameactions">
|
|
|
<h3>UsernameActions<a class="headerlink" href="#usernameactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.username.UsernameActions"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.username.UsernameActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.username.</span></span><span class="sig-name descname"><span class="pre">UsernameActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.username.UsernameActions" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="chartactions">
|
|
|
<h3>ChartActions<a class="headerlink" href="#chartactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.chart.ChartActions"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.chart.ChartActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.chart.</span></span><span class="sig-name descname"><span class="pre">ChartActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.chart.ChartActions" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="antennaactions">
|
|
|
<h3>AntennaActions<a class="headerlink" href="#antennaactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.antenna.AntennaActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.antenna.AntennaActions.create">create</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.antenna.AntennaActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.antenna.</span></span><span class="sig-name descname"><span class="pre">AntennaActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.antenna.AntennaActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.antenna.AntennaActions.create">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">src</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'home'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'all'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'users'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'list'</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keywords</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_keywords</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">users</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">case_sensitive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">local_only</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">with_replies</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">with_file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">notify</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_list_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.antenna.Antenna" title="mipac.models.antenna.Antenna"><span class="pre">Antenna</span></a></span></span><a class="headerlink" href="#mipac.actions.antenna.AntennaActions.create" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Create an antenna.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>name</strong> (<em>str</em>) – Name of the antenna.</p></li>
|
|
|
<li><p><strong>src</strong> (<em>IAntennaReceiveSource</em>) – Receive source of the antenna.</p></li>
|
|
|
<li><p><strong>keywords</strong> (<em>list</em><em>[</em><em>list</em><em>[</em><em>str</em><em>]</em><em>]</em>) – Receive keywords.</p></li>
|
|
|
<li><p><strong>exclude_keywords</strong> (<em>list</em><em>[</em><em>list</em><em>[</em><em>str</em><em>]</em><em>] </em><em>| </em><em>None</em><em>, </em><em>default None</em>) – Excluded keywords.</p></li>
|
|
|
<li><p><strong>local_only</strong> (<em>bool</em><em>, </em><em>default MISSING</em>) – Whether to limit to local notes.</p></li>
|
|
|
<li><p><strong>users</strong> (<em>list</em><em>[</em><em>str</em><em>] </em><em>| </em><em>None</em><em>, </em><em>default None</em>) – List of target user ID. Required when selecting ‘users’ as the receive source.</p></li>
|
|
|
<li><p><strong>case_sensitive</strong> (<em>bool</em><em>, </em><em>default False</em>) – Whether to differentiate between uppercase and lowercase letters.</p></li>
|
|
|
<li><p><strong>with_replies</strong> (<em>bool</em><em>, </em><em>default False</em>) – Whether to include replies.</p></li>
|
|
|
<li><p><strong>with_file</strong> (<em>bool</em><em>, </em><em>default False</em>) – Whether to limit to notes with attached files.</p></li>
|
|
|
<li><p><strong>notify</strong> (<em>bool</em><em>, </em><em>default False</em>) – Whether to notify for new notes.</p></li>
|
|
|
<li><p><strong>user_list_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default None</em>) – List of user IDs when selecting ‘users’ as the receive source for the antenna.</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>The created antenna.</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.antenna.Antenna" title="mipac.models.antenna.Antenna">Antenna</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientantennaactions">
|
|
|
<h3>ClientAntennaActions<a class="headerlink" href="#clientantennaactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.antenna.ClientAntennaActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.antenna.ClientAntennaActions.delete">delete</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.antenna.ClientAntennaActions.show">show</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.antenna.ClientAntennaActions.update">update</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.antenna.ClientAntennaActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.antenna.</span></span><span class="sig-name descname"><span class="pre">ClientAntennaActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">antenna_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.antenna.ClientAntennaActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.antenna.ClientAntennaActions.delete">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">antenna_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.antenna.ClientAntennaActions.delete" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Delete antenna from identifier</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>antenna_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>optional</em>) – target identifier</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p><a class="reference internal" href="#mipac.errors.base.ParameterError" title="mipac.errors.base.ParameterError"><strong>ParameterError</strong></a> – antenna id is required</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>success or failure</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.antenna.ClientAntennaActions.show">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">show</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">antenna_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.antenna.Antenna" title="mipac.models.antenna.Antenna"><span class="pre">Antenna</span></a></span></span><a class="headerlink" href="#mipac.actions.antenna.ClientAntennaActions.show" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Show antenna from identifier</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>antenna_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>optional</em>) – target identifier, by default None</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>antenna object</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.antenna.Antenna" title="mipac.models.antenna.Antenna">Antenna</a></p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p><a class="reference internal" href="#mipac.errors.base.ParameterError" title="mipac.errors.base.ParameterError"><strong>ParameterError</strong></a> – antenna id is required</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.antenna.ClientAntennaActions.update">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">src</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'home'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'all'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'users'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'list'</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keywords</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_keywords</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">users</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">case_sensitive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">with_replies</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">with_file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">notify</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_list_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">antenna_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.antenna.Antenna" title="mipac.models.antenna.Antenna"><span class="pre">Antenna</span></a></span></span><a class="headerlink" href="#mipac.actions.antenna.ClientAntennaActions.update" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Update an antenna.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>name</strong> (<em>str</em>) – Name of the antenna.</p></li>
|
|
|
<li><p><strong>src</strong> (<em>IAntennaReceiveSource</em>) – Receive source of the antenna.</p></li>
|
|
|
<li><p><strong>keywords</strong> (<em>list</em><em>[</em><em>list</em><em>[</em><em>str</em><em>]</em><em>]</em>) – Receive keywords.</p></li>
|
|
|
<li><p><strong>exclude_keywords</strong> (<em>list</em><em>[</em><em>list</em><em>[</em><em>str</em><em>]</em><em>]</em>) – Excluded keywords.</p></li>
|
|
|
<li><p><strong>users</strong> (<em>list</em><em>[</em><em>str</em><em>]</em>) – List of target user ID. Required when selecting ‘users’ as the receive source.</p></li>
|
|
|
<li><p><strong>case_sensitive</strong> (<em>bool</em>) – Whether to differentiate between uppercase and lowercase letters.</p></li>
|
|
|
<li><p><strong>with_replies</strong> (<em>bool</em>) – Whether to include replies.</p></li>
|
|
|
<li><p><strong>with_file</strong> (<em>bool</em>) – Whether to limit to notes with attached files.</p></li>
|
|
|
<li><p><strong>notify</strong> (<em>bool</em>) – Whether to notify for new notes.</p></li>
|
|
|
<li><p><strong>user_list_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default None</em>) – List of user IDs when selecting ‘users’ as the receive source for the antenna.</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>The created antenna.</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.antenna.Antenna" title="mipac.models.antenna.Antenna">Antenna</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="sharedantennaactions">
|
|
|
<h3>SharedAntennaActions<a class="headerlink" href="#sharedantennaactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.antenna.SharedAntennaActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.antenna.SharedAntennaActions.delete">delete</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.antenna.SharedAntennaActions.show">show</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.antenna.SharedAntennaActions.update">update</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.antenna.SharedAntennaActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.antenna.</span></span><span class="sig-name descname"><span class="pre">SharedAntennaActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.antenna.SharedAntennaActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.antenna.SharedAntennaActions.delete">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">antenna_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.antenna.SharedAntennaActions.delete" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Delete antenna from identifier</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>antenna_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>optional</em>) – target identifier</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p><a class="reference internal" href="#mipac.errors.base.ParameterError" title="mipac.errors.base.ParameterError"><strong>ParameterError</strong></a> – antenna id is required</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>success or failure</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.antenna.SharedAntennaActions.show">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">show</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">antenna_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.antenna.Antenna" title="mipac.models.antenna.Antenna"><span class="pre">Antenna</span></a></span></span><a class="headerlink" href="#mipac.actions.antenna.SharedAntennaActions.show" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Show antenna from identifier</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>antenna_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>optional</em>) – target identifier, by default None</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>antenna object</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.antenna.Antenna" title="mipac.models.antenna.Antenna">Antenna</a></p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p><a class="reference internal" href="#mipac.errors.base.ParameterError" title="mipac.errors.base.ParameterError"><strong>ParameterError</strong></a> – antenna id is required</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.antenna.SharedAntennaActions.update">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">src</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'home'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'all'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'users'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'list'</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keywords</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exclude_keywords</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">users</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">case_sensitive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">with_replies</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">with_file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">notify</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_list_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">antenna_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.antenna.Antenna" title="mipac.models.antenna.Antenna"><span class="pre">Antenna</span></a></span></span><a class="headerlink" href="#mipac.actions.antenna.SharedAntennaActions.update" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Update an antenna.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>name</strong> (<em>str</em>) – Name of the antenna.</p></li>
|
|
|
<li><p><strong>src</strong> (<em>IAntennaReceiveSource</em>) – Receive source of the antenna.</p></li>
|
|
|
<li><p><strong>keywords</strong> (<em>list</em><em>[</em><em>list</em><em>[</em><em>str</em><em>]</em><em>]</em>) – Receive keywords.</p></li>
|
|
|
<li><p><strong>exclude_keywords</strong> (<em>list</em><em>[</em><em>list</em><em>[</em><em>str</em><em>]</em><em>]</em>) – Excluded keywords.</p></li>
|
|
|
<li><p><strong>users</strong> (<em>list</em><em>[</em><em>str</em><em>]</em>) – List of target user ID. Required when selecting ‘users’ as the receive source.</p></li>
|
|
|
<li><p><strong>case_sensitive</strong> (<em>bool</em>) – Whether to differentiate between uppercase and lowercase letters.</p></li>
|
|
|
<li><p><strong>with_replies</strong> (<em>bool</em>) – Whether to include replies.</p></li>
|
|
|
<li><p><strong>with_file</strong> (<em>bool</em>) – Whether to limit to notes with attached files.</p></li>
|
|
|
<li><p><strong>notify</strong> (<em>bool</em>) – Whether to notify for new notes.</p></li>
|
|
|
<li><p><strong>user_list_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default None</em>) – List of user IDs when selecting ‘users’ as the receive source for the antenna.</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>The created antenna.</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.antenna.Antenna" title="mipac.models.antenna.Antenna">Antenna</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientpollactions">
|
|
|
<h3>ClientPollActions<a class="headerlink" href="#clientpollactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.poll.ClientPollActions"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.poll.ClientPollActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.poll.</span></span><span class="sig-name descname"><span class="pre">ClientPollActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.poll.ClientPollActions" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="pollactions">
|
|
|
<h3>PollActions<a class="headerlink" href="#pollactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.poll.PollActions"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.poll.PollActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.poll.</span></span><span class="sig-name descname"><span class="pre">PollActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.poll.PollActions" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="sharedpollactions">
|
|
|
<h3>SharedPollActions<a class="headerlink" href="#sharedpollactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.poll.SharedPollActions"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.poll.SharedPollActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.poll.</span></span><span class="sig-name descname"><span class="pre">SharedPollActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.poll.SharedPollActions" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="myactions">
|
|
|
<h3>MyActions<a class="headerlink" href="#myactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.my.MyActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.my.MyActions.get_claim_achievement">get_claim_achievement</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.my.MyActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.my.</span></span><span class="sig-name descname"><span class="pre">MyActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.my.MyActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.my.MyActions.get_claim_achievement">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_claim_achievement</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'notes1'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'notes10'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'notes100'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'notes500'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'notes1000'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'notes5000'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'notes10000'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'notes20000'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'notes30000'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'notes40000'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'notes50000'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'notes60000'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'notes70000'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'notes80000'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'notes90000'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'notes100000'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'login3'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'login7'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'login15'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'login30'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'login60'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'login100'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'login200'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'login300'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'login400'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'login500'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'login600'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'login700'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'login800'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'login900'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'login1000'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'passedSinceAccountCreated1'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'passedSinceAccountCreated2'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'passedSinceAccountCreated3'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'loggedInOnBirthday'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'loggedInOnNewYearsDay'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'noteClipped1'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'noteFavorited1'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'myNoteFavorited1'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'profileFilled'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'markedAsCat'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'following1'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'following10'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'following50'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'following100'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'following300'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'followers1'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'followers10'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'followers50'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'followers100'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'followers300'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'followers500'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'followers1000'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'collectAchievements30'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'viewAchievements3min'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'iLoveMisskey'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'foundTreasure'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'client30min'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'client60min'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'noteDeletedWithin1min'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'postedAtLateNight'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'postedAt0min0sec'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'selfQuote'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'htl20npm'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'viewInstanceChart'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'outputHelloWorldOnScratchpad'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'open3windows'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'driveFolderCircularReference'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'reactWithoutRead'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'clickedClickHere'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'justPlainLucky'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'setNameToSyuilo'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'cookieClicked'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'brainDiver'</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.my.MyActions.get_claim_achievement" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>指定した名前の実績を解除します</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>name</strong> (<em>実績名</em>) – 解除したい実績の名前</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>成功したか否か</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p><strong>NotSupportVersion</strong> – 実績機能が存在しないサーバーを使用している</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientfavoriteactions">
|
|
|
<h3>ClientFavoriteActions<a class="headerlink" href="#clientfavoriteactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.favorite.ClientFavoriteActions"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.favorite.ClientFavoriteActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.favorite.</span></span><span class="sig-name descname"><span class="pre">ClientFavoriteActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">note_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.favorite.ClientFavoriteActions" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="favoriteactions">
|
|
|
<h3>FavoriteActions<a class="headerlink" href="#favoriteactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.favorite.FavoriteActions"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.favorite.FavoriteActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.favorite.</span></span><span class="sig-name descname"><span class="pre">FavoriteActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.favorite.FavoriteActions" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="sharedfavoriteactions">
|
|
|
<h3>SharedFavoriteActions<a class="headerlink" href="#sharedfavoriteactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.favorite.SharedFavoriteActions"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.favorite.SharedFavoriteActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.favorite.</span></span><span class="sig-name descname"><span class="pre">SharedFavoriteActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.favorite.SharedFavoriteActions" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientuseractions">
|
|
|
<h3>ClientUserActions<a class="headerlink" href="#clientuseractions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.user.ClientUserActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.user.ClientUserActions.get_achievements">get_achievements</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="method">
|
|
|
def</span><a class="reference internal" href="#mipac.actions.user.ClientUserActions.get_all_featured_notes">get_all_featured_notes</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.user.ClientUserActions.get_featured_notes">get_featured_notes</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.user.ClientUserActions.get_followers">get_followers</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.user.ClientUserActions.get_following">get_following</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.user.ClientUserActions.get_frequently_replied_users">get_frequently_replied_users</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.user.ClientUserActions.get_gallery_posts">get_gallery_posts</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.user.ClientUserActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.user.</span></span><span class="sig-name descname"><span class="pre">ClientUserActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.models.lite.user.PartialUser" title="mipac.models.lite.user.PartialUser"><span class="pre">PartialUser</span></a></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.user.ClientUserActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.user.ClientUserActions.get_achievements">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_achievements</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.user.Achievement" title="mipac.models.user.Achievement"><span class="pre">Achievement</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.user.ClientUserActions.get_achievements" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get achievements of user.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.user.ClientUserActions.get_all_featured_notes">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_all_featured_notes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">AsyncGenerator</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.user.ClientUserActions.get_all_featured_notes" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get all featured notes of user.</p>
|
|
|
<p>Endpoint: <cite>/api/users/featured-notes</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>limit</strong> (<em>int</em><em>, </em><em>default=10</em>) – The maximum number of featured notes to return.</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get featured notes before this id.</p></li>
|
|
|
<li><p><strong>user_id</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get featured notes with this user id.</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>A list of featured notes.</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.user.ClientUserActions.get_featured_notes">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_featured_notes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.user.ClientUserActions.get_featured_notes" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get featured notes of user.</p>
|
|
|
<p>Endpoint: <cite>/api/users/featured-notes</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>limit</strong> (<em>int</em><em>, </em><em>default=10</em>) – The maximum number of featured notes to return.</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get featured notes before this id.</p></li>
|
|
|
<li><p><strong>user_id</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get featured notes with this user id.</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>A list of featured notes.</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.user.ClientUserActions.get_followers">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_followers</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.user.Follower" title="mipac.models.user.Follower"><span class="pre">Follower</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.user.ClientUserActions.get_followers" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get followers of user.</p>
|
|
|
<p>Endpoint: <cite>/api/users/followers</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get followers after this id.</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get followers before this id.</p></li>
|
|
|
<li><p><strong>limit</strong> (<em>int</em><em>, </em><em>default=10</em>) – The maximum number of followers to return.</p></li>
|
|
|
<li><p><strong>username</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get followers with this username.</p></li>
|
|
|
<li><p><strong>host</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get followers with this host.</p></li>
|
|
|
<li><p><strong>user_id</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get followers with this user id.</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>A list of followers.</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.user.Follower" title="mipac.models.user.Follower">Follower</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.user.ClientUserActions.get_following">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_following</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">birthday</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.user.Following" title="mipac.models.user.Following"><span class="pre">Following</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.user.ClientUserActions.get_following" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get following of user.</p>
|
|
|
<p>Endpoint: <cite>/api/users/following</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get following after this id.</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get following before this id.</p></li>
|
|
|
<li><p><strong>limit</strong> (<em>int</em><em>, </em><em>default=10</em>) – The maximum number of following to return.</p></li>
|
|
|
<li><p><strong>username</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get following with this username.</p></li>
|
|
|
<li><p><strong>host</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get following with this host.</p></li>
|
|
|
<li><p><strong>user_id</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get following with this user id.</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>A list of following.</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.user.Following" title="mipac.models.user.Following">Following</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.user.ClientUserActions.get_frequently_replied_users">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_frequently_replied_users</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.user.FrequentlyRepliedUser" title="mipac.models.user.FrequentlyRepliedUser"><span class="pre">FrequentlyRepliedUser</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.user.ClientUserActions.get_frequently_replied_users" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get frequently replied users of user.</p>
|
|
|
<p>Endpoint: <cite>/api/users/get-frequently-replied-users</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>limit</strong> (<em>int</em><em>, </em><em>default=10</em>) – The maximum number of frequently replied users to return.</p></li>
|
|
|
<li><p><strong>user_id</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get frequently replied users with this user id.</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>A list of frequently replied users.</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.user.FrequentlyRepliedUser" title="mipac.models.user.FrequentlyRepliedUser">FrequentlyRepliedUser</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.user.ClientUserActions.get_gallery_posts">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_gallery_posts</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.gallery.GalleryPost" title="mipac.models.gallery.GalleryPost"><span class="pre">GalleryPost</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.user.ClientUserActions.get_gallery_posts" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get gallery posts of user.</p>
|
|
|
<p>Endpoint: <cite>/api/users/gallery/posts</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>limit</strong> (<em>int</em><em>, </em><em>default=10</em>) – The maximum number of gallery posts to return.</p></li>
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get gallery posts after this id.</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get gallery posts before this id.</p></li>
|
|
|
<li><p><strong>user_id</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get gallery posts with this user id.</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>A list of gallery posts.</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.gallery.GalleryPost" title="mipac.models.gallery.GalleryPost">GalleryPost</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="shareduseractions">
|
|
|
<h3>SharedUserActions<a class="headerlink" href="#shareduseractions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.user.SharedUserActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.user.SharedUserActions.get_achievements">get_achievements</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="method">
|
|
|
def</span><a class="reference internal" href="#mipac.actions.user.SharedUserActions.get_all_featured_notes">get_all_featured_notes</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.user.SharedUserActions.get_featured_notes">get_featured_notes</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.user.SharedUserActions.get_followers">get_followers</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.user.SharedUserActions.get_following">get_following</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.user.SharedUserActions.get_frequently_replied_users">get_frequently_replied_users</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.user.SharedUserActions.get_gallery_posts">get_gallery_posts</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.user.SharedUserActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.user.</span></span><span class="sig-name descname"><span class="pre">SharedUserActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.user.SharedUserActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.user.SharedUserActions.get_achievements">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_achievements</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.user.Achievement" title="mipac.models.user.Achievement"><span class="pre">Achievement</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.user.SharedUserActions.get_achievements" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get achievements of user.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.user.SharedUserActions.get_all_featured_notes">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_all_featured_notes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">AsyncGenerator</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.user.SharedUserActions.get_all_featured_notes" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get all featured notes of user.</p>
|
|
|
<p>Endpoint: <cite>/api/users/featured-notes</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>limit</strong> (<em>int</em><em>, </em><em>default=10</em>) – The maximum number of featured notes to return.</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get featured notes before this id.</p></li>
|
|
|
<li><p><strong>user_id</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get featured notes with this user id.</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>A list of featured notes.</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.user.SharedUserActions.get_featured_notes">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_featured_notes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.user.SharedUserActions.get_featured_notes" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get featured notes of user.</p>
|
|
|
<p>Endpoint: <cite>/api/users/featured-notes</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>limit</strong> (<em>int</em><em>, </em><em>default=10</em>) – The maximum number of featured notes to return.</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get featured notes before this id.</p></li>
|
|
|
<li><p><strong>user_id</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get featured notes with this user id.</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>A list of featured notes.</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.user.SharedUserActions.get_followers">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_followers</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.user.Follower" title="mipac.models.user.Follower"><span class="pre">Follower</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.user.SharedUserActions.get_followers" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get followers of user.</p>
|
|
|
<p>Endpoint: <cite>/api/users/followers</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get followers after this id.</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get followers before this id.</p></li>
|
|
|
<li><p><strong>limit</strong> (<em>int</em><em>, </em><em>default=10</em>) – The maximum number of followers to return.</p></li>
|
|
|
<li><p><strong>username</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get followers with this username.</p></li>
|
|
|
<li><p><strong>host</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get followers with this host.</p></li>
|
|
|
<li><p><strong>user_id</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get followers with this user id.</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>A list of followers.</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.user.Follower" title="mipac.models.user.Follower">Follower</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.user.SharedUserActions.get_following">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_following</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">birthday</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.user.Following" title="mipac.models.user.Following"><span class="pre">Following</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.user.SharedUserActions.get_following" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get following of user.</p>
|
|
|
<p>Endpoint: <cite>/api/users/following</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get following after this id.</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get following before this id.</p></li>
|
|
|
<li><p><strong>limit</strong> (<em>int</em><em>, </em><em>default=10</em>) – The maximum number of following to return.</p></li>
|
|
|
<li><p><strong>username</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get following with this username.</p></li>
|
|
|
<li><p><strong>host</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get following with this host.</p></li>
|
|
|
<li><p><strong>user_id</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get following with this user id.</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>A list of following.</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.user.Following" title="mipac.models.user.Following">Following</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.user.SharedUserActions.get_frequently_replied_users">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_frequently_replied_users</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.user.FrequentlyRepliedUser" title="mipac.models.user.FrequentlyRepliedUser"><span class="pre">FrequentlyRepliedUser</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.user.SharedUserActions.get_frequently_replied_users" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get frequently replied users of user.</p>
|
|
|
<p>Endpoint: <cite>/api/users/get-frequently-replied-users</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>limit</strong> (<em>int</em><em>, </em><em>default=10</em>) – The maximum number of frequently replied users to return.</p></li>
|
|
|
<li><p><strong>user_id</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get frequently replied users with this user id.</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>A list of frequently replied users.</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.user.FrequentlyRepliedUser" title="mipac.models.user.FrequentlyRepliedUser">FrequentlyRepliedUser</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.user.SharedUserActions.get_gallery_posts">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_gallery_posts</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.gallery.GalleryPost" title="mipac.models.gallery.GalleryPost"><span class="pre">GalleryPost</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.user.SharedUserActions.get_gallery_posts" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get gallery posts of user.</p>
|
|
|
<p>Endpoint: <cite>/api/users/gallery/posts</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>limit</strong> (<em>int</em><em>, </em><em>default=10</em>) – The maximum number of gallery posts to return.</p></li>
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get gallery posts after this id.</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get gallery posts before this id.</p></li>
|
|
|
<li><p><strong>user_id</strong> (<em>str</em><em>, </em><em>default=None</em>) – Get gallery posts with this user id.</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>A list of gallery posts.</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.gallery.GalleryPost" title="mipac.models.gallery.GalleryPost">GalleryPost</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="useractions">
|
|
|
<h3>UserActions<a class="headerlink" href="#useractions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.user.UserActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.user.UserActions.fetch">fetch</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.user.UserActions.get">get</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.user.UserActions.get_me">get_me</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="method">
|
|
|
def</span><a class="reference internal" href="#mipac.actions.user.UserActions.get_mention">get_mention</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="method">
|
|
|
def</span><a class="reference internal" href="#mipac.actions.user.UserActions.search">search</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.user.UserActions.search_by_username_and_host">search_by_username_and_host</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.user.UserActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.user.</span></span><span class="sig-name descname"><span class="pre">UserActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.user.UserActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.user.UserActions.fetch">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fetch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_ids</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.user.UserDetailedNotMe" title="mipac.models.user.UserDetailedNotMe"><span class="pre">UserDetailedNotMe</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#mipac.models.user.MeDetailed" title="mipac.models.user.MeDetailed"><span class="pre">MeDetailed</span></a></span></span><a class="headerlink" href="#mipac.actions.user.UserActions.fetch" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Retrieve the latest user information using the target user ID or username.
|
|
|
If you do not need the latest information, you should basically use the <cite>get</cite> method.
|
|
|
This method accesses the server each time,
|
|
|
which may increase the number of server accesses.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>user_id</strong> (<em>str</em>) – target user id</p></li>
|
|
|
<li><p><strong>username</strong> (<em>str</em>) – target username</p></li>
|
|
|
<li><p><strong>username</strong> – target username</p></li>
|
|
|
<li><p><strong>host</strong> (<em>str</em><em>, </em><em>default=None</em>) – Hosts with target users</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.user.UserActions.get">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_ids</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.user.UserDetailedNotMe" title="mipac.models.user.UserDetailedNotMe"><span class="pre">UserDetailedNotMe</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#mipac.models.user.MeDetailed" title="mipac.models.user.MeDetailed"><span class="pre">MeDetailed</span></a></span></span><a class="headerlink" href="#mipac.actions.user.UserActions.get" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Retrieve user information from the user ID using the cache.
|
|
|
If there is no cache, <cite>fetch</cite> is automatically used.
|
|
|
The <cite>fetch</cite> method is recommended if you want up-to-date user information.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>user_id</strong> (<em>str</em>) – target user id</p></li>
|
|
|
<li><p><strong>user_ids</strong> (<em>list</em><em>[</em><em>str</em><em>]</em>) – target user ids</p></li>
|
|
|
<li><p><strong>username</strong> (<em>str</em>) – target username</p></li>
|
|
|
<li><p><strong>host</strong> (<em>str</em><em>, </em><em>default=None</em>) – Hosts with target users</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.user.UserActions.get_me">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_me</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.user.MeDetailed" title="mipac.models.user.MeDetailed"><span class="pre">MeDetailed</span></a></span></span><a class="headerlink" href="#mipac.actions.user.UserActions.get_me" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>ログインしているユーザーの情報を取得します</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.user.UserActions.get_mention">
|
|
|
<span class="sig-name descname"><span class="pre">get_mention</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.models.lite.user.PartialUser" title="mipac.models.lite.user.PartialUser"><span class="pre">PartialUser</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#mipac.actions.user.UserActions.get_mention" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get mention name of user.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>user</strong> (<em>Optional</em><em>[</em><em>User</em><em>]</em><em>, </em><em>default=None</em>) – The object of the user whose mentions you want to retrieve</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>メンション</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>str</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.user.UserActions.search">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">search</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">100</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">offset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">origin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'local'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'remote'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'combined'</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'combined'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">detail</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="k"><span class="pre">False</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">get_all</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">AsyncGenerator</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.lite.user.PartialUser" title="mipac.models.lite.user.PartialUser"><span class="pre">PartialUser</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.user.UserActions.search" title="Link to this definition">#</a></dt>
|
|
|
<dt class="sig sig-object py">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">search</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">100</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">offset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">origin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'local'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'remote'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'combined'</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'combined'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">detail</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="k"><span class="pre">True</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">get_all</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">AsyncGenerator</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.user.UserDetailedNotMe" title="mipac.models.user.UserDetailedNotMe"><span class="pre">UserDetailedNotMe</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#mipac.models.user.MeDetailed" title="mipac.models.user.MeDetailed"><span class="pre">MeDetailed</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></span></span></dt>
|
|
|
<dd><p>Search users by keyword.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>query</strong> (<em>str</em>) – Keyword to search.</p></li>
|
|
|
<li><p><strong>limit</strong> (<em>int</em><em>, </em><em>default=100</em>) – The maximum number of users to return.</p></li>
|
|
|
<li><p><strong>offset</strong> (<em>int</em><em>, </em><em>default=0</em>) – The number of users to skip.</p></li>
|
|
|
<li><p><strong>origin</strong> (<em>Literal</em><em>[</em><em>'local'</em><em>, </em><em>'remote'</em><em>, </em><em>'combined'</em><em>]</em><em>, </em><em>default='combined'</em>) – The origin of users to search.</p></li>
|
|
|
<li><p><strong>detail</strong> (<em>Literal</em><em>[</em><em>True</em><em>, </em><em>False</em><em>]</em><em>, </em><em>default=True</em>) – Whether to return detailed user information.</p></li>
|
|
|
<li><p><strong>get_all</strong> (<em>bool</em><em>, </em><em>default=False</em>) – Whether to return all users.</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.user.UserActions.search_by_username_and_host">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">search_by_username_and_host</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">username</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">100</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">detail</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.user.UserDetailedNotMe" title="mipac.models.user.UserDetailedNotMe"><span class="pre">UserDetailedNotMe</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#mipac.models.user.MeDetailed" title="mipac.models.user.MeDetailed"><span class="pre">MeDetailed</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#mipac.models.lite.user.PartialUser" title="mipac.models.lite.user.PartialUser"><span class="pre">PartialUser</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.user.UserActions.search_by_username_and_host" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Search users by username and host.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>username</strong> (<em>str</em>) – Username of user.</p></li>
|
|
|
<li><p><strong>host</strong> (<em>str</em>) – Host of user.</p></li>
|
|
|
<li><p><strong>limit</strong> (<em>int</em><em>, </em><em>default=100</em>) – The maximum number of users to return.</p></li>
|
|
|
<li><p><strong>detail</strong> (<em>bool</em><em>, </em><em>default=True</em>) – Weather to get detailed user information.</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>A list of users.</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.user.UserDetailedNotMe" title="mipac.models.user.UserDetailedNotMe">UserDetailedNotMe</a> | <a class="reference internal" href="#mipac.models.user.MeDetailed" title="mipac.models.user.MeDetailed">MeDetailed</a> | <a class="reference internal" href="#mipac.models.lite.user.PartialUser" title="mipac.models.lite.user.PartialUser">PartialUser</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientactions">
|
|
|
<h3>ClientActions<a class="headerlink" href="#clientactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.client.ClientActions"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.client.ClientActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.client.</span></span><span class="sig-name descname"><span class="pre">ClientActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.client.ClientActions" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientmuteactions">
|
|
|
<h3>ClientMuteActions<a class="headerlink" href="#clientmuteactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.users.mute.ClientMuteActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.users.mute.ClientMuteActions.create">create</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.users.mute.ClientMuteActions.delete">delete</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.users.mute.ClientMuteActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.users.mute.</span></span><span class="sig-name descname"><span class="pre">ClientMuteActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.users.mute.ClientMuteActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.users.mute.ClientMuteActions.create">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">expires_at</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.users.mute.ClientMuteActions.create" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>指定したユーザーをミュートします</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>user_id</strong> (<em>str</em>) – 対象のユーザーID</p></li>
|
|
|
<li><p><strong>expires_at</strong> (<em>int</em><em> | </em><em>None</em>) – ミュートする期間(秒)、無期限でミュートする場合はNoneを指定します</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>ミュートに成功したかどうか</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.users.mute.ClientMuteActions.delete">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.users.mute.ClientMuteActions.delete" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>指定したユーザーのミュートを解除します</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>user_id</strong> (<em>str</em>) – 対象のユーザーID</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>ミュート解除に成功したかどうか</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="muteactions">
|
|
|
<h3>MuteActions<a class="headerlink" href="#muteactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.users.mute.MuteActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="method">
|
|
|
def</span><a class="reference internal" href="#mipac.actions.users.mute.MuteActions.get_all_list">get_all_list</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.users.mute.MuteActions.get_list">get_list</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.users.mute.MuteActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.users.mute.</span></span><span class="sig-name descname"><span class="pre">MuteActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.users.mute.MuteActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.users.mute.MuteActions.get_all_list">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_all_list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">30</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.users.mute.MuteActions.get_all_list" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>ミュートしている全てのユーザーを取得します</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>limit</strong> (<em>int</em>) – 取得するユーザー数, by default 30</p></li>
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em> | </em><em>None</em>) – 指定したIDより後のミュート中のユーザーを取得します, default=None</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em> | </em><em>None</em>) – 指定したIDより前のミュート中のユーザーを取得します, default=None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>ミュートしているユーザー</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>AsyncGenerator[<a class="reference internal" href="#mipac.models.mute.MutedUser" title="mipac.models.mute.MutedUser">MutedUser</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.users.mute.MuteActions.get_list">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">30</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.mute.MutedUser" title="mipac.models.mute.MutedUser"><span class="pre">MutedUser</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.users.mute.MuteActions.get_list" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>ミュートしているユーザーの一覧を取得します</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>ミュートしているユーザーの一覧</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>list[<a class="reference internal" href="#mipac.models.mute.MutedUser" title="mipac.models.mute.MutedUser">MutedUser</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="sharedmuteactions">
|
|
|
<h3>SharedMuteActions<a class="headerlink" href="#sharedmuteactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.users.mute.SharedMuteActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.users.mute.SharedMuteActions.create">create</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.users.mute.SharedMuteActions.delete">delete</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.users.mute.SharedMuteActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.users.mute.</span></span><span class="sig-name descname"><span class="pre">SharedMuteActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.users.mute.SharedMuteActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.users.mute.SharedMuteActions.create">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">expires_at</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.users.mute.SharedMuteActions.create" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>指定したユーザーをミュートします</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>user_id</strong> (<em>str</em><em> | </em><em>None</em>) – 対象のユーザーID, default=None</p></li>
|
|
|
<li><p><strong>expires_at</strong> (<em>int</em><em> | </em><em>None</em>) – ミュートする期間(秒)、無期限でミュートする場合はNoneを指定します</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>ミュートに成功したかどうか</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.users.mute.SharedMuteActions.delete">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.users.mute.SharedMuteActions.delete" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>指定したユーザーのミュートを解除します</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>user_id</strong> (<em>str</em><em> | </em><em>None</em>) – 対象のユーザーID, default=None</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>ミュート解除に成功したかどうか</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientpartialuserlistactions">
|
|
|
<h3>ClientPartialUserListActions<a class="headerlink" href="#clientpartialuserlistactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.users.list.ClientPartialUserListActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.users.list.ClientPartialUserListActions.get_list">get_list</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.users.list.ClientPartialUserListActions.pull">pull</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.users.list.ClientPartialUserListActions.push">push</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.users.list.ClientPartialUserListActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.users.list.</span></span><span class="sig-name descname"><span class="pre">ClientPartialUserListActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.users.list.ClientPartialUserListActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>ユーザー向けのリストのアクションを提供します。</p>
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.users.list.ClientPartialUserListActions.get_list">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.user.UserList" title="mipac.models.user.UserList"><span class="pre">UserList</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.users.list.ClientPartialUserListActions.get_list" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get the user lists of a user</p>
|
|
|
<p>Endpoint <cite>/api/users/lists/list</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>user_id</strong> (<em>str</em>) – The id of the user to get the lists of</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>The user lists the user has</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.user.UserList" title="mipac.models.user.UserList">UserList</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.users.list.ClientPartialUserListActions.pull">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">pull</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">list_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.users.list.ClientPartialUserListActions.pull" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Pull a user from a user list</p>
|
|
|
<p>Endpoint <cite>/api/users/lists/pull</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>list_id</strong> (<em>str</em>) – The id of the user list to pull from</p></li>
|
|
|
<li><p><strong>user_id</strong> (<em>str</em><em>, </em><em>optional</em>) – The id of the user to pull, by default None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>True if the user was pulled, False otherwise</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.users.list.ClientPartialUserListActions.push">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">push</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">list_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.users.list.ClientPartialUserListActions.push" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Push a user to a user list</p>
|
|
|
<p>Endpoint <cite>/api/users/lists/push</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>list_id</strong> (<em>str</em>) – The id of the user list to push to</p></li>
|
|
|
<li><p><strong>user_id</strong> (<em>str</em><em>, </em><em>optional</em>) – The id of the user to push, by default None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>True if the user was pushed, False otherwise</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientuserlistactions">
|
|
|
<h3>ClientUserListActions<a class="headerlink" href="#clientuserlistactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.users.list.ClientUserListActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.users.list.ClientUserListActions.delete">delete</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.users.list.ClientUserListActions.favorite">favorite</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.users.list.ClientUserListActions.show">show</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.users.list.ClientUserListActions.unfavorite">unfavorite</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.users.list.ClientUserListActions.update">update</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.users.list.ClientUserListActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.users.list.</span></span><span class="sig-name descname"><span class="pre">ClientUserListActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">list_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.users.list.ClientUserListActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.users.list.ClientUserListActions.delete">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">list_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.users.list.ClientUserListActions.delete" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Delete a user list</p>
|
|
|
<p>Endpoint <cite>/api/users/lists/delete</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>list_id</strong> (<em>str</em><em>, </em><em>optional</em>) – The id of the user list to delete, by default None</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>True if the user list was deleted, False otherwise</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.users.list.ClientUserListActions.favorite">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">favorite</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">list_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.users.list.ClientUserListActions.favorite" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Favorite a user list</p>
|
|
|
<p>Endpoint <cite>/api/users/lists/favorite</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>list_id</strong> (<em>str</em><em>, </em><em>optional</em>) – The id of the user list to favorite, by default None</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>True if the user list was favorited, False otherwise</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.users.list.ClientUserListActions.show">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">show</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">for_public</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">list_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.user.UserList" title="mipac.models.user.UserList"><span class="pre">UserList</span></a></span></span><a class="headerlink" href="#mipac.actions.users.list.ClientUserListActions.show" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Show a user list</p>
|
|
|
<p>Endpoint <cite>/api/users/lists/show</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>for_public</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to show the user list for the public, by default False</p></li>
|
|
|
<li><p><strong>list_id</strong> (<em>str</em><em>, </em><em>optional</em>) – The id of the user list to show, by default None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>The user list</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.user.UserList" title="mipac.models.user.UserList">UserList</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.users.list.ClientUserListActions.unfavorite">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">unfavorite</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">list_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.users.list.ClientUserListActions.unfavorite" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Unfavorite a user list</p>
|
|
|
<p>Endpoint <cite>/api/users/lists/unfavorite</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>list_id</strong> (<em>str</em><em>, </em><em>optional</em>) – The id of the user list to unfavorite, by default None</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>True if the user list was unfavorited, False otherwise</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.users.list.ClientUserListActions.update">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_public</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">list_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.user.UserList" title="mipac.models.user.UserList"><span class="pre">UserList</span></a></span></span><a class="headerlink" href="#mipac.actions.users.list.ClientUserListActions.update" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Update a user list</p>
|
|
|
<p>Endpoint <cite>/api/users/lists/update</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>name</strong> (<em>str</em><em>, </em><em>optional</em>) – The new name of the user list, by default MISSING</p></li>
|
|
|
<li><p><strong>is_public</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether the user list should be public, by default MISSING</p></li>
|
|
|
<li><p><strong>list_id</strong> (<em>str</em><em>, </em><em>optional</em>) – The id of the user list to update, by default None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>The updated user list</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.user.UserList" title="mipac.models.user.UserList">UserList</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="sharedpartialuserlistactions">
|
|
|
<h3>SharedPartialUserListActions<a class="headerlink" href="#sharedpartialuserlistactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.users.list.SharedPartialUserListActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.users.list.SharedPartialUserListActions.get_list">get_list</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.users.list.SharedPartialUserListActions.pull">pull</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.users.list.SharedPartialUserListActions.push">push</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.users.list.SharedPartialUserListActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.users.list.</span></span><span class="sig-name descname"><span class="pre">SharedPartialUserListActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.users.list.SharedPartialUserListActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.users.list.SharedPartialUserListActions.get_list">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_list</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.user.UserList" title="mipac.models.user.UserList"><span class="pre">UserList</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.users.list.SharedPartialUserListActions.get_list" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get the user lists of a user</p>
|
|
|
<p>Endpoint <cite>/api/users/lists/list</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>user_id</strong> (<em>str</em>) – The id of the user to get the lists of</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>The user lists the user has</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.user.UserList" title="mipac.models.user.UserList">UserList</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.users.list.SharedPartialUserListActions.pull">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">pull</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">list_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.users.list.SharedPartialUserListActions.pull" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Pull a user from a user list</p>
|
|
|
<p>Endpoint <cite>/api/users/lists/pull</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>list_id</strong> (<em>str</em>) – The id of the user list to pull from</p></li>
|
|
|
<li><p><strong>user_id</strong> (<em>str</em><em>, </em><em>optional</em>) – The id of the user to pull, by default None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>True if the user was pulled, False otherwise</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.users.list.SharedPartialUserListActions.push">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">push</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">list_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.users.list.SharedPartialUserListActions.push" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Push a user to a user list</p>
|
|
|
<p>Endpoint <cite>/api/users/lists/push</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>list_id</strong> (<em>str</em>) – The id of the user list to push to</p></li>
|
|
|
<li><p><strong>user_id</strong> (<em>str</em><em>, </em><em>optional</em>) – The id of the user to push, by default None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>True if the user was pushed, False otherwise</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="shareduserlistactions">
|
|
|
<h3>SharedUserListActions<a class="headerlink" href="#shareduserlistactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.users.list.SharedUserListActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.users.list.SharedUserListActions.delete">delete</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.users.list.SharedUserListActions.favorite">favorite</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.users.list.SharedUserListActions.show">show</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.users.list.SharedUserListActions.unfavorite">unfavorite</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.users.list.SharedUserListActions.update">update</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.users.list.SharedUserListActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.users.list.</span></span><span class="sig-name descname"><span class="pre">SharedUserListActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.users.list.SharedUserListActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.users.list.SharedUserListActions.delete">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">list_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.users.list.SharedUserListActions.delete" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Delete a user list</p>
|
|
|
<p>Endpoint <cite>/api/users/lists/delete</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>list_id</strong> (<em>str</em><em>, </em><em>optional</em>) – The id of the user list to delete, by default None</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>True if the user list was deleted, False otherwise</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.users.list.SharedUserListActions.favorite">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">favorite</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">list_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.users.list.SharedUserListActions.favorite" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Favorite a user list</p>
|
|
|
<p>Endpoint <cite>/api/users/lists/favorite</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>list_id</strong> (<em>str</em><em>, </em><em>optional</em>) – The id of the user list to favorite, by default None</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>True if the user list was favorited, False otherwise</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.users.list.SharedUserListActions.show">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">show</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">for_public</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">list_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.user.UserList" title="mipac.models.user.UserList"><span class="pre">UserList</span></a></span></span><a class="headerlink" href="#mipac.actions.users.list.SharedUserListActions.show" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Show a user list</p>
|
|
|
<p>Endpoint <cite>/api/users/lists/show</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>for_public</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to show the user list for the public, by default False</p></li>
|
|
|
<li><p><strong>list_id</strong> (<em>str</em><em>, </em><em>optional</em>) – The id of the user list to show, by default None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>The user list</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.user.UserList" title="mipac.models.user.UserList">UserList</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.users.list.SharedUserListActions.unfavorite">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">unfavorite</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">list_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.users.list.SharedUserListActions.unfavorite" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Unfavorite a user list</p>
|
|
|
<p>Endpoint <cite>/api/users/lists/unfavorite</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>list_id</strong> (<em>str</em><em>, </em><em>optional</em>) – The id of the user list to unfavorite, by default None</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>True if the user list was unfavorited, False otherwise</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.users.list.SharedUserListActions.update">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_public</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">list_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.user.UserList" title="mipac.models.user.UserList"><span class="pre">UserList</span></a></span></span><a class="headerlink" href="#mipac.actions.users.list.SharedUserListActions.update" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Update a user list</p>
|
|
|
<p>Endpoint <cite>/api/users/lists/update</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>name</strong> (<em>str</em><em>, </em><em>optional</em>) – The new name of the user list, by default MISSING</p></li>
|
|
|
<li><p><strong>is_public</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether the user list should be public, by default MISSING</p></li>
|
|
|
<li><p><strong>list_id</strong> (<em>str</em><em>, </em><em>optional</em>) – The id of the user list to update, by default None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>The updated user list</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.user.UserList" title="mipac.models.user.UserList">UserList</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="userlistactions">
|
|
|
<h3>UserListActions<a class="headerlink" href="#userlistactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.users.list.UserListActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.users.list.UserListActions.create">create</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.users.list.UserListActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.users.list.</span></span><span class="sig-name descname"><span class="pre">UserListActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.users.list.UserListActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.users.list.UserListActions.create">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.user.UserList" title="mipac.models.user.UserList"><span class="pre">UserList</span></a></span></span><a class="headerlink" href="#mipac.actions.users.list.UserListActions.create" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Create a new user list</p>
|
|
|
<p>Endpoint <cite>/api/users/lists/create</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>name</strong> (<em>str</em>) – The name of the new user list</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>The created user list</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.user.UserList" title="mipac.models.user.UserList">UserList</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="admininviteactions">
|
|
|
<h3>AdminInviteActions<a class="headerlink" href="#admininviteactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.admins.invite.AdminInviteActions"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.admins.invite.AdminInviteActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.admins.invite.</span></span><span class="sig-name descname"><span class="pre">AdminInviteActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.admins.invite.AdminInviteActions" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="adminannouncementactions">
|
|
|
<h3>AdminAnnouncementActions<a class="headerlink" href="#adminannouncementactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.admins.announcement.AdminAnnouncementActions"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.admins.announcement.AdminAnnouncementActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.admins.announcement.</span></span><span class="sig-name descname"><span class="pre">AdminAnnouncementActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.admins.announcement.AdminAnnouncementActions" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientadminannouncementactions">
|
|
|
<h3>ClientAdminAnnouncementActions<a class="headerlink" href="#clientadminannouncementactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.admins.announcement.ClientAdminAnnouncementActions"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.admins.announcement.ClientAdminAnnouncementActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.admins.announcement.</span></span><span class="sig-name descname"><span class="pre">ClientAdminAnnouncementActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">announce_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.admins.announcement.ClientAdminAnnouncementActions" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="sharedadminannouncementactions">
|
|
|
<h3>SharedAdminAnnouncementActions<a class="headerlink" href="#sharedadminannouncementactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.admins.announcement.SharedAdminAnnouncementActions"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.admins.announcement.SharedAdminAnnouncementActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.admins.announcement.</span></span><span class="sig-name descname"><span class="pre">SharedAdminAnnouncementActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.admins.announcement.SharedAdminAnnouncementActions" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="adminemojiactions">
|
|
|
<h3>AdminEmojiActions<a class="headerlink" href="#adminemojiactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.admins.emoji.AdminEmojiActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.admins.emoji.AdminEmojiActions.remove">remove</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.admins.emoji.AdminEmojiActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.admins.emoji.</span></span><span class="sig-name descname"><span class="pre">AdminEmojiActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">emoji_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.admins.emoji.AdminEmojiActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.admins.emoji.AdminEmojiActions.remove">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">remove</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">emoji_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.admins.emoji.AdminEmojiActions.remove" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>指定したIdの絵文字を削除します</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>emoji_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>optional</em>) – 削除する絵文字のId, by default None</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>成功したかどうか</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p><a class="reference internal" href="#mipac.errors.base.NotExistRequiredData" title="mipac.errors.base.NotExistRequiredData"><strong>NotExistRequiredData</strong></a> – Idが不足している</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="adminactions">
|
|
|
<h3>AdminActions<a class="headerlink" href="#adminactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.admins.admin.AdminActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.admins.admin.AdminActions.get_meta">get_meta</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.admins.admin.AdminActions.reset_password">reset_password</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.admins.admin.AdminActions.resolve_abuse_user_report">resolve_abuse_user_report</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.admins.admin.AdminActions.send_email">send_email</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.admins.admin.AdminActions.suspend_user">suspend_user</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.admins.admin.AdminActions.unsuspend_user">unsuspend_user</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.admins.admin.AdminActions.update_user_note">update_user_note</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.admins.admin.AdminActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.admins.admin.</span></span><span class="sig-name descname"><span class="pre">AdminActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.admins.admin.AdminActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.admins.admin.AdminActions.get_meta">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_meta</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">detail</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.meta.AdminMeta" title="mipac.models.meta.AdminMeta"><span class="pre">AdminMeta</span></a></span></span><a class="headerlink" href="#mipac.actions.admins.admin.AdminActions.get_meta" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get admin meta
|
|
|
Endpoint: <cite>/api/admin/meta</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>detail</strong> (<em>bool</em><em>, </em><em>optional</em>) – flag of detail, by default False</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.admins.admin.AdminActions.reset_password">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">reset_password</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#mipac.actions.admins.admin.AdminActions.reset_password" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>target user’s password reset
|
|
|
Endpoint: <cite>/api/admin/reset-password</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>user_id</strong> (<em>str</em>) – target user’s id</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>new password</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>str</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.admins.admin.AdminActions.resolve_abuse_user_report">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">resolve_abuse_user_report</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">report_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">forward</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.admins.admin.AdminActions.resolve_abuse_user_report" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Resolve abuse user report
|
|
|
Endpoint: <cite>/api/admin/resolve-abuse-user-report</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>report_id</strong> (<em>str</em>) – report id</p></li>
|
|
|
<li><p><strong>forward</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to forward the report to a remote server</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.admins.admin.AdminActions.send_email">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">send_email</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">to</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subject</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">text</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.admins.admin.AdminActions.send_email" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Send email to specified address
|
|
|
Endpoint: <cite>/api/admin/send-email</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>to</strong> (<em>str</em>) – email address to send</p></li>
|
|
|
<li><p><strong>subject</strong> (<em>str</em>) – email subject</p></li>
|
|
|
<li><p><strong>text</strong> (<em>str</em>) – email body</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.admins.admin.AdminActions.suspend_user">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">suspend_user</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.admins.admin.AdminActions.suspend_user" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Suspends the user for the specified Id
|
|
|
Endpoint: <cite>/api/admin/suspend-user</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>user_id</strong> (<em>str</em>) – Id of user to suspend</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>success or failed</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.admins.admin.AdminActions.unsuspend_user">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">unsuspend_user</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.admins.admin.AdminActions.unsuspend_user" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Unsuspend user with specified Id
|
|
|
Endpoint: <cite>/api/admin/unsuspend-user</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>user_id</strong> (<em>str</em>) – Id of user to unsuspend</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>success or failed</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.admins.admin.AdminActions.update_user_note">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">update_user_note</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">text</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.admins.admin.AdminActions.update_user_note" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Update user note
|
|
|
Endpoint: <cite>/api/admin/update-user-note</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>user_id</strong> (<em>str</em>) – target user’s id</p></li>
|
|
|
<li><p><strong>text</strong> (<em>str</em>) – new note</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="admindriveactions">
|
|
|
<h3>AdminDriveActions<a class="headerlink" href="#admindriveactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.admins.drive.AdminDriveActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.admins.drive.AdminDriveActions.clean_remote_files">clean_remote_files</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.admins.drive.AdminDriveActions.cleanup">cleanup</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.admins.drive.AdminDriveActions.get_files">get_files</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.admins.drive.AdminDriveActions.show_file">show_file</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.admins.drive.AdminDriveActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.admins.drive.</span></span><span class="sig-name descname"><span class="pre">AdminDriveActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.admins.drive.AdminDriveActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.admins.drive.AdminDriveActions.clean_remote_files">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">clean_remote_files</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.admins.drive.AdminDriveActions.clean_remote_files" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Clean remote files</p>
|
|
|
<p>Endpoint: <cite>/api/admin/drive/clean-remote-files</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>Whether the remote files were cleaned</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.admins.drive.AdminDriveActions.cleanup">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cleanup</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.admins.drive.AdminDriveActions.cleanup" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Clean up the drive</p>
|
|
|
<p>Endpoint: <cite>/api/admin/drive/cleanup</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>Whether the drive was cleaned up</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.admins.drive.AdminDriveActions.get_files">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_files</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">origin</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'combined'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'local'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'remote'</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'local'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hostname</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File"><span class="pre">File</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.admins.drive.AdminDriveActions.get_files" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get all files</p>
|
|
|
<p>Endpoint: <cite>/api/admin/drive/files</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>limit</strong> (<em>int</em>) – The number of files to get</p></li>
|
|
|
<li><p><strong>since_id</strong> (<em>str</em>) – The id of the file to start from</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em>) – The id of the file to end at</p></li>
|
|
|
<li><p><strong>type</strong> (<em>str</em>) – The type of file to get</p></li>
|
|
|
<li><p><strong>user_id</strong> (<em>str</em>) – The id of the user to get files from</p></li>
|
|
|
<li><p><strong>origin</strong> (<em>Literal</em><em>[</em><em>'combined'</em><em>, </em><em>'local'</em><em>, </em><em>'remote'</em><em>]</em>) – The origin of the files</p></li>
|
|
|
<li><p><strong>hostname</strong> (<em>str</em>) – The hostname of the files</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>A list of files</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File">File</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.admins.drive.AdminDriveActions.show_file">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">show_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.admins.drive.AdminDriveActions.show_file" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Show a file</p>
|
|
|
<p>Endpoint: <cite>/api/admin/drive/files/show</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>file_id</strong> (<em>str</em>) – The id of the file to show</p></li>
|
|
|
<li><p><strong>url</strong> (<em>str</em>) – The url of the file to show</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>The file</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>dict[str, Any]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="adminadactions">
|
|
|
<h3>AdminAdActions<a class="headerlink" href="#adminadactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.admins.ad.AdminAdActions"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.admins.ad.AdminAdActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.admins.ad.</span></span><span class="sig-name descname"><span class="pre">AdminAdActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.admins.ad.AdminAdActions" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientadminadactions">
|
|
|
<h3>ClientAdminAdActions<a class="headerlink" href="#clientadminadactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.admins.ad.ClientAdminAdActions"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.admins.ad.ClientAdminAdActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.admins.ad.</span></span><span class="sig-name descname"><span class="pre">ClientAdminAdActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ad_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.admins.ad.ClientAdminAdActions" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="sharedadminadactions">
|
|
|
<h3>SharedAdminAdActions<a class="headerlink" href="#sharedadminadactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.admins.ad.SharedAdminAdActions"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.admins.ad.SharedAdminAdActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.admins.ad.</span></span><span class="sig-name descname"><span class="pre">SharedAdminAdActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.admins.ad.SharedAdminAdActions" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="adminroleactions">
|
|
|
<h3>AdminRoleActions<a class="headerlink" href="#adminroleactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.admins.roles.AdminRoleActions"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.admins.roles.AdminRoleActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.admins.roles.</span></span><span class="sig-name descname"><span class="pre">AdminRoleActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">role_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.admins.roles.AdminRoleActions" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="adminrolemodelactions">
|
|
|
<h3>AdminRoleModelActions<a class="headerlink" href="#adminrolemodelactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.admins.roles.AdminRoleModelActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.admins.roles.AdminRoleModelActions.assign">assign</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.admins.roles.AdminRoleModelActions.unassign">unassign</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.admins.roles.AdminRoleModelActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.admins.roles.</span></span><span class="sig-name descname"><span class="pre">AdminRoleModelActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">role_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.admins.roles.AdminRoleModelActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.admins.roles.AdminRoleModelActions.assign">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">assign</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">role_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expires_at</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.admins.roles.AdminRoleModelActions.assign" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>指定したユーザーに指定したロールを付与します</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>role_id</strong> (<em>str</em>) – ロールのID</p></li>
|
|
|
<li><p><strong>user_id</strong> (<em>str</em>) – ロールを付与する対象のユーザーID</p></li>
|
|
|
<li><p><strong>expires_at</strong> (<em>int</em><em> | </em><em>None</em><em>, </em><em>optional</em>) – いつまでロールを付与するか, by default None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>成功したか否か</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.admins.roles.AdminRoleModelActions.unassign">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">unassign</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">role_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.admins.roles.AdminRoleModelActions.unassign" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>指定したユーザーに指定したロールを付与します</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>role_id</strong> (<em>str</em>) – ロールのID</p></li>
|
|
|
<li><p><strong>user_id</strong> (<em>str</em>) – ロールを付与する対象のユーザーID</p></li>
|
|
|
<li><p><strong>expires_at</strong> (<em>int</em><em> | </em><em>None</em><em>, </em><em>optional</em>) – いつまでロールを付与するか, by default None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>成功したか否か</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="adminuseractions">
|
|
|
<h3>AdminUserActions<a class="headerlink" href="#adminuseractions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.admins.user.AdminUserActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.admins.user.AdminUserActions.delete_account">delete_account</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.admins.user.AdminUserActions.show_user">show_user</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.admins.user.AdminUserActions.suspend">suspend</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.admins.user.AdminUserActions.unsuspend">unsuspend</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.admins.user.AdminUserActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.admins.user.</span></span><span class="sig-name descname"><span class="pre">AdminUserActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.admins.user.AdminUserActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.admins.user.AdminUserActions.delete_account">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">delete_account</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.admins.user.AdminUserActions.delete_account" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Deletes the user with the specified user ID.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>user_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – ID of the user to be deleted</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Success or failure</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.admins.user.AdminUserActions.show_user">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">show_user</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.user.UserDetailedNotMe" title="mipac.models.user.UserDetailedNotMe"><span class="pre">UserDetailedNotMe</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#mipac.models.user.MeDetailed" title="mipac.models.user.MeDetailed"><span class="pre">MeDetailed</span></a></span></span><a class="headerlink" href="#mipac.actions.admins.user.AdminUserActions.show_user" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Shows the user with the specified user ID.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>user_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – ID of the user to be shown</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p><a class="reference internal" href="#mipac.models.user.UserDetailedNotMe" title="mipac.models.user.UserDetailedNotMe">UserDetailedNotMe</a> | <a class="reference internal" href="#mipac.models.user.MeDetailed" title="mipac.models.user.MeDetailed">MeDetailed</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.admins.user.AdminUserActions.suspend">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">suspend</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.admins.user.AdminUserActions.suspend" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Suspends the user with the specified user ID.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>user_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – ID of the user to be suspended</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Success or failure</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.admins.user.AdminUserActions.unsuspend">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">unsuspend</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.admins.user.AdminUserActions.unsuspend" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Unsuspends the user with the specified user ID.</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>user_id</strong> (<em>str</em><em> | </em><em>None</em><em>, </em><em>default=None</em>) – ID of the user to be unsuspended</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Success or failure</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientfileactionsinfolder">
|
|
|
<h3>ClientFileActionsInFolder<a class="headerlink" href="#clientfileactionsinfolder" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.drive.folders.ClientFileActionsInFolder"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.drive.folders.ClientFileActionsInFolder.create">create</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.drive.folders.ClientFileActionsInFolder.find">find</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.drive.folders.ClientFileActionsInFolder.update">update</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.drive.folders.ClientFileActionsInFolder.upload_from_url">upload_from_url</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.folders.ClientFileActionsInFolder">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.drive.folders.</span></span><span class="sig-name descname"><span class="pre">ClientFileActionsInFolder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">folder_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.drive.folders.ClientFileActionsInFolder" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>File actions in a folder</p>
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.folders.ClientFileActionsInFolder.create">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">comment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_sensitive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">force</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File"><span class="pre">File</span></a></span></span><a class="headerlink" href="#mipac.actions.drive.folders.ClientFileActionsInFolder.create" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Upload a file to the drive</p>
|
|
|
<p>Endpoint: <cite>/api/drive/files/create</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>file</strong> (<em>str</em>) – The file to upload</p></li>
|
|
|
<li><p><strong>folder_id</strong> (<em>str</em><em> | </em><em>None</em>) – The id of the folder to upload the file to, defaults to None</p></li>
|
|
|
<li><p><strong>name</strong> (<em>str</em><em> | </em><em>None</em>) – The name of the file, defaults to None</p></li>
|
|
|
<li><p><strong>comment</strong> (<em>str</em><em> | </em><em>None</em>) – The comment of the file, defaults to None</p></li>
|
|
|
<li><p><strong>is_sensitive</strong> (<em>bool</em>) – Whether the file is sensitive or not, defaults to False</p></li>
|
|
|
<li><p><strong>force</strong> (<em>bool</em>) – Whether to force upload the file or not, defaults to False</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>The uploaded file</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File">File</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.folders.ClientFileActionsInFolder.find">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">find</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File"><span class="pre">File</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.drive.folders.ClientFileActionsInFolder.find" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Find a file by its name</p>
|
|
|
<p>Endpoint: <cite>/api/drive/files/find</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>name</strong> (<em>str</em>) – The name of the file to find</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>The found files</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File">File</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.folders.ClientFileActionsInFolder.update">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_sensitive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">comment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.drive.folders.ClientFileActionsInFolder.update" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Update a file</p>
|
|
|
<p>Endpoint: <cite>/api/drive/files/update</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>file_id</strong> (<em>str</em><em> | </em><em>None</em>) – The id of the file to update, defaults to None</p></li>
|
|
|
<li><p><strong>name</strong> (<em>str</em><em> | </em><em>None</em>) – The name of the file, defaults to MISSING</p></li>
|
|
|
<li><p><strong>is_sensitive</strong> (<em>bool</em>) – Whether the file is sensitive or not, defaults to MISSING</p></li>
|
|
|
<li><p><strong>comment</strong> (<em>str</em><em> | </em><em>None</em>) – The comment of the file, defaults to MISSING</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>The updated file</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File">File</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.folders.ClientFileActionsInFolder.upload_from_url">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">upload_from_url</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_sensitive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">comment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">marker</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">force</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.drive.folders.ClientFileActionsInFolder.upload_from_url" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Upload a file to the drive from a url</p>
|
|
|
<p>Endpoint: <cite>/api/drive/files/upload-from-url</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>url</strong> (<em>str</em>) – The url of the file to upload</p></li>
|
|
|
<li><p><strong>is_sensitive</strong> (<em>bool</em>) – Whether the file is sensitive or not, defaults to False</p></li>
|
|
|
<li><p><strong>comment</strong> (<em>str</em><em> | </em><em>None</em>) – The comment of the file, defaults to None</p></li>
|
|
|
<li><p><strong>marker</strong> (<em>str</em><em> | </em><em>None</em>) – The marker of the file, defaults to None</p></li>
|
|
|
<li><p><strong>force</strong> (<em>bool</em>) – Whether to force upload the file or not, defaults to False</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Whether the file was uploaded or not</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientfolderactions">
|
|
|
<h3>ClientFolderActions<a class="headerlink" href="#clientfolderactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.drive.folders.ClientFolderActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.drive.folders.ClientFolderActions.create">create</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.drive.folders.ClientFolderActions.delete">delete</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.drive.folders.ClientFolderActions.gets">gets</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.drive.folders.ClientFolderActions.update">update</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.folders.ClientFolderActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.drive.folders.</span></span><span class="sig-name descname"><span class="pre">ClientFolderActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">folder_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.drive.folders.ClientFolderActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.folders.ClientFolderActions.create">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.drive.Folder" title="mipac.models.drive.Folder"><span class="pre">Folder</span></a></span></span><a class="headerlink" href="#mipac.actions.drive.folders.ClientFolderActions.create" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Create a new folder</p>
|
|
|
<p>Endpoint: <cite>/api/drive/folders/create</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>name</strong> (<em>str</em><em>, </em><em>optional</em>) – The name of the folder, by default None</p></li>
|
|
|
<li><p><strong>parent_id</strong> (<em>str</em><em>, </em><em>optional</em>) – The parent ID of the folder, by default None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>The created folder</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.drive.Folder" title="mipac.models.drive.Folder">Folder</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.folders.ClientFolderActions.delete">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">folder_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.drive.folders.ClientFolderActions.delete" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Delete a folder</p>
|
|
|
<p>Endpoint: <cite>/api/drive/folders/delete</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>folder_id</strong> (<em>str</em><em>, </em><em>optional</em>) – The ID of the folder, by default None</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Whether the folder was deleted or not</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.folders.ClientFolderActions.gets">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">gets</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">folder_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.drive.Folder" title="mipac.models.drive.Folder"><span class="pre">Folder</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.drive.folders.ClientFolderActions.gets" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get folders</p>
|
|
|
<p>Endpoint: <cite>/api/drive/folders</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>limit</strong> (<em>int</em>) – The limit of folders to get, defaults to 10</p></li>
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em> | </em><em>None</em>) – The ID of the folder to get since, defaults to None</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em> | </em><em>None</em>) – The ID of the folder to get until, defaults to None</p></li>
|
|
|
<li><p><strong>folder_id</strong> (<em>str</em><em> | </em><em>None</em>) – The ID of the folder to get, defaults to None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>The found folders</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.drive.Folder" title="mipac.models.drive.Folder">Folder</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.folders.ClientFolderActions.update">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">folder_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.drive.Folder" title="mipac.models.drive.Folder"><span class="pre">Folder</span></a></span></span><a class="headerlink" href="#mipac.actions.drive.folders.ClientFolderActions.update" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Update a folder</p>
|
|
|
<p>Endpoint: <cite>/api/drive/folders/update</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>name</strong> (<em>str</em><em>, </em><em>optional</em>) – The name of the folder, by default MISSING</p></li>
|
|
|
<li><p><strong>parent_id</strong> (<em>str</em><em>, </em><em>optional</em>) – The parent ID of the folder, by default MISSING</p></li>
|
|
|
<li><p><strong>folder_id</strong> (<em>str</em><em>, </em><em>optional</em>) – The ID of the folder, by default None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>The updated folder</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.drive.Folder" title="mipac.models.drive.Folder">Folder</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="folderactions">
|
|
|
<h3>FolderActions<a class="headerlink" href="#folderactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.drive.folders.FolderActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.drive.folders.FolderActions.find">find</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.drive.folders.FolderActions.show">show</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.folders.FolderActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.drive.folders.</span></span><span class="sig-name descname"><span class="pre">FolderActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.drive.folders.FolderActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.folders.FolderActions.find">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">find</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.drive.Folder" title="mipac.models.drive.Folder"><span class="pre">Folder</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.drive.folders.FolderActions.find" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Find folders</p>
|
|
|
<p>Endpoint: <cite>/api/drive/folders/find</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>name</strong> (<em>str</em>) – The name of the folder</p></li>
|
|
|
<li><p><strong>parent_id</strong> (<em>str</em><em>, </em><em>optional</em>) – The parent ID of the folder, by default None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>The found folders</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.drive.Folder" title="mipac.models.drive.Folder">Folder</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.folders.FolderActions.show">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">show</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">folder_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.drive.Folder" title="mipac.models.drive.Folder"><span class="pre">Folder</span></a></span></span><a class="headerlink" href="#mipac.actions.drive.folders.FolderActions.show" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Show a folder</p>
|
|
|
<p>Endpoint: <cite>/api/drive/folders/show</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>folder_id</strong> (<em>str</em>) – The ID of the folder</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>The found folder</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.drive.Folder" title="mipac.models.drive.Folder">Folder</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="sharedfolderactions">
|
|
|
<h3>SharedFolderActions<a class="headerlink" href="#sharedfolderactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.drive.folders.SharedFolderActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.drive.folders.SharedFolderActions.create">create</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.drive.folders.SharedFolderActions.delete">delete</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.drive.folders.SharedFolderActions.gets">gets</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.drive.folders.SharedFolderActions.update">update</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.folders.SharedFolderActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.drive.folders.</span></span><span class="sig-name descname"><span class="pre">SharedFolderActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.drive.folders.SharedFolderActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.folders.SharedFolderActions.create">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.drive.Folder" title="mipac.models.drive.Folder"><span class="pre">Folder</span></a></span></span><a class="headerlink" href="#mipac.actions.drive.folders.SharedFolderActions.create" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Create a new folder</p>
|
|
|
<p>Endpoint: <cite>/api/drive/folders/create</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>name</strong> (<em>str</em><em>, </em><em>optional</em>) – The name of the folder, by default None</p></li>
|
|
|
<li><p><strong>parent_id</strong> (<em>str</em><em>, </em><em>optional</em>) – The parent ID of the folder, by default None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>The created folder</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.drive.Folder" title="mipac.models.drive.Folder">Folder</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.folders.SharedFolderActions.delete">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">folder_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.drive.folders.SharedFolderActions.delete" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Delete a folder</p>
|
|
|
<p>Endpoint: <cite>/api/drive/folders/delete</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>folder_id</strong> (<em>str</em><em>, </em><em>optional</em>) – The ID of the folder, by default None</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>Whether the folder was deleted or not</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.folders.SharedFolderActions.gets">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">gets</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">folder_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.drive.Folder" title="mipac.models.drive.Folder"><span class="pre">Folder</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.drive.folders.SharedFolderActions.gets" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get folders</p>
|
|
|
<p>Endpoint: <cite>/api/drive/folders</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>limit</strong> (<em>int</em>) – The limit of folders to get, defaults to 10</p></li>
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em> | </em><em>None</em>) – The ID of the folder to get since, defaults to None</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em> | </em><em>None</em>) – The ID of the folder to get until, defaults to None</p></li>
|
|
|
<li><p><strong>folder_id</strong> (<em>str</em><em> | </em><em>None</em>) – The ID of the folder to get, defaults to None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>The found folders</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.drive.Folder" title="mipac.models.drive.Folder">Folder</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.folders.SharedFolderActions.update">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">folder_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.drive.Folder" title="mipac.models.drive.Folder"><span class="pre">Folder</span></a></span></span><a class="headerlink" href="#mipac.actions.drive.folders.SharedFolderActions.update" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Update a folder</p>
|
|
|
<p>Endpoint: <cite>/api/drive/folders/update</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>name</strong> (<em>str</em><em>, </em><em>optional</em>) – The name of the folder, by default MISSING</p></li>
|
|
|
<li><p><strong>parent_id</strong> (<em>str</em><em>, </em><em>optional</em>) – The parent ID of the folder, by default MISSING</p></li>
|
|
|
<li><p><strong>folder_id</strong> (<em>str</em><em>, </em><em>optional</em>) – The ID of the folder, by default None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>The updated folder</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.drive.Folder" title="mipac.models.drive.Folder">Folder</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="driveactions">
|
|
|
<h3>DriveActions<a class="headerlink" href="#driveactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.drive.drive.DriveActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.drive.drive.DriveActions.get_status">get_status</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.drive.drive.DriveActions.stream">stream</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.drive.DriveActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.drive.drive.</span></span><span class="sig-name descname"><span class="pre">DriveActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.drive.drive.DriveActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.drive.DriveActions.get_status">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_status</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.drive.DriveStatus" title="mipac.models.drive.DriveStatus"><span class="pre">DriveStatus</span></a></span></span><a class="headerlink" href="#mipac.actions.drive.drive.DriveActions.get_status" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get the status of the drive</p>
|
|
|
<p>Endpoint: <cite>/api/drive</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>The status of the drive</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p><a class="reference internal" href="#mipac.models.drive.DriveStatus" title="mipac.models.drive.DriveStatus">DriveStatus</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.drive.DriveActions.stream">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">stream</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File"><span class="pre">File</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.drive.drive.DriveActions.stream" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Stream files from the drive</p>
|
|
|
<p>Endpoint: <cite>/api/drive/stream</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>limit</strong> (<em>int</em>) – The number of files to get</p></li>
|
|
|
<li><p><strong>since_id</strong> (<em>str</em>) – The id of the file to start from</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em>) – The id of the file to end at</p></li>
|
|
|
<li><p><strong>type</strong> (<em>str</em>) – The type of file to get</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>A list of files</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File">File</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="clientfileactions">
|
|
|
<h3>ClientFileActions<a class="headerlink" href="#clientfileactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.drive.files.ClientFileActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.drive.files.ClientFileActions.delete">delete</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.drive.files.ClientFileActions.get_attached_notes">get_attached_notes</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.drive.files.ClientFileActions.update">update</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.files.ClientFileActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.drive.files.</span></span><span class="sig-name descname"><span class="pre">ClientFileActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_ids</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.drive.files.ClientFileActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.files.ClientFileActions.delete">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.drive.files.ClientFileActions.delete" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>指定したファイルIDのファイルを削除します</p>
|
|
|
<p>Endpoint: <cite>/api/drive/files/delete</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>file_id</strong> (<em>str</em><em> | </em><em>None</em>) – 対象のファイルID, default=None</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>削除に成功したかどうか</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.files.ClientFileActions.get_attached_notes">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_attached_notes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.drive.files.ClientFileActions.get_attached_notes" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get the attached notes of a file</p>
|
|
|
<p>Endpoint: <cite>/api/drive/files/attached-notes</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em> | </em><em>None</em>) – The id of the note to start from, defaults to None</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em> | </em><em>None</em>) – The id of the note to end at, defaults to None</p></li>
|
|
|
<li><p><strong>limit</strong> (<em>int</em>) – The amount of notes to get, defaults to 10</p></li>
|
|
|
<li><p><strong>file_id</strong> (<em>str</em><em> | </em><em>None</em>) – The id of the file to get notes from, defaults to None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>The attached notes of the file</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.files.ClientFileActions.update">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">folder_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_sensitive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">comment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File"><span class="pre">File</span></a></span></span><a class="headerlink" href="#mipac.actions.drive.files.ClientFileActions.update" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>指定したIDのファイル情報を更新します</p>
|
|
|
<p>Endpoint: <cite>/api/drive/files/update</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>folder_id</strong> (<em>str</em><em> | </em><em>None</em>) – ファイルを置くフォルダID, default=MISSING</p></li>
|
|
|
<li><p><strong>name</strong> (<em>str</em><em> | </em><em>None</em>) – ファイル名, default=MISSING</p></li>
|
|
|
<li><p><strong>is_sensitive</strong> (<em>bool</em>) – ファイルがセンシティブかどうか, default=MISSING</p></li>
|
|
|
<li><p><strong>comment</strong> (<em>str</em><em> | </em><em>None</em>) – ファイルのコメント, default=MISSING</p></li>
|
|
|
<li><p><strong>file_id</strong> (<em>str</em><em> | </em><em>None</em>) – 対象のファイルID, default=None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>更新後のファイル</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File">File</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="fileactions">
|
|
|
<h3>FileActions<a class="headerlink" href="#fileactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.drive.files.FileActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.drive.files.FileActions.check_existence">check_existence</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.drive.files.FileActions.create">create</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.drive.files.FileActions.find">find</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.drive.files.FileActions.find_by_hash">find_by_hash</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.drive.files.FileActions.get_files">get_files</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.drive.files.FileActions.show">show</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.drive.files.FileActions.upload_from_url">upload_from_url</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.files.FileActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.drive.files.</span></span><span class="sig-name descname"><span class="pre">FileActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.drive.files.FileActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.files.FileActions.check_existence">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">check_existence</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">md5</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.drive.files.FileActions.check_existence" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>指定したmd5のファイルが既に存在するか確認します</p>
|
|
|
<p>Endpoint: <cite>/api/drive/files/check-existence</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>md5</strong> (<em>str</em>) – 確認したいmd5</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>存在するかしないか</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.files.FileActions.create">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">bytes</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">PathLike</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">BufferedIOBase</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">folder_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">comment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_sensitive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">force</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File"><span class="pre">File</span></a></span></span><a class="headerlink" href="#mipac.actions.drive.files.FileActions.create" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Upload a file to the drive</p>
|
|
|
<p>Endpoint: <cite>/api/drive/files/create</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>file</strong> (<em>str</em><em> | </em><em>bytes</em><em> | </em><em>os.PathLike</em><em>[</em><em>Any</em><em>] </em><em>| </em><em>io.BufferedIOBase</em>) – アップロードするファイル</p></li>
|
|
|
<li><p><strong>folder_id</strong> (<em>str</em><em> | </em><em>None</em>) – アップロード先のフォルダID, default=None</p></li>
|
|
|
<li><p><strong>name</strong> (<em>str</em><em> | </em><em>None</em>) – ファイルの名前, default=None</p></li>
|
|
|
<li><p><strong>comment</strong> (<em>str</em><em> | </em><em>None</em>) – ファイルのコメント, default=None</p></li>
|
|
|
<li><p><strong>is_sensitive</strong> (<em>bool</em>) – ファイルがセンシティブかどうか, default=False</p></li>
|
|
|
<li><p><strong>force</strong> (<em>bool</em>) – ファイルが既に存在する場合でも強制的にアップロードするかどうか, default=False</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>アップロードしたファイル</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File">File</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.files.FileActions.find">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">find</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">folder_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File"><span class="pre">File</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.drive.files.FileActions.find" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>指定した名前のファイルを検索します</p>
|
|
|
<p>Endpoint: <cite>/api/drive/files/find</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>name</strong> (<em>str</em>) – 検索したいファイルの名前</p></li>
|
|
|
<li><p><strong>folder_id</strong> (<em>str</em><em> | </em><em>None</em>) – ファイルを検索するフォルダID, default=None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>The found files</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File">File</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.files.FileActions.find_by_hash">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">find_by_hash</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">md5</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File"><span class="pre">File</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.drive.files.FileActions.find_by_hash" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>指定したハッシュのファイルを検索します</p>
|
|
|
<p>Endpoint: <cite>/api/drive/files/find-by-hash</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>md5</strong> (<em>str</em>) – 検索したいファイルのハッシュ</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>見つかったファイル</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File">File</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.files.FileActions.get_files">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_files</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">folder_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sort</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'+createdAt'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'-createdAt'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'+name'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'-name'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'+size'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'-size'</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File"><span class="pre">File</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.drive.files.FileActions.get_files" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get the files of the drive</p>
|
|
|
<p>Endpoint: <cite>/api/drive/files</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>limit</strong> (<em>int</em>) – The amount of files to get, defaults to 10</p></li>
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em> | </em><em>None</em>) – The id of the file to start from, defaults to None</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em> | </em><em>None</em>) – The id of the file to end at, defaults to None</p></li>
|
|
|
<li><p><strong>folder_id</strong> (<em>str</em><em> | </em><em>None</em>) – The id of the folder to get files from, defaults to None</p></li>
|
|
|
<li><p><strong>type</strong> (<em>str</em><em> | </em><em>None</em>) – The type of file to get, defaults to None</p></li>
|
|
|
<li><p><strong>sort</strong> (<em>IDriveSort</em><em> | </em><em>None</em>) – The way to sort the files, defaults to None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>The files of the drive</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File">File</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.files.FileActions.show">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">show</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File"><span class="pre">File</span></a></span></span><a class="headerlink" href="#mipac.actions.drive.files.FileActions.show" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>指定したIDのファイル情報を取得します</p>
|
|
|
<p>Endpoint: <cite>/api/drive/files/show</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>file_id</strong> (<em>str</em>) – 対象のファイルID</p></li>
|
|
|
<li><p><strong>url</strong> (<em>str</em><em> | </em><em>None</em>) – 取得したいファイルのURL, default=None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>取得したファイル</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File">File</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.files.FileActions.upload_from_url">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">upload_from_url</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">folder_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_sensitive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">comment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">marker</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">force</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.drive.files.FileActions.upload_from_url" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Upload a file to the drive from a url</p>
|
|
|
<p>Endpoint: <cite>/api/drive/files/upload-from-url</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>url</strong> (<em>str</em>) – アップロードするファイルのURL</p></li>
|
|
|
<li><p><strong>folder_id</strong> (<em>str</em><em> | </em><em>None</em>) – アップロード先のフォルダID, default=None</p></li>
|
|
|
<li><p><strong>is_sensitive</strong> (<em>bool</em>) – ファイルがセンシティブかどうか, default=False</p></li>
|
|
|
<li><p><strong>comment</strong> (<em>str</em><em> | </em><em>None</em>) – ファイルのコメント, default=None</p></li>
|
|
|
<li><p><strong>marker</strong> (<em>str</em><em> | </em><em>None</em>) – ストリーミング通信でアップロード完了後に区別するためのマーカー, default=None</p></li>
|
|
|
<li><p><strong>force</strong> (<em>bool</em>) – 同様のファイルが既に存在する場合でも強制的にアップロードするかどうか, default=False</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>アップロードのリクエストに成功したかどうか</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="sharedfileactions">
|
|
|
<h3>SharedFileActions<a class="headerlink" href="#sharedfileactions" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.actions.drive.files.SharedFileActions"><div class="py-attribute-table-column">
|
|
|
<span>
|
|
|
Methods</span><ul>
|
|
|
<li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.drive.files.SharedFileActions.delete">delete</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.drive.files.SharedFileActions.get_attached_notes">get_attached_notes</a></li><li class="py-attribute-table-entry">
|
|
|
<span class="py-attribute-table-badge" title="coroutine">
|
|
|
async</span><a class="reference internal" href="#mipac.actions.drive.files.SharedFileActions.update">update</a></li></ul>
|
|
|
</div></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.files.SharedFileActions">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.actions.drive.files.</span></span><span class="sig-name descname"><span class="pre">SharedFileActions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.actions.drive.files.SharedFileActions" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.files.SharedFileActions.delete">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.actions.drive.files.SharedFileActions.delete" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>指定したファイルIDのファイルを削除します</p>
|
|
|
<p>Endpoint: <cite>/api/drive/files/delete</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>file_id</strong> (<em>str</em><em> | </em><em>None</em>) – 対象のファイルID, default=None</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>削除に成功したかどうか</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.files.SharedFileActions.get_attached_notes">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_attached_notes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">since_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">until_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note"><span class="pre">Note</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.actions.drive.files.SharedFileActions.get_attached_notes" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Get the attached notes of a file</p>
|
|
|
<p>Endpoint: <cite>/api/drive/files/attached-notes</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>since_id</strong> (<em>str</em><em> | </em><em>None</em>) – The id of the note to start from, defaults to None</p></li>
|
|
|
<li><p><strong>until_id</strong> (<em>str</em><em> | </em><em>None</em>) – The id of the note to end at, defaults to None</p></li>
|
|
|
<li><p><strong>limit</strong> (<em>int</em>) – The amount of notes to get, defaults to 10</p></li>
|
|
|
<li><p><strong>file_id</strong> (<em>str</em><em> | </em><em>None</em>) – The id of the file to get notes from, defaults to None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>The attached notes of the file</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>list[<a class="reference internal" href="#mipac.models.note.Note" title="mipac.models.note.Note">Note</a>]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
<dl class="py method">
|
|
|
<dt class="sig sig-object py" id="mipac.actions.drive.files.SharedFileActions.update">
|
|
|
<em class="property"><span class="pre">async</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">update</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">folder_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_sensitive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">comment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">MISSING</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File"><span class="pre">File</span></a></span></span><a class="headerlink" href="#mipac.actions.drive.files.SharedFileActions.update" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>指定したIDのファイル情報を更新します</p>
|
|
|
<p>Endpoint: <cite>/api/drive/files/update</cite></p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>folder_id</strong> (<em>str</em><em> | </em><em>None</em>) – ファイルを置くフォルダID, default=MISSING</p></li>
|
|
|
<li><p><strong>name</strong> (<em>str</em><em> | </em><em>None</em>) – ファイル名, default=MISSING</p></li>
|
|
|
<li><p><strong>is_sensitive</strong> (<em>bool</em>) – ファイルがセンシティブかどうか, default=MISSING</p></li>
|
|
|
<li><p><strong>comment</strong> (<em>str</em><em> | </em><em>None</em>) – ファイルのコメント, default=MISSING</p></li>
|
|
|
<li><p><strong>file_id</strong> (<em>str</em><em> | </em><em>None</em>) – 対象のファイルID, default=None</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>更新後のファイル</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><a class="reference internal" href="#mipac.models.drive.File" title="mipac.models.drive.File">File</a></p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
</section>
|
|
|
<section id="type-class">
|
|
|
<h2>Type class<a class="headerlink" href="#type-class" title="Link to this heading">#</a></h2>
|
|
|
<section id="iblocking">
|
|
|
<h3>IBlocking<a class="headerlink" href="#iblocking" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.blocking.IBlocking"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.blocking.IBlocking">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.blocking.</span></span><span class="sig-name descname"><span class="pre">IBlocking</span></span><a class="headerlink" href="#mipac.types.blocking.IBlocking" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="iinvitecode">
|
|
|
<h3>IInviteCode<a class="headerlink" href="#iinvitecode" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.invite.IInviteCode"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.invite.IInviteCode">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.invite.</span></span><span class="sig-name descname"><span class="pre">IInviteCode</span></span><a class="headerlink" href="#mipac.types.invite.IInviteCode" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="iinvitelimit">
|
|
|
<h3>IInviteLimit<a class="headerlink" href="#iinvitelimit" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.invite.IInviteLimit"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.invite.IInviteLimit">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.invite.</span></span><span class="sig-name descname"><span class="pre">IInviteLimit</span></span><a class="headerlink" href="#mipac.types.invite.IInviteLimit" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="igallerypost">
|
|
|
<h3>IGalleryPost<a class="headerlink" href="#igallerypost" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.gallery.IGalleryPost"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.gallery.IGalleryPost">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.gallery.</span></span><span class="sig-name descname"><span class="pre">IGalleryPost</span></span><a class="headerlink" href="#mipac.types.gallery.IGalleryPost" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="imuteduser">
|
|
|
<h3>IMutedUser<a class="headerlink" href="#imuteduser" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.mute.IMutedUser"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.mute.IMutedUser">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.mute.</span></span><span class="sig-name descname"><span class="pre">IMutedUser</span></span><a class="headerlink" href="#mipac.types.mute.IMutedUser" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="ifederationfollowcommon">
|
|
|
<h3>IFederationFollowCommon<a class="headerlink" href="#ifederationfollowcommon" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.follow.IFederationFollowCommon"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.follow.IFederationFollowCommon">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.follow.</span></span><span class="sig-name descname"><span class="pre">IFederationFollowCommon</span></span><a class="headerlink" href="#mipac.types.follow.IFederationFollowCommon" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="ifederationfollower">
|
|
|
<h3>IFederationFollower<a class="headerlink" href="#ifederationfollower" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.follow.IFederationFollower"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.follow.IFederationFollower">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.follow.</span></span><span class="sig-name descname"><span class="pre">IFederationFollower</span></span><a class="headerlink" href="#mipac.types.follow.IFederationFollower" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="ifederationfollowing">
|
|
|
<h3>IFederationFollowing<a class="headerlink" href="#ifederationfollowing" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.follow.IFederationFollowing"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.follow.IFederationFollowing">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.follow.</span></span><span class="sig-name descname"><span class="pre">IFederationFollowing</span></span><a class="headerlink" href="#mipac.types.follow.IFederationFollowing" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="ifollowrequest">
|
|
|
<h3>IFollowRequest<a class="headerlink" href="#ifollowrequest" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.follow.IFollowRequest"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.follow.IFollowRequest">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.follow.</span></span><span class="sig-name descname"><span class="pre">IFollowRequest</span></span><a class="headerlink" href="#mipac.types.follow.IFollowRequest" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="iannouncement">
|
|
|
<h3>IAnnouncement<a class="headerlink" href="#iannouncement" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.announcement.IAnnouncement"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.announcement.IAnnouncement">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.announcement.</span></span><span class="sig-name descname"><span class="pre">IAnnouncement</span></span><a class="headerlink" href="#mipac.types.announcement.IAnnouncement" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="iannouncementdetailed">
|
|
|
<h3>IAnnouncementDetailed<a class="headerlink" href="#iannouncementdetailed" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.announcement.IAnnouncementDetailed"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.announcement.IAnnouncementDetailed">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.announcement.</span></span><span class="sig-name descname"><span class="pre">IAnnouncementDetailed</span></span><a class="headerlink" href="#mipac.types.announcement.IAnnouncementDetailed" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>管理者から見たアナウンス</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="icreatednote">
|
|
|
<h3>ICreatedNote<a class="headerlink" href="#icreatednote" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.note.ICreatedNote"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.note.ICreatedNote">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.note.</span></span><span class="sig-name descname"><span class="pre">ICreatedNote</span></span><a class="headerlink" href="#mipac.types.note.ICreatedNote" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>created note</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="inote">
|
|
|
<h3>INote<a class="headerlink" href="#inote" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.note.INote"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.note.INote">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.note.</span></span><span class="sig-name descname"><span class="pre">INote</span></span><a class="headerlink" href="#mipac.types.note.INote" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Misskey Raw Model: Note</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="inotechannel">
|
|
|
<h3>INoteChannel<a class="headerlink" href="#inotechannel" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.note.INoteChannel"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.note.INoteChannel">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.note.</span></span><span class="sig-name descname"><span class="pre">INoteChannel</span></span><a class="headerlink" href="#mipac.types.note.INoteChannel" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>ノート内にあるチャンネルの情報</p>
|
|
|
<p>ログインしていてもis_following等は存在しない</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="inotereaction">
|
|
|
<h3>INoteReaction<a class="headerlink" href="#inotereaction" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.note.INoteReaction"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.note.INoteReaction">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.note.</span></span><span class="sig-name descname"><span class="pre">INoteReaction</span></span><a class="headerlink" href="#mipac.types.note.INoteReaction" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="inotestate">
|
|
|
<h3>INoteState<a class="headerlink" href="#inotestate" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.note.INoteState"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.note.INoteState">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.note.</span></span><span class="sig-name descname"><span class="pre">INoteState</span></span><a class="headerlink" href="#mipac.types.note.INoteState" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="inotetranslateresult">
|
|
|
<h3>INoteTranslateResult<a class="headerlink" href="#inotetranslateresult" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.note.INoteTranslateResult"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.note.INoteTranslateResult">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.note.</span></span><span class="sig-name descname"><span class="pre">INoteTranslateResult</span></span><a class="headerlink" href="#mipac.types.note.INoteTranslateResult" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="inoteupdated">
|
|
|
<h3>INoteUpdated<a class="headerlink" href="#inoteupdated" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.note.INoteUpdated"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.note.INoteUpdated">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.note.</span></span><span class="sig-name descname"><span class="pre">INoteUpdated</span></span><a class="headerlink" href="#mipac.types.note.INoteUpdated" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="inoteupdateddelete">
|
|
|
<h3>INoteUpdatedDelete<a class="headerlink" href="#inoteupdateddelete" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.note.INoteUpdatedDelete"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.note.INoteUpdatedDelete">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.note.</span></span><span class="sig-name descname"><span class="pre">INoteUpdatedDelete</span></span><a class="headerlink" href="#mipac.types.note.INoteUpdatedDelete" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="inoteupdateddeletebody">
|
|
|
<h3>INoteUpdatedDeleteBody<a class="headerlink" href="#inoteupdateddeletebody" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.note.INoteUpdatedDeleteBody"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.note.INoteUpdatedDeleteBody">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.note.</span></span><span class="sig-name descname"><span class="pre">INoteUpdatedDeleteBody</span></span><a class="headerlink" href="#mipac.types.note.INoteUpdatedDeleteBody" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="inoteupdatedreaction">
|
|
|
<h3>INoteUpdatedReaction<a class="headerlink" href="#inoteupdatedreaction" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.note.INoteUpdatedReaction"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.note.INoteUpdatedReaction">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.note.</span></span><span class="sig-name descname"><span class="pre">INoteUpdatedReaction</span></span><a class="headerlink" href="#mipac.types.note.INoteUpdatedReaction" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="inoteupdatedreactionbody">
|
|
|
<h3>INoteUpdatedReactionBody<a class="headerlink" href="#inoteupdatedreactionbody" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.note.INoteUpdatedReactionBody"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.note.INoteUpdatedReactionBody">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.note.</span></span><span class="sig-name descname"><span class="pre">INoteUpdatedReactionBody</span></span><a class="headerlink" href="#mipac.types.note.INoteUpdatedReactionBody" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="iachievementnf">
|
|
|
<h3>IAchievementNf<a class="headerlink" href="#iachievementnf" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.notification.IAchievementNf"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.notification.IAchievementNf">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.notification.</span></span><span class="sig-name descname"><span class="pre">IAchievementNf</span></span><a class="headerlink" href="#mipac.types.notification.IAchievementNf" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="inotenf">
|
|
|
<h3>INoteNf<a class="headerlink" href="#inotenf" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.notification.INoteNf"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.notification.INoteNf">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.notification.</span></span><span class="sig-name descname"><span class="pre">INoteNf</span></span><a class="headerlink" href="#mipac.types.notification.INoteNf" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="inotification">
|
|
|
<h3>INotification<a class="headerlink" href="#inotification" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.notification.INotification"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.notification.INotification">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.notification.</span></span><span class="sig-name descname"><span class="pre">INotification</span></span><a class="headerlink" href="#mipac.types.notification.INotification" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="ipollendnf">
|
|
|
<h3>IPollEndNf<a class="headerlink" href="#ipollendnf" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.notification.IPollEndNf"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.notification.IPollEndNf">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.notification.</span></span><span class="sig-name descname"><span class="pre">IPollEndNf</span></span><a class="headerlink" href="#mipac.types.notification.IPollEndNf" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="ireactionnf">
|
|
|
<h3>IReactionNf<a class="headerlink" href="#ireactionnf" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.notification.IReactionNf"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.notification.IReactionNf">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.notification.</span></span><span class="sig-name descname"><span class="pre">IReactionNf</span></span><a class="headerlink" href="#mipac.types.notification.IReactionNf" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="iusernf">
|
|
|
<h3>IUserNf<a class="headerlink" href="#iusernf" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.notification.IUserNf"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.notification.IUserNf">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.notification.</span></span><span class="sig-name descname"><span class="pre">IUserNf</span></span><a class="headerlink" href="#mipac.types.notification.IUserNf" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="emojipayload">
|
|
|
<h3>EmojiPayload<a class="headerlink" href="#emojipayload" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.emoji.EmojiPayload"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.emoji.EmojiPayload">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.emoji.</span></span><span class="sig-name descname"><span class="pre">EmojiPayload</span></span><a class="headerlink" href="#mipac.types.emoji.EmojiPayload" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="icustomemoji">
|
|
|
<h3>ICustomEmoji<a class="headerlink" href="#icustomemoji" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.emoji.ICustomEmoji"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.emoji.ICustomEmoji">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.emoji.</span></span><span class="sig-name descname"><span class="pre">ICustomEmoji</span></span><a class="headerlink" href="#mipac.types.emoji.ICustomEmoji" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="icustomemojilite">
|
|
|
<h3>ICustomEmojiLite<a class="headerlink" href="#icustomemojilite" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.emoji.ICustomEmojiLite"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.emoji.ICustomEmojiLite">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.emoji.</span></span><span class="sig-name descname"><span class="pre">ICustomEmojiLite</span></span><a class="headerlink" href="#mipac.types.emoji.ICustomEmojiLite" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="icustomemojiliterequired">
|
|
|
<h3>ICustomEmojiLiteRequired<a class="headerlink" href="#icustomemojiliterequired" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.emoji.ICustomEmojiLiteRequired"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.emoji.ICustomEmojiLiteRequired">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.emoji.</span></span><span class="sig-name descname"><span class="pre">ICustomEmojiLiteRequired</span></span><a class="headerlink" href="#mipac.types.emoji.ICustomEmojiLiteRequired" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="iemojidetailed">
|
|
|
<h3>IEmojiDetailed<a class="headerlink" href="#iemojidetailed" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.emoji.IEmojiDetailed"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.emoji.IEmojiDetailed">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.emoji.</span></span><span class="sig-name descname"><span class="pre">IEmojiDetailed</span></span><a class="headerlink" href="#mipac.types.emoji.IEmojiDetailed" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="iemojisimple">
|
|
|
<h3>IEmojiSimple<a class="headerlink" href="#iemojisimple" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.emoji.IEmojiSimple"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.emoji.IEmojiSimple">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.emoji.</span></span><span class="sig-name descname"><span class="pre">IEmojiSimple</span></span><a class="headerlink" href="#mipac.types.emoji.IEmojiSimple" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="iclip">
|
|
|
<h3>IClip<a class="headerlink" href="#iclip" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.clip.IClip"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.clip.IClip">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.clip.</span></span><span class="sig-name descname"><span class="pre">IClip</span></span><a class="headerlink" href="#mipac.types.clip.IClip" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="notereactionpayload">
|
|
|
<h3>NoteReactionPayload<a class="headerlink" href="#notereactionpayload" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.reaction.NoteReactionPayload"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.reaction.NoteReactionPayload">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.reaction.</span></span><span class="sig-name descname"><span class="pre">NoteReactionPayload</span></span><a class="headerlink" href="#mipac.types.reaction.NoteReactionPayload" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="ichannel">
|
|
|
<h3>IChannel<a class="headerlink" href="#ichannel" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.channel.IChannel"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.channel.IChannel">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.channel.</span></span><span class="sig-name descname"><span class="pre">IChannel</span></span><a class="headerlink" href="#mipac.types.channel.IChannel" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="iindexstat">
|
|
|
<h3>IIndexStat<a class="headerlink" href="#iindexstat" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.admin.IIndexStat"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.admin.IIndexStat">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.admin.</span></span><span class="sig-name descname"><span class="pre">IIndexStat</span></span><a class="headerlink" href="#mipac.types.admin.IIndexStat" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="imoderationlog">
|
|
|
<h3>IModerationLog<a class="headerlink" href="#imoderationlog" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.admin.IModerationLog"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.admin.IModerationLog">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.admin.</span></span><span class="sig-name descname"><span class="pre">IModerationLog</span></span><a class="headerlink" href="#mipac.types.admin.IModerationLog" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="iserverinfo">
|
|
|
<h3>IServerInfo<a class="headerlink" href="#iserverinfo" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.admin.IServerInfo"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.admin.IServerInfo">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.admin.</span></span><span class="sig-name descname"><span class="pre">IServerInfo</span></span><a class="headerlink" href="#mipac.types.admin.IServerInfo" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="iserverinfocpu">
|
|
|
<h3>IServerInfoCpu<a class="headerlink" href="#iserverinfocpu" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.admin.IServerInfoCpu"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.admin.IServerInfoCpu">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.admin.</span></span><span class="sig-name descname"><span class="pre">IServerInfoCpu</span></span><a class="headerlink" href="#mipac.types.admin.IServerInfoCpu" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="iserverinfofs">
|
|
|
<h3>IServerInfoFs<a class="headerlink" href="#iserverinfofs" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.admin.IServerInfoFs"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.admin.IServerInfoFs">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.admin.</span></span><span class="sig-name descname"><span class="pre">IServerInfoFs</span></span><a class="headerlink" href="#mipac.types.admin.IServerInfoFs" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="iserverinfomem">
|
|
|
<h3>IServerInfoMem<a class="headerlink" href="#iserverinfomem" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.admin.IServerInfoMem"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.admin.IServerInfoMem">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.admin.</span></span><span class="sig-name descname"><span class="pre">IServerInfoMem</span></span><a class="headerlink" href="#mipac.types.admin.IServerInfoMem" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="iserverinfonet">
|
|
|
<h3>IServerInfoNet<a class="headerlink" href="#iserverinfonet" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.admin.IServerInfoNet"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.admin.IServerInfoNet">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.admin.</span></span><span class="sig-name descname"><span class="pre">IServerInfoNet</span></span><a class="headerlink" href="#mipac.types.admin.IServerInfoNet" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="itablestats">
|
|
|
<h3>ITableStats<a class="headerlink" href="#itablestats" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.admin.ITableStats"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.admin.ITableStats">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.admin.</span></span><span class="sig-name descname"><span class="pre">ITableStats</span></span><a class="headerlink" href="#mipac.types.admin.ITableStats" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="iuserip">
|
|
|
<h3>IUserIP<a class="headerlink" href="#iuserip" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.admin.IUserIP"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.admin.IUserIP">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.admin.</span></span><span class="sig-name descname"><span class="pre">IUserIP</span></span><a class="headerlink" href="#mipac.types.admin.IUserIP" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="iusernameavailable">
|
|
|
<h3>IUsernameAvailable<a class="headerlink" href="#iusernameavailable" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.username.IUsernameAvailable"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.username.IUsernameAvailable">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.username.</span></span><span class="sig-name descname"><span class="pre">IUsernameAvailable</span></span><a class="headerlink" href="#mipac.types.username.IUsernameAvailable" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="iactiveuserschart">
|
|
|
<h3>IActiveUsersChart<a class="headerlink" href="#iactiveuserschart" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.chart.IActiveUsersChart"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.chart.IActiveUsersChart">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.chart.</span></span><span class="sig-name descname"><span class="pre">IActiveUsersChart</span></span><a class="headerlink" href="#mipac.types.chart.IActiveUsersChart" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="idrivechart">
|
|
|
<h3>IDriveChart<a class="headerlink" href="#idrivechart" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.chart.IDriveChart"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.chart.IDriveChart">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.chart.</span></span><span class="sig-name descname"><span class="pre">IDriveChart</span></span><a class="headerlink" href="#mipac.types.chart.IDriveChart" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="idrivelocalchart">
|
|
|
<h3>IDriveLocalChart<a class="headerlink" href="#idrivelocalchart" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.chart.IDriveLocalChart"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.chart.IDriveLocalChart">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.chart.</span></span><span class="sig-name descname"><span class="pre">IDriveLocalChart</span></span><a class="headerlink" href="#mipac.types.chart.IDriveLocalChart" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="idriveremotechart">
|
|
|
<h3>IDriveRemoteChart<a class="headerlink" href="#idriveremotechart" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.chart.IDriveRemoteChart"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.chart.IDriveRemoteChart">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.chart.</span></span><span class="sig-name descname"><span class="pre">IDriveRemoteChart</span></span><a class="headerlink" href="#mipac.types.chart.IDriveRemoteChart" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="idrivestatus">
|
|
|
<h3>IDriveStatus<a class="headerlink" href="#idrivestatus" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.drive.IDriveStatus"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.drive.IDriveStatus">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.drive.</span></span><span class="sig-name descname"><span class="pre">IDriveStatus</span></span><a class="headerlink" href="#mipac.types.drive.IDriveStatus" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="ifile">
|
|
|
<h3>IFile<a class="headerlink" href="#ifile" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.drive.IFile"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.drive.IFile">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.drive.</span></span><span class="sig-name descname"><span class="pre">IFile</span></span><a class="headerlink" href="#mipac.types.drive.IFile" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>ファイル情報</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="ifileproperties">
|
|
|
<h3>IFileProperties<a class="headerlink" href="#ifileproperties" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.drive.IFileProperties"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.drive.IFileProperties">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.drive.</span></span><span class="sig-name descname"><span class="pre">IFileProperties</span></span><a class="headerlink" href="#mipac.types.drive.IFileProperties" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>プロパティー情報</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="ifolder">
|
|
|
<h3>IFolder<a class="headerlink" href="#ifolder" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.drive.IFolder"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.drive.IFolder">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.drive.</span></span><span class="sig-name descname"><span class="pre">IFolder</span></span><a class="headerlink" href="#mipac.types.drive.IFolder" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>フォルダーの情報</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="iantenna">
|
|
|
<h3>IAntenna<a class="headerlink" href="#iantenna" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.antenna.IAntenna"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.antenna.IAntenna">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.antenna.</span></span><span class="sig-name descname"><span class="pre">IAntenna</span></span><a class="headerlink" href="#mipac.types.antenna.IAntenna" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="ifederationinstance">
|
|
|
<h3>IFederationInstance<a class="headerlink" href="#ifederationinstance" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.instance.IFederationInstance"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.instance.IFederationInstance">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.instance.</span></span><span class="sig-name descname"><span class="pre">IFederationInstance</span></span><a class="headerlink" href="#mipac.types.instance.IFederationInstance" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="ifederationinstancerequired">
|
|
|
<h3>IFederationInstanceRequired<a class="headerlink" href="#ifederationinstancerequired" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.instance.IFederationInstanceRequired"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.instance.IFederationInstanceRequired">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.instance.</span></span><span class="sig-name descname"><span class="pre">IFederationInstanceRequired</span></span><a class="headerlink" href="#mipac.types.instance.IFederationInstanceRequired" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="ifederationinstancestat">
|
|
|
<h3>IFederationInstanceStat<a class="headerlink" href="#ifederationinstancestat" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.instance.IFederationInstanceStat"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.instance.IFederationInstanceStat">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.instance.</span></span><span class="sig-name descname"><span class="pre">IFederationInstanceStat</span></span><a class="headerlink" href="#mipac.types.instance.IFederationInstanceStat" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="iinstancelite">
|
|
|
<h3>IInstanceLite<a class="headerlink" href="#iinstancelite" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.instance.IInstanceLite"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.instance.IInstanceLite">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.instance.</span></span><span class="sig-name descname"><span class="pre">IInstanceLite</span></span><a class="headerlink" href="#mipac.types.instance.IInstanceLite" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="attachedfilepayload">
|
|
|
<h3>AttachedFilePayload<a class="headerlink" href="#attachedfilepayload" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.page.AttachedFilePayload"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.page.AttachedFilePayload">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.page.</span></span><span class="sig-name descname"><span class="pre">AttachedFilePayload</span></span><a class="headerlink" href="#mipac.types.page.AttachedFilePayload" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="eyecatchingimagepayload">
|
|
|
<h3>EyeCatchingImagePayload<a class="headerlink" href="#eyecatchingimagepayload" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.page.EyeCatchingImagePayload"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.page.EyeCatchingImagePayload">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.page.</span></span><span class="sig-name descname"><span class="pre">EyeCatchingImagePayload</span></span><a class="headerlink" href="#mipac.types.page.EyeCatchingImagePayload" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="ipage">
|
|
|
<h3>IPage<a class="headerlink" href="#ipage" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.page.IPage"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.page.IPage">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.page.</span></span><span class="sig-name descname"><span class="pre">IPage</span></span><a class="headerlink" href="#mipac.types.page.IPage" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="ipagerequired">
|
|
|
<h3>IPageRequired<a class="headerlink" href="#ipagerequired" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.page.IPageRequired"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.page.IPageRequired">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.page.</span></span><span class="sig-name descname"><span class="pre">IPageRequired</span></span><a class="headerlink" href="#mipac.types.page.IPageRequired" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="pagecontentpayload">
|
|
|
<h3>PageContentPayload<a class="headerlink" href="#pagecontentpayload" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.page.PageContentPayload"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.page.PageContentPayload">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.page.</span></span><span class="sig-name descname"><span class="pre">PageContentPayload</span></span><a class="headerlink" href="#mipac.types.page.PageContentPayload" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="pagefilepayload">
|
|
|
<h3>PageFilePayload<a class="headerlink" href="#pagefilepayload" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.page.PageFilePayload"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.page.PageFilePayload">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.page.</span></span><span class="sig-name descname"><span class="pre">PageFilePayload</span></span><a class="headerlink" href="#mipac.types.page.PageFilePayload" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="pagepayload">
|
|
|
<h3>PagePayload<a class="headerlink" href="#pagepayload" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.page.PagePayload"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.page.PagePayload">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.page.</span></span><span class="sig-name descname"><span class="pre">PagePayload</span></span><a class="headerlink" href="#mipac.types.page.PagePayload" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="variablepayload">
|
|
|
<h3>VariablePayload<a class="headerlink" href="#variablepayload" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.page.VariablePayload"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.page.VariablePayload">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.page.</span></span><span class="sig-name descname"><span class="pre">VariablePayload</span></span><a class="headerlink" href="#mipac.types.page.VariablePayload" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="icreatepoll">
|
|
|
<h3>ICreatePoll<a class="headerlink" href="#icreatepoll" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.poll.ICreatePoll"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.poll.ICreatePoll">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.poll.</span></span><span class="sig-name descname"><span class="pre">ICreatePoll</span></span><a class="headerlink" href="#mipac.types.poll.ICreatePoll" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="ipoll">
|
|
|
<h3>IPoll<a class="headerlink" href="#ipoll" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.poll.IPoll"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.poll.IPoll">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.poll.</span></span><span class="sig-name descname"><span class="pre">IPoll</span></span><a class="headerlink" href="#mipac.types.poll.IPoll" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Questionnaire object</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="ipollchoice">
|
|
|
<h3>IPollChoice<a class="headerlink" href="#ipollchoice" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.poll.IPollChoice"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.poll.IPollChoice">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.poll.</span></span><span class="sig-name descname"><span class="pre">IPollChoice</span></span><a class="headerlink" href="#mipac.types.poll.IPollChoice" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="iad">
|
|
|
<h3>IAd<a class="headerlink" href="#iad" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.ads.IAd"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.ads.IAd">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.ads.</span></span><span class="sig-name descname"><span class="pre">IAd</span></span><a class="headerlink" href="#mipac.types.ads.IAd" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="ipartialad">
|
|
|
<h3>IPartialAd<a class="headerlink" href="#ipartialad" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.ads.IPartialAd"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.ads.IPartialAd">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.ads.</span></span><span class="sig-name descname"><span class="pre">IPartialAd</span></span><a class="headerlink" href="#mipac.types.ads.IPartialAd" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="is-me-role">
|
|
|
<h3>is_me_role<a class="headerlink" href="#is-me-role" title="Link to this heading">#</a></h3>
|
|
|
<dl class="py function">
|
|
|
<dt class="sig sig-object py" id="mipac.types.roles.is_me_role">
|
|
|
<span class="sig-prename descclassname"><span class="pre">mipac.types.roles.</span></span><span class="sig-name descname"><span class="pre">is_me_role</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.roles.IMeRole" title="mipac.types.roles.IMeRole"><span class="pre">IMeRole</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#mipac.types.roles.IRoleUser" title="mipac.types.roles.IRoleUser"><span class="pre">IRoleUser</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">me_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">TypeGuard</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.types.roles.IMeRole" title="mipac.types.roles.IMeRole"><span class="pre">IMeRole</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.types.roles.is_me_role" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="imerole">
|
|
|
<h3>IMeRole<a class="headerlink" href="#imerole" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.roles.IMeRole"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.roles.IMeRole">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.roles.</span></span><span class="sig-name descname"><span class="pre">IMeRole</span></span><a class="headerlink" href="#mipac.types.roles.IMeRole" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="ipartialrole">
|
|
|
<h3>IPartialRole<a class="headerlink" href="#ipartialrole" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.roles.IPartialRole"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.roles.IPartialRole">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.roles.</span></span><span class="sig-name descname"><span class="pre">IPartialRole</span></span><a class="headerlink" href="#mipac.types.roles.IPartialRole" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="irole">
|
|
|
<h3>IRole<a class="headerlink" href="#irole" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.roles.IRole"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.roles.IRole">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.roles.</span></span><span class="sig-name descname"><span class="pre">IRole</span></span><a class="headerlink" href="#mipac.types.roles.IRole" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="irolepolicies">
|
|
|
<h3>IRolePolicies<a class="headerlink" href="#irolepolicies" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.roles.IRolePolicies"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.roles.IRolePolicies">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.roles.</span></span><span class="sig-name descname"><span class="pre">IRolePolicies</span></span><a class="headerlink" href="#mipac.types.roles.IRolePolicies" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="iroleuser">
|
|
|
<h3>IRoleUser<a class="headerlink" href="#iroleuser" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.roles.IRoleUser"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.roles.IRoleUser">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.roles.</span></span><span class="sig-name descname"><span class="pre">IRoleUser</span></span><a class="headerlink" href="#mipac.types.roles.IRoleUser" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="is-me-detailed">
|
|
|
<h3>is_me_detailed<a class="headerlink" href="#is-me-detailed" title="Link to this heading">#</a></h3>
|
|
|
<dl class="py function">
|
|
|
<dt class="sig sig-object py" id="mipac.types.user.is_me_detailed">
|
|
|
<span class="sig-prename descclassname"><span class="pre">mipac.types.user.</span></span><span class="sig-name descname"><span class="pre">is_me_detailed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.user.IPartialUser" title="mipac.types.user.IPartialUser"><span class="pre">IPartialUser</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#mipac.types.user.IUserDetailedNotMeSchema" title="mipac.types.user.IUserDetailedNotMeSchema"><span class="pre">IUserDetailedNotMeSchema</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#mipac.types.user.IMeDetailedSchema" title="mipac.types.user.IMeDetailedSchema"><span class="pre">IMeDetailedSchema</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">TypeGuard</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.types.user.IMeDetailedSchema" title="mipac.types.user.IMeDetailedSchema"><span class="pre">IMeDetailedSchema</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.types.user.is_me_detailed" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>IMeDetailedOnlySchemaで avatar_id
|
|
|
IUserDetailedNotMeOnlySchemaで url
|
|
|
を持っているのでどちらともを満たしたものがIMeDetailedSchema</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="is-partial-user">
|
|
|
<h3>is_partial_user<a class="headerlink" href="#is-partial-user" title="Link to this heading">#</a></h3>
|
|
|
<dl class="py function">
|
|
|
<dt class="sig sig-object py" id="mipac.types.user.is_partial_user">
|
|
|
<span class="sig-prename descclassname"><span class="pre">mipac.types.user.</span></span><span class="sig-name descname"><span class="pre">is_partial_user</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.user.IPartialUser" title="mipac.types.user.IPartialUser"><span class="pre">IPartialUser</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#mipac.types.user.IUserDetailedNotMeSchema" title="mipac.types.user.IUserDetailedNotMeSchema"><span class="pre">IUserDetailedNotMeSchema</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#mipac.types.user.IMeDetailedSchema" title="mipac.types.user.IMeDetailedSchema"><span class="pre">IMeDetailedSchema</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">TypeGuard</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.types.user.IPartialUser" title="mipac.types.user.IPartialUser"><span class="pre">IPartialUser</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.types.user.is_partial_user" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>他のUser型は全て IUserDetailedNotMeSchema 経由で IUserDetailedNotMeOnlySchema を継承しているため
|
|
|
url が無いことを確認し区別する
|
|
|
念のために avatar_url があることも確認する</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="is-user-detailed">
|
|
|
<h3>is_user_detailed<a class="headerlink" href="#is-user-detailed" title="Link to this heading">#</a></h3>
|
|
|
<dl class="py function">
|
|
|
<dt class="sig sig-object py" id="mipac.types.user.is_user_detailed">
|
|
|
<span class="sig-prename descclassname"><span class="pre">mipac.types.user.</span></span><span class="sig-name descname"><span class="pre">is_user_detailed</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.user.IPartialUser" title="mipac.types.user.IPartialUser"><span class="pre">IPartialUser</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#mipac.types.user.IUserDetailedNotMeSchema" title="mipac.types.user.IUserDetailedNotMeSchema"><span class="pre">IUserDetailedNotMeSchema</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#mipac.types.user.IMeDetailedSchema" title="mipac.types.user.IMeDetailedSchema"><span class="pre">IMeDetailedSchema</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">TypeGuard</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.types.user.IUserDetailedNotMeSchema" title="mipac.types.user.IUserDetailedNotMeSchema"><span class="pre">IUserDetailedNotMeSchema</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#mipac.types.user.IMeDetailedSchema" title="mipac.types.user.IMeDetailedSchema"><span class="pre">IMeDetailedSchema</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.types.user.is_user_detailed" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="is-user-detailed-not-me">
|
|
|
<h3>is_user_detailed_not_me<a class="headerlink" href="#is-user-detailed-not-me" title="Link to this heading">#</a></h3>
|
|
|
<dl class="py function">
|
|
|
<dt class="sig sig-object py" id="mipac.types.user.is_user_detailed_not_me">
|
|
|
<span class="sig-prename descclassname"><span class="pre">mipac.types.user.</span></span><span class="sig-name descname"><span class="pre">is_user_detailed_not_me</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.types.user.IPartialUser" title="mipac.types.user.IPartialUser"><span class="pre">IPartialUser</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#mipac.types.user.IUserDetailedNotMeSchema" title="mipac.types.user.IUserDetailedNotMeSchema"><span class="pre">IUserDetailedNotMeSchema</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="#mipac.types.user.IMeDetailedSchema" title="mipac.types.user.IMeDetailedSchema"><span class="pre">IMeDetailedSchema</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">TypeGuard</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#mipac.types.user.IUserDetailedNotMeSchema" title="mipac.types.user.IUserDetailedNotMeSchema"><span class="pre">IUserDetailedNotMeSchema</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.types.user.is_user_detailed_not_me" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>IUserDetailedNotMeSchemaが持つ url が有ることを確認し
|
|
|
IMeDetailedOnlySchema が持つ avatar_id が無いことを確認する
|
|
|
こうすることで IMeDetailedSchema と区別する</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="getfrequentlyrepliedusersresponse">
|
|
|
<h3>GetFrequentlyRepliedUsersResponse<a class="headerlink" href="#getfrequentlyrepliedusersresponse" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.user.GetFrequentlyRepliedUsersResponse"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.user.GetFrequentlyRepliedUsersResponse">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.user.</span></span><span class="sig-name descname"><span class="pre">GetFrequentlyRepliedUsersResponse</span></span><a class="headerlink" href="#mipac.types.user.GetFrequentlyRepliedUsersResponse" title="Link to this definition">#</a></dt>
|
|
|
<dd><p><cite>users/get-frequently-replied-users</cite> のレスポンス</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="iachievement">
|
|
|
<h3>IAchievement<a class="headerlink" href="#iachievement" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.user.IAchievement"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.user.IAchievement">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.user.</span></span><span class="sig-name descname"><span class="pre">IAchievement</span></span><a class="headerlink" href="#mipac.types.user.IAchievement" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="iavatardecoration">
|
|
|
<h3>IAvatarDecoration<a class="headerlink" href="#iavatardecoration" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.user.IAvatarDecoration"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.user.IAvatarDecoration">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.user.</span></span><span class="sig-name descname"><span class="pre">IAvatarDecoration</span></span><a class="headerlink" href="#mipac.types.user.IAvatarDecoration" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="ibadgerole">
|
|
|
<h3>IBadgeRole<a class="headerlink" href="#ibadgerole" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.user.IBadgeRole"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.user.IBadgeRole">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.user.</span></span><span class="sig-name descname"><span class="pre">IBadgeRole</span></span><a class="headerlink" href="#mipac.types.user.IBadgeRole" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="imedetailedonlyschema">
|
|
|
<h3>IMeDetailedOnlySchema<a class="headerlink" href="#imedetailedonlyschema" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.user.IMeDetailedOnlySchema"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.user.IMeDetailedOnlySchema">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.user.</span></span><span class="sig-name descname"><span class="pre">IMeDetailedOnlySchema</span></span><a class="headerlink" href="#mipac.types.user.IMeDetailedOnlySchema" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="imedetailedschema">
|
|
|
<h3>IMeDetailedSchema<a class="headerlink" href="#imedetailedschema" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.user.IMeDetailedSchema"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.user.IMeDetailedSchema">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.user.</span></span><span class="sig-name descname"><span class="pre">IMeDetailedSchema</span></span><a class="headerlink" href="#mipac.types.user.IMeDetailedSchema" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="ipartialuser">
|
|
|
<h3>IPartialUser<a class="headerlink" href="#ipartialuser" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.user.IPartialUser"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.user.IPartialUser">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.user.</span></span><span class="sig-name descname"><span class="pre">IPartialUser</span></span><a class="headerlink" href="#mipac.types.user.IPartialUser" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Misskey Schema: <cite>packedUserLiteSchema</cite></p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="isignin">
|
|
|
<h3>ISignin<a class="headerlink" href="#isignin" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.user.ISignin"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.user.ISignin">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.user.</span></span><span class="sig-name descname"><span class="pre">ISignin</span></span><a class="headerlink" href="#mipac.types.user.ISignin" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="iuserdetailednotmeonlyschema">
|
|
|
<h3>IUserDetailedNotMeOnlySchema<a class="headerlink" href="#iuserdetailednotmeonlyschema" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.user.IUserDetailedNotMeOnlySchema"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.user.IUserDetailedNotMeOnlySchema">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.user.</span></span><span class="sig-name descname"><span class="pre">IUserDetailedNotMeOnlySchema</span></span><a class="headerlink" href="#mipac.types.user.IUserDetailedNotMeOnlySchema" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Misskey Schema: <cite>packedUserDetailedNotMeOnlySchema</cite></p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="iuserdetailednotmeschema">
|
|
|
<h3>IUserDetailedNotMeSchema<a class="headerlink" href="#iuserdetailednotmeschema" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.user.IUserDetailedNotMeSchema"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.user.IUserDetailedNotMeSchema">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.user.</span></span><span class="sig-name descname"><span class="pre">IUserDetailedNotMeSchema</span></span><a class="headerlink" href="#mipac.types.user.IUserDetailedNotMeSchema" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="iuserfield">
|
|
|
<h3>IUserField<a class="headerlink" href="#iuserfield" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.user.IUserField"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.user.IUserField">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.user.</span></span><span class="sig-name descname"><span class="pre">IUserField</span></span><a class="headerlink" href="#mipac.types.user.IUserField" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="iuserlist">
|
|
|
<h3>IUserList<a class="headerlink" href="#iuserlist" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.user.IUserList"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.user.IUserList">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.user.</span></span><span class="sig-name descname"><span class="pre">IUserList</span></span><a class="headerlink" href="#mipac.types.user.IUserList" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="iuserlistmembership">
|
|
|
<h3>IUserListMembership<a class="headerlink" href="#iuserlistmembership" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.user.IUserListMembership"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.user.IUserListMembership">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.user.</span></span><span class="sig-name descname"><span class="pre">IUserListMembership</span></span><a class="headerlink" href="#mipac.types.user.IUserListMembership" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="iuserrequired">
|
|
|
<h3>IUserRequired<a class="headerlink" href="#iuserrequired" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.user.IUserRequired"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.user.IUserRequired">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.user.</span></span><span class="sig-name descname"><span class="pre">IUserRequired</span></span><a class="headerlink" href="#mipac.types.user.IUserRequired" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="iuserrole">
|
|
|
<h3>IUserRole<a class="headerlink" href="#iuserrole" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.user.IUserRole"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.user.IUserRole">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.user.</span></span><span class="sig-name descname"><span class="pre">IUserRole</span></span><a class="headerlink" href="#mipac.types.user.IUserRole" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Deprecated</p>
|
|
|
<p>Will be removed in v0.7.0</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="iusersecuritykey">
|
|
|
<h3>IUserSecurityKey<a class="headerlink" href="#iusersecuritykey" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.user.IUserSecurityKey"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.user.IUserSecurityKey">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.user.</span></span><span class="sig-name descname"><span class="pre">IUserSecurityKey</span></span><a class="headerlink" href="#mipac.types.user.IUserSecurityKey" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="notificationrecieveconfig">
|
|
|
<h3>NotificationRecieveConfig<a class="headerlink" href="#notificationrecieveconfig" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.user.NotificationRecieveConfig"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.user.NotificationRecieveConfig">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.user.</span></span><span class="sig-name descname"><span class="pre">NotificationRecieveConfig</span></span><a class="headerlink" href="#mipac.types.user.NotificationRecieveConfig" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="notificationrecieveconfigtype">
|
|
|
<h3>NotificationRecieveConfigType<a class="headerlink" href="#notificationrecieveconfigtype" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.user.NotificationRecieveConfigType"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.user.NotificationRecieveConfigType">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.user.</span></span><span class="sig-name descname"><span class="pre">NotificationRecieveConfigType</span></span><a class="headerlink" href="#mipac.types.user.NotificationRecieveConfigType" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="notificationrecieveconfigwithuserlist">
|
|
|
<h3>NotificationRecieveConfigWithUserList<a class="headerlink" href="#notificationrecieveconfigwithuserlist" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.user.NotificationRecieveConfigWithUserList"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.user.NotificationRecieveConfigWithUserList">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.user.</span></span><span class="sig-name descname"><span class="pre">NotificationRecieveConfigWithUserList</span></span><a class="headerlink" href="#mipac.types.user.NotificationRecieveConfigWithUserList" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="iadminmeta">
|
|
|
<h3>IAdminMeta<a class="headerlink" href="#iadminmeta" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.meta.IAdminMeta"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.meta.IAdminMeta">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.meta.</span></span><span class="sig-name descname"><span class="pre">IAdminMeta</span></span><a class="headerlink" href="#mipac.types.meta.IAdminMeta" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="ifeatures">
|
|
|
<h3>IFeatures<a class="headerlink" href="#ifeatures" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.meta.IFeatures"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.meta.IFeatures">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.meta.</span></span><span class="sig-name descname"><span class="pre">IFeatures</span></span><a class="headerlink" href="#mipac.types.meta.IFeatures" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="imeta">
|
|
|
<h3>IMeta<a class="headerlink" href="#imeta" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.meta.IMeta"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.meta.IMeta">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.meta.</span></span><span class="sig-name descname"><span class="pre">IMeta</span></span><a class="headerlink" href="#mipac.types.meta.IMeta" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="ipartialmeta">
|
|
|
<h3>IPartialMeta<a class="headerlink" href="#ipartialmeta" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.meta.IPartialMeta"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.meta.IPartialMeta">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.meta.</span></span><span class="sig-name descname"><span class="pre">IPartialMeta</span></span><a class="headerlink" href="#mipac.types.meta.IPartialMeta" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="ipolicies">
|
|
|
<h3>IPolicies<a class="headerlink" href="#ipolicies" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.meta.IPolicies"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.meta.IPolicies">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.meta.</span></span><span class="sig-name descname"><span class="pre">IPolicies</span></span><a class="headerlink" href="#mipac.types.meta.IPolicies" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="iupdatemetabody">
|
|
|
<h3>IUpdateMetaBody<a class="headerlink" href="#iupdatemetabody" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.types.meta.IUpdateMetaBody"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.types.meta.IUpdateMetaBody">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.types.meta.</span></span><span class="sig-name descname"><span class="pre">IUpdateMetaBody</span></span><a class="headerlink" href="#mipac.types.meta.IUpdateMetaBody" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
</section>
|
|
|
<section id="errors">
|
|
|
<h2>Errors<a class="headerlink" href="#errors" title="Link to this heading">#</a></h2>
|
|
|
<section id="accessdeniederror">
|
|
|
<h3>AccessDeniedError<a class="headerlink" href="#accessdeniederror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.AccessDeniedError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.AccessDeniedError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">AccessDeniedError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.AccessDeniedError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>アクセス権限がありません。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="alreadyaddederror">
|
|
|
<h3>AlreadyAddedError<a class="headerlink" href="#alreadyaddederror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.AlreadyAddedError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.AlreadyAddedError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">AlreadyAddedError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.AlreadyAddedError" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="alreadyblockingerror">
|
|
|
<h3>AlreadyBlockingError<a class="headerlink" href="#alreadyblockingerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.AlreadyBlockingError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.AlreadyBlockingError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">AlreadyBlockingError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.AlreadyBlockingError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>すでにブロックしています。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="alreadyclippederror">
|
|
|
<h3>AlreadyClippedError<a class="headerlink" href="#alreadyclippederror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.AlreadyClippedError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.AlreadyClippedError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">AlreadyClippedError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.AlreadyClippedError" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="alreadyexpirederror">
|
|
|
<h3>AlreadyExpiredError<a class="headerlink" href="#alreadyexpirederror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.AlreadyExpiredError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.AlreadyExpiredError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">AlreadyExpiredError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.AlreadyExpiredError" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="alreadyfavoritederror">
|
|
|
<h3>AlreadyFavoritedError<a class="headerlink" href="#alreadyfavoritederror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.AlreadyFavoritedError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.AlreadyFavoritedError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">AlreadyFavoritedError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.AlreadyFavoritedError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>既にお気に入り登録されています。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="alreadyfollowingerror">
|
|
|
<h3>AlreadyFollowingError<a class="headerlink" href="#alreadyfollowingerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.AlreadyFollowingError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.AlreadyFollowingError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">AlreadyFollowingError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.AlreadyFollowingError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>すでにフォローしています。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="alreadyinvitederror">
|
|
|
<h3>AlreadyInvitedError<a class="headerlink" href="#alreadyinvitederror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.AlreadyInvitedError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.AlreadyInvitedError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">AlreadyInvitedError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.AlreadyInvitedError" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="alreadylikederror">
|
|
|
<h3>AlreadyLikedError<a class="headerlink" href="#alreadylikederror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.AlreadyLikedError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.AlreadyLikedError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">AlreadyLikedError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.AlreadyLikedError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>すでにいいねをつけています。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="alreadymutingerror">
|
|
|
<h3>AlreadyMutingError<a class="headerlink" href="#alreadymutingerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.AlreadyMutingError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.AlreadyMutingError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">AlreadyMutingError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.AlreadyMutingError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>すでにそのユーザーをミュートしています。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="alreadypinnederror">
|
|
|
<h3>AlreadyPinnedError<a class="headerlink" href="#alreadypinnederror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.AlreadyPinnedError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.AlreadyPinnedError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">AlreadyPinnedError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.AlreadyPinnedError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>指定されたノートは既にピン留めされています。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="alreadypromotederror">
|
|
|
<h3>AlreadyPromotedError<a class="headerlink" href="#alreadypromotederror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.AlreadyPromotedError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.AlreadyPromotedError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">AlreadyPromotedError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.AlreadyPromotedError" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="alreadyreactederror">
|
|
|
<h3>AlreadyReactedError<a class="headerlink" href="#alreadyreactederror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.AlreadyReactedError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.AlreadyReactedError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">AlreadyReactedError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.AlreadyReactedError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>既にリアクションしています。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="alreadyvotederror">
|
|
|
<h3>AlreadyVotedError<a class="headerlink" href="#alreadyvotederror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.AlreadyVotedError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.AlreadyVotedError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">AlreadyVotedError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.AlreadyVotedError" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="avatarnotanimageerror">
|
|
|
<h3>AvatarNotAnImageError<a class="headerlink" href="#avatarnotanimageerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.AvatarNotAnImageError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.AvatarNotAnImageError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">AvatarNotAnImageError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.AvatarNotAnImageError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>アバター画像に、画像ではないファイルが指定されました。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="bannernotanimageerror">
|
|
|
<h3>BannerNotAnImageError<a class="headerlink" href="#bannernotanimageerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.BannerNotAnImageError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.BannerNotAnImageError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">BannerNotAnImageError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.BannerNotAnImageError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>バナー画像に、画像ではないファイルが指定されました。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="blockederror">
|
|
|
<h3>BlockedError<a class="headerlink" href="#blockederror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.BlockedError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.BlockedError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">BlockedError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.BlockedError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>ユーザーにブロックされています。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="blockeeisyourselferror">
|
|
|
<h3>BlockeeIsYourselfError<a class="headerlink" href="#blockeeisyourselferror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.BlockeeIsYourselfError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.BlockeeIsYourselfError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">BlockeeIsYourselfError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.BlockeeIsYourselfError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>自分のブロックを解除しようとしました。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="blockingerror">
|
|
|
<h3>BlockingError<a class="headerlink" href="#blockingerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.BlockingError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.BlockingError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">BlockingError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.BlockingError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>ユーザーをブロックしています。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="cannotcreatealreadyexpiredpollerror">
|
|
|
<h3>CannotCreateAlreadyExpiredPollError<a class="headerlink" href="#cannotcreatealreadyexpiredpollerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.CannotCreateAlreadyExpiredPollError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.CannotCreateAlreadyExpiredPollError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">CannotCreateAlreadyExpiredPollError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.CannotCreateAlreadyExpiredPollError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>アンケートの期限の指定が誤っています。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="cannotrenotetoapurerenoteerror">
|
|
|
<h3>CannotRenoteToAPureRenoteError<a class="headerlink" href="#cannotrenotetoapurerenoteerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.CannotRenoteToAPureRenoteError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.CannotRenoteToAPureRenoteError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">CannotRenoteToAPureRenoteError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.CannotRenoteToAPureRenoteError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>単純なRenoteを再度Renoteすることはできません。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="cannotreplytoapurerenoteerror">
|
|
|
<h3>CannotReplyToAPureRenoteError<a class="headerlink" href="#cannotreplytoapurerenoteerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.CannotReplyToAPureRenoteError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.CannotReplyToAPureRenoteError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">CannotReplyToAPureRenoteError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.CannotReplyToAPureRenoteError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>単純なRenoteに返信することはできません。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="cannotreporttheadminerror">
|
|
|
<h3>CannotReportTheAdminError<a class="headerlink" href="#cannotreporttheadminerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.CannotReportTheAdminError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.CannotReportTheAdminError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">CannotReportTheAdminError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.CannotReportTheAdminError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>管理者を通報しようとしました。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="cannotreportyourselferror">
|
|
|
<h3>CannotReportYourselfError<a class="headerlink" href="#cannotreportyourselferror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.CannotReportYourselfError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.CannotReportYourselfError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">CannotReportYourselfError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.CannotReportYourselfError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>自身を通報しようとしました。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="contentrequirederror">
|
|
|
<h3>ContentRequiredError<a class="headerlink" href="#contentrequirederror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.ContentRequiredError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.ContentRequiredError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">ContentRequiredError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.ContentRequiredError" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="credentialrequirederror">
|
|
|
<h3>CredentialRequiredError<a class="headerlink" href="#credentialrequirederror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.CredentialRequiredError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.CredentialRequiredError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">CredentialRequiredError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.CredentialRequiredError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>クレデンシャル必須のエンドポイントにクレデンシャル無しでリクエストされました。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="failedtoresolveremoteusererror">
|
|
|
<h3>FailedToResolveRemoteUserError<a class="headerlink" href="#failedtoresolveremoteusererror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.FailedToResolveRemoteUserError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.FailedToResolveRemoteUserError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">FailedToResolveRemoteUserError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.FailedToResolveRemoteUserError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>リモートユーザーの検索に失敗しました。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="followrequestnotfounderror">
|
|
|
<h3>FollowRequestNotFoundError<a class="headerlink" href="#followrequestnotfounderror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.FollowRequestNotFoundError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.FollowRequestNotFoundError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">FollowRequestNotFoundError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.FollowRequestNotFoundError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>フォローリクエストがありません。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="followeeisyourselferror">
|
|
|
<h3>FolloweeIsYourselfError<a class="headerlink" href="#followeeisyourselferror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.FolloweeIsYourselfError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.FolloweeIsYourselfError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">FolloweeIsYourselfError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.FolloweeIsYourselfError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>自分のフォローを解除しようとしました。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="followerisyourselferror">
|
|
|
<h3>FollowerIsYourselfError<a class="headerlink" href="#followerisyourselferror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.FollowerIsYourselfError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.FollowerIsYourselfError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">FollowerIsYourselfError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.FollowerIsYourselfError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>自分をフォロワー解除しようとしました。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="forbiddenerror">
|
|
|
<h3>ForbiddenError<a class="headerlink" href="#forbiddenerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.ForbiddenError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.ForbiddenError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">ForbiddenError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.ForbiddenError" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="groupaccessdeniederror">
|
|
|
<h3>GroupAccessDeniedError<a class="headerlink" href="#groupaccessdeniederror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.GroupAccessDeniedError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.GroupAccessDeniedError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">GroupAccessDeniedError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.GroupAccessDeniedError" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="gtldisablederror">
|
|
|
<h3>GtlDisabledError<a class="headerlink" href="#gtldisablederror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.GtlDisabledError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.GtlDisabledError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">GtlDisabledError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.GtlDisabledError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>グローバルタイムラインが無効になっています。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="haschildfilesorfolderserror">
|
|
|
<h3>HasChildFilesOrFoldersError<a class="headerlink" href="#haschildfilesorfolderserror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.HasChildFilesOrFoldersError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.HasChildFilesOrFoldersError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">HasChildFilesOrFoldersError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.HasChildFilesOrFoldersError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>フォルダーが空ではありません。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="inappropriateerror">
|
|
|
<h3>InappropriateError<a class="headerlink" href="#inappropriateerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.InappropriateError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.InappropriateError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">InappropriateError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.InappropriateError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>不適切なコンテンツを含んでいる可能性があると判定されました。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="internalerrorerror">
|
|
|
<h3>InternalErrorError<a class="headerlink" href="#internalerrorerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.InternalErrorError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.InternalErrorError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">InternalErrorError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.InternalErrorError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>サーバー内部で問題が発生しました。引き続き問題が発生する場合は管理者にお問い合わせください。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="invalidchoiceerror">
|
|
|
<h3>InvalidChoiceError<a class="headerlink" href="#invalidchoiceerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.InvalidChoiceError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.InvalidChoiceError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">InvalidChoiceError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.InvalidChoiceError" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="invalidfilenameerror">
|
|
|
<h3>InvalidFileNameError<a class="headerlink" href="#invalidfilenameerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.InvalidFileNameError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.InvalidFileNameError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">InvalidFileNameError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.InvalidFileNameError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>ファイル名が不正です。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="invalidparamerror">
|
|
|
<h3>InvalidParamError<a class="headerlink" href="#invalidparamerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.InvalidParamError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.InvalidParamError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">InvalidParamError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.InvalidParamError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>リクエストパラメータに誤りがあります。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="invalidregexperror">
|
|
|
<h3>InvalidRegexpError<a class="headerlink" href="#invalidregexperror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.InvalidRegexpError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.InvalidRegexpError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">InvalidRegexpError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.InvalidRegexpError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>正規表現が不正です。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="invalidurlerror">
|
|
|
<h3>InvalidUrlError<a class="headerlink" href="#invalidurlerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.InvalidUrlError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.InvalidUrlError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">InvalidUrlError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.InvalidUrlError" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="isownererror">
|
|
|
<h3>IsOwnerError<a class="headerlink" href="#isownererror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.IsOwnerError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.IsOwnerError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">IsOwnerError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.IsOwnerError" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="ltldisablederror">
|
|
|
<h3>LtlDisabledError<a class="headerlink" href="#ltldisablederror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.LtlDisabledError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.LtlDisabledError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">LtlDisabledError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.LtlDisabledError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>ローカルタイムラインが無効になっています。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="mosuchfileerror">
|
|
|
<h3>MoSuchFileError<a class="headerlink" href="#mosuchfileerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.MoSuchFileError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.MoSuchFileError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">MoSuchFileError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.MoSuchFileError" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="muteeisyourselferror">
|
|
|
<h3>MuteeIsYourselfError<a class="headerlink" href="#muteeisyourselferror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.MuteeIsYourselfError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.MuteeIsYourselfError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">MuteeIsYourselfError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.MuteeIsYourselfError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>自分に対してミュートを解除しようとしました。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="namealreadyexistserror">
|
|
|
<h3>NameAlreadyExistsError<a class="headerlink" href="#namealreadyexistserror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NameAlreadyExistsError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NameAlreadyExistsError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NameAlreadyExistsError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NameAlreadyExistsError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>同じURLにページがすでに存在します。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="nofollowrequesterror">
|
|
|
<h3>NoFollowRequestError<a class="headerlink" href="#nofollowrequesterror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NoFollowRequestError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NoFollowRequestError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NoFollowRequestError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NoFollowRequestError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>ユーザーからのフォローリクエストがありません。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="nofreespaceerror">
|
|
|
<h3>NoFreeSpaceError<a class="headerlink" href="#nofreespaceerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NoFreeSpaceError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NoFreeSpaceError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NoFreeSpaceError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NoFreeSpaceError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>ドライブに空き容量がありません。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="nopollerror">
|
|
|
<h3>NoPollError<a class="headerlink" href="#nopollerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NoPollError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NoPollError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NoPollError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NoPollError" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="nosuchaderror">
|
|
|
<h3>NoSuchAdError<a class="headerlink" href="#nosuchaderror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NoSuchAdError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NoSuchAdError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NoSuchAdError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NoSuchAdError" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="nosuchannouncementerror">
|
|
|
<h3>NoSuchAnnouncementError<a class="headerlink" href="#nosuchannouncementerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NoSuchAnnouncementError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NoSuchAnnouncementError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NoSuchAnnouncementError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NoSuchAnnouncementError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>お知らせが存在しません。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="nosuchantennaerror">
|
|
|
<h3>NoSuchAntennaError<a class="headerlink" href="#nosuchantennaerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NoSuchAntennaError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NoSuchAntennaError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NoSuchAntennaError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NoSuchAntennaError" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="nosuchapperror">
|
|
|
<h3>NoSuchAppError<a class="headerlink" href="#nosuchapperror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NoSuchAppError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NoSuchAppError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NoSuchAppError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NoSuchAppError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>アプリが存在しません。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="nosuchavatarerror">
|
|
|
<h3>NoSuchAvatarError<a class="headerlink" href="#nosuchavatarerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NoSuchAvatarError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NoSuchAvatarError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NoSuchAvatarError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NoSuchAvatarError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>アバター画像のファイルが存在しません。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="nosuchbannererror">
|
|
|
<h3>NoSuchBannerError<a class="headerlink" href="#nosuchbannererror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NoSuchBannerError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NoSuchBannerError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NoSuchBannerError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NoSuchBannerError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>バナー画像のファイルが存在しません。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="nosuchchannelerror">
|
|
|
<h3>NoSuchChannelError<a class="headerlink" href="#nosuchchannelerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NoSuchChannelError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NoSuchChannelError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NoSuchChannelError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NoSuchChannelError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>指定されたチャンネルが存在しないか、アクセスが許可されていません。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="nosuchcliperror">
|
|
|
<h3>NoSuchClipError<a class="headerlink" href="#nosuchcliperror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NoSuchClipError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NoSuchClipError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NoSuchClipError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NoSuchClipError" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="nosuchemojierror">
|
|
|
<h3>NoSuchEmojiError<a class="headerlink" href="#nosuchemojierror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NoSuchEmojiError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NoSuchEmojiError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NoSuchEmojiError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NoSuchEmojiError" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="nosuchfileerror">
|
|
|
<h3>NoSuchFileError<a class="headerlink" href="#nosuchfileerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NoSuchFileError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NoSuchFileError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NoSuchFileError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NoSuchFileError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>ファイルが存在しません。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="nosuchfoldererror">
|
|
|
<h3>NoSuchFolderError<a class="headerlink" href="#nosuchfoldererror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NoSuchFolderError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NoSuchFolderError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NoSuchFolderError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NoSuchFolderError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>フォルダーが存在しません。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="nosuchgrouperror">
|
|
|
<h3>NoSuchGroupError<a class="headerlink" href="#nosuchgrouperror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NoSuchGroupError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NoSuchGroupError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NoSuchGroupError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NoSuchGroupError" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="nosuchgroupmembererror">
|
|
|
<h3>NoSuchGroupMemberError<a class="headerlink" href="#nosuchgroupmembererror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NoSuchGroupMemberError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NoSuchGroupMemberError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NoSuchGroupMemberError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NoSuchGroupMemberError" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="nosuchhashtagerror">
|
|
|
<h3>NoSuchHashtagError<a class="headerlink" href="#nosuchhashtagerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NoSuchHashtagError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NoSuchHashtagError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NoSuchHashtagError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NoSuchHashtagError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>ハッシュタグが存在しません。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="nosuchinvitationerror">
|
|
|
<h3>NoSuchInvitationError<a class="headerlink" href="#nosuchinvitationerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NoSuchInvitationError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NoSuchInvitationError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NoSuchInvitationError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NoSuchInvitationError" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="nosuchlisterror">
|
|
|
<h3>NoSuchListError<a class="headerlink" href="#nosuchlisterror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NoSuchListError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NoSuchListError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NoSuchListError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NoSuchListError" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="nosuchmessageerror">
|
|
|
<h3>NoSuchMessageError<a class="headerlink" href="#nosuchmessageerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NoSuchMessageError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NoSuchMessageError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NoSuchMessageError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NoSuchMessageError" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="nosuchnoteerror">
|
|
|
<h3>NoSuchNoteError<a class="headerlink" href="#nosuchnoteerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NoSuchNoteError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NoSuchNoteError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NoSuchNoteError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NoSuchNoteError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>指定されたノートが存在しないか、アクセスが許可されていません。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="nosuchnotificationerror">
|
|
|
<h3>NoSuchNotificationError<a class="headerlink" href="#nosuchnotificationerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NoSuchNotificationError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NoSuchNotificationError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NoSuchNotificationError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NoSuchNotificationError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>通知が存在しません。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="nosuchobjecterror">
|
|
|
<h3>NoSuchObjectError<a class="headerlink" href="#nosuchobjecterror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NoSuchObjectError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NoSuchObjectError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NoSuchObjectError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NoSuchObjectError" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="nosuchpageerror">
|
|
|
<h3>NoSuchPageError<a class="headerlink" href="#nosuchpageerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NoSuchPageError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NoSuchPageError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NoSuchPageError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NoSuchPageError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>ページが存在しません。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="nosuchparentfoldererror">
|
|
|
<h3>NoSuchParentFolderError<a class="headerlink" href="#nosuchparentfoldererror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NoSuchParentFolderError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NoSuchParentFolderError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NoSuchParentFolderError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NoSuchParentFolderError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>親フォルダーが存在しません。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="nosuchposterror">
|
|
|
<h3>NoSuchPostError<a class="headerlink" href="#nosuchposterror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NoSuchPostError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NoSuchPostError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NoSuchPostError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NoSuchPostError" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="nosuchrenotetargeterror">
|
|
|
<h3>NoSuchRenoteTargetError<a class="headerlink" href="#nosuchrenotetargeterror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NoSuchRenoteTargetError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NoSuchRenoteTargetError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NoSuchRenoteTargetError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NoSuchRenoteTargetError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Renoteに指定されたノートが存在しないか、アクセスが許可されていません。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="nosuchreplytargeterror">
|
|
|
<h3>NoSuchReplyTargetError<a class="headerlink" href="#nosuchreplytargeterror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NoSuchReplyTargetError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NoSuchReplyTargetError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NoSuchReplyTargetError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NoSuchReplyTargetError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>返信先に指定されたノートが存在しないか、アクセスが許可されていません。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="nosuchsessionerror">
|
|
|
<h3>NoSuchSessionError<a class="headerlink" href="#nosuchsessionerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NoSuchSessionError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NoSuchSessionError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NoSuchSessionError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NoSuchSessionError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>セッションが存在しません。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="nosuchusererror">
|
|
|
<h3>NoSuchUserError<a class="headerlink" href="#nosuchusererror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NoSuchUserError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NoSuchUserError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NoSuchUserError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NoSuchUserError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>ユーザーが存在しません。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="nosuchusergrouperror">
|
|
|
<h3>NoSuchUserGroupError<a class="headerlink" href="#nosuchusergrouperror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NoSuchUserGroupError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NoSuchUserGroupError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NoSuchUserGroupError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NoSuchUserGroupError" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="nosuchuserlisterror">
|
|
|
<h3>NoSuchUserListError<a class="headerlink" href="#nosuchuserlisterror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NoSuchUserListError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NoSuchUserListError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NoSuchUserListError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NoSuchUserListError" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="nosuchwebhookerror">
|
|
|
<h3>NoSuchWebhookError<a class="headerlink" href="#nosuchwebhookerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NoSuchWebhookError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NoSuchWebhookError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NoSuchWebhookError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NoSuchWebhookError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Webhookが存在しません。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="notblockingerror">
|
|
|
<h3>NotBlockingError<a class="headerlink" href="#notblockingerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NotBlockingError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NotBlockingError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NotBlockingError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NotBlockingError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>ブロックしていないユーザーです。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="notfavoritederror">
|
|
|
<h3>NotFavoritedError<a class="headerlink" href="#notfavoritederror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NotFavoritedError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NotFavoritedError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NotFavoritedError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NotFavoritedError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>お気に入り登録されていません。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="notfollowingerror">
|
|
|
<h3>NotFollowingError<a class="headerlink" href="#notfollowingerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NotFollowingError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NotFollowingError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NotFollowingError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NotFollowingError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>ユーザーにフォローされていません。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="notlikederror">
|
|
|
<h3>NotLikedError<a class="headerlink" href="#notlikederror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NotLikedError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NotLikedError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NotLikedError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NotLikedError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>いいねをつけていないページです。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="notmutingerror">
|
|
|
<h3>NotMutingError<a class="headerlink" href="#notmutingerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NotMutingError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NotMutingError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NotMutingError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NotMutingError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>対象となるユーザーをそもそもミュートしていません。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="notreactederror">
|
|
|
<h3>NotReactedError<a class="headerlink" href="#notreactederror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.NotReactedError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.NotReactedError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">NotReactedError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.NotReactedError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>リアクションしていません。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="pendingsessionerror">
|
|
|
<h3>PendingSessionError<a class="headerlink" href="#pendingsessionerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.PendingSessionError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.PendingSessionError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">PendingSessionError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.PendingSessionError" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="permissiondeniederror">
|
|
|
<h3>PermissionDeniedError<a class="headerlink" href="#permissiondeniederror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.PermissionDeniedError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.PermissionDeniedError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">PermissionDeniedError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.PermissionDeniedError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>与えられたクレデンシャルには必要なパーミッションがありません。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="pinlimitexceedederror">
|
|
|
<h3>PinLimitExceededError<a class="headerlink" href="#pinlimitexceedederror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.PinLimitExceededError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.PinLimitExceededError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">PinLimitExceededError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.PinLimitExceededError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>これ以上ピン留めできません。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="ratelimitexceedederror">
|
|
|
<h3>RateLimitExceededError<a class="headerlink" href="#ratelimitexceedederror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.RateLimitExceededError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.RateLimitExceededError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">RateLimitExceededError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.RateLimitExceededError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>レートリミットによる制限のため一時的に利用できません。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="reactionsnotpublicerror">
|
|
|
<h3>ReactionsNotPublicError<a class="headerlink" href="#reactionsnotpublicerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.ReactionsNotPublicError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.ReactionsNotPublicError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">ReactionsNotPublicError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.ReactionsNotPublicError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>リアクションが公開されていません。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="recipientisyourselferror">
|
|
|
<h3>RecipientIsYourselfError<a class="headerlink" href="#recipientisyourselferror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.RecipientIsYourselfError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.RecipientIsYourselfError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">RecipientIsYourselfError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.RecipientIsYourselfError" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="stldisablederror">
|
|
|
<h3>StlDisabledError<a class="headerlink" href="#stldisablederror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.StlDisabledError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.StlDisabledError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">StlDisabledError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.StlDisabledError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>ソーシャルタイムラインが無効になっています。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="youareownererror">
|
|
|
<h3>YouAreOwnerError<a class="headerlink" href="#youareownererror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.YouAreOwnerError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.YouAreOwnerError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">YouAreOwnerError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.YouAreOwnerError" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="youhavebeenblockederror">
|
|
|
<h3>YouHaveBeenBlockedError<a class="headerlink" href="#youhavebeenblockederror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.YouHaveBeenBlockedError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.YouHaveBeenBlockedError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">YouHaveBeenBlockedError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.YouHaveBeenBlockedError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>ブロックされているユーザーのノートにリアクションは行えません。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="youraccountsuspendederror">
|
|
|
<h3>YourAccountSuspendedError<a class="headerlink" href="#youraccountsuspendederror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.YourAccountSuspendedError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.YourAccountSuspendedError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">YourAccountSuspendedError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.YourAccountSuspendedError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>アカウントが凍結されているため利用できません。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="yourpageerror">
|
|
|
<h3>YourPageError<a class="headerlink" href="#yourpageerror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.YourPageError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.YourPageError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">YourPageError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.YourPageError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>自身のページにいいねをつけようとしました。</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="yourposterror">
|
|
|
<h3>YourPostError<a class="headerlink" href="#yourposterror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.errors.YourPostError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.errors.YourPostError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.errors.</span></span><span class="sig-name descname"><span class="pre">YourPostError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.errors.YourPostError" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="apierror">
|
|
|
<h3>APIError<a class="headerlink" href="#apierror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.base.APIError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.base.APIError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.base.</span></span><span class="sig-name descname"><span class="pre">APIError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.errors.base.APIError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>APIのエラー</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="credentialserror">
|
|
|
<h3>CredentialsError<a class="headerlink" href="#credentialserror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.base.CredentialsError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.base.CredentialsError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.base.</span></span><span class="sig-name descname"><span class="pre">CredentialsError</span></span><a class="headerlink" href="#mipac.errors.base.CredentialsError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>認証情報に関するエラー</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="notexistrequireddata">
|
|
|
<h3>NotExistRequiredData<a class="headerlink" href="#notexistrequireddata" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.base.NotExistRequiredData"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.base.NotExistRequiredData">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.base.</span></span><span class="sig-name descname"><span class="pre">NotExistRequiredData</span></span><a class="headerlink" href="#mipac.errors.base.NotExistRequiredData" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>クラスの中に必要なデータが不足している</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="parametererror">
|
|
|
<h3>ParameterError<a class="headerlink" href="#parametererror" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.errors.base.ParameterError"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.errors.base.ParameterError">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.errors.base.</span></span><span class="sig-name descname"><span class="pre">ParameterError</span></span><a class="headerlink" href="#mipac.errors.base.ParameterError" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>引数に関するエラー</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
</section>
|
|
|
<section id="other">
|
|
|
<h2>__OTHER<a class="headerlink" href="#other" title="Link to this heading">#</a></h2>
|
|
|
<section id="json-or-text">
|
|
|
<h3>json_or_text<a class="headerlink" href="#json-or-text" title="Link to this heading">#</a></h3>
|
|
|
<dl class="py function">
|
|
|
<dt class="sig sig-object py" id="mipac.http.json_or_text">
|
|
|
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.http.</span></span><span class="sig-name descname"><span class="pre">json_or_text</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ClientResponse</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.http.json_or_text" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="httpclient">
|
|
|
<h3>HTTPClient<a class="headerlink" href="#httpclient" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.http.HTTPClient"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.http.HTTPClient">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.http.</span></span><span class="sig-name descname"><span class="pre">HTTPClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.http.HTTPClient" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="misskeyclientwebsocketresponse">
|
|
|
<h3>MisskeyClientWebSocketResponse<a class="headerlink" href="#misskeyclientwebsocketresponse" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.http.MisskeyClientWebSocketResponse"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.http.MisskeyClientWebSocketResponse">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.http.</span></span><span class="sig-name descname"><span class="pre">MisskeyClientWebSocketResponse</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">reader</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">FlowControlDataQueue</span><span class="p"><span class="pre">[</span></span><span class="pre">WSMessage</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">writer</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">WebSocketWriter</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">protocol</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ClientResponse</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">autoclose</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">autoping</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">loop</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">AbstractEventLoop</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">receive_timeout</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">heartbeat</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compress</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_notakeover</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.http.MisskeyClientWebSocketResponse" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="route">
|
|
|
<h3>Route<a class="headerlink" href="#route" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.http.Route"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.http.Route">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.http.</span></span><span class="sig-name descname"><span class="pre">Route</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'GET'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'POST'</span></span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'/api/admin/meta'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/abuse-user-reports'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/accounts/create'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/accounts/delete'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/accounts/find-by-email'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/ad/create'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/ad/delete'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/ad/list'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/ad/update'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/announcements/create'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/announcements/delete'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/announcements/list'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/announcements/update'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/avatar-decorations/create'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/avatar-decorations/delete'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/avatar-decorations/list'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/avatar-decorations/update'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/delete-all-files-of-a-user'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/unset-user-avatar'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/unset-user-banner'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/drive/clean-remote-files'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/drive/cleanup'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/drive/files'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/drive/show-file'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/emoji/add-aliases-bulk'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/emoji/add'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/emoji/copy'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/emoji/delete-bulk'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/emoji/delete'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/emoji/import-zip'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/emoji/list-remote'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/emoji/list'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/emoji/remove-aliases-bulk'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/emoji/set-aliases-bulk'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/emoji/set-category-bulk'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/emoji/set-license-bulk'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/emoji/update'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/federation/delete-all-files'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/federation/refresh-remote-instance-metadata'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/federation/remove-all-following'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/federation/update-instance'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/get-index-stats'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/get-table-stats'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/get-user-ips'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/invite/create'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/invite/list'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/promo/create'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/queue/clear'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/queue/deliver-delayed'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/queue/inbox-delayed'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/queue/promote'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/queue/stats'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/relays/add'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/relays/list'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/relays/remove'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/reset-password'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/resolve-abuse-user-report'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/send-email'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/server-info'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/show-moderation-logs'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/show-user'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/show-users'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/suspend-user'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/unsuspend-user'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/update-meta'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/delete-account'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/update-user-note'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/roles/create'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/roles/delete'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/roles/list'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/roles/show'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/roles/update'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/roles/assign'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/roles/unassign'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/roles/update-default-policies'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/admin/roles/users'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/announcements'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/antennas/create'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/antennas/delete'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/antennas/list'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/antennas/notes'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/antennas/show'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/antennas/update'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/ap/get'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/ap/show'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/app/create'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/app/show'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/auth/accept'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/auth/session/generate'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/auth/session/show'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/auth/session/userkey'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/blocking/create'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/blocking/delete'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/blocking/list'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/channels/create'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/channels/featured'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/channels/follow'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/channels/followed'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/channels/owned'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/channels/show'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/channels/timeline'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/channels/unfollow'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/channels/update'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/channels/favorite'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/channels/unfavorite'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/channels/my-favorites'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/channels/search'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/charts/active-users'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/charts/ap-request'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/charts/drive'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/charts/federation'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/charts/instance'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/charts/notes'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/charts/user/drive'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/charts/user/following'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/charts/user/notes'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/charts/user/pv'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/charts/user/reactions'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/charts/users'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/clips/add-note'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/clips/remove-note'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/clips/create'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/clips/delete'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/clips/list'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/clips/notes'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/clips/show'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/clips/update'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/clips/favorite'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/clips/unfavorite'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/clips/my-favorites'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/drive'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/drive/files'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/drive/files/attached-notes'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/drive/files/check-existence'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/drive/files/create'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/drive/files/delete'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/drive/files/find-by-hash'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/drive/files/find'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/drive/files/show'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/drive/files/update'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/drive/files/upload-from-url'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/drive/folders'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/drive/folders/create'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/drive/folders/delete'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/drive/folders/find'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/drive/folders/show'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/drive/folders/update'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/drive/stream'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/email-address/available'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/endpoint'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/endpoints'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/export-custom-emojis'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/federation/followers'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/federation/following'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/federation/instances'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/federation/show-instance'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/federation/update-remote-user'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/federation/users'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/federation/stats'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/following/create'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/following/delete'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/following/update'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/following/update-all'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/following/invalidate'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/following/requests/accept'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/following/requests/cancel'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/following/requests/list'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/following/requests/reject'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/gallery/featured'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/gallery/popular'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/gallery/posts'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/gallery/posts/create'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/gallery/posts/delete'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/gallery/posts/like'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/gallery/posts/show'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/gallery/posts/unlike'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/gallery/posts/update'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/get-online-users-count'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/get-avatar-decorations'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/hashtags/list'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/hashtags/search'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/hashtags/show'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/hashtags/trend'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/hashtags/users'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/2fa/done'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/2fa/key-done'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/2fa/password-less'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/2fa/register-key'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/2fa/register'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/2fa/update-key'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/2fa/remove-key'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/2fa/unregister'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/apps'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/authorized-apps'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/claim-achievement'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/change-password'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/delete-account'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/export-blocking'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/export-following'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/export-mute'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/export-notes'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/export-clips'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/export-favorites'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/export-user-lists'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/export-antennas'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/favorites'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/gallery/likes'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/gallery/posts'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/import-blocking'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/import-following'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/import-muting'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/import-user-lists'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/import-antennas'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/notifications'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/notifications-grouped'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/page-likes'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/pages'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/pin'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/read-all-unread-notes'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/read-announcement'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/regenerate-token'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/registry/get-all'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/registry/get-detail'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/registry/get'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/registry/keys-with-type'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/registry/keys'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/registry/remove'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/registry/scopes-with-domain'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/registry/set'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/revoke-token'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/signin-history'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/unpin'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/update-email'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/update'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/move'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/webhooks/create'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/webhooks/list'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/webhooks/show'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/webhooks/update'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/i/webhooks/delete'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/invite/create'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/invite/delete'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/invite/list'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/invite/limit'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/meta'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/emojis'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/emoji'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/miauth/gen-token'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/mute/create'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/mute/delete'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/mute/list'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/renote-mute/create'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/renote-mute/delete'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/renote-mute/list'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/my/apps'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/notes'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/notes/children'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/notes/clips'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/notes/conversation'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/notes/create'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/notes/delete'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/notes/favorites/create'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/notes/favorites/delete'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/notes/featured'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/notes/global-timeline'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/notes/hybrid-timeline'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/notes/local-timeline'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/notes/mentions'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/notes/polls/recommendation'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/notes/polls/vote'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/notes/reactions'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/notes/reactions/create'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/notes/reactions/delete'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/notes/renotes'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/notes/replies'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/notes/search-by-tag'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/notes/search'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/notes/show'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/notes/state'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/notes/thread-muting/create'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/notes/thread-muting/delete'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/notes/timeline'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/notes/translate'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/notes/unrenote'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/notes/user-list-timeline'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/notifications/create'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/notifications/mark-all-as-read'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/notifications/test-notification'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/page-push'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/pages/create'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/pages/delete'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/pages/featured'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/pages/like'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/pages/show'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/pages/unlike'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/pages/update'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/flash/create'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/flash/delete'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/flash/featured'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/flash/like'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/flash/show'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/flash/unlike'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/flash/update'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/flash/my'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/flash/my-likes'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/ping'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/pinned-users'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/promo/read'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/roles/list'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/roles/show'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/roles/users'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/roles/notes'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/request-reset-password'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/reset-db'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/reset-password'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/server-info'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/stats'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/sw/show-registration'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/sw/update-registration'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/sw/register'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/sw/unregister'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/test'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/username/available'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/users'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/users/clips'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/users/followers'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/users/following'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/users/gallery/posts'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/users/get-frequently-replied-users'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/users/featured-notes'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/users/lists/create'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/users/lists/delete'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/users/lists/list'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/users/lists/pull'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/users/lists/push'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/users/lists/show'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/users/lists/favorite'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/users/lists/unfavorite'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/users/lists/update'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/users/lists/create-from-public'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/users/lists/update-membership'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/users/lists/get-memberships'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/users/notes'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/users/pages'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/users/flashs'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/users/reactions'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/users/recommendation'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/users/relation'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/users/report-abuse'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/users/search-by-username-and-host'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/users/search'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/users/show'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/users/achievements'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/users/update-memo'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/fetch-rss'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/fetch-external-resources'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/retention'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/bubble-game/register'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/bubble-game/ranking'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/reversi/cancel-match'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/reversi/games'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/reversi/match'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/reversi/invitations'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/reversi/show-game'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/reversi/surrender'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'/api/reversi/verify'</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.http.Route" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="cacheconfig">
|
|
|
<h3>CacheConfig<a class="headerlink" href="#cacheconfig" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.config.CacheConfig"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.config.CacheConfig">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.config.</span></span><span class="sig-name descname"><span class="pre">CacheConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.config.CacheConfigData" title="mipac.config.CacheConfigData"><span class="pre">CacheConfigData</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.config.CacheConfig" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="cacheconfigdata">
|
|
|
<h3>CacheConfigData<a class="headerlink" href="#cacheconfigdata" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.config.CacheConfigData"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.config.CacheConfigData">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.config.</span></span><span class="sig-name descname"><span class="pre">CacheConfigData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">maxsize</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1024</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ttl</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">360</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.config.CacheConfigData" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="config">
|
|
|
<h3>Config<a class="headerlink" href="#config" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.config.Config"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.config.Config">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.config.</span></span><span class="sig-name descname"><span class="pre">Config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_ssl</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cache</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.config.CacheConfigData" title="mipac.config.CacheConfigData"><span class="pre">CacheConfigData</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">features</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.config.IFeatures" title="mipac.config.IFeatures"><span class="pre">IFeatures</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limits</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.config.ILimits" title="mipac.config.ILimits"><span class="pre">ILimits</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.config.Config" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="id1">
|
|
|
<h3>Features<a class="headerlink" href="#id1" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.config.Features"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.config.Features">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.config.</span></span><span class="sig-name descname"><span class="pre">Features</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">features</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.config.IFeatures" title="mipac.config.IFeatures"><span class="pre">IFeatures</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.config.Features" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="id2">
|
|
|
<h3>IFeatures<a class="headerlink" href="#id2" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.config.IFeatures"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.config.IFeatures">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.config.</span></span><span class="sig-name descname"><span class="pre">IFeatures</span></span><a class="headerlink" href="#mipac.config.IFeatures" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="ilimits">
|
|
|
<h3>ILimits<a class="headerlink" href="#ilimits" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.config.ILimits"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.config.ILimits">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.config.</span></span><span class="sig-name descname"><span class="pre">ILimits</span></span><a class="headerlink" href="#mipac.config.ILimits" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="limits">
|
|
|
<h3>Limits<a class="headerlink" href="#limits" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.config.Limits"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.config.Limits">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.config.</span></span><span class="sig-name descname"><span class="pre">Limits</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">limits</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.config.ILimits" title="mipac.config.ILimits"><span class="pre">ILimits</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.config.Limits" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="mifile">
|
|
|
<h3>MiFile<a class="headerlink" href="#mifile" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.file.MiFile"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.file.MiFile">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.file.</span></span><span class="sig-name descname"><span class="pre">MiFile</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">file_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">folder_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">comment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_sensitive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">force</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.file.MiFile" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="client">
|
|
|
<h3>Client<a class="headerlink" href="#client" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.client.Client"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.client.Client">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.client.</span></span><span class="sig-name descname"><span class="pre">Client</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">log_level</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'NOTSET'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'DEBUG'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'INFO'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'WARNING'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'ERROR'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'CRITICAL'</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'INFO'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.client.Client" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="abstractaction">
|
|
|
<h3>AbstractAction<a class="headerlink" href="#abstractaction" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.abstract.action.AbstractAction"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.abstract.action.AbstractAction">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.abstract.action.</span></span><span class="sig-name descname"><span class="pre">AbstractAction</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.abstract.action.AbstractAction" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="abstractmanager">
|
|
|
<h3>AbstractManager<a class="headerlink" href="#abstractmanager" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.abstract.manager.AbstractManager"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.abstract.manager.AbstractManager">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.abstract.manager.</span></span><span class="sig-name descname"><span class="pre">AbstractManager</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.manager.client.ClientManager" title="mipac.manager.client.ClientManager"><span class="pre">ClientManager</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.abstract.manager.AbstractManager" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="cache">
|
|
|
<h3>cache<a class="headerlink" href="#cache" title="Link to this heading">#</a></h3>
|
|
|
<dl class="py function">
|
|
|
<dt class="sig sig-object py" id="mipac.utils.cache.cache">
|
|
|
<span class="sig-prename descclassname"><span class="pre">mipac.utils.cache.</span></span><span class="sig-name descname"><span class="pre">cache</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">group</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'default'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">override</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.utils.cache.cache" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="get-cache-key">
|
|
|
<h3>get_cache_key<a class="headerlink" href="#get-cache-key" title="Link to this heading">#</a></h3>
|
|
|
<dl class="py function">
|
|
|
<dt class="sig sig-object py" id="mipac.utils.cache.get_cache_key">
|
|
|
<span class="sig-prename descclassname"><span class="pre">mipac.utils.cache.</span></span><span class="sig-name descname"><span class="pre">get_cache_key</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.utils.cache.get_cache_key" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="set-cache">
|
|
|
<h3>set_cache<a class="headerlink" href="#set-cache" title="Link to this heading">#</a></h3>
|
|
|
<dl class="py function">
|
|
|
<dt class="sig sig-object py" id="mipac.utils.cache.set_cache">
|
|
|
<span class="sig-prename descclassname"><span class="pre">mipac.utils.cache.</span></span><span class="sig-name descname"><span class="pre">set_cache</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">group</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.utils.cache.set_cache" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="check-multi-arg">
|
|
|
<h3>check_multi_arg<a class="headerlink" href="#check-multi-arg" title="Link to this heading">#</a></h3>
|
|
|
<dl class="py function">
|
|
|
<dt class="sig sig-object py" id="mipac.utils.util.check_multi_arg">
|
|
|
<span class="sig-prename descclassname"><span class="pre">mipac.utils.util.</span></span><span class="sig-name descname"><span class="pre">check_multi_arg</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#mipac.utils.util.check_multi_arg" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>複数の値を受け取り値が存在するかをboolで返します</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>args</strong> (<em>list</em>) – 確認したい変数のリスト</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>存在する場合はTrue, 存在しない場合はFalse</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>bool</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="credentials-required">
|
|
|
<h3>credentials_required<a class="headerlink" href="#credentials-required" title="Link to this heading">#</a></h3>
|
|
|
<dl class="py function">
|
|
|
<dt class="sig sig-object py" id="mipac.utils.util.credentials_required">
|
|
|
<span class="sig-prename descclassname"><span class="pre">mipac.utils.util.</span></span><span class="sig-name descname"><span class="pre">credentials_required</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.utils.util.credentials_required" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="deprecated">
|
|
|
<h3>deprecated<a class="headerlink" href="#deprecated" title="Link to this heading">#</a></h3>
|
|
|
<dl class="py function">
|
|
|
<dt class="sig sig-object py" id="mipac.utils.util.deprecated">
|
|
|
<span class="sig-prename descclassname"><span class="pre">mipac.utils.util.</span></span><span class="sig-name descname"><span class="pre">deprecated</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.utils.util.deprecated" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>This is a decorator which can be used to mark functions
|
|
|
as deprecated. It will result in a warning being emitted
|
|
|
when the function is used.</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="colors">
|
|
|
<h3>Colors<a class="headerlink" href="#colors" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.utils.util.Colors"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.utils.util.Colors">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.utils.util.</span></span><span class="sig-name descname"><span class="pre">Colors</span></span><a class="headerlink" href="#mipac.utils.util.Colors" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="deprecatedclass">
|
|
|
<h3>DeprecatedClass<a class="headerlink" href="#deprecatedclass" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.utils.util.DeprecatedClass"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.utils.util.DeprecatedClass">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.utils.util.</span></span><span class="sig-name descname"><span class="pre">DeprecatedClass</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">remove_in_version</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.utils.util.DeprecatedClass" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="mitime">
|
|
|
<h3>MiTime<a class="headerlink" href="#mitime" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.utils.util.MiTime"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.utils.util.MiTime">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.utils.util.</span></span><span class="sig-name descname"><span class="pre">MiTime</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">start</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">timedelta</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">end</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.utils.util.MiTime" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="missing">
|
|
|
<h3>Missing<a class="headerlink" href="#missing" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.utils.util.Missing"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.utils.util.Missing">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.utils.util.</span></span><span class="sig-name descname"><span class="pre">Missing</span></span><a class="headerlink" href="#mipac.utils.util.Missing" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="imiauthpayload">
|
|
|
<h3>IMiAuthPayload<a class="headerlink" href="#imiauthpayload" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.utils.auth.IMiAuthPayload"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.utils.auth.IMiAuthPayload">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.utils.auth.</span></span><span class="sig-name descname"><span class="pre">IMiAuthPayload</span></span><a class="headerlink" href="#mipac.utils.auth.IMiAuthPayload" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="miauth">
|
|
|
<h3>MiAuth<a class="headerlink" href="#miauth" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.utils.auth.MiAuth"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.utils.auth.MiAuth">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.utils.auth.</span></span><span class="sig-name descname"><span class="pre">MiAuth</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">protocol</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'http'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'https'</span></span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.utils.auth.MiAuth" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>Misskey v12以降のインスタンスで使用可能な認証方式です</p>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="setup-logging">
|
|
|
<h3>setup_logging<a class="headerlink" href="#setup-logging" title="Link to this heading">#</a></h3>
|
|
|
<dl class="py function">
|
|
|
<dt class="sig sig-object py" id="mipac.utils.log.setup_logging">
|
|
|
<span class="sig-prename descclassname"><span class="pre">mipac.utils.log.</span></span><span class="sig-name descname"><span class="pre">setup_logging</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">handler</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Handler</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">formatter</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Formatter</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">level</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'NOTSET'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'DEBUG'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'INFO'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'WARNING'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'ERROR'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'CRITICAL'</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'INFO'</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#mipac.utils.log.setup_logging" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="pagination">
|
|
|
<h3>Pagination<a class="headerlink" href="#pagination" title="Link to this heading">#</a></h3>
|
|
|
<div class="py-attribute-table" data-move-to-id="mipac.utils.pagination.Pagination"></div><dl class="py class">
|
|
|
<dt class="sig sig-object py" id="mipac.utils.pagination.Pagination">
|
|
|
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">mipac.utils.pagination.</span></span><span class="sig-name descname"><span class="pre">Pagination</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">http_client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.HTTPClient" title="mipac.http.HTTPClient"><span class="pre">HTTPClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">route</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#mipac.http.Route" title="mipac.http.Route"><span class="pre">Route</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">json</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">auth</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">remove_none</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lower</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pagination_type</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Literal</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'until'</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'count'</span></span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'until'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">100</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.utils.pagination.Pagination" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="bool-to-string">
|
|
|
<h3>bool_to_string<a class="headerlink" href="#bool-to-string" title="Link to this heading">#</a></h3>
|
|
|
<dl class="py function">
|
|
|
<dt class="sig sig-object py" id="mipac.utils.format.bool_to_string">
|
|
|
<span class="sig-prename descclassname"><span class="pre">mipac.utils.format.</span></span><span class="sig-name descname"><span class="pre">bool_to_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">boolean</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#mipac.utils.format.bool_to_string" title="Link to this definition">#</a></dt>
|
|
|
<dd><p>boolを小文字にして文字列として返します</p>
|
|
|
<dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>boolean</strong> (<em>bool</em>) – 変更したいbool値</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p><strong>true or false</strong> – 小文字になったbool文字列</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>str</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="convert-dict-keys-to-camel">
|
|
|
<h3>convert_dict_keys_to_camel<a class="headerlink" href="#convert-dict-keys-to-camel" title="Link to this heading">#</a></h3>
|
|
|
<dl class="py function">
|
|
|
<dt class="sig sig-object py" id="mipac.utils.format.convert_dict_keys_to_camel">
|
|
|
<span class="sig-prename descclassname"><span class="pre">mipac.utils.format.</span></span><span class="sig-name descname"><span class="pre">convert_dict_keys_to_camel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Mapping</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">replace_list</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Mapping</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.utils.format.convert_dict_keys_to_camel" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="remove-dict-empty">
|
|
|
<h3>remove_dict_empty<a class="headerlink" href="#remove-dict-empty" title="Link to this heading">#</a></h3>
|
|
|
<dl class="py function">
|
|
|
<dt class="sig sig-object py" id="mipac.utils.format.remove_dict_empty">
|
|
|
<span class="sig-prename descclassname"><span class="pre">mipac.utils.format.</span></span><span class="sig-name descname"><span class="pre">remove_dict_empty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignore_keys</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.utils.format.remove_dict_empty" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>data</strong> (<em>dict</em>) – 空のkeyを削除したいdict</p></li>
|
|
|
<li><p><strong>ignore_keys</strong> (<em>list</em>) – 削除したくないkeyのリスト</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p><strong>_data</strong> – 空のkeyがなくなったdict</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>dict</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="remove-dict-missing">
|
|
|
<h3>remove_dict_missing<a class="headerlink" href="#remove-dict-missing" title="Link to this heading">#</a></h3>
|
|
|
<dl class="py function">
|
|
|
<dt class="sig sig-object py" id="mipac.utils.format.remove_dict_missing">
|
|
|
<span class="sig-prename descclassname"><span class="pre">mipac.utils.format.</span></span><span class="sig-name descname"><span class="pre">remove_dict_missing</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.utils.format.remove_dict_missing" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>data</strong> (<em>dict</em>) – 空のkeyを削除したいdict</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p><strong>_data</strong> – MISSINGのkeyがなくなったdict</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>dict</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="remove-list-empty">
|
|
|
<h3>remove_list_empty<a class="headerlink" href="#remove-list-empty" title="Link to this heading">#</a></h3>
|
|
|
<dl class="py function">
|
|
|
<dt class="sig sig-object py" id="mipac.utils.format.remove_list_empty">
|
|
|
<span class="sig-prename descclassname"><span class="pre">mipac.utils.format.</span></span><span class="sig-name descname"><span class="pre">remove_list_empty</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.utils.format.remove_list_empty" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p><strong>data</strong> (<em>dict</em>) – 空のkeyを削除したいdict</p>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>空のkeyがなくなったdict</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>dict[str, Any]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="snake-to-camel">
|
|
|
<h3>snake_to_camel<a class="headerlink" href="#snake-to-camel" title="Link to this heading">#</a></h3>
|
|
|
<dl class="py function">
|
|
|
<dt class="sig sig-object py" id="mipac.utils.format.snake_to_camel">
|
|
|
<span class="sig-prename descclassname"><span class="pre">mipac.utils.format.</span></span><span class="sig-name descname"><span class="pre">snake_to_camel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">snake_str</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">replace_list</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#mipac.utils.format.snake_to_camel" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="str-lower">
|
|
|
<h3>str_lower<a class="headerlink" href="#str-lower" title="Link to this heading">#</a></h3>
|
|
|
<dl class="py function">
|
|
|
<dt class="sig sig-object py" id="mipac.utils.format.str_lower">
|
|
|
<span class="sig-prename descclassname"><span class="pre">mipac.utils.format.</span></span><span class="sig-name descname"><span class="pre">str_lower</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mipac.utils.format.str_lower" title="Link to this definition">#</a></dt>
|
|
|
<dd></dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="str-to-datetime">
|
|
|
<h3>str_to_datetime<a class="headerlink" href="#str-to-datetime" title="Link to this heading">#</a></h3>
|
|
|
<dl class="py function">
|
|
|
<dt class="sig sig-object py" id="mipac.utils.format.str_to_datetime">
|
|
|
<span class="sig-prename descclassname"><span class="pre">mipac.utils.format.</span></span><span class="sig-name descname"><span class="pre">str_to_datetime</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">format</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'%Y-%m-%dT%H:%M:%S.%fZ'</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">datetime</span></span></span><a class="headerlink" href="#mipac.utils.format.str_to_datetime" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>data</strong> (<em>str</em>) – datetimeに変更したい文字列</p></li>
|
|
|
<li><p><strong>format</strong> (<em>str</em>) – dataのフォーマット</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p>変換後のデータ</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>datetime</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
<section id="upper-to-lower">
|
|
|
<h3>upper_to_lower<a class="headerlink" href="#upper-to-lower" title="Link to this heading">#</a></h3>
|
|
|
<dl class="py function">
|
|
|
<dt class="sig sig-object py" id="mipac.utils.format.upper_to_lower">
|
|
|
<span class="sig-prename descclassname"><span class="pre">mipac.utils.format.</span></span><span class="sig-name descname"><span class="pre">upper_to_lower</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">field</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nest</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">replace_list</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#mipac.utils.format.upper_to_lower" title="Link to this definition">#</a></dt>
|
|
|
<dd><dl class="field-list simple">
|
|
|
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><ul class="simple">
|
|
|
<li><p><strong>data</strong> (<em>dict</em><em>[</em><em>str</em><em>, </em><em>Any</em><em>]</em>) – 小文字にしたいkeyがあるdict</p></li>
|
|
|
<li><p><strong>field</strong> (<em>dict</em><em>[</em><em>str</em><em>, </em><em>Any</em><em>] </em><em>| </em><em>None</em><em>, </em><em>default=None</em>) – 謎</p></li>
|
|
|
<li><p><strong>nest</strong> (<em>bool</em><em>, </em><em>default=True</em>) – ネストされたdictのkeyも小文字にするか否か</p></li>
|
|
|
<li><p><strong>replace_list</strong> (<em>dict</em><em>[</em><em>str</em><em>, </em><em>Any</em><em>] </em><em>| </em><em>None</em><em>, </em><em>default=None</em>) – dictのkey名を特定の物に置き換える</p></li>
|
|
|
</ul>
|
|
|
</dd>
|
|
|
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
|
|
<dd class="field-even"><p><strong>field</strong> – 小文字になった, key名が変更されたdict</p>
|
|
|
</dd>
|
|
|
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
|
|
<dd class="field-odd"><p>dict[str, Any]</p>
|
|
|
</dd>
|
|
|
</dl>
|
|
|
</dd></dl>
|
|
|
|
|
|
</section>
|
|
|
</section>
|
|
|
</section>
|
|
|
|
|
|
</article>
|
|
|
</div>
|
|
|
<footer>
|
|
|
|
|
|
<div class="related-pages">
|
|
|
|
|
|
|
|
|
</div>
|
|
|
<div class="bottom-of-page">
|
|
|
<div class="left-details">
|
|
|
<div class="copyright">
|
|
|
Copyright © 2023, yupix
|
|
|
</div>
|
|
|
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
|
|
|
|
|
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
|
|
|
|
|
</div>
|
|
|
<div class="right-details">
|
|
|
|
|
|
</div>
|
|
|
</div>
|
|
|
|
|
|
</footer>
|
|
|
</div>
|
|
|
<aside class="toc-drawer">
|
|
|
|
|
|
|
|
|
<div class="toc-sticky toc-scroll">
|
|
|
<div class="toc-title-container">
|
|
|
<span class="toc-title">
|
|
|
On this page
|
|
|
</span>
|
|
|
</div>
|
|
|
<div class="toc-tree-container">
|
|
|
<div class="toc-tree">
|
|
|
<ul>
|
|
|
<li><a class="reference internal" href="#">API Reference</a><ul>
|
|
|
<li><a class="reference internal" href="#misskey-models">Misskey Models</a><ul>
|
|
|
<li><a class="reference internal" href="#blocking">Blocking</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.blocking.Blocking"><code class="docutils literal notranslate"><span class="pre">Blocking</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.blocking.Blocking.api"><code class="docutils literal notranslate"><span class="pre">Blocking.api</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.blocking.Blocking.blockee"><code class="docutils literal notranslate"><span class="pre">Blocking.blockee</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.blocking.Blocking.blockee_id"><code class="docutils literal notranslate"><span class="pre">Blocking.blockee_id</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.blocking.Blocking.created_at"><code class="docutils literal notranslate"><span class="pre">Blocking.created_at</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.blocking.Blocking.id"><code class="docutils literal notranslate"><span class="pre">Blocking.id</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#invitecode">InviteCode</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.invite.InviteCode"><code class="docutils literal notranslate"><span class="pre">InviteCode</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#invitelimit">InviteLimit</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.invite.InviteLimit"><code class="docutils literal notranslate"><span class="pre">InviteLimit</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#gallerypost">GalleryPost</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.gallery.GalleryPost"><code class="docutils literal notranslate"><span class="pre">GalleryPost</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#muteduser">MutedUser</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.mute.MutedUser"><code class="docutils literal notranslate"><span class="pre">MutedUser</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#followrequest">FollowRequest</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.follow.FollowRequest"><code class="docutils literal notranslate"><span class="pre">FollowRequest</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#announcement">Announcement</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.announcement.Announcement"><code class="docutils literal notranslate"><span class="pre">Announcement</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#announcementdetailed">AnnouncementDetailed</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.announcement.AnnouncementDetailed"><code class="docutils literal notranslate"><span class="pre">AnnouncementDetailed</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.announcement.AnnouncementDetailed.reads"><code class="docutils literal notranslate"><span class="pre">AnnouncementDetailed.reads</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#header">Header</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Header"><code class="docutils literal notranslate"><span class="pre">Header</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#note">Note</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note"><code class="docutils literal notranslate"><span class="pre">Note</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.api"><code class="docutils literal notranslate"><span class="pre">Note.api</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.author"><code class="docutils literal notranslate"><span class="pre">Note.author</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.channel"><code class="docutils literal notranslate"><span class="pre">Note.channel</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.channel_id"><code class="docutils literal notranslate"><span class="pre">Note.channel_id</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.clipped_count"><code class="docutils literal notranslate"><span class="pre">Note.clipped_count</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.content"><code class="docutils literal notranslate"><span class="pre">Note.content</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.created_at"><code class="docutils literal notranslate"><span class="pre">Note.created_at</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.cw"><code class="docutils literal notranslate"><span class="pre">Note.cw</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.deleted_at"><code class="docutils literal notranslate"><span class="pre">Note.deleted_at</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.emojis"><code class="docutils literal notranslate"><span class="pre">Note.emojis</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.file_ids"><code class="docutils literal notranslate"><span class="pre">Note.file_ids</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.files"><code class="docutils literal notranslate"><span class="pre">Note.files</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.id"><code class="docutils literal notranslate"><span class="pre">Note.id</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.is_hidden"><code class="docutils literal notranslate"><span class="pre">Note.is_hidden</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.local_only"><code class="docutils literal notranslate"><span class="pre">Note.local_only</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.mentions"><code class="docutils literal notranslate"><span class="pre">Note.mentions</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.my_reaction"><code class="docutils literal notranslate"><span class="pre">Note.my_reaction</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.poll"><code class="docutils literal notranslate"><span class="pre">Note.poll</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.reaction_acceptance"><code class="docutils literal notranslate"><span class="pre">Note.reaction_acceptance</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.reaction_and_user_pair_cache"><code class="docutils literal notranslate"><span class="pre">Note.reaction_and_user_pair_cache</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.reactions"><code class="docutils literal notranslate"><span class="pre">Note.reactions</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.renote"><code class="docutils literal notranslate"><span class="pre">Note.renote</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.renote_count"><code class="docutils literal notranslate"><span class="pre">Note.renote_count</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.renote_id"><code class="docutils literal notranslate"><span class="pre">Note.renote_id</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.replies_count"><code class="docutils literal notranslate"><span class="pre">Note.replies_count</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.reply"><code class="docutils literal notranslate"><span class="pre">Note.reply</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.reply_id"><code class="docutils literal notranslate"><span class="pre">Note.reply_id</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.tags"><code class="docutils literal notranslate"><span class="pre">Note.tags</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.text"><code class="docutils literal notranslate"><span class="pre">Note.text</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.uri"><code class="docutils literal notranslate"><span class="pre">Note.uri</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.url"><code class="docutils literal notranslate"><span class="pre">Note.url</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.user"><code class="docutils literal notranslate"><span class="pre">Note.user</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.user_id"><code class="docutils literal notranslate"><span class="pre">Note.user_id</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.visibility"><code class="docutils literal notranslate"><span class="pre">Note.visibility</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.Note.visible_user_ids"><code class="docutils literal notranslate"><span class="pre">Note.visible_user_ids</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#notechannel">NoteChannel</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.NoteChannel"><code class="docutils literal notranslate"><span class="pre">NoteChannel</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.NoteChannel.allow_renote_to_external"><code class="docutils literal notranslate"><span class="pre">NoteChannel.allow_renote_to_external</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.NoteChannel.color"><code class="docutils literal notranslate"><span class="pre">NoteChannel.color</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.NoteChannel.id"><code class="docutils literal notranslate"><span class="pre">NoteChannel.id</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.NoteChannel.is_sensitive"><code class="docutils literal notranslate"><span class="pre">NoteChannel.is_sensitive</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.NoteChannel.name"><code class="docutils literal notranslate"><span class="pre">NoteChannel.name</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.NoteChannel.user_id"><code class="docutils literal notranslate"><span class="pre">NoteChannel.user_id</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#notedeleted">NoteDeleted</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.NoteDeleted"><code class="docutils literal notranslate"><span class="pre">NoteDeleted</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#notereaction">NoteReaction</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.NoteReaction"><code class="docutils literal notranslate"><span class="pre">NoteReaction</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.NoteReaction.created_at"><code class="docutils literal notranslate"><span class="pre">NoteReaction.created_at</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.NoteReaction.id"><code class="docutils literal notranslate"><span class="pre">NoteReaction.id</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.NoteReaction.type"><code class="docutils literal notranslate"><span class="pre">NoteReaction.type</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.NoteReaction.user"><code class="docutils literal notranslate"><span class="pre">NoteReaction.user</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#notestate">NoteState</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.NoteState"><code class="docutils literal notranslate"><span class="pre">NoteState</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#notetranslateresult">NoteTranslateResult</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.note.NoteTranslateResult"><code class="docutils literal notranslate"><span class="pre">NoteTranslateResult</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#notification">Notification</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.notification.Notification"><code class="docutils literal notranslate"><span class="pre">Notification</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#notificationachievement">NotificationAchievement</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.notification.NotificationAchievement"><code class="docutils literal notranslate"><span class="pre">NotificationAchievement</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#notificationfollow">NotificationFollow</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.notification.NotificationFollow"><code class="docutils literal notranslate"><span class="pre">NotificationFollow</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#notificationfollowrequest">NotificationFollowRequest</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.notification.NotificationFollowRequest"><code class="docutils literal notranslate"><span class="pre">NotificationFollowRequest</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#notificationnote">NotificationNote</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.notification.NotificationNote"><code class="docutils literal notranslate"><span class="pre">NotificationNote</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#notificationpollend">NotificationPollEnd</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.notification.NotificationPollEnd"><code class="docutils literal notranslate"><span class="pre">NotificationPollEnd</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#notificationreaction">NotificationReaction</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.notification.NotificationReaction"><code class="docutils literal notranslate"><span class="pre">NotificationReaction</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#customemoji">CustomEmoji</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.emoji.CustomEmoji"><code class="docutils literal notranslate"><span class="pre">CustomEmoji</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#emojidetailed">EmojiDetailed</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.emoji.EmojiDetailed"><code class="docutils literal notranslate"><span class="pre">EmojiDetailed</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#emojisimple">EmojiSimple</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.emoji.EmojiSimple"><code class="docutils literal notranslate"><span class="pre">EmojiSimple</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clip">Clip</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.clip.Clip"><code class="docutils literal notranslate"><span class="pre">Clip</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.clip.Clip.created_at"><code class="docutils literal notranslate"><span class="pre">Clip.created_at</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.clip.Clip.description"><code class="docutils literal notranslate"><span class="pre">Clip.description</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.clip.Clip.favorited_count"><code class="docutils literal notranslate"><span class="pre">Clip.favorited_count</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.clip.Clip.id"><code class="docutils literal notranslate"><span class="pre">Clip.id</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.clip.Clip.is_favorited"><code class="docutils literal notranslate"><span class="pre">Clip.is_favorited</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.clip.Clip.is_public"><code class="docutils literal notranslate"><span class="pre">Clip.is_public</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.clip.Clip.last_clipped_at"><code class="docutils literal notranslate"><span class="pre">Clip.last_clipped_at</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.clip.Clip.name"><code class="docutils literal notranslate"><span class="pre">Clip.name</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.clip.Clip.user"><code class="docutils literal notranslate"><span class="pre">Clip.user</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.clip.Clip.user_id"><code class="docutils literal notranslate"><span class="pre">Clip.user_id</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#partialreaction">PartialReaction</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.reaction.PartialReaction"><code class="docutils literal notranslate"><span class="pre">PartialReaction</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#channel">Channel</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.channel.Channel"><code class="docutils literal notranslate"><span class="pre">Channel</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.channel.Channel.allow_renote_to_external"><code class="docutils literal notranslate"><span class="pre">Channel.allow_renote_to_external</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.channel.Channel.api"><code class="docutils literal notranslate"><span class="pre">Channel.api</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.channel.Channel.banner_url"><code class="docutils literal notranslate"><span class="pre">Channel.banner_url</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.channel.Channel.color"><code class="docutils literal notranslate"><span class="pre">Channel.color</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.channel.Channel.created_at"><code class="docutils literal notranslate"><span class="pre">Channel.created_at</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.channel.Channel.description"><code class="docutils literal notranslate"><span class="pre">Channel.description</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.channel.Channel.id"><code class="docutils literal notranslate"><span class="pre">Channel.id</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.channel.Channel.is_archived"><code class="docutils literal notranslate"><span class="pre">Channel.is_archived</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.channel.Channel.is_favorited"><code class="docutils literal notranslate"><span class="pre">Channel.is_favorited</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.channel.Channel.is_following"><code class="docutils literal notranslate"><span class="pre">Channel.is_following</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.channel.Channel.is_sensitive"><code class="docutils literal notranslate"><span class="pre">Channel.is_sensitive</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.channel.Channel.last_noted_at"><code class="docutils literal notranslate"><span class="pre">Channel.last_noted_at</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.channel.Channel.name"><code class="docutils literal notranslate"><span class="pre">Channel.name</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.channel.Channel.notes_count"><code class="docutils literal notranslate"><span class="pre">Channel.notes_count</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.channel.Channel.pinned_note_ids"><code class="docutils literal notranslate"><span class="pre">Channel.pinned_note_ids</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.channel.Channel.pinned_notes"><code class="docutils literal notranslate"><span class="pre">Channel.pinned_notes</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.channel.Channel.user_id"><code class="docutils literal notranslate"><span class="pre">Channel.user_id</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.channel.Channel.users_count"><code class="docutils literal notranslate"><span class="pre">Channel.users_count</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#indexstat">IndexStat</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.admin.IndexStat"><code class="docutils literal notranslate"><span class="pre">IndexStat</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#moderationlog">ModerationLog</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.admin.ModerationLog"><code class="docutils literal notranslate"><span class="pre">ModerationLog</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#serverinfo">ServerInfo</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.admin.ServerInfo"><code class="docutils literal notranslate"><span class="pre">ServerInfo</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#serverinfocpu">ServerInfoCpu</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.admin.ServerInfoCpu"><code class="docutils literal notranslate"><span class="pre">ServerInfoCpu</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#serverinfofs">ServerInfoFs</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.admin.ServerInfoFs"><code class="docutils literal notranslate"><span class="pre">ServerInfoFs</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#serverinfomem">ServerInfoMem</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.admin.ServerInfoMem"><code class="docutils literal notranslate"><span class="pre">ServerInfoMem</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#serverinfonet">ServerInfoNet</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.admin.ServerInfoNet"><code class="docutils literal notranslate"><span class="pre">ServerInfoNet</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#userip">UserIP</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.admin.UserIP"><code class="docutils literal notranslate"><span class="pre">UserIP</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#usernameavailable">UsernameAvailable</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.username.UsernameAvailable"><code class="docutils literal notranslate"><span class="pre">UsernameAvailable</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#activeuserschart">ActiveUsersChart</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.chart.ActiveUsersChart"><code class="docutils literal notranslate"><span class="pre">ActiveUsersChart</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#drivechart">DriveChart</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.chart.DriveChart"><code class="docutils literal notranslate"><span class="pre">DriveChart</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#drivelocalchart">DriveLocalChart</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.chart.DriveLocalChart"><code class="docutils literal notranslate"><span class="pre">DriveLocalChart</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#driveremotechart">DriveRemoteChart</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.chart.DriveRemoteChart"><code class="docutils literal notranslate"><span class="pre">DriveRemoteChart</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#drivestatus">DriveStatus</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.drive.DriveStatus"><code class="docutils literal notranslate"><span class="pre">DriveStatus</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.drive.DriveStatus.capacity"><code class="docutils literal notranslate"><span class="pre">DriveStatus.capacity</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.drive.DriveStatus.usage"><code class="docutils literal notranslate"><span class="pre">DriveStatus.usage</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#file">File</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.drive.File"><code class="docutils literal notranslate"><span class="pre">File</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#fileproperties">FileProperties</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.drive.FileProperties"><code class="docutils literal notranslate"><span class="pre">FileProperties</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#folder">Folder</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.drive.Folder"><code class="docutils literal notranslate"><span class="pre">Folder</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#antenna">Antenna</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.antenna.Antenna"><code class="docutils literal notranslate"><span class="pre">Antenna</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#ad">Ad</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.ad.Ad"><code class="docutils literal notranslate"><span class="pre">Ad</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#federationinstance">FederationInstance</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.instance.FederationInstance"><code class="docutils literal notranslate"><span class="pre">FederationInstance</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#mipoll">MiPoll</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.poll.MiPoll"><code class="docutils literal notranslate"><span class="pre">MiPoll</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#poll">Poll</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.poll.Poll"><code class="docutils literal notranslate"><span class="pre">Poll</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#pollchoice">PollChoice</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.poll.PollChoice"><code class="docutils literal notranslate"><span class="pre">PollChoice</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#merole">MeRole</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.roles.MeRole"><code class="docutils literal notranslate"><span class="pre">MeRole</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#role">Role</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.roles.Role"><code class="docutils literal notranslate"><span class="pre">Role</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#rolepolicies">RolePolicies</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.roles.RolePolicies"><code class="docutils literal notranslate"><span class="pre">RolePolicies</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#roleuser">RoleUser</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.roles.RoleUser"><code class="docutils literal notranslate"><span class="pre">RoleUser</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#packed-user">packed_user</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.user.packed_user"><code class="docutils literal notranslate"><span class="pre">packed_user()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#achievement">Achievement</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.user.Achievement"><code class="docutils literal notranslate"><span class="pre">Achievement</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#followcommon">FollowCommon</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.user.FollowCommon"><code class="docutils literal notranslate"><span class="pre">FollowCommon</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#follower">Follower</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.user.Follower"><code class="docutils literal notranslate"><span class="pre">Follower</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#following">Following</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.user.Following"><code class="docutils literal notranslate"><span class="pre">Following</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#frequentlyreplieduser">FrequentlyRepliedUser</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.user.FrequentlyRepliedUser"><code class="docutils literal notranslate"><span class="pre">FrequentlyRepliedUser</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#medetailed">MeDetailed</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.user.MeDetailed"><code class="docutils literal notranslate"><span class="pre">MeDetailed</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#medetailedonly">MeDetailedOnly</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.user.MeDetailedOnly"><code class="docutils literal notranslate"><span class="pre">MeDetailedOnly</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#userdetailednotme">UserDetailedNotMe</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.user.UserDetailedNotMe"><code class="docutils literal notranslate"><span class="pre">UserDetailedNotMe</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#userdetailednotmeonly">UserDetailedNotMeOnly</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.user.UserDetailedNotMeOnly"><code class="docutils literal notranslate"><span class="pre">UserDetailedNotMeOnly</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#userfield">UserField</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.user.UserField"><code class="docutils literal notranslate"><span class="pre">UserField</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#userlist">UserList</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.user.UserList"><code class="docutils literal notranslate"><span class="pre">UserList</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#userlistmembership">UserListMembership</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.user.UserListMembership"><code class="docutils literal notranslate"><span class="pre">UserListMembership</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#adminmeta">AdminMeta</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.meta.AdminMeta"><code class="docutils literal notranslate"><span class="pre">AdminMeta</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#features">Features</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.meta.Features"><code class="docutils literal notranslate"><span class="pre">Features</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#meta">Meta</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.meta.Meta"><code class="docutils literal notranslate"><span class="pre">Meta</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#partialcustomemoji">PartialCustomEmoji</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.emoji.PartialCustomEmoji"><code class="docutils literal notranslate"><span class="pre">PartialCustomEmoji</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#partialrole">PartialRole</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.role.PartialRole"><code class="docutils literal notranslate"><span class="pre">PartialRole</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#partialad">PartialAd</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.ad.PartialAd"><code class="docutils literal notranslate"><span class="pre">PartialAd</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#liteinstance">LiteInstance</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.instance.LiteInstance"><code class="docutils literal notranslate"><span class="pre">LiteInstance</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#avatardecoration">AvatarDecoration</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.user.AvatarDecoration"><code class="docutils literal notranslate"><span class="pre">AvatarDecoration</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.user.AvatarDecoration.angle"><code class="docutils literal notranslate"><span class="pre">AvatarDecoration.angle</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.user.AvatarDecoration.flip_h"><code class="docutils literal notranslate"><span class="pre">AvatarDecoration.flip_h</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.user.AvatarDecoration.id"><code class="docutils literal notranslate"><span class="pre">AvatarDecoration.id</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.user.AvatarDecoration.offset_x"><code class="docutils literal notranslate"><span class="pre">AvatarDecoration.offset_x</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.user.AvatarDecoration.offset_y"><code class="docutils literal notranslate"><span class="pre">AvatarDecoration.offset_y</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.user.AvatarDecoration.url"><code class="docutils literal notranslate"><span class="pre">AvatarDecoration.url</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#badgerole">BadgeRole</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.user.BadgeRole"><code class="docutils literal notranslate"><span class="pre">BadgeRole</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.user.BadgeRole.display_order"><code class="docutils literal notranslate"><span class="pre">BadgeRole.display_order</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.user.BadgeRole.icon_url"><code class="docutils literal notranslate"><span class="pre">BadgeRole.icon_url</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.user.BadgeRole.name"><code class="docutils literal notranslate"><span class="pre">BadgeRole.name</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#partialuser">PartialUser</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.user.PartialUser"><code class="docutils literal notranslate"><span class="pre">PartialUser</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.user.PartialUser.api"><code class="docutils literal notranslate"><span class="pre">PartialUser.api</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.user.PartialUser.avatar_blurhash"><code class="docutils literal notranslate"><span class="pre">PartialUser.avatar_blurhash</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.user.PartialUser.avatar_decoration"><code class="docutils literal notranslate"><span class="pre">PartialUser.avatar_decoration</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.user.PartialUser.avatar_url"><code class="docutils literal notranslate"><span class="pre">PartialUser.avatar_url</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.user.PartialUser.badge_roles"><code class="docutils literal notranslate"><span class="pre">PartialUser.badge_roles</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.user.PartialUser.emojis"><code class="docutils literal notranslate"><span class="pre">PartialUser.emojis</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.user.PartialUser.host"><code class="docutils literal notranslate"><span class="pre">PartialUser.host</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.user.PartialUser.id"><code class="docutils literal notranslate"><span class="pre">PartialUser.id</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.user.PartialUser.instance"><code class="docutils literal notranslate"><span class="pre">PartialUser.instance</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.user.PartialUser.is_bot"><code class="docutils literal notranslate"><span class="pre">PartialUser.is_bot</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.user.PartialUser.is_cat"><code class="docutils literal notranslate"><span class="pre">PartialUser.is_cat</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.user.PartialUser.name"><code class="docutils literal notranslate"><span class="pre">PartialUser.name</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.user.PartialUser.nickname"><code class="docutils literal notranslate"><span class="pre">PartialUser.nickname</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.user.PartialUser.online_status"><code class="docutils literal notranslate"><span class="pre">PartialUser.online_status</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.user.PartialUser.username"><code class="docutils literal notranslate"><span class="pre">PartialUser.username</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#partialmeta">PartialMeta</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.meta.PartialMeta"><code class="docutils literal notranslate"><span class="pre">PartialMeta</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#policies">Policies</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.meta.Policies"><code class="docutils literal notranslate"><span class="pre">Policies</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.meta.Policies.can_edit_note"><code class="docutils literal notranslate"><span class="pre">Policies.can_edit_note</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.meta.Policies.can_hide_ads"><code class="docutils literal notranslate"><span class="pre">Policies.can_hide_ads</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.meta.Policies.can_invite"><code class="docutils literal notranslate"><span class="pre">Policies.can_invite</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.meta.Policies.can_manage_custom_emojis"><code class="docutils literal notranslate"><span class="pre">Policies.can_manage_custom_emojis</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.meta.Policies.can_public_note"><code class="docutils literal notranslate"><span class="pre">Policies.can_public_note</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.meta.Policies.can_search_notes"><code class="docutils literal notranslate"><span class="pre">Policies.can_search_notes</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.meta.Policies.can_use_translator"><code class="docutils literal notranslate"><span class="pre">Policies.can_use_translator</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.meta.Policies.gtl_available"><code class="docutils literal notranslate"><span class="pre">Policies.gtl_available</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.models.lite.meta.Policies.ltl_available"><code class="docutils literal notranslate"><span class="pre">Policies.ltl_available</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#managers">Managers</a><ul>
|
|
|
<li><a class="reference internal" href="#blockingmanager">BlockingManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.blocking.BlockingManager"><code class="docutils literal notranslate"><span class="pre">BlockingManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientblockingmanager">ClientBlockingManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.blocking.ClientBlockingManager"><code class="docutils literal notranslate"><span class="pre">ClientBlockingManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientinvitemanager">ClientInviteManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.invite.ClientInviteManager"><code class="docutils literal notranslate"><span class="pre">ClientInviteManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#invitemanager">InviteManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.invite.InviteManager"><code class="docutils literal notranslate"><span class="pre">InviteManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#followmanager">FollowManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.follow.FollowManager"><code class="docutils literal notranslate"><span class="pre">FollowManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#followrequestmanager">FollowRequestManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.follow.FollowRequestManager"><code class="docutils literal notranslate"><span class="pre">FollowRequestManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientnotemanager">ClientNoteManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.note.ClientNoteManager"><code class="docutils literal notranslate"><span class="pre">ClientNoteManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#notemanager">NoteManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.note.NoteManager"><code class="docutils literal notranslate"><span class="pre">NoteManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#emojimanager">EmojiManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.emoji.EmojiManager"><code class="docutils literal notranslate"><span class="pre">EmojiManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientclipmanager">ClientClipManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.clip.ClientClipManager"><code class="docutils literal notranslate"><span class="pre">ClientClipManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clipmanager">ClipManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.clip.ClipManager"><code class="docutils literal notranslate"><span class="pre">ClipManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#federationmanager">FederationManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.federation.FederationManager"><code class="docutils literal notranslate"><span class="pre">FederationManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientreactionmanager">ClientReactionManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.reaction.ClientReactionManager"><code class="docutils literal notranslate"><span class="pre">ClientReactionManager</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.reaction.ClientReactionManager.action"><code class="docutils literal notranslate"><span class="pre">ClientReactionManager.action</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#reactionmanager">ReactionManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.reaction.ReactionManager"><code class="docutils literal notranslate"><span class="pre">ReactionManager</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.reaction.ReactionManager.action"><code class="docutils literal notranslate"><span class="pre">ReactionManager.action</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#channelmanager">ChannelManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.channel.ChannelManager"><code class="docutils literal notranslate"><span class="pre">ChannelManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientchannelmanager">ClientChannelManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.channel.ClientChannelManager"><code class="docutils literal notranslate"><span class="pre">ClientChannelManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#rolemanager">RoleManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.role.RoleManager"><code class="docutils literal notranslate"><span class="pre">RoleManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#usernamemanager">UsernameManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.username.UsernameManager"><code class="docutils literal notranslate"><span class="pre">UsernameManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#chartmanager">ChartManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.chart.ChartManager"><code class="docutils literal notranslate"><span class="pre">ChartManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#antennamanager">AntennaManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.antenna.AntennaManager"><code class="docutils literal notranslate"><span class="pre">AntennaManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientantennamanager">ClientAntennaManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.antenna.ClientAntennaManager"><code class="docutils literal notranslate"><span class="pre">ClientAntennaManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#pagesmanager">PagesManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.page.PagesManager"><code class="docutils literal notranslate"><span class="pre">PagesManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientpollmanager">ClientPollManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.poll.ClientPollManager"><code class="docutils literal notranslate"><span class="pre">ClientPollManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#pollmanager">PollManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.poll.PollManager"><code class="docutils literal notranslate"><span class="pre">PollManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#mymanager">MyManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.my.MyManager"><code class="docutils literal notranslate"><span class="pre">MyManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientfavoritemanager">ClientFavoriteManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.favorite.ClientFavoriteManager"><code class="docutils literal notranslate"><span class="pre">ClientFavoriteManager</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.favorite.ClientFavoriteManager.action"><code class="docutils literal notranslate"><span class="pre">ClientFavoriteManager.action</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#favoritemanager">FavoriteManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.favorite.FavoriteManager"><code class="docutils literal notranslate"><span class="pre">FavoriteManager</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.favorite.FavoriteManager.action"><code class="docutils literal notranslate"><span class="pre">FavoriteManager.action</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientusermanager">ClientUserManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.user.ClientUserManager"><code class="docutils literal notranslate"><span class="pre">ClientUserManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#usermanager">UserManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.user.UserManager"><code class="docutils literal notranslate"><span class="pre">UserManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientmanager">ClientManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.client.ClientManager"><code class="docutils literal notranslate"><span class="pre">ClientManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientmutemanager">ClientMuteManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.users.mute.ClientMuteManager"><code class="docutils literal notranslate"><span class="pre">ClientMuteManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#mutemanager">MuteManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.users.mute.MuteManager"><code class="docutils literal notranslate"><span class="pre">MuteManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientpartialuserlistmanager">ClientPartialUserListManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.users.list.ClientPartialUserListManager"><code class="docutils literal notranslate"><span class="pre">ClientPartialUserListManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientuserlistmanager">ClientUserListManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.users.list.ClientUserListManager"><code class="docutils literal notranslate"><span class="pre">ClientUserListManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#userlistmanager">UserListManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.users.list.UserListManager"><code class="docutils literal notranslate"><span class="pre">UserListManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#admininvitemanager">AdminInviteManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.admins.invite.AdminInviteManager"><code class="docutils literal notranslate"><span class="pre">AdminInviteManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#adminannouncementmanager">AdminAnnouncementManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.admins.announcement.AdminAnnouncementManager"><code class="docutils literal notranslate"><span class="pre">AdminAnnouncementManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientadminannouncementmanager">ClientAdminAnnouncementManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.admins.announcement.ClientAdminAnnouncementManager"><code class="docutils literal notranslate"><span class="pre">ClientAdminAnnouncementManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#adminemojimanager">AdminEmojiManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.admins.emoji.AdminEmojiManager"><code class="docutils literal notranslate"><span class="pre">AdminEmojiManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#adminmanager">AdminManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.admins.admin.AdminManager"><code class="docutils literal notranslate"><span class="pre">AdminManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#admindrivemanager">AdminDriveManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.admins.drive.AdminDriveManager"><code class="docutils literal notranslate"><span class="pre">AdminDriveManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#adminadmanager">AdminAdManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.admins.ad.AdminAdManager"><code class="docutils literal notranslate"><span class="pre">AdminAdManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientadminadmanager">ClientAdminAdManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.admins.ad.ClientAdminAdManager"><code class="docutils literal notranslate"><span class="pre">ClientAdminAdManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#adminrolesmanager">AdminRolesManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.admins.roles.AdminRolesManager"><code class="docutils literal notranslate"><span class="pre">AdminRolesManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#adminrolesmodelmanager">AdminRolesModelManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.admins.roles.AdminRolesModelManager"><code class="docutils literal notranslate"><span class="pre">AdminRolesModelManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#adminusermanager">AdminUserManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.admins.user.AdminUserManager"><code class="docutils literal notranslate"><span class="pre">AdminUserManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientfoldermanager">ClientFolderManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.drive.folders.ClientFolderManager"><code class="docutils literal notranslate"><span class="pre">ClientFolderManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#foldermanager">FolderManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.drive.folders.FolderManager"><code class="docutils literal notranslate"><span class="pre">FolderManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#drivemanager">DriveManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.drive.drive.DriveManager"><code class="docutils literal notranslate"><span class="pre">DriveManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientfilemanager">ClientFileManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.drive.files.ClientFileManager"><code class="docutils literal notranslate"><span class="pre">ClientFileManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#drivefilemanager">DriveFileManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.manager.drive.files.DriveFileManager"><code class="docutils literal notranslate"><span class="pre">DriveFileManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#actions">Actions</a><ul>
|
|
|
<li><a class="reference internal" href="#blockingactions">BlockingActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.blocking.BlockingActions"><code class="docutils literal notranslate"><span class="pre">BlockingActions</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientblockingactions">ClientBlockingActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.blocking.ClientBlockingActions"><code class="docutils literal notranslate"><span class="pre">ClientBlockingActions</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#sharedblockingactions">SharedBlockingActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.blocking.SharedBlockingActions"><code class="docutils literal notranslate"><span class="pre">SharedBlockingActions</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientinviteactions">ClientInviteActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.invite.ClientInviteActions"><code class="docutils literal notranslate"><span class="pre">ClientInviteActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.invite.ClientInviteActions.delete"><code class="docutils literal notranslate"><span class="pre">ClientInviteActions.delete()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#inviteactions">InviteActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.invite.InviteActions"><code class="docutils literal notranslate"><span class="pre">InviteActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.invite.InviteActions.create"><code class="docutils literal notranslate"><span class="pre">InviteActions.create()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.invite.InviteActions.get_all_list"><code class="docutils literal notranslate"><span class="pre">InviteActions.get_all_list()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.invite.InviteActions.get_limit"><code class="docutils literal notranslate"><span class="pre">InviteActions.get_limit()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.invite.InviteActions.get_list"><code class="docutils literal notranslate"><span class="pre">InviteActions.get_list()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#sharedinviteactions">SharedInviteActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.invite.SharedInviteActions"><code class="docutils literal notranslate"><span class="pre">SharedInviteActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.invite.SharedInviteActions.delete"><code class="docutils literal notranslate"><span class="pre">SharedInviteActions.delete()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#followactions">FollowActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.follow.FollowActions"><code class="docutils literal notranslate"><span class="pre">FollowActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.follow.FollowActions.add"><code class="docutils literal notranslate"><span class="pre">FollowActions.add()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.follow.FollowActions.invalidate"><code class="docutils literal notranslate"><span class="pre">FollowActions.invalidate()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.follow.FollowActions.remove"><code class="docutils literal notranslate"><span class="pre">FollowActions.remove()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#followrequestactions">FollowRequestActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.follow.FollowRequestActions"><code class="docutils literal notranslate"><span class="pre">FollowRequestActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.follow.FollowRequestActions.accept"><code class="docutils literal notranslate"><span class="pre">FollowRequestActions.accept()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.follow.FollowRequestActions.cancel"><code class="docutils literal notranslate"><span class="pre">FollowRequestActions.cancel()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.follow.FollowRequestActions.get_all"><code class="docutils literal notranslate"><span class="pre">FollowRequestActions.get_all()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.follow.FollowRequestActions.reject"><code class="docutils literal notranslate"><span class="pre">FollowRequestActions.reject()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#create-note-body">create_note_body</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.create_note_body"><code class="docutils literal notranslate"><span class="pre">create_note_body()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientnoteactions">ClientNoteActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.ClientNoteActions"><code class="docutils literal notranslate"><span class="pre">ClientNoteActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.ClientNoteActions.add_clips"><code class="docutils literal notranslate"><span class="pre">ClientNoteActions.add_clips()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.ClientNoteActions.create_quote"><code class="docutils literal notranslate"><span class="pre">ClientNoteActions.create_quote()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.ClientNoteActions.create_renote"><code class="docutils literal notranslate"><span class="pre">ClientNoteActions.create_renote()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.ClientNoteActions.delete"><code class="docutils literal notranslate"><span class="pre">ClientNoteActions.delete()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.ClientNoteActions.fetch_children"><code class="docutils literal notranslate"><span class="pre">ClientNoteActions.fetch_children()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.ClientNoteActions.fetch_state"><code class="docutils literal notranslate"><span class="pre">ClientNoteActions.fetch_state()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.ClientNoteActions.get_all_children"><code class="docutils literal notranslate"><span class="pre">ClientNoteActions.get_all_children()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.ClientNoteActions.get_all_replies"><code class="docutils literal notranslate"><span class="pre">ClientNoteActions.get_all_replies()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.ClientNoteActions.get_clips"><code class="docutils literal notranslate"><span class="pre">ClientNoteActions.get_clips()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.ClientNoteActions.get_conversation"><code class="docutils literal notranslate"><span class="pre">ClientNoteActions.get_conversation()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.ClientNoteActions.get_renotes"><code class="docutils literal notranslate"><span class="pre">ClientNoteActions.get_renotes()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.ClientNoteActions.get_replies"><code class="docutils literal notranslate"><span class="pre">ClientNoteActions.get_replies()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.ClientNoteActions.get_state"><code class="docutils literal notranslate"><span class="pre">ClientNoteActions.get_state()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.ClientNoteActions.renote"><code class="docutils literal notranslate"><span class="pre">ClientNoteActions.renote()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.ClientNoteActions.translate"><code class="docutils literal notranslate"><span class="pre">ClientNoteActions.translate()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.ClientNoteActions.un_renote"><code class="docutils literal notranslate"><span class="pre">ClientNoteActions.un_renote()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#noteactions">NoteActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.NoteActions"><code class="docutils literal notranslate"><span class="pre">NoteActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.NoteActions.fetch"><code class="docutils literal notranslate"><span class="pre">NoteActions.fetch()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.NoteActions.get"><code class="docutils literal notranslate"><span class="pre">NoteActions.get()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.NoteActions.get_featured"><code class="docutils literal notranslate"><span class="pre">NoteActions.get_featured()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.NoteActions.get_global_time_line"><code class="docutils literal notranslate"><span class="pre">NoteActions.get_global_time_line()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.NoteActions.get_mentions"><code class="docutils literal notranslate"><span class="pre">NoteActions.get_mentions()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.NoteActions.get_time_line"><code class="docutils literal notranslate"><span class="pre">NoteActions.get_time_line()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.NoteActions.send"><code class="docutils literal notranslate"><span class="pre">NoteActions.send()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#sharednoteactions">SharedNoteActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.SharedNoteActions"><code class="docutils literal notranslate"><span class="pre">SharedNoteActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.SharedNoteActions.add_clips"><code class="docutils literal notranslate"><span class="pre">SharedNoteActions.add_clips()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.SharedNoteActions.create_quote"><code class="docutils literal notranslate"><span class="pre">SharedNoteActions.create_quote()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.SharedNoteActions.create_renote"><code class="docutils literal notranslate"><span class="pre">SharedNoteActions.create_renote()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.SharedNoteActions.delete"><code class="docutils literal notranslate"><span class="pre">SharedNoteActions.delete()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.SharedNoteActions.fetch_children"><code class="docutils literal notranslate"><span class="pre">SharedNoteActions.fetch_children()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.SharedNoteActions.fetch_state"><code class="docutils literal notranslate"><span class="pre">SharedNoteActions.fetch_state()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.SharedNoteActions.get_all_children"><code class="docutils literal notranslate"><span class="pre">SharedNoteActions.get_all_children()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.SharedNoteActions.get_all_replies"><code class="docutils literal notranslate"><span class="pre">SharedNoteActions.get_all_replies()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.SharedNoteActions.get_clips"><code class="docutils literal notranslate"><span class="pre">SharedNoteActions.get_clips()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.SharedNoteActions.get_conversation"><code class="docutils literal notranslate"><span class="pre">SharedNoteActions.get_conversation()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.SharedNoteActions.get_renotes"><code class="docutils literal notranslate"><span class="pre">SharedNoteActions.get_renotes()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.SharedNoteActions.get_replies"><code class="docutils literal notranslate"><span class="pre">SharedNoteActions.get_replies()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.SharedNoteActions.get_state"><code class="docutils literal notranslate"><span class="pre">SharedNoteActions.get_state()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.SharedNoteActions.renote"><code class="docutils literal notranslate"><span class="pre">SharedNoteActions.renote()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.SharedNoteActions.translate"><code class="docutils literal notranslate"><span class="pre">SharedNoteActions.translate()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.note.SharedNoteActions.un_renote"><code class="docutils literal notranslate"><span class="pre">SharedNoteActions.un_renote()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#emojiactions">EmojiActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.emoji.EmojiActions"><code class="docutils literal notranslate"><span class="pre">EmojiActions</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientclipactions">ClientClipActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.clip.ClientClipActions"><code class="docutils literal notranslate"><span class="pre">ClientClipActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.clip.ClientClipActions.add_note"><code class="docutils literal notranslate"><span class="pre">ClientClipActions.add_note()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.clip.ClientClipActions.delete"><code class="docutils literal notranslate"><span class="pre">ClientClipActions.delete()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.clip.ClientClipActions.get_notes"><code class="docutils literal notranslate"><span class="pre">ClientClipActions.get_notes()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.clip.ClientClipActions.remove_note"><code class="docutils literal notranslate"><span class="pre">ClientClipActions.remove_note()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.clip.ClientClipActions.update"><code class="docutils literal notranslate"><span class="pre">ClientClipActions.update()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clipactions">ClipActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.clip.ClipActions"><code class="docutils literal notranslate"><span class="pre">ClipActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.clip.ClipActions.create"><code class="docutils literal notranslate"><span class="pre">ClipActions.create()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.clip.ClipActions.get"><code class="docutils literal notranslate"><span class="pre">ClipActions.get()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.clip.ClipActions.get_list"><code class="docutils literal notranslate"><span class="pre">ClipActions.get_list()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.clip.ClipActions.get_my_favorites"><code class="docutils literal notranslate"><span class="pre">ClipActions.get_my_favorites()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#sharedclipactions">SharedClipActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.clip.SharedClipActions"><code class="docutils literal notranslate"><span class="pre">SharedClipActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.clip.SharedClipActions.add_note"><code class="docutils literal notranslate"><span class="pre">SharedClipActions.add_note()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.clip.SharedClipActions.delete"><code class="docutils literal notranslate"><span class="pre">SharedClipActions.delete()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.clip.SharedClipActions.get_notes"><code class="docutils literal notranslate"><span class="pre">SharedClipActions.get_notes()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.clip.SharedClipActions.remove_note"><code class="docutils literal notranslate"><span class="pre">SharedClipActions.remove_note()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.clip.SharedClipActions.update"><code class="docutils literal notranslate"><span class="pre">SharedClipActions.update()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#federationactions">FederationActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.federation.FederationActions"><code class="docutils literal notranslate"><span class="pre">FederationActions</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientreactionactions">ClientReactionActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.reaction.ClientReactionActions"><code class="docutils literal notranslate"><span class="pre">ClientReactionActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.reaction.ClientReactionActions.add"><code class="docutils literal notranslate"><span class="pre">ClientReactionActions.add()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.reaction.ClientReactionActions.remove"><code class="docutils literal notranslate"><span class="pre">ClientReactionActions.remove()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#reactionactions">ReactionActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.reaction.ReactionActions"><code class="docutils literal notranslate"><span class="pre">ReactionActions</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#sharedreactionactions">SharedReactionActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.reaction.SharedReactionActions"><code class="docutils literal notranslate"><span class="pre">SharedReactionActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.reaction.SharedReactionActions.add"><code class="docutils literal notranslate"><span class="pre">SharedReactionActions.add()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.reaction.SharedReactionActions.remove"><code class="docutils literal notranslate"><span class="pre">SharedReactionActions.remove()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#channelactions">ChannelActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.channel.ChannelActions"><code class="docutils literal notranslate"><span class="pre">ChannelActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.channel.ChannelActions.create"><code class="docutils literal notranslate"><span class="pre">ChannelActions.create()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.channel.ChannelActions.featured"><code class="docutils literal notranslate"><span class="pre">ChannelActions.featured()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.channel.ChannelActions.get_all_followed"><code class="docutils literal notranslate"><span class="pre">ChannelActions.get_all_followed()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.channel.ChannelActions.get_all_owned"><code class="docutils literal notranslate"><span class="pre">ChannelActions.get_all_owned()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.channel.ChannelActions.my_favorites"><code class="docutils literal notranslate"><span class="pre">ChannelActions.my_favorites()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.channel.ChannelActions.owned"><code class="docutils literal notranslate"><span class="pre">ChannelActions.owned()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.channel.ChannelActions.search"><code class="docutils literal notranslate"><span class="pre">ChannelActions.search()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.channel.ChannelActions.show"><code class="docutils literal notranslate"><span class="pre">ChannelActions.show()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientchannelactions">ClientChannelActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.channel.ClientChannelActions"><code class="docutils literal notranslate"><span class="pre">ClientChannelActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.channel.ClientChannelActions.favorite"><code class="docutils literal notranslate"><span class="pre">ClientChannelActions.favorite()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.channel.ClientChannelActions.follow"><code class="docutils literal notranslate"><span class="pre">ClientChannelActions.follow()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.channel.ClientChannelActions.get_all_timeline"><code class="docutils literal notranslate"><span class="pre">ClientChannelActions.get_all_timeline()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.channel.ClientChannelActions.send"><code class="docutils literal notranslate"><span class="pre">ClientChannelActions.send()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.channel.ClientChannelActions.timeline"><code class="docutils literal notranslate"><span class="pre">ClientChannelActions.timeline()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.channel.ClientChannelActions.unfavorite"><code class="docutils literal notranslate"><span class="pre">ClientChannelActions.unfavorite()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.channel.ClientChannelActions.unfollow"><code class="docutils literal notranslate"><span class="pre">ClientChannelActions.unfollow()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.channel.ClientChannelActions.update"><code class="docutils literal notranslate"><span class="pre">ClientChannelActions.update()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#sharedchannelactions">SharedChannelActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.channel.SharedChannelActions"><code class="docutils literal notranslate"><span class="pre">SharedChannelActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.channel.SharedChannelActions.favorite"><code class="docutils literal notranslate"><span class="pre">SharedChannelActions.favorite()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.channel.SharedChannelActions.follow"><code class="docutils literal notranslate"><span class="pre">SharedChannelActions.follow()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.channel.SharedChannelActions.get_all_timeline"><code class="docutils literal notranslate"><span class="pre">SharedChannelActions.get_all_timeline()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.channel.SharedChannelActions.send"><code class="docutils literal notranslate"><span class="pre">SharedChannelActions.send()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.channel.SharedChannelActions.timeline"><code class="docutils literal notranslate"><span class="pre">SharedChannelActions.timeline()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.channel.SharedChannelActions.unfavorite"><code class="docutils literal notranslate"><span class="pre">SharedChannelActions.unfavorite()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.channel.SharedChannelActions.unfollow"><code class="docutils literal notranslate"><span class="pre">SharedChannelActions.unfollow()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.channel.SharedChannelActions.update"><code class="docutils literal notranslate"><span class="pre">SharedChannelActions.update()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#roleactions">RoleActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.role.RoleActions"><code class="docutils literal notranslate"><span class="pre">RoleActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.role.RoleActions.get"><code class="docutils literal notranslate"><span class="pre">RoleActions.get()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.role.RoleActions.get_list"><code class="docutils literal notranslate"><span class="pre">RoleActions.get_list()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.role.RoleActions.get_notes"><code class="docutils literal notranslate"><span class="pre">RoleActions.get_notes()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.role.RoleActions.get_users"><code class="docutils literal notranslate"><span class="pre">RoleActions.get_users()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#usernameactions">UsernameActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.username.UsernameActions"><code class="docutils literal notranslate"><span class="pre">UsernameActions</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#chartactions">ChartActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.chart.ChartActions"><code class="docutils literal notranslate"><span class="pre">ChartActions</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#antennaactions">AntennaActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.antenna.AntennaActions"><code class="docutils literal notranslate"><span class="pre">AntennaActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.antenna.AntennaActions.create"><code class="docutils literal notranslate"><span class="pre">AntennaActions.create()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientantennaactions">ClientAntennaActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.antenna.ClientAntennaActions"><code class="docutils literal notranslate"><span class="pre">ClientAntennaActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.antenna.ClientAntennaActions.delete"><code class="docutils literal notranslate"><span class="pre">ClientAntennaActions.delete()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.antenna.ClientAntennaActions.show"><code class="docutils literal notranslate"><span class="pre">ClientAntennaActions.show()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.antenna.ClientAntennaActions.update"><code class="docutils literal notranslate"><span class="pre">ClientAntennaActions.update()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#sharedantennaactions">SharedAntennaActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.antenna.SharedAntennaActions"><code class="docutils literal notranslate"><span class="pre">SharedAntennaActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.antenna.SharedAntennaActions.delete"><code class="docutils literal notranslate"><span class="pre">SharedAntennaActions.delete()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.antenna.SharedAntennaActions.show"><code class="docutils literal notranslate"><span class="pre">SharedAntennaActions.show()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.antenna.SharedAntennaActions.update"><code class="docutils literal notranslate"><span class="pre">SharedAntennaActions.update()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientpollactions">ClientPollActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.poll.ClientPollActions"><code class="docutils literal notranslate"><span class="pre">ClientPollActions</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#pollactions">PollActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.poll.PollActions"><code class="docutils literal notranslate"><span class="pre">PollActions</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#sharedpollactions">SharedPollActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.poll.SharedPollActions"><code class="docutils literal notranslate"><span class="pre">SharedPollActions</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#myactions">MyActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.my.MyActions"><code class="docutils literal notranslate"><span class="pre">MyActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.my.MyActions.get_claim_achievement"><code class="docutils literal notranslate"><span class="pre">MyActions.get_claim_achievement()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientfavoriteactions">ClientFavoriteActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.favorite.ClientFavoriteActions"><code class="docutils literal notranslate"><span class="pre">ClientFavoriteActions</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#favoriteactions">FavoriteActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.favorite.FavoriteActions"><code class="docutils literal notranslate"><span class="pre">FavoriteActions</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#sharedfavoriteactions">SharedFavoriteActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.favorite.SharedFavoriteActions"><code class="docutils literal notranslate"><span class="pre">SharedFavoriteActions</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientuseractions">ClientUserActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.user.ClientUserActions"><code class="docutils literal notranslate"><span class="pre">ClientUserActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.user.ClientUserActions.get_achievements"><code class="docutils literal notranslate"><span class="pre">ClientUserActions.get_achievements()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.user.ClientUserActions.get_all_featured_notes"><code class="docutils literal notranslate"><span class="pre">ClientUserActions.get_all_featured_notes()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.user.ClientUserActions.get_featured_notes"><code class="docutils literal notranslate"><span class="pre">ClientUserActions.get_featured_notes()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.user.ClientUserActions.get_followers"><code class="docutils literal notranslate"><span class="pre">ClientUserActions.get_followers()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.user.ClientUserActions.get_following"><code class="docutils literal notranslate"><span class="pre">ClientUserActions.get_following()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.user.ClientUserActions.get_frequently_replied_users"><code class="docutils literal notranslate"><span class="pre">ClientUserActions.get_frequently_replied_users()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.user.ClientUserActions.get_gallery_posts"><code class="docutils literal notranslate"><span class="pre">ClientUserActions.get_gallery_posts()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#shareduseractions">SharedUserActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.user.SharedUserActions"><code class="docutils literal notranslate"><span class="pre">SharedUserActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.user.SharedUserActions.get_achievements"><code class="docutils literal notranslate"><span class="pre">SharedUserActions.get_achievements()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.user.SharedUserActions.get_all_featured_notes"><code class="docutils literal notranslate"><span class="pre">SharedUserActions.get_all_featured_notes()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.user.SharedUserActions.get_featured_notes"><code class="docutils literal notranslate"><span class="pre">SharedUserActions.get_featured_notes()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.user.SharedUserActions.get_followers"><code class="docutils literal notranslate"><span class="pre">SharedUserActions.get_followers()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.user.SharedUserActions.get_following"><code class="docutils literal notranslate"><span class="pre">SharedUserActions.get_following()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.user.SharedUserActions.get_frequently_replied_users"><code class="docutils literal notranslate"><span class="pre">SharedUserActions.get_frequently_replied_users()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.user.SharedUserActions.get_gallery_posts"><code class="docutils literal notranslate"><span class="pre">SharedUserActions.get_gallery_posts()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#useractions">UserActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.user.UserActions"><code class="docutils literal notranslate"><span class="pre">UserActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.user.UserActions.fetch"><code class="docutils literal notranslate"><span class="pre">UserActions.fetch()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.user.UserActions.get"><code class="docutils literal notranslate"><span class="pre">UserActions.get()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.user.UserActions.get_me"><code class="docutils literal notranslate"><span class="pre">UserActions.get_me()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.user.UserActions.get_mention"><code class="docutils literal notranslate"><span class="pre">UserActions.get_mention()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.user.UserActions.search"><code class="docutils literal notranslate"><span class="pre">UserActions.search()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.user.UserActions.search_by_username_and_host"><code class="docutils literal notranslate"><span class="pre">UserActions.search_by_username_and_host()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientactions">ClientActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.client.ClientActions"><code class="docutils literal notranslate"><span class="pre">ClientActions</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientmuteactions">ClientMuteActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.users.mute.ClientMuteActions"><code class="docutils literal notranslate"><span class="pre">ClientMuteActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.users.mute.ClientMuteActions.create"><code class="docutils literal notranslate"><span class="pre">ClientMuteActions.create()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.users.mute.ClientMuteActions.delete"><code class="docutils literal notranslate"><span class="pre">ClientMuteActions.delete()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#muteactions">MuteActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.users.mute.MuteActions"><code class="docutils literal notranslate"><span class="pre">MuteActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.users.mute.MuteActions.get_all_list"><code class="docutils literal notranslate"><span class="pre">MuteActions.get_all_list()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.users.mute.MuteActions.get_list"><code class="docutils literal notranslate"><span class="pre">MuteActions.get_list()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#sharedmuteactions">SharedMuteActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.users.mute.SharedMuteActions"><code class="docutils literal notranslate"><span class="pre">SharedMuteActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.users.mute.SharedMuteActions.create"><code class="docutils literal notranslate"><span class="pre">SharedMuteActions.create()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.users.mute.SharedMuteActions.delete"><code class="docutils literal notranslate"><span class="pre">SharedMuteActions.delete()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientpartialuserlistactions">ClientPartialUserListActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.users.list.ClientPartialUserListActions"><code class="docutils literal notranslate"><span class="pre">ClientPartialUserListActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.users.list.ClientPartialUserListActions.get_list"><code class="docutils literal notranslate"><span class="pre">ClientPartialUserListActions.get_list()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.users.list.ClientPartialUserListActions.pull"><code class="docutils literal notranslate"><span class="pre">ClientPartialUserListActions.pull()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.users.list.ClientPartialUserListActions.push"><code class="docutils literal notranslate"><span class="pre">ClientPartialUserListActions.push()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientuserlistactions">ClientUserListActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.users.list.ClientUserListActions"><code class="docutils literal notranslate"><span class="pre">ClientUserListActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.users.list.ClientUserListActions.delete"><code class="docutils literal notranslate"><span class="pre">ClientUserListActions.delete()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.users.list.ClientUserListActions.favorite"><code class="docutils literal notranslate"><span class="pre">ClientUserListActions.favorite()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.users.list.ClientUserListActions.show"><code class="docutils literal notranslate"><span class="pre">ClientUserListActions.show()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.users.list.ClientUserListActions.unfavorite"><code class="docutils literal notranslate"><span class="pre">ClientUserListActions.unfavorite()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.users.list.ClientUserListActions.update"><code class="docutils literal notranslate"><span class="pre">ClientUserListActions.update()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#sharedpartialuserlistactions">SharedPartialUserListActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.users.list.SharedPartialUserListActions"><code class="docutils literal notranslate"><span class="pre">SharedPartialUserListActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.users.list.SharedPartialUserListActions.get_list"><code class="docutils literal notranslate"><span class="pre">SharedPartialUserListActions.get_list()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.users.list.SharedPartialUserListActions.pull"><code class="docutils literal notranslate"><span class="pre">SharedPartialUserListActions.pull()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.users.list.SharedPartialUserListActions.push"><code class="docutils literal notranslate"><span class="pre">SharedPartialUserListActions.push()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#shareduserlistactions">SharedUserListActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.users.list.SharedUserListActions"><code class="docutils literal notranslate"><span class="pre">SharedUserListActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.users.list.SharedUserListActions.delete"><code class="docutils literal notranslate"><span class="pre">SharedUserListActions.delete()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.users.list.SharedUserListActions.favorite"><code class="docutils literal notranslate"><span class="pre">SharedUserListActions.favorite()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.users.list.SharedUserListActions.show"><code class="docutils literal notranslate"><span class="pre">SharedUserListActions.show()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.users.list.SharedUserListActions.unfavorite"><code class="docutils literal notranslate"><span class="pre">SharedUserListActions.unfavorite()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.users.list.SharedUserListActions.update"><code class="docutils literal notranslate"><span class="pre">SharedUserListActions.update()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#userlistactions">UserListActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.users.list.UserListActions"><code class="docutils literal notranslate"><span class="pre">UserListActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.users.list.UserListActions.create"><code class="docutils literal notranslate"><span class="pre">UserListActions.create()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#admininviteactions">AdminInviteActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.admins.invite.AdminInviteActions"><code class="docutils literal notranslate"><span class="pre">AdminInviteActions</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#adminannouncementactions">AdminAnnouncementActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.admins.announcement.AdminAnnouncementActions"><code class="docutils literal notranslate"><span class="pre">AdminAnnouncementActions</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientadminannouncementactions">ClientAdminAnnouncementActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.admins.announcement.ClientAdminAnnouncementActions"><code class="docutils literal notranslate"><span class="pre">ClientAdminAnnouncementActions</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#sharedadminannouncementactions">SharedAdminAnnouncementActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.admins.announcement.SharedAdminAnnouncementActions"><code class="docutils literal notranslate"><span class="pre">SharedAdminAnnouncementActions</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#adminemojiactions">AdminEmojiActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.admins.emoji.AdminEmojiActions"><code class="docutils literal notranslate"><span class="pre">AdminEmojiActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.admins.emoji.AdminEmojiActions.remove"><code class="docutils literal notranslate"><span class="pre">AdminEmojiActions.remove()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#adminactions">AdminActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.admins.admin.AdminActions"><code class="docutils literal notranslate"><span class="pre">AdminActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.admins.admin.AdminActions.get_meta"><code class="docutils literal notranslate"><span class="pre">AdminActions.get_meta()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.admins.admin.AdminActions.reset_password"><code class="docutils literal notranslate"><span class="pre">AdminActions.reset_password()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.admins.admin.AdminActions.resolve_abuse_user_report"><code class="docutils literal notranslate"><span class="pre">AdminActions.resolve_abuse_user_report()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.admins.admin.AdminActions.send_email"><code class="docutils literal notranslate"><span class="pre">AdminActions.send_email()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.admins.admin.AdminActions.suspend_user"><code class="docutils literal notranslate"><span class="pre">AdminActions.suspend_user()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.admins.admin.AdminActions.unsuspend_user"><code class="docutils literal notranslate"><span class="pre">AdminActions.unsuspend_user()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.admins.admin.AdminActions.update_user_note"><code class="docutils literal notranslate"><span class="pre">AdminActions.update_user_note()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#admindriveactions">AdminDriveActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.admins.drive.AdminDriveActions"><code class="docutils literal notranslate"><span class="pre">AdminDriveActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.admins.drive.AdminDriveActions.clean_remote_files"><code class="docutils literal notranslate"><span class="pre">AdminDriveActions.clean_remote_files()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.admins.drive.AdminDriveActions.cleanup"><code class="docutils literal notranslate"><span class="pre">AdminDriveActions.cleanup()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.admins.drive.AdminDriveActions.get_files"><code class="docutils literal notranslate"><span class="pre">AdminDriveActions.get_files()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.admins.drive.AdminDriveActions.show_file"><code class="docutils literal notranslate"><span class="pre">AdminDriveActions.show_file()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#adminadactions">AdminAdActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.admins.ad.AdminAdActions"><code class="docutils literal notranslate"><span class="pre">AdminAdActions</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientadminadactions">ClientAdminAdActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.admins.ad.ClientAdminAdActions"><code class="docutils literal notranslate"><span class="pre">ClientAdminAdActions</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#sharedadminadactions">SharedAdminAdActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.admins.ad.SharedAdminAdActions"><code class="docutils literal notranslate"><span class="pre">SharedAdminAdActions</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#adminroleactions">AdminRoleActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.admins.roles.AdminRoleActions"><code class="docutils literal notranslate"><span class="pre">AdminRoleActions</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#adminrolemodelactions">AdminRoleModelActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.admins.roles.AdminRoleModelActions"><code class="docutils literal notranslate"><span class="pre">AdminRoleModelActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.admins.roles.AdminRoleModelActions.assign"><code class="docutils literal notranslate"><span class="pre">AdminRoleModelActions.assign()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.admins.roles.AdminRoleModelActions.unassign"><code class="docutils literal notranslate"><span class="pre">AdminRoleModelActions.unassign()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#adminuseractions">AdminUserActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.admins.user.AdminUserActions"><code class="docutils literal notranslate"><span class="pre">AdminUserActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.admins.user.AdminUserActions.delete_account"><code class="docutils literal notranslate"><span class="pre">AdminUserActions.delete_account()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.admins.user.AdminUserActions.show_user"><code class="docutils literal notranslate"><span class="pre">AdminUserActions.show_user()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.admins.user.AdminUserActions.suspend"><code class="docutils literal notranslate"><span class="pre">AdminUserActions.suspend()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.admins.user.AdminUserActions.unsuspend"><code class="docutils literal notranslate"><span class="pre">AdminUserActions.unsuspend()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientfileactionsinfolder">ClientFileActionsInFolder</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.folders.ClientFileActionsInFolder"><code class="docutils literal notranslate"><span class="pre">ClientFileActionsInFolder</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.folders.ClientFileActionsInFolder.create"><code class="docutils literal notranslate"><span class="pre">ClientFileActionsInFolder.create()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.folders.ClientFileActionsInFolder.find"><code class="docutils literal notranslate"><span class="pre">ClientFileActionsInFolder.find()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.folders.ClientFileActionsInFolder.update"><code class="docutils literal notranslate"><span class="pre">ClientFileActionsInFolder.update()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.folders.ClientFileActionsInFolder.upload_from_url"><code class="docutils literal notranslate"><span class="pre">ClientFileActionsInFolder.upload_from_url()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientfolderactions">ClientFolderActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.folders.ClientFolderActions"><code class="docutils literal notranslate"><span class="pre">ClientFolderActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.folders.ClientFolderActions.create"><code class="docutils literal notranslate"><span class="pre">ClientFolderActions.create()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.folders.ClientFolderActions.delete"><code class="docutils literal notranslate"><span class="pre">ClientFolderActions.delete()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.folders.ClientFolderActions.gets"><code class="docutils literal notranslate"><span class="pre">ClientFolderActions.gets()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.folders.ClientFolderActions.update"><code class="docutils literal notranslate"><span class="pre">ClientFolderActions.update()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#folderactions">FolderActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.folders.FolderActions"><code class="docutils literal notranslate"><span class="pre">FolderActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.folders.FolderActions.find"><code class="docutils literal notranslate"><span class="pre">FolderActions.find()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.folders.FolderActions.show"><code class="docutils literal notranslate"><span class="pre">FolderActions.show()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#sharedfolderactions">SharedFolderActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.folders.SharedFolderActions"><code class="docutils literal notranslate"><span class="pre">SharedFolderActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.folders.SharedFolderActions.create"><code class="docutils literal notranslate"><span class="pre">SharedFolderActions.create()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.folders.SharedFolderActions.delete"><code class="docutils literal notranslate"><span class="pre">SharedFolderActions.delete()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.folders.SharedFolderActions.gets"><code class="docutils literal notranslate"><span class="pre">SharedFolderActions.gets()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.folders.SharedFolderActions.update"><code class="docutils literal notranslate"><span class="pre">SharedFolderActions.update()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#driveactions">DriveActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.drive.DriveActions"><code class="docutils literal notranslate"><span class="pre">DriveActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.drive.DriveActions.get_status"><code class="docutils literal notranslate"><span class="pre">DriveActions.get_status()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.drive.DriveActions.stream"><code class="docutils literal notranslate"><span class="pre">DriveActions.stream()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#clientfileactions">ClientFileActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.files.ClientFileActions"><code class="docutils literal notranslate"><span class="pre">ClientFileActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.files.ClientFileActions.delete"><code class="docutils literal notranslate"><span class="pre">ClientFileActions.delete()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.files.ClientFileActions.get_attached_notes"><code class="docutils literal notranslate"><span class="pre">ClientFileActions.get_attached_notes()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.files.ClientFileActions.update"><code class="docutils literal notranslate"><span class="pre">ClientFileActions.update()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#fileactions">FileActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.files.FileActions"><code class="docutils literal notranslate"><span class="pre">FileActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.files.FileActions.check_existence"><code class="docutils literal notranslate"><span class="pre">FileActions.check_existence()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.files.FileActions.create"><code class="docutils literal notranslate"><span class="pre">FileActions.create()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.files.FileActions.find"><code class="docutils literal notranslate"><span class="pre">FileActions.find()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.files.FileActions.find_by_hash"><code class="docutils literal notranslate"><span class="pre">FileActions.find_by_hash()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.files.FileActions.get_files"><code class="docutils literal notranslate"><span class="pre">FileActions.get_files()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.files.FileActions.show"><code class="docutils literal notranslate"><span class="pre">FileActions.show()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.files.FileActions.upload_from_url"><code class="docutils literal notranslate"><span class="pre">FileActions.upload_from_url()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#sharedfileactions">SharedFileActions</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.files.SharedFileActions"><code class="docutils literal notranslate"><span class="pre">SharedFileActions</span></code></a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.files.SharedFileActions.delete"><code class="docutils literal notranslate"><span class="pre">SharedFileActions.delete()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.files.SharedFileActions.get_attached_notes"><code class="docutils literal notranslate"><span class="pre">SharedFileActions.get_attached_notes()</span></code></a></li>
|
|
|
<li><a class="reference internal" href="#mipac.actions.drive.files.SharedFileActions.update"><code class="docutils literal notranslate"><span class="pre">SharedFileActions.update()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#type-class">Type class</a><ul>
|
|
|
<li><a class="reference internal" href="#iblocking">IBlocking</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.blocking.IBlocking"><code class="docutils literal notranslate"><span class="pre">IBlocking</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#iinvitecode">IInviteCode</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.invite.IInviteCode"><code class="docutils literal notranslate"><span class="pre">IInviteCode</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#iinvitelimit">IInviteLimit</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.invite.IInviteLimit"><code class="docutils literal notranslate"><span class="pre">IInviteLimit</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#igallerypost">IGalleryPost</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.gallery.IGalleryPost"><code class="docutils literal notranslate"><span class="pre">IGalleryPost</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#imuteduser">IMutedUser</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.mute.IMutedUser"><code class="docutils literal notranslate"><span class="pre">IMutedUser</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#ifederationfollowcommon">IFederationFollowCommon</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.follow.IFederationFollowCommon"><code class="docutils literal notranslate"><span class="pre">IFederationFollowCommon</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#ifederationfollower">IFederationFollower</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.follow.IFederationFollower"><code class="docutils literal notranslate"><span class="pre">IFederationFollower</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#ifederationfollowing">IFederationFollowing</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.follow.IFederationFollowing"><code class="docutils literal notranslate"><span class="pre">IFederationFollowing</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#ifollowrequest">IFollowRequest</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.follow.IFollowRequest"><code class="docutils literal notranslate"><span class="pre">IFollowRequest</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#iannouncement">IAnnouncement</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.announcement.IAnnouncement"><code class="docutils literal notranslate"><span class="pre">IAnnouncement</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#iannouncementdetailed">IAnnouncementDetailed</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.announcement.IAnnouncementDetailed"><code class="docutils literal notranslate"><span class="pre">IAnnouncementDetailed</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#icreatednote">ICreatedNote</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.note.ICreatedNote"><code class="docutils literal notranslate"><span class="pre">ICreatedNote</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#inote">INote</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.note.INote"><code class="docutils literal notranslate"><span class="pre">INote</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#inotechannel">INoteChannel</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.note.INoteChannel"><code class="docutils literal notranslate"><span class="pre">INoteChannel</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#inotereaction">INoteReaction</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.note.INoteReaction"><code class="docutils literal notranslate"><span class="pre">INoteReaction</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#inotestate">INoteState</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.note.INoteState"><code class="docutils literal notranslate"><span class="pre">INoteState</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#inotetranslateresult">INoteTranslateResult</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.note.INoteTranslateResult"><code class="docutils literal notranslate"><span class="pre">INoteTranslateResult</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#inoteupdated">INoteUpdated</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.note.INoteUpdated"><code class="docutils literal notranslate"><span class="pre">INoteUpdated</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#inoteupdateddelete">INoteUpdatedDelete</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.note.INoteUpdatedDelete"><code class="docutils literal notranslate"><span class="pre">INoteUpdatedDelete</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#inoteupdateddeletebody">INoteUpdatedDeleteBody</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.note.INoteUpdatedDeleteBody"><code class="docutils literal notranslate"><span class="pre">INoteUpdatedDeleteBody</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#inoteupdatedreaction">INoteUpdatedReaction</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.note.INoteUpdatedReaction"><code class="docutils literal notranslate"><span class="pre">INoteUpdatedReaction</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#inoteupdatedreactionbody">INoteUpdatedReactionBody</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.note.INoteUpdatedReactionBody"><code class="docutils literal notranslate"><span class="pre">INoteUpdatedReactionBody</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#iachievementnf">IAchievementNf</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.notification.IAchievementNf"><code class="docutils literal notranslate"><span class="pre">IAchievementNf</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#inotenf">INoteNf</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.notification.INoteNf"><code class="docutils literal notranslate"><span class="pre">INoteNf</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#inotification">INotification</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.notification.INotification"><code class="docutils literal notranslate"><span class="pre">INotification</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#ipollendnf">IPollEndNf</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.notification.IPollEndNf"><code class="docutils literal notranslate"><span class="pre">IPollEndNf</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#ireactionnf">IReactionNf</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.notification.IReactionNf"><code class="docutils literal notranslate"><span class="pre">IReactionNf</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#iusernf">IUserNf</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.notification.IUserNf"><code class="docutils literal notranslate"><span class="pre">IUserNf</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#emojipayload">EmojiPayload</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.emoji.EmojiPayload"><code class="docutils literal notranslate"><span class="pre">EmojiPayload</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#icustomemoji">ICustomEmoji</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.emoji.ICustomEmoji"><code class="docutils literal notranslate"><span class="pre">ICustomEmoji</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#icustomemojilite">ICustomEmojiLite</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.emoji.ICustomEmojiLite"><code class="docutils literal notranslate"><span class="pre">ICustomEmojiLite</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#icustomemojiliterequired">ICustomEmojiLiteRequired</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.emoji.ICustomEmojiLiteRequired"><code class="docutils literal notranslate"><span class="pre">ICustomEmojiLiteRequired</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#iemojidetailed">IEmojiDetailed</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.emoji.IEmojiDetailed"><code class="docutils literal notranslate"><span class="pre">IEmojiDetailed</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#iemojisimple">IEmojiSimple</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.emoji.IEmojiSimple"><code class="docutils literal notranslate"><span class="pre">IEmojiSimple</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#iclip">IClip</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.clip.IClip"><code class="docutils literal notranslate"><span class="pre">IClip</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#notereactionpayload">NoteReactionPayload</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.reaction.NoteReactionPayload"><code class="docutils literal notranslate"><span class="pre">NoteReactionPayload</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#ichannel">IChannel</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.channel.IChannel"><code class="docutils literal notranslate"><span class="pre">IChannel</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#iindexstat">IIndexStat</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.admin.IIndexStat"><code class="docutils literal notranslate"><span class="pre">IIndexStat</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#imoderationlog">IModerationLog</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.admin.IModerationLog"><code class="docutils literal notranslate"><span class="pre">IModerationLog</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#iserverinfo">IServerInfo</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.admin.IServerInfo"><code class="docutils literal notranslate"><span class="pre">IServerInfo</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#iserverinfocpu">IServerInfoCpu</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.admin.IServerInfoCpu"><code class="docutils literal notranslate"><span class="pre">IServerInfoCpu</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#iserverinfofs">IServerInfoFs</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.admin.IServerInfoFs"><code class="docutils literal notranslate"><span class="pre">IServerInfoFs</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#iserverinfomem">IServerInfoMem</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.admin.IServerInfoMem"><code class="docutils literal notranslate"><span class="pre">IServerInfoMem</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#iserverinfonet">IServerInfoNet</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.admin.IServerInfoNet"><code class="docutils literal notranslate"><span class="pre">IServerInfoNet</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#itablestats">ITableStats</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.admin.ITableStats"><code class="docutils literal notranslate"><span class="pre">ITableStats</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#iuserip">IUserIP</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.admin.IUserIP"><code class="docutils literal notranslate"><span class="pre">IUserIP</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#iusernameavailable">IUsernameAvailable</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.username.IUsernameAvailable"><code class="docutils literal notranslate"><span class="pre">IUsernameAvailable</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#iactiveuserschart">IActiveUsersChart</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.chart.IActiveUsersChart"><code class="docutils literal notranslate"><span class="pre">IActiveUsersChart</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#idrivechart">IDriveChart</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.chart.IDriveChart"><code class="docutils literal notranslate"><span class="pre">IDriveChart</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#idrivelocalchart">IDriveLocalChart</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.chart.IDriveLocalChart"><code class="docutils literal notranslate"><span class="pre">IDriveLocalChart</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#idriveremotechart">IDriveRemoteChart</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.chart.IDriveRemoteChart"><code class="docutils literal notranslate"><span class="pre">IDriveRemoteChart</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#idrivestatus">IDriveStatus</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.drive.IDriveStatus"><code class="docutils literal notranslate"><span class="pre">IDriveStatus</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#ifile">IFile</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.drive.IFile"><code class="docutils literal notranslate"><span class="pre">IFile</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#ifileproperties">IFileProperties</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.drive.IFileProperties"><code class="docutils literal notranslate"><span class="pre">IFileProperties</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#ifolder">IFolder</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.drive.IFolder"><code class="docutils literal notranslate"><span class="pre">IFolder</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#iantenna">IAntenna</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.antenna.IAntenna"><code class="docutils literal notranslate"><span class="pre">IAntenna</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#ifederationinstance">IFederationInstance</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.instance.IFederationInstance"><code class="docutils literal notranslate"><span class="pre">IFederationInstance</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#ifederationinstancerequired">IFederationInstanceRequired</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.instance.IFederationInstanceRequired"><code class="docutils literal notranslate"><span class="pre">IFederationInstanceRequired</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#ifederationinstancestat">IFederationInstanceStat</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.instance.IFederationInstanceStat"><code class="docutils literal notranslate"><span class="pre">IFederationInstanceStat</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#iinstancelite">IInstanceLite</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.instance.IInstanceLite"><code class="docutils literal notranslate"><span class="pre">IInstanceLite</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#attachedfilepayload">AttachedFilePayload</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.page.AttachedFilePayload"><code class="docutils literal notranslate"><span class="pre">AttachedFilePayload</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#eyecatchingimagepayload">EyeCatchingImagePayload</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.page.EyeCatchingImagePayload"><code class="docutils literal notranslate"><span class="pre">EyeCatchingImagePayload</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#ipage">IPage</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.page.IPage"><code class="docutils literal notranslate"><span class="pre">IPage</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#ipagerequired">IPageRequired</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.page.IPageRequired"><code class="docutils literal notranslate"><span class="pre">IPageRequired</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#pagecontentpayload">PageContentPayload</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.page.PageContentPayload"><code class="docutils literal notranslate"><span class="pre">PageContentPayload</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#pagefilepayload">PageFilePayload</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.page.PageFilePayload"><code class="docutils literal notranslate"><span class="pre">PageFilePayload</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#pagepayload">PagePayload</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.page.PagePayload"><code class="docutils literal notranslate"><span class="pre">PagePayload</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#variablepayload">VariablePayload</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.page.VariablePayload"><code class="docutils literal notranslate"><span class="pre">VariablePayload</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#icreatepoll">ICreatePoll</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.poll.ICreatePoll"><code class="docutils literal notranslate"><span class="pre">ICreatePoll</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#ipoll">IPoll</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.poll.IPoll"><code class="docutils literal notranslate"><span class="pre">IPoll</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#ipollchoice">IPollChoice</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.poll.IPollChoice"><code class="docutils literal notranslate"><span class="pre">IPollChoice</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#iad">IAd</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.ads.IAd"><code class="docutils literal notranslate"><span class="pre">IAd</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#ipartialad">IPartialAd</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.ads.IPartialAd"><code class="docutils literal notranslate"><span class="pre">IPartialAd</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#is-me-role">is_me_role</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.roles.is_me_role"><code class="docutils literal notranslate"><span class="pre">is_me_role()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#imerole">IMeRole</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.roles.IMeRole"><code class="docutils literal notranslate"><span class="pre">IMeRole</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#ipartialrole">IPartialRole</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.roles.IPartialRole"><code class="docutils literal notranslate"><span class="pre">IPartialRole</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#irole">IRole</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.roles.IRole"><code class="docutils literal notranslate"><span class="pre">IRole</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#irolepolicies">IRolePolicies</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.roles.IRolePolicies"><code class="docutils literal notranslate"><span class="pre">IRolePolicies</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#iroleuser">IRoleUser</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.roles.IRoleUser"><code class="docutils literal notranslate"><span class="pre">IRoleUser</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#is-me-detailed">is_me_detailed</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.user.is_me_detailed"><code class="docutils literal notranslate"><span class="pre">is_me_detailed()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#is-partial-user">is_partial_user</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.user.is_partial_user"><code class="docutils literal notranslate"><span class="pre">is_partial_user()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#is-user-detailed">is_user_detailed</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.user.is_user_detailed"><code class="docutils literal notranslate"><span class="pre">is_user_detailed()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#is-user-detailed-not-me">is_user_detailed_not_me</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.user.is_user_detailed_not_me"><code class="docutils literal notranslate"><span class="pre">is_user_detailed_not_me()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#getfrequentlyrepliedusersresponse">GetFrequentlyRepliedUsersResponse</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.user.GetFrequentlyRepliedUsersResponse"><code class="docutils literal notranslate"><span class="pre">GetFrequentlyRepliedUsersResponse</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#iachievement">IAchievement</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.user.IAchievement"><code class="docutils literal notranslate"><span class="pre">IAchievement</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#iavatardecoration">IAvatarDecoration</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.user.IAvatarDecoration"><code class="docutils literal notranslate"><span class="pre">IAvatarDecoration</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#ibadgerole">IBadgeRole</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.user.IBadgeRole"><code class="docutils literal notranslate"><span class="pre">IBadgeRole</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#imedetailedonlyschema">IMeDetailedOnlySchema</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.user.IMeDetailedOnlySchema"><code class="docutils literal notranslate"><span class="pre">IMeDetailedOnlySchema</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#imedetailedschema">IMeDetailedSchema</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.user.IMeDetailedSchema"><code class="docutils literal notranslate"><span class="pre">IMeDetailedSchema</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#ipartialuser">IPartialUser</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.user.IPartialUser"><code class="docutils literal notranslate"><span class="pre">IPartialUser</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#isignin">ISignin</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.user.ISignin"><code class="docutils literal notranslate"><span class="pre">ISignin</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#iuserdetailednotmeonlyschema">IUserDetailedNotMeOnlySchema</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.user.IUserDetailedNotMeOnlySchema"><code class="docutils literal notranslate"><span class="pre">IUserDetailedNotMeOnlySchema</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#iuserdetailednotmeschema">IUserDetailedNotMeSchema</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.user.IUserDetailedNotMeSchema"><code class="docutils literal notranslate"><span class="pre">IUserDetailedNotMeSchema</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#iuserfield">IUserField</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.user.IUserField"><code class="docutils literal notranslate"><span class="pre">IUserField</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#iuserlist">IUserList</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.user.IUserList"><code class="docutils literal notranslate"><span class="pre">IUserList</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#iuserlistmembership">IUserListMembership</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.user.IUserListMembership"><code class="docutils literal notranslate"><span class="pre">IUserListMembership</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#iuserrequired">IUserRequired</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.user.IUserRequired"><code class="docutils literal notranslate"><span class="pre">IUserRequired</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#iuserrole">IUserRole</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.user.IUserRole"><code class="docutils literal notranslate"><span class="pre">IUserRole</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#iusersecuritykey">IUserSecurityKey</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.user.IUserSecurityKey"><code class="docutils literal notranslate"><span class="pre">IUserSecurityKey</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#notificationrecieveconfig">NotificationRecieveConfig</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.user.NotificationRecieveConfig"><code class="docutils literal notranslate"><span class="pre">NotificationRecieveConfig</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#notificationrecieveconfigtype">NotificationRecieveConfigType</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.user.NotificationRecieveConfigType"><code class="docutils literal notranslate"><span class="pre">NotificationRecieveConfigType</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#notificationrecieveconfigwithuserlist">NotificationRecieveConfigWithUserList</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.user.NotificationRecieveConfigWithUserList"><code class="docutils literal notranslate"><span class="pre">NotificationRecieveConfigWithUserList</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#iadminmeta">IAdminMeta</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.meta.IAdminMeta"><code class="docutils literal notranslate"><span class="pre">IAdminMeta</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#ifeatures">IFeatures</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.meta.IFeatures"><code class="docutils literal notranslate"><span class="pre">IFeatures</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#imeta">IMeta</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.meta.IMeta"><code class="docutils literal notranslate"><span class="pre">IMeta</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#ipartialmeta">IPartialMeta</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.meta.IPartialMeta"><code class="docutils literal notranslate"><span class="pre">IPartialMeta</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#ipolicies">IPolicies</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.meta.IPolicies"><code class="docutils literal notranslate"><span class="pre">IPolicies</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#iupdatemetabody">IUpdateMetaBody</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.types.meta.IUpdateMetaBody"><code class="docutils literal notranslate"><span class="pre">IUpdateMetaBody</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#errors">Errors</a><ul>
|
|
|
<li><a class="reference internal" href="#accessdeniederror">AccessDeniedError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.AccessDeniedError"><code class="docutils literal notranslate"><span class="pre">AccessDeniedError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#alreadyaddederror">AlreadyAddedError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.AlreadyAddedError"><code class="docutils literal notranslate"><span class="pre">AlreadyAddedError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#alreadyblockingerror">AlreadyBlockingError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.AlreadyBlockingError"><code class="docutils literal notranslate"><span class="pre">AlreadyBlockingError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#alreadyclippederror">AlreadyClippedError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.AlreadyClippedError"><code class="docutils literal notranslate"><span class="pre">AlreadyClippedError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#alreadyexpirederror">AlreadyExpiredError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.AlreadyExpiredError"><code class="docutils literal notranslate"><span class="pre">AlreadyExpiredError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#alreadyfavoritederror">AlreadyFavoritedError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.AlreadyFavoritedError"><code class="docutils literal notranslate"><span class="pre">AlreadyFavoritedError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#alreadyfollowingerror">AlreadyFollowingError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.AlreadyFollowingError"><code class="docutils literal notranslate"><span class="pre">AlreadyFollowingError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#alreadyinvitederror">AlreadyInvitedError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.AlreadyInvitedError"><code class="docutils literal notranslate"><span class="pre">AlreadyInvitedError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#alreadylikederror">AlreadyLikedError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.AlreadyLikedError"><code class="docutils literal notranslate"><span class="pre">AlreadyLikedError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#alreadymutingerror">AlreadyMutingError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.AlreadyMutingError"><code class="docutils literal notranslate"><span class="pre">AlreadyMutingError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#alreadypinnederror">AlreadyPinnedError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.AlreadyPinnedError"><code class="docutils literal notranslate"><span class="pre">AlreadyPinnedError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#alreadypromotederror">AlreadyPromotedError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.AlreadyPromotedError"><code class="docutils literal notranslate"><span class="pre">AlreadyPromotedError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#alreadyreactederror">AlreadyReactedError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.AlreadyReactedError"><code class="docutils literal notranslate"><span class="pre">AlreadyReactedError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#alreadyvotederror">AlreadyVotedError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.AlreadyVotedError"><code class="docutils literal notranslate"><span class="pre">AlreadyVotedError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#avatarnotanimageerror">AvatarNotAnImageError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.AvatarNotAnImageError"><code class="docutils literal notranslate"><span class="pre">AvatarNotAnImageError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#bannernotanimageerror">BannerNotAnImageError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.BannerNotAnImageError"><code class="docutils literal notranslate"><span class="pre">BannerNotAnImageError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#blockederror">BlockedError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.BlockedError"><code class="docutils literal notranslate"><span class="pre">BlockedError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#blockeeisyourselferror">BlockeeIsYourselfError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.BlockeeIsYourselfError"><code class="docutils literal notranslate"><span class="pre">BlockeeIsYourselfError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#blockingerror">BlockingError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.BlockingError"><code class="docutils literal notranslate"><span class="pre">BlockingError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#cannotcreatealreadyexpiredpollerror">CannotCreateAlreadyExpiredPollError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.CannotCreateAlreadyExpiredPollError"><code class="docutils literal notranslate"><span class="pre">CannotCreateAlreadyExpiredPollError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#cannotrenotetoapurerenoteerror">CannotRenoteToAPureRenoteError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.CannotRenoteToAPureRenoteError"><code class="docutils literal notranslate"><span class="pre">CannotRenoteToAPureRenoteError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#cannotreplytoapurerenoteerror">CannotReplyToAPureRenoteError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.CannotReplyToAPureRenoteError"><code class="docutils literal notranslate"><span class="pre">CannotReplyToAPureRenoteError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#cannotreporttheadminerror">CannotReportTheAdminError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.CannotReportTheAdminError"><code class="docutils literal notranslate"><span class="pre">CannotReportTheAdminError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#cannotreportyourselferror">CannotReportYourselfError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.CannotReportYourselfError"><code class="docutils literal notranslate"><span class="pre">CannotReportYourselfError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#contentrequirederror">ContentRequiredError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.ContentRequiredError"><code class="docutils literal notranslate"><span class="pre">ContentRequiredError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#credentialrequirederror">CredentialRequiredError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.CredentialRequiredError"><code class="docutils literal notranslate"><span class="pre">CredentialRequiredError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#failedtoresolveremoteusererror">FailedToResolveRemoteUserError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.FailedToResolveRemoteUserError"><code class="docutils literal notranslate"><span class="pre">FailedToResolveRemoteUserError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#followrequestnotfounderror">FollowRequestNotFoundError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.FollowRequestNotFoundError"><code class="docutils literal notranslate"><span class="pre">FollowRequestNotFoundError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#followeeisyourselferror">FolloweeIsYourselfError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.FolloweeIsYourselfError"><code class="docutils literal notranslate"><span class="pre">FolloweeIsYourselfError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#followerisyourselferror">FollowerIsYourselfError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.FollowerIsYourselfError"><code class="docutils literal notranslate"><span class="pre">FollowerIsYourselfError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#forbiddenerror">ForbiddenError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.ForbiddenError"><code class="docutils literal notranslate"><span class="pre">ForbiddenError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#groupaccessdeniederror">GroupAccessDeniedError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.GroupAccessDeniedError"><code class="docutils literal notranslate"><span class="pre">GroupAccessDeniedError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#gtldisablederror">GtlDisabledError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.GtlDisabledError"><code class="docutils literal notranslate"><span class="pre">GtlDisabledError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#haschildfilesorfolderserror">HasChildFilesOrFoldersError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.HasChildFilesOrFoldersError"><code class="docutils literal notranslate"><span class="pre">HasChildFilesOrFoldersError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#inappropriateerror">InappropriateError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.InappropriateError"><code class="docutils literal notranslate"><span class="pre">InappropriateError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#internalerrorerror">InternalErrorError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.InternalErrorError"><code class="docutils literal notranslate"><span class="pre">InternalErrorError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#invalidchoiceerror">InvalidChoiceError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.InvalidChoiceError"><code class="docutils literal notranslate"><span class="pre">InvalidChoiceError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#invalidfilenameerror">InvalidFileNameError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.InvalidFileNameError"><code class="docutils literal notranslate"><span class="pre">InvalidFileNameError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#invalidparamerror">InvalidParamError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.InvalidParamError"><code class="docutils literal notranslate"><span class="pre">InvalidParamError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#invalidregexperror">InvalidRegexpError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.InvalidRegexpError"><code class="docutils literal notranslate"><span class="pre">InvalidRegexpError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#invalidurlerror">InvalidUrlError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.InvalidUrlError"><code class="docutils literal notranslate"><span class="pre">InvalidUrlError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#isownererror">IsOwnerError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.IsOwnerError"><code class="docutils literal notranslate"><span class="pre">IsOwnerError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#ltldisablederror">LtlDisabledError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.LtlDisabledError"><code class="docutils literal notranslate"><span class="pre">LtlDisabledError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#mosuchfileerror">MoSuchFileError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.MoSuchFileError"><code class="docutils literal notranslate"><span class="pre">MoSuchFileError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#muteeisyourselferror">MuteeIsYourselfError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.MuteeIsYourselfError"><code class="docutils literal notranslate"><span class="pre">MuteeIsYourselfError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#namealreadyexistserror">NameAlreadyExistsError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NameAlreadyExistsError"><code class="docutils literal notranslate"><span class="pre">NameAlreadyExistsError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#nofollowrequesterror">NoFollowRequestError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NoFollowRequestError"><code class="docutils literal notranslate"><span class="pre">NoFollowRequestError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#nofreespaceerror">NoFreeSpaceError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NoFreeSpaceError"><code class="docutils literal notranslate"><span class="pre">NoFreeSpaceError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#nopollerror">NoPollError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NoPollError"><code class="docutils literal notranslate"><span class="pre">NoPollError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#nosuchaderror">NoSuchAdError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NoSuchAdError"><code class="docutils literal notranslate"><span class="pre">NoSuchAdError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#nosuchannouncementerror">NoSuchAnnouncementError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NoSuchAnnouncementError"><code class="docutils literal notranslate"><span class="pre">NoSuchAnnouncementError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#nosuchantennaerror">NoSuchAntennaError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NoSuchAntennaError"><code class="docutils literal notranslate"><span class="pre">NoSuchAntennaError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#nosuchapperror">NoSuchAppError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NoSuchAppError"><code class="docutils literal notranslate"><span class="pre">NoSuchAppError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#nosuchavatarerror">NoSuchAvatarError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NoSuchAvatarError"><code class="docutils literal notranslate"><span class="pre">NoSuchAvatarError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#nosuchbannererror">NoSuchBannerError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NoSuchBannerError"><code class="docutils literal notranslate"><span class="pre">NoSuchBannerError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#nosuchchannelerror">NoSuchChannelError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NoSuchChannelError"><code class="docutils literal notranslate"><span class="pre">NoSuchChannelError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#nosuchcliperror">NoSuchClipError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NoSuchClipError"><code class="docutils literal notranslate"><span class="pre">NoSuchClipError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#nosuchemojierror">NoSuchEmojiError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NoSuchEmojiError"><code class="docutils literal notranslate"><span class="pre">NoSuchEmojiError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#nosuchfileerror">NoSuchFileError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NoSuchFileError"><code class="docutils literal notranslate"><span class="pre">NoSuchFileError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#nosuchfoldererror">NoSuchFolderError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NoSuchFolderError"><code class="docutils literal notranslate"><span class="pre">NoSuchFolderError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#nosuchgrouperror">NoSuchGroupError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NoSuchGroupError"><code class="docutils literal notranslate"><span class="pre">NoSuchGroupError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#nosuchgroupmembererror">NoSuchGroupMemberError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NoSuchGroupMemberError"><code class="docutils literal notranslate"><span class="pre">NoSuchGroupMemberError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#nosuchhashtagerror">NoSuchHashtagError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NoSuchHashtagError"><code class="docutils literal notranslate"><span class="pre">NoSuchHashtagError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#nosuchinvitationerror">NoSuchInvitationError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NoSuchInvitationError"><code class="docutils literal notranslate"><span class="pre">NoSuchInvitationError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#nosuchlisterror">NoSuchListError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NoSuchListError"><code class="docutils literal notranslate"><span class="pre">NoSuchListError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#nosuchmessageerror">NoSuchMessageError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NoSuchMessageError"><code class="docutils literal notranslate"><span class="pre">NoSuchMessageError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#nosuchnoteerror">NoSuchNoteError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NoSuchNoteError"><code class="docutils literal notranslate"><span class="pre">NoSuchNoteError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#nosuchnotificationerror">NoSuchNotificationError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NoSuchNotificationError"><code class="docutils literal notranslate"><span class="pre">NoSuchNotificationError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#nosuchobjecterror">NoSuchObjectError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NoSuchObjectError"><code class="docutils literal notranslate"><span class="pre">NoSuchObjectError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#nosuchpageerror">NoSuchPageError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NoSuchPageError"><code class="docutils literal notranslate"><span class="pre">NoSuchPageError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#nosuchparentfoldererror">NoSuchParentFolderError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NoSuchParentFolderError"><code class="docutils literal notranslate"><span class="pre">NoSuchParentFolderError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#nosuchposterror">NoSuchPostError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NoSuchPostError"><code class="docutils literal notranslate"><span class="pre">NoSuchPostError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#nosuchrenotetargeterror">NoSuchRenoteTargetError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NoSuchRenoteTargetError"><code class="docutils literal notranslate"><span class="pre">NoSuchRenoteTargetError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#nosuchreplytargeterror">NoSuchReplyTargetError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NoSuchReplyTargetError"><code class="docutils literal notranslate"><span class="pre">NoSuchReplyTargetError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#nosuchsessionerror">NoSuchSessionError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NoSuchSessionError"><code class="docutils literal notranslate"><span class="pre">NoSuchSessionError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#nosuchusererror">NoSuchUserError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NoSuchUserError"><code class="docutils literal notranslate"><span class="pre">NoSuchUserError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#nosuchusergrouperror">NoSuchUserGroupError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NoSuchUserGroupError"><code class="docutils literal notranslate"><span class="pre">NoSuchUserGroupError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#nosuchuserlisterror">NoSuchUserListError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NoSuchUserListError"><code class="docutils literal notranslate"><span class="pre">NoSuchUserListError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#nosuchwebhookerror">NoSuchWebhookError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NoSuchWebhookError"><code class="docutils literal notranslate"><span class="pre">NoSuchWebhookError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#notblockingerror">NotBlockingError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NotBlockingError"><code class="docutils literal notranslate"><span class="pre">NotBlockingError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#notfavoritederror">NotFavoritedError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NotFavoritedError"><code class="docutils literal notranslate"><span class="pre">NotFavoritedError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#notfollowingerror">NotFollowingError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NotFollowingError"><code class="docutils literal notranslate"><span class="pre">NotFollowingError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#notlikederror">NotLikedError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NotLikedError"><code class="docutils literal notranslate"><span class="pre">NotLikedError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#notmutingerror">NotMutingError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NotMutingError"><code class="docutils literal notranslate"><span class="pre">NotMutingError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#notreactederror">NotReactedError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.NotReactedError"><code class="docutils literal notranslate"><span class="pre">NotReactedError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#pendingsessionerror">PendingSessionError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.PendingSessionError"><code class="docutils literal notranslate"><span class="pre">PendingSessionError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#permissiondeniederror">PermissionDeniedError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.PermissionDeniedError"><code class="docutils literal notranslate"><span class="pre">PermissionDeniedError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#pinlimitexceedederror">PinLimitExceededError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.PinLimitExceededError"><code class="docutils literal notranslate"><span class="pre">PinLimitExceededError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#ratelimitexceedederror">RateLimitExceededError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.RateLimitExceededError"><code class="docutils literal notranslate"><span class="pre">RateLimitExceededError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#reactionsnotpublicerror">ReactionsNotPublicError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.ReactionsNotPublicError"><code class="docutils literal notranslate"><span class="pre">ReactionsNotPublicError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#recipientisyourselferror">RecipientIsYourselfError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.RecipientIsYourselfError"><code class="docutils literal notranslate"><span class="pre">RecipientIsYourselfError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#stldisablederror">StlDisabledError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.StlDisabledError"><code class="docutils literal notranslate"><span class="pre">StlDisabledError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#youareownererror">YouAreOwnerError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.YouAreOwnerError"><code class="docutils literal notranslate"><span class="pre">YouAreOwnerError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#youhavebeenblockederror">YouHaveBeenBlockedError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.YouHaveBeenBlockedError"><code class="docutils literal notranslate"><span class="pre">YouHaveBeenBlockedError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#youraccountsuspendederror">YourAccountSuspendedError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.YourAccountSuspendedError"><code class="docutils literal notranslate"><span class="pre">YourAccountSuspendedError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#yourpageerror">YourPageError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.YourPageError"><code class="docutils literal notranslate"><span class="pre">YourPageError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#yourposterror">YourPostError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.errors.YourPostError"><code class="docutils literal notranslate"><span class="pre">YourPostError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#apierror">APIError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.base.APIError"><code class="docutils literal notranslate"><span class="pre">APIError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#credentialserror">CredentialsError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.base.CredentialsError"><code class="docutils literal notranslate"><span class="pre">CredentialsError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#notexistrequireddata">NotExistRequiredData</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.base.NotExistRequiredData"><code class="docutils literal notranslate"><span class="pre">NotExistRequiredData</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#parametererror">ParameterError</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.errors.base.ParameterError"><code class="docutils literal notranslate"><span class="pre">ParameterError</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#other">__OTHER</a><ul>
|
|
|
<li><a class="reference internal" href="#json-or-text">json_or_text</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.http.json_or_text"><code class="docutils literal notranslate"><span class="pre">json_or_text()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#httpclient">HTTPClient</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.http.HTTPClient"><code class="docutils literal notranslate"><span class="pre">HTTPClient</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#misskeyclientwebsocketresponse">MisskeyClientWebSocketResponse</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.http.MisskeyClientWebSocketResponse"><code class="docutils literal notranslate"><span class="pre">MisskeyClientWebSocketResponse</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#route">Route</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.http.Route"><code class="docutils literal notranslate"><span class="pre">Route</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#cacheconfig">CacheConfig</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.config.CacheConfig"><code class="docutils literal notranslate"><span class="pre">CacheConfig</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#cacheconfigdata">CacheConfigData</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.config.CacheConfigData"><code class="docutils literal notranslate"><span class="pre">CacheConfigData</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#config">Config</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.config.Config"><code class="docutils literal notranslate"><span class="pre">Config</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#id1">Features</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.config.Features"><code class="docutils literal notranslate"><span class="pre">Features</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#id2">IFeatures</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.config.IFeatures"><code class="docutils literal notranslate"><span class="pre">IFeatures</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#ilimits">ILimits</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.config.ILimits"><code class="docutils literal notranslate"><span class="pre">ILimits</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#limits">Limits</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.config.Limits"><code class="docutils literal notranslate"><span class="pre">Limits</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#mifile">MiFile</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.file.MiFile"><code class="docutils literal notranslate"><span class="pre">MiFile</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#client">Client</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.client.Client"><code class="docutils literal notranslate"><span class="pre">Client</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#abstractaction">AbstractAction</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.abstract.action.AbstractAction"><code class="docutils literal notranslate"><span class="pre">AbstractAction</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#abstractmanager">AbstractManager</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.abstract.manager.AbstractManager"><code class="docutils literal notranslate"><span class="pre">AbstractManager</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#cache">cache</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.utils.cache.cache"><code class="docutils literal notranslate"><span class="pre">cache()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#get-cache-key">get_cache_key</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.utils.cache.get_cache_key"><code class="docutils literal notranslate"><span class="pre">get_cache_key()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#set-cache">set_cache</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.utils.cache.set_cache"><code class="docutils literal notranslate"><span class="pre">set_cache()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#check-multi-arg">check_multi_arg</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.utils.util.check_multi_arg"><code class="docutils literal notranslate"><span class="pre">check_multi_arg()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#credentials-required">credentials_required</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.utils.util.credentials_required"><code class="docutils literal notranslate"><span class="pre">credentials_required()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#deprecated">deprecated</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.utils.util.deprecated"><code class="docutils literal notranslate"><span class="pre">deprecated()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#colors">Colors</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.utils.util.Colors"><code class="docutils literal notranslate"><span class="pre">Colors</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#deprecatedclass">DeprecatedClass</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.utils.util.DeprecatedClass"><code class="docutils literal notranslate"><span class="pre">DeprecatedClass</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#mitime">MiTime</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.utils.util.MiTime"><code class="docutils literal notranslate"><span class="pre">MiTime</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#missing">Missing</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.utils.util.Missing"><code class="docutils literal notranslate"><span class="pre">Missing</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#imiauthpayload">IMiAuthPayload</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.utils.auth.IMiAuthPayload"><code class="docutils literal notranslate"><span class="pre">IMiAuthPayload</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#miauth">MiAuth</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.utils.auth.MiAuth"><code class="docutils literal notranslate"><span class="pre">MiAuth</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#setup-logging">setup_logging</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.utils.log.setup_logging"><code class="docutils literal notranslate"><span class="pre">setup_logging()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#pagination">Pagination</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.utils.pagination.Pagination"><code class="docutils literal notranslate"><span class="pre">Pagination</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#bool-to-string">bool_to_string</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.utils.format.bool_to_string"><code class="docutils literal notranslate"><span class="pre">bool_to_string()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#convert-dict-keys-to-camel">convert_dict_keys_to_camel</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.utils.format.convert_dict_keys_to_camel"><code class="docutils literal notranslate"><span class="pre">convert_dict_keys_to_camel()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#remove-dict-empty">remove_dict_empty</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.utils.format.remove_dict_empty"><code class="docutils literal notranslate"><span class="pre">remove_dict_empty()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#remove-dict-missing">remove_dict_missing</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.utils.format.remove_dict_missing"><code class="docutils literal notranslate"><span class="pre">remove_dict_missing()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#remove-list-empty">remove_list_empty</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.utils.format.remove_list_empty"><code class="docutils literal notranslate"><span class="pre">remove_list_empty()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#snake-to-camel">snake_to_camel</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.utils.format.snake_to_camel"><code class="docutils literal notranslate"><span class="pre">snake_to_camel()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#str-lower">str_lower</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.utils.format.str_lower"><code class="docutils literal notranslate"><span class="pre">str_lower()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#str-to-datetime">str_to_datetime</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.utils.format.str_to_datetime"><code class="docutils literal notranslate"><span class="pre">str_to_datetime()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><a class="reference internal" href="#upper-to-lower">upper_to_lower</a><ul>
|
|
|
<li><a class="reference internal" href="#mipac.utils.format.upper_to_lower"><code class="docutils literal notranslate"><span class="pre">upper_to_lower()</span></code></a></li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
|
|
|
|
|
|
</aside>
|
|
|
</div>
|
|
|
</div><script src="_static/documentation_options.js?v=5929fcd5"></script>
|
|
|
<script src="_static/doctools.js?v=888ff710"></script>
|
|
|
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
|
|
<script src="_static/scripts/furo.js?v=32e29ea5"></script>
|
|
|
<script src="_static/js/custom.js?v=56568dd3"></script>
|
|
|
</body>
|
|
|
</html> |
