Skip to content

Commit 663c4a1

Browse files
seratchseratch
committed
version 1.16.0
1 parent bd4ead2 commit 663c4a1

32 files changed

+1692
-137
lines changed

‎docs/api-docs/slack_bolt/adapter/asgi/aiohttp/index.html‎

Lines changed: 219 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,219 @@
1+
<!doctype html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
6+
<meta name="generator" content="pdoc 0.10.0" />
7+
<title>slack_bolt.adapter.asgi.aiohttp API documentation</title>
8+
<meta name="description" content="" />
9+
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
10+
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
11+
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
12+
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
13+
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
14+
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
15+
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
16+
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
17+
</head>
18+
<body>
19+
<main>
20+
<article id="content">
21+
<header>
22+
<h1 class="title">Module <code>slack_bolt.adapter.asgi.aiohttp</code></h1>
23+
</header>
24+
<section id="section-intro">
25+
<details class="source">
26+
<summary>
27+
<span>Expand source code</span>
28+
</summary>
29+
<pre><code class="python">from slack_bolt.oauth.async_oauth_flow import AsyncOAuthFlow
30+
31+
from slack_bolt.adapter.asgi.http_request import AsgiHttpRequest
32+
from slack_bolt.adapter.asgi.builtin import SlackRequestHandler
33+
34+
from slack_bolt.async_app import AsyncApp
35+
36+
from slack_bolt.async_app import AsyncBoltRequest
37+
from slack_bolt.response import BoltResponse
38+
39+
40+
class AsyncSlackRequestHandler(SlackRequestHandler):
41+
app: AsyncApp
42+
43+
def __init__(self, app: AsyncApp, path: str = &#34;/slack/events&#34;):
44+
&#34;&#34;&#34;Setup Bolt as an ASGI web framework, this will make your application compatible with ASGI web servers.
45+
This can be used for production deployment.
46+
47+
With the default settings, `http://localhost:3000/slack/events`
48+
Run Bolt with [uvicron](https://www.uvicorn.org/)
49+
50+
# Python
51+
app = AsyncApp()
52+
api = SlackRequestHandler(app)
53+
54+
# bash
55+
export SLACK_SIGNING_SECRET=***
56+
export SLACK_BOT_TOKEN=xoxb-***
57+
uvicorn app:api --port 3000 --log-level debug
58+
59+
Args:
60+
app: Your bolt application
61+
path: The path to handle request from Slack (Default: `/slack/events`)
62+
&#34;&#34;&#34;
63+
self.path = path
64+
self.app = app
65+
66+
async def dispatch(self, request: AsgiHttpRequest) -&gt; BoltResponse:
67+
return await self.app.async_dispatch(
68+
AsyncBoltRequest(body=await request.get_raw_body(), query=request.query_string, headers=request.get_headers())
69+
)
70+
71+
async def handle_installation(self, request: AsgiHttpRequest) -&gt; BoltResponse:
72+
oauth_flow: AsyncOAuthFlow = self.app.oauth_flow
73+
return await oauth_flow.handle_installation(
74+
AsyncBoltRequest(body=await request.get_raw_body(), query=request.query_string, headers=request.get_headers())
75+
)
76+
77+
async def handle_callback(self, request: AsgiHttpRequest) -&gt; BoltResponse:
78+
oauth_flow: AsyncOAuthFlow = self.app.oauth_flow
79+
return await oauth_flow.handle_callback(
80+
AsyncBoltRequest(body=await request.get_raw_body(), query=request.query_string, headers=request.get_headers())
81+
)</code></pre>
82+
</details>
83+
</section>
84+
<section>
85+
</section>
86+
<section>
87+
</section>
88+
<section>
89+
</section>
90+
<section>
91+
<h2 class="section-title" id="header-classes">Classes</h2>
92+
<dl>
93+
<dt id="slack_bolt.adapter.asgi.aiohttp.AsyncSlackRequestHandler"><code class="flex name class">
94+
<span>class <span class="ident">AsyncSlackRequestHandler</span></span>
95+
<span>(</span><span>app: <a title="slack_bolt.app.async_app.AsyncApp" href="../../../app/async_app.html#slack_bolt.app.async_app.AsyncApp">AsyncApp</a>, path: str = '/slack/events')</span>
96+
</code></dt>
97+
<dd>
98+
<div class="desc"><p>Setup Bolt as an ASGI web framework, this will make your application compatible with ASGI web servers.
99+
This can be used for production deployment.</p>
100+
<p>With the default settings, <code>http://localhost:3000/slack/events</code>
101+
Run Bolt with <a href="https://www.uvicorn.org/">uvicron</a></p>
102+
<pre><code># Python
103+
app = AsyncApp()
104+
api = SlackRequestHandler(app)
105+
106+
# bash
107+
export SLACK_SIGNING_SECRET=***
108+
export SLACK_BOT_TOKEN=xoxb-***
109+
uvicorn app:api --port 3000 --log-level debug
110+
</code></pre>
111+
<h2 id="args">Args</h2>
112+
<dl>
113+
<dt><strong><code>app</code></strong></dt>
114+
<dd>Your bolt application</dd>
115+
<dt><strong><code>path</code></strong></dt>
116+
<dd>The path to handle request from Slack (Default: <code>/slack/events</code>)</dd>
117+
</dl></div>
118+
<details class="source">
119+
<summary>
120+
<span>Expand source code</span>
121+
</summary>
122+
<pre><code class="python">class AsyncSlackRequestHandler(SlackRequestHandler):
123+
app: AsyncApp
124+
125+
def __init__(self, app: AsyncApp, path: str = &#34;/slack/events&#34;):
126+
&#34;&#34;&#34;Setup Bolt as an ASGI web framework, this will make your application compatible with ASGI web servers.
127+
This can be used for production deployment.
128+
129+
With the default settings, `http://localhost:3000/slack/events`
130+
Run Bolt with [uvicron](https://www.uvicorn.org/)
131+
132+
# Python
133+
app = AsyncApp()
134+
api = SlackRequestHandler(app)
135+
136+
# bash
137+
export SLACK_SIGNING_SECRET=***
138+
export SLACK_BOT_TOKEN=xoxb-***
139+
uvicorn app:api --port 3000 --log-level debug
140+
141+
Args:
142+
app: Your bolt application
143+
path: The path to handle request from Slack (Default: `/slack/events`)
144+
&#34;&#34;&#34;
145+
self.path = path
146+
self.app = app
147+
148+
async def dispatch(self, request: AsgiHttpRequest) -&gt; BoltResponse:
149+
return await self.app.async_dispatch(
150+
AsyncBoltRequest(body=await request.get_raw_body(), query=request.query_string, headers=request.get_headers())
151+
)
152+
153+
async def handle_installation(self, request: AsgiHttpRequest) -&gt; BoltResponse:
154+
oauth_flow: AsyncOAuthFlow = self.app.oauth_flow
155+
return await oauth_flow.handle_installation(
156+
AsyncBoltRequest(body=await request.get_raw_body(), query=request.query_string, headers=request.get_headers())
157+
)
158+
159+
async def handle_callback(self, request: AsgiHttpRequest) -&gt; BoltResponse:
160+
oauth_flow: AsyncOAuthFlow = self.app.oauth_flow
161+
return await oauth_flow.handle_callback(
162+
AsyncBoltRequest(body=await request.get_raw_body(), query=request.query_string, headers=request.get_headers())
163+
)</code></pre>
164+
</details>
165+
<h3>Ancestors</h3>
166+
<ul class="hlist">
167+
<li><a title="slack_bolt.adapter.asgi.builtin.SlackRequestHandler" href="../builtin/index.html#slack_bolt.adapter.asgi.builtin.SlackRequestHandler">SlackRequestHandler</a></li>
168+
<li><a title="slack_bolt.adapter.asgi.base_handler.BaseSlackRequestHandler" href="../base_handler.html#slack_bolt.adapter.asgi.base_handler.BaseSlackRequestHandler">BaseSlackRequestHandler</a></li>
169+
</ul>
170+
<h3>Class variables</h3>
171+
<dl>
172+
<dt id="slack_bolt.adapter.asgi.aiohttp.AsyncSlackRequestHandler.app"><code class="name">var <span class="ident">app</span> : <a title="slack_bolt.app.async_app.AsyncApp" href="../../../app/async_app.html#slack_bolt.app.async_app.AsyncApp">AsyncApp</a></code></dt>
173+
<dd>
174+
<div class="desc"></div>
175+
</dd>
176+
</dl>
177+
<h3>Inherited members</h3>
178+
<ul class="hlist">
179+
<li><code><b><a title="slack_bolt.adapter.asgi.builtin.SlackRequestHandler" href="../builtin/index.html#slack_bolt.adapter.asgi.builtin.SlackRequestHandler">SlackRequestHandler</a></b></code>:
180+
<ul class="hlist">
181+
<li><code><a title="slack_bolt.adapter.asgi.builtin.SlackRequestHandler.dispatch" href="../base_handler.html#slack_bolt.adapter.asgi.base_handler.BaseSlackRequestHandler.dispatch">dispatch</a></code></li>
182+
<li><code><a title="slack_bolt.adapter.asgi.builtin.SlackRequestHandler.handle_callback" href="../base_handler.html#slack_bolt.adapter.asgi.base_handler.BaseSlackRequestHandler.handle_callback">handle_callback</a></code></li>
183+
<li><code><a title="slack_bolt.adapter.asgi.builtin.SlackRequestHandler.handle_installation" href="../base_handler.html#slack_bolt.adapter.asgi.base_handler.BaseSlackRequestHandler.handle_installation">handle_installation</a></code></li>
184+
</ul>
185+
</li>
186+
</ul>
187+
</dd>
188+
</dl>
189+
</section>
190+
</article>
191+
<nav id="sidebar">
192+
<h1>Index</h1>
193+
<div class="toc">
194+
<ul></ul>
195+
</div>
196+
<ul id="index">
197+
<li><h3>Super-module</h3>
198+
<ul>
199+
<li><code><a title="slack_bolt.adapter.asgi" href="../index.html">slack_bolt.adapter.asgi</a></code></li>
200+
</ul>
201+
</li>
202+
<li><h3><a href="#header-classes">Classes</a></h3>
203+
<ul>
204+
<li>
205+
<h4><code><a title="slack_bolt.adapter.asgi.aiohttp.AsyncSlackRequestHandler" href="#slack_bolt.adapter.asgi.aiohttp.AsyncSlackRequestHandler">AsyncSlackRequestHandler</a></code></h4>
206+
<ul class="">
207+
<li><code><a title="slack_bolt.adapter.asgi.aiohttp.AsyncSlackRequestHandler.app" href="#slack_bolt.adapter.asgi.aiohttp.AsyncSlackRequestHandler.app">app</a></code></li>
208+
</ul>
209+
</li>
210+
</ul>
211+
</li>
212+
</ul>
213+
</nav>
214+
</main>
215+
<footer id="footer">
216+
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
217+
</footer>
218+
</body>
219+
</html>

0 commit comments

Comments
 (0)