bolt-python/docs/reference/context/async_context.html at main · SAY-5/bolt-python

729 lines (673 loc) · 39.1 KB
<!doctype html>
<html lang="en">
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
<meta name="generator" content="pdoc3 0.11.6">
<title>slack_bolt.context.async_context API documentation</title>
<meta name="description" content="">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;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:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 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 .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#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-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;min-width:max-content}.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 1em;margin:1em 0}.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>
<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}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
<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>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => {
hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
hljs.highlightAll();
/* Collapse source docstrings */
setTimeout(() => {
[...document.querySelectorAll('.hljs.language-python > .hljs-string')]
.filter(el => el.innerHTML.length > 200 && ['"""', "'''"].includes(el.innerHTML.substring(0, 3)))
.forEach(el => {
let d = document.createElement('details');
d.classList.add('hljs-string');
d.innerHTML = '<summary>"""</summary>' + el.innerHTML.substring(3);
el.replaceWith(d);
})</script>
<article id="content">
<h1 class="title">Module <code>slack_bolt.context.async_context</code></h1>
<section id="section-intro">
<h2 class="section-title" id="header-classes">Classes</h2>
<dt id="slack_bolt.context.async_context.AsyncBoltContext"><code class="flex name class">
<span>class <span class="ident">AsyncBoltContext</span></span>
<span>(</span><span>*args, **kwargs)</span>
</code></dt>
<details class="source">
<span>Expand source code</span>
<pre><code class="python">class AsyncBoltContext(BaseContext):
    &#34;&#34;&#34;Context object associated with a request from Slack.&#34;&#34;&#34;
    def to_copyable(self) -&gt; &#34;AsyncBoltContext&#34;:
        new_dict = {}
        for prop_name, prop_value in self.items():
            if prop_name in self.copyable_standard_property_names:
                # all the standard properties are copiable
                new_dict[prop_name] = prop_value
            elif prop_name in self.non_copyable_standard_property_names:
                # Do nothing with this property (e.g., listener_runner)
                continue
            else:
                    copied_value = create_copy(prop_value)
                    new_dict[prop_name] = copied_value
                except TypeError as te:
                    self.logger.debug(
                        f&#34;Skipped setting &#39;{prop_name}&#39; to a copied request for lazy listeners &#34;
                        f&#34;as it&#39;s not possible to make a deep copy (error: {te})&#34;
        return AsyncBoltContext(new_dict)
    # The return type is intentionally string to avoid circular imports
    @property
    def listener_runner(self) -&gt; &#34;AsyncioListenerRunner&#34;:
        &#34;&#34;&#34;The properly configured listener_runner that is available for middleware/listeners.&#34;&#34;&#34;
        return self[&#34;listener_runner&#34;]
    @property
    def client(self) -&gt; AsyncWebClient:
        &#34;&#34;&#34;The `AsyncWebClient` instance available for this request.
            @app.event(&#34;app_mention&#34;)
            async def handle_events(context):
                await context.client.chat_postMessage(
                    channel=context.channel_id,
                    text=&#34;Thanks!&#34;,
            # You can access &#34;client&#34; this way too.
            @app.event(&#34;app_mention&#34;)
            async def handle_events(client, context):
                await client.chat_postMessage(
                    channel=context.channel_id,
                    text=&#34;Thanks!&#34;,
        Returns:
            `AsyncWebClient` instance
        &#34;&#34;&#34;
        if &#34;client&#34; not in self:
            self[&#34;client&#34;] = AsyncWebClient(token=None)
        return self[&#34;client&#34;]
    @property
    def ack(self) -&gt; AsyncAck:
        &#34;&#34;&#34;`ack()` function for this request.
            @app.action(&#34;button&#34;)
            async def handle_button_clicks(context):
                await context.ack()
            # You can access &#34;ack&#34; this way too.
            @app.action(&#34;button&#34;)
            async def handle_button_clicks(ack):
                await ack()
        Returns:
            Callable `ack()` function
        &#34;&#34;&#34;
        if &#34;ack&#34; not in self:
            self[&#34;ack&#34;] = AsyncAck()
        return self[&#34;ack&#34;]
    @property
    def say(self) -&gt; AsyncSay:
        &#34;&#34;&#34;`say()` function for this request.
            @app.action(&#34;button&#34;)
            async def handle_button_clicks(context):
                await context.ack()
                await context.say(&#34;Hi!&#34;)
            # You can access &#34;ack&#34; this way too.
            @app.action(&#34;button&#34;)
            async def handle_button_clicks(ack, say):
                await ack()
                await say(&#34;Hi!&#34;)
        Returns:
            Callable `say()` function
        &#34;&#34;&#34;
        if &#34;say&#34; not in self:
            self[&#34;say&#34;] = AsyncSay(client=self.client, channel=self.channel_id)
        return self[&#34;say&#34;]
    @property
    def respond(self) -&gt; Optional[AsyncRespond]:
        &#34;&#34;&#34;`respond()` function for this request.
            @app.action(&#34;button&#34;)
            async def handle_button_clicks(context):
                await context.ack()
                await context.respond(&#34;Hi!&#34;)
            # You can access &#34;ack&#34; this way too.
            @app.action(&#34;button&#34;)
            async def handle_button_clicks(ack, respond):
                await ack()
                await respond(&#34;Hi!&#34;)
        Returns:
            Callable `respond()` function
        &#34;&#34;&#34;
        if &#34;respond&#34; not in self:
            self[&#34;respond&#34;] = AsyncRespond(
                response_url=self.response_url,
                proxy=self.client.proxy,
                ssl=self.client.ssl,
        return self[&#34;respond&#34;]
    @property
    def complete(self) -&gt; AsyncComplete:
        &#34;&#34;&#34;`complete()` function for this request. Once a custom function&#39;s state is set to complete,
        any outputs the function returns will be passed along to the next step of its housing workflow,
        or complete the workflow if the function is the last step in a workflow. Additionally,
        any interactivity handlers associated to a function invocation will no longer be invocable.
            @app.function(&#34;reverse&#34;)
            async def handle_button_clicks(ack, complete):
                await ack()
                await complete(outputs={&#34;stringReverse&#34;:&#34;olleh&#34;})
            @app.function(&#34;reverse&#34;)
            async def handle_button_clicks(context):
                await context.ack()
                await context.complete(outputs={&#34;stringReverse&#34;:&#34;olleh&#34;})
        Returns:
            Callable `complete()` function
        &#34;&#34;&#34;
        if &#34;complete&#34; not in self:
            self[&#34;complete&#34;] = AsyncComplete(client=self.client, function_execution_id=self.function_execution_id)
        return self[&#34;complete&#34;]
    @property
    def fail(self) -&gt; AsyncFail:
        &#34;&#34;&#34;`fail()` function for this request. Once a custom function&#39;s state is set to error,
        its housing workflow will be interrupted and any provided error message will be passed
        on to the end user through SlackBot. Additionally, any interactivity handlers associated
        to a function invocation will no longer be invocable.
            @app.function(&#34;reverse&#34;)
            async def handle_button_clicks(ack, fail):
                await ack()
                await fail(error=&#34;something went wrong&#34;)
            @app.function(&#34;reverse&#34;)
            async def handle_button_clicks(context):
                await context.ack()
                await context.fail(error=&#34;something went wrong&#34;)
        Returns:
            Callable `fail()` function
        &#34;&#34;&#34;
        if &#34;fail&#34; not in self:
            self[&#34;fail&#34;] = AsyncFail(client=self.client, function_execution_id=self.function_execution_id)
        return self[&#34;fail&#34;]
    @property
    def set_title(self) -&gt; Optional[AsyncSetTitle]:
        return self.get(&#34;set_title&#34;)
    @property
    def set_status(self) -&gt; Optional[AsyncSetStatus]:
        return self.get(&#34;set_status&#34;)
    @property
    def set_suggested_prompts(self) -&gt; Optional[AsyncSetSuggestedPrompts]:
        return self.get(&#34;set_suggested_prompts&#34;)
    @property
    def get_thread_context(self) -&gt; Optional[AsyncGetThreadContext]:
        return self.get(&#34;get_thread_context&#34;)
    @property
    def say_stream(self) -&gt; Optional[AsyncSayStream]:
        return self.get(&#34;say_stream&#34;)
    @property
    def save_thread_context(self) -&gt; Optional[AsyncSaveThreadContext]:
        return self.get(&#34;save_thread_context&#34;)</code></pre>
<div class="desc"><p>Context object associated with a request from Slack.</p></div>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="slack_bolt.context.base_context.BaseContext" href="base_context.html#slack_bolt.context.base_context.BaseContext">BaseContext</a></li>
<li>builtins.dict</li>
<h3>Instance variables</h3>
<dt id="slack_bolt.context.async_context.AsyncBoltContext.ack"><code class="name">prop <span class="ident">ack</span> : <a title="slack_bolt.context.ack.async_ack.AsyncAck" href="ack/async_ack.html#slack_bolt.context.ack.async_ack.AsyncAck">AsyncAck</a></code></dt>
<details class="source">
<span>Expand source code</span>
<pre><code class="python">@property
def ack(self) -&gt; AsyncAck:
    &#34;&#34;&#34;`ack()` function for this request.
        @app.action(&#34;button&#34;)
        async def handle_button_clicks(context):
            await context.ack()
        # You can access &#34;ack&#34; this way too.
        @app.action(&#34;button&#34;)
        async def handle_button_clicks(ack):
            await ack()
    Returns:
        Callable `ack()` function
    &#34;&#34;&#34;
    if &#34;ack&#34; not in self:
        self[&#34;ack&#34;] = AsyncAck()
    return self[&#34;ack&#34;]</code></pre>
<div class="desc"><p><code>ack()</code> function for this request.</p>
<pre><code>@app.action("button")
async def handle_button_clicks(context):
    await context.ack()
# You can access "ack" this way too.
@app.action("button")
async def handle_button_clicks(ack):
    await ack()
</code></pre>
<h2 id="returns">Returns</h2>
<p>Callable <code>ack()</code> function</p></div>
<dt id="slack_bolt.context.async_context.AsyncBoltContext.client"><code class="name">prop <span class="ident">client</span> : slack_sdk.web.async_client.AsyncWebClient</code></dt>
<details class="source">
<span>Expand source code</span>
<pre><code class="python">@property
def client(self) -&gt; AsyncWebClient:
    &#34;&#34;&#34;The `AsyncWebClient` instance available for this request.
        @app.event(&#34;app_mention&#34;)
        async def handle_events(context):
            await context.client.chat_postMessage(
                channel=context.channel_id,
                text=&#34;Thanks!&#34;,
        # You can access &#34;client&#34; this way too.
        @app.event(&#34;app_mention&#34;)
        async def handle_events(client, context):
            await client.chat_postMessage(
                channel=context.channel_id,
                text=&#34;Thanks!&#34;,
    Returns:
        `AsyncWebClient` instance
    &#34;&#34;&#34;
    if &#34;client&#34; not in self:
        self[&#34;client&#34;] = AsyncWebClient(token=None)
    return self[&#34;client&#34;]</code></pre>
<div class="desc"><p>The <code>AsyncWebClient</code> instance available for this request.</p>
<pre><code>@app.event("app_mention")
async def handle_events(context):
    await context.client.chat_postMessage(
        channel=context.channel_id,
        text="Thanks!",
# You can access "client" this way too.
@app.event("app_mention")
async def handle_events(client, context):
    await client.chat_postMessage(
        channel=context.channel_id,
        text="Thanks!",
</code></pre>
<h2 id="returns">Returns</h2>
<p><code>AsyncWebClient</code> instance</p></div>
<dt id="slack_bolt.context.async_context.AsyncBoltContext.complete"><code class="name">prop <span class="ident">complete</span> : <a title="slack_bolt.context.complete.async_complete.AsyncComplete" href="complete/async_complete.html#slack_bolt.context.complete.async_complete.AsyncComplete">AsyncComplete</a></code></dt>
<details class="source">
<span>Expand source code</span>
<pre><code class="python">@property
def complete(self) -&gt; AsyncComplete:
    &#34;&#34;&#34;`complete()` function for this request. Once a custom function&#39;s state is set to complete,
    any outputs the function returns will be passed along to the next step of its housing workflow,
    or complete the workflow if the function is the last step in a workflow. Additionally,
    any interactivity handlers associated to a function invocation will no longer be invocable.
        @app.function(&#34;reverse&#34;)
        async def handle_button_clicks(ack, complete):
            await ack()
            await complete(outputs={&#34;stringReverse&#34;:&#34;olleh&#34;})
        @app.function(&#34;reverse&#34;)
        async def handle_button_clicks(context):
            await context.ack()
            await context.complete(outputs={&#34;stringReverse&#34;:&#34;olleh&#34;})
    Returns:
        Callable `complete()` function
    &#34;&#34;&#34;
    if &#34;complete&#34; not in self:
        self[&#34;complete&#34;] = AsyncComplete(client=self.client, function_execution_id=self.function_execution_id)
    return self[&#34;complete&#34;]</code></pre>
<div class="desc"><p><code>complete()</code> function for this request. Once a custom function's state is set to complete,
any outputs the function returns will be passed along to the next step of its housing workflow,
or complete the workflow if the function is the last step in a workflow. Additionally,
any interactivity handlers associated to a function invocation will no longer be invocable.</p>
<pre><code>@app.function("reverse")
async def handle_button_clicks(ack, complete):
    await ack()
    await complete(outputs={"stringReverse":"olleh"})
@app.function("reverse")
async def handle_button_clicks(context):
    await context.ack()
    await context.complete(outputs={"stringReverse":"olleh"})
</code></pre>
<h2 id="returns">Returns</h2>
<p>Callable <code>complete()</code> function</p></div>
<dt id="slack_bolt.context.async_context.AsyncBoltContext.fail"><code class="name">prop <span class="ident">fail</span> : <a title="slack_bolt.context.fail.async_fail.AsyncFail" href="fail/async_fail.html#slack_bolt.context.fail.async_fail.AsyncFail">AsyncFail</a></code></dt>
<details class="source">
<span>Expand source code</span>
<pre><code class="python">@property
def fail(self) -&gt; AsyncFail:
    &#34;&#34;&#34;`fail()` function for this request. Once a custom function&#39;s state is set to error,
    its housing workflow will be interrupted and any provided error message will be passed
    on to the end user through SlackBot. Additionally, any interactivity handlers associated
    to a function invocation will no longer be invocable.
        @app.function(&#34;reverse&#34;)
        async def handle_button_clicks(ack, fail):
            await ack()
            await fail(error=&#34;something went wrong&#34;)
        @app.function(&#34;reverse&#34;)
        async def handle_button_clicks(context):
            await context.ack()
            await context.fail(error=&#34;something went wrong&#34;)
    Returns:
        Callable `fail()` function
    &#34;&#34;&#34;
    if &#34;fail&#34; not in self:
        self[&#34;fail&#34;] = AsyncFail(client=self.client, function_execution_id=self.function_execution_id)
    return self[&#34;fail&#34;]</code></pre>
<div class="desc"><p><code>fail()</code> function for this request. Once a custom function's state is set to error,
its housing workflow will be interrupted and any provided error message will be passed
on to the end user through SlackBot. Additionally, any interactivity handlers associated
to a function invocation will no longer be invocable.</p>
<pre><code>@app.function("reverse")
async def handle_button_clicks(ack, fail):
    await ack()
    await fail(error="something went wrong")
@app.function("reverse")
async def handle_button_clicks(context):
    await context.ack()
    await context.fail(error="something went wrong")
</code></pre>
<h2 id="returns">Returns</h2>
<p>Callable <code>fail()</code> function</p></div>
<dt id="slack_bolt.context.async_context.AsyncBoltContext.get_thread_context"><code class="name">prop <span class="ident">get_thread_context</span> : <a title="slack_bolt.context.get_thread_context.async_get_thread_context.AsyncGetThreadContext" href="get_thread_context/async_get_thread_context.html#slack_bolt.context.get_thread_context.async_get_thread_context.AsyncGetThreadContext">AsyncGetThreadContext</a> | None</code></dt>
<details class="source">
<span>Expand source code</span>
<pre><code class="python">@property
def get_thread_context(self) -&gt; Optional[AsyncGetThreadContext]:
    return self.get(&#34;get_thread_context&#34;)</code></pre>
<div class="desc"></div>
<dt id="slack_bolt.context.async_context.AsyncBoltContext.listener_runner"><code class="name">prop <span class="ident">listener_runner</span> : AsyncioListenerRunner</code></dt>
<details class="source">
<span>Expand source code</span>
<pre><code class="python">@property
def listener_runner(self) -&gt; &#34;AsyncioListenerRunner&#34;:
    &#34;&#34;&#34;The properly configured listener_runner that is available for middleware/listeners.&#34;&#34;&#34;
    return self[&#34;listener_runner&#34;]</code></pre>
<div class="desc"><p>The properly configured listener_runner that is available for middleware/listeners.</p></div>
<dt id="slack_bolt.context.async_context.AsyncBoltContext.respond"><code class="name">prop <span class="ident">respond</span> : <a title="slack_bolt.context.respond.async_respond.AsyncRespond" href="respond/async_respond.html#slack_bolt.context.respond.async_respond.AsyncRespond">AsyncRespond</a> | None</code></dt>
<details class="source">
<span>Expand source code</span>
<pre><code class="python">@property
def respond(self) -&gt; Optional[AsyncRespond]:
    &#34;&#34;&#34;`respond()` function for this request.
        @app.action(&#34;button&#34;)
        async def handle_button_clicks(context):
            await context.ack()
            await context.respond(&#34;Hi!&#34;)
        # You can access &#34;ack&#34; this way too.
        @app.action(&#34;button&#34;)
        async def handle_button_clicks(ack, respond):
            await ack()
            await respond(&#34;Hi!&#34;)
    Returns:
        Callable `respond()` function
    &#34;&#34;&#34;
    if &#34;respond&#34; not in self:
        self[&#34;respond&#34;] = AsyncRespond(
            response_url=self.response_url,
            proxy=self.client.proxy,
            ssl=self.client.ssl,
    return self[&#34;respond&#34;]</code></pre>
<div class="desc"><p><code>respond()</code> function for this request.</p>
<pre><code>@app.action("button")
async def handle_button_clicks(context):
    await context.ack()
    await context.respond("Hi!")
# You can access "ack" this way too.
@app.action("button")
async def handle_button_clicks(ack, respond):
    await ack()
    await respond("Hi!")
</code></pre>
<h2 id="returns">Returns</h2>
<p>Callable <code>respond()</code> function</p></div>
<dt id="slack_bolt.context.async_context.AsyncBoltContext.save_thread_context"><code class="name">prop <span class="ident">save_thread_context</span> : <a title="slack_bolt.context.save_thread_context.async_save_thread_context.AsyncSaveThreadContext" href="save_thread_context/async_save_thread_context.html#slack_bolt.context.save_thread_context.async_save_thread_context.AsyncSaveThreadContext">AsyncSaveThreadContext</a> | None</code></dt>
<details class="source">
<span>Expand source code</span>
<pre><code class="python">@property
def save_thread_context(self) -&gt; Optional[AsyncSaveThreadContext]:
    return self.get(&#34;save_thread_context&#34;)</code></pre>
<div class="desc"></div>
<dt id="slack_bolt.context.async_context.AsyncBoltContext.say"><code class="name">prop <span class="ident">say</span> : <a title="slack_bolt.context.say.async_say.AsyncSay" href="say/async_say.html#slack_bolt.context.say.async_say.AsyncSay">AsyncSay</a></code></dt>
<details class="source">
<span>Expand source code</span>
<pre><code class="python">@property
def say(self) -&gt; AsyncSay:
    &#34;&#34;&#34;`say()` function for this request.
        @app.action(&#34;button&#34;)
        async def handle_button_clicks(context):
            await context.ack()
            await context.say(&#34;Hi!&#34;)
        # You can access &#34;ack&#34; this way too.
        @app.action(&#34;button&#34;)
        async def handle_button_clicks(ack, say):
            await ack()
            await say(&#34;Hi!&#34;)
    Returns:
        Callable `say()` function
    &#34;&#34;&#34;
    if &#34;say&#34; not in self:
        self[&#34;say&#34;] = AsyncSay(client=self.client, channel=self.channel_id)
    return self[&#34;say&#34;]</code></pre>
<div class="desc"><p><code>say()</code> function for this request.</p>
<pre><code>@app.action("button")
async def handle_button_clicks(context):
    await context.ack()
    await context.say("Hi!")
# You can access "ack" this way too.
@app.action("button")
async def handle_button_clicks(ack, say):
    await ack()
    await say("Hi!")
</code></pre>
<h2 id="returns">Returns</h2>
<p>Callable <code>say()</code> function</p></div>
<dt id="slack_bolt.context.async_context.AsyncBoltContext.say_stream"><code class="name">prop <span class="ident">say_stream</span> : <a title="slack_bolt.context.say_stream.async_say_stream.AsyncSayStream" href="say_stream/async_say_stream.html#slack_bolt.context.say_stream.async_say_stream.AsyncSayStream">AsyncSayStream</a> | None</code></dt>
<details class="source">
<span>Expand source code</span>
<pre><code class="python">@property
def say_stream(self) -&gt; Optional[AsyncSayStream]:
    return self.get(&#34;say_stream&#34;)</code></pre>
<div class="desc"></div>
<dt id="slack_bolt.context.async_context.AsyncBoltContext.set_status"><code class="name">prop <span class="ident">set_status</span> : <a title="slack_bolt.context.set_status.async_set_status.AsyncSetStatus" href="set_status/async_set_status.html#slack_bolt.context.set_status.async_set_status.AsyncSetStatus">AsyncSetStatus</a> | None</code></dt>
<details class="source">
<span>Expand source code</span>
<pre><code class="python">@property
def set_status(self) -&gt; Optional[AsyncSetStatus]:
    return self.get(&#34;set_status&#34;)</code></pre>
<div class="desc"></div>
<dt id="slack_bolt.context.async_context.AsyncBoltContext.set_suggested_prompts"><code class="name">prop <span class="ident">set_suggested_prompts</span> : <a title="slack_bolt.context.set_suggested_prompts.async_set_suggested_prompts.AsyncSetSuggestedPrompts" href="set_suggested_prompts/async_set_suggested_prompts.html#slack_bolt.context.set_suggested_prompts.async_set_suggested_prompts.AsyncSetSuggestedPrompts">AsyncSetSuggestedPrompts</a> | None</code></dt>
<details class="source">
<span>Expand source code</span>
<pre><code class="python">@property
def set_suggested_prompts(self) -&gt; Optional[AsyncSetSuggestedPrompts]:
    return self.get(&#34;set_suggested_prompts&#34;)</code></pre>
<div class="desc"></div>
<dt id="slack_bolt.context.async_context.AsyncBoltContext.set_title"><code class="name">prop <span class="ident">set_title</span> : <a title="slack_bolt.context.set_title.async_set_title.AsyncSetTitle" href="set_title/async_set_title.html#slack_bolt.context.set_title.async_set_title.AsyncSetTitle">AsyncSetTitle</a> | None</code></dt>
<details class="source">
<span>Expand source code</span>
<pre><code class="python">@property
def set_title(self) -&gt; Optional[AsyncSetTitle]:
    return self.get(&#34;set_title&#34;)</code></pre>
<div class="desc"></div>
<h3>Methods</h3>
<dt id="slack_bolt.context.async_context.AsyncBoltContext.to_copyable"><code class="name flex">
<span>def <span class="ident">to_copyable</span></span>(<span>self) ‑> <a title="slack_bolt.context.async_context.AsyncBoltContext" href="#slack_bolt.context.async_context.AsyncBoltContext">AsyncBoltContext</a></span>
</code></dt>
<details class="source">
<span>Expand source code</span>
<pre><code class="python">def to_copyable(self) -&gt; &#34;AsyncBoltContext&#34;:
    new_dict = {}
    for prop_name, prop_value in self.items():
        if prop_name in self.copyable_standard_property_names:
            # all the standard properties are copiable
            new_dict[prop_name] = prop_value
        elif prop_name in self.non_copyable_standard_property_names:
            # Do nothing with this property (e.g., listener_runner)
            continue
        else:
            try:
                copied_value = create_copy(prop_value)
                new_dict[prop_name] = copied_value
            except TypeError as te:
                self.logger.debug(
                    f&#34;Skipped setting &#39;{prop_name}&#39; to a copied request for lazy listeners &#34;
                    f&#34;as it&#39;s not possible to make a deep copy (error: {te})&#34;
    return AsyncBoltContext(new_dict)</code></pre>
<div class="desc"></div>
<h3>Inherited members</h3>
<ul class="hlist">
<li><code><b><a title="slack_bolt.context.base_context.BaseContext" href="base_context.html#slack_bolt.context.base_context.BaseContext">BaseContext</a></b></code>:
<ul class="hlist">
<li><code><a title="slack_bolt.context.base_context.BaseContext.actor_enterprise_id" href="base_context.html#slack_bolt.context.base_context.BaseContext.actor_enterprise_id">actor_enterprise_id</a></code></li>
<li><code><a title="slack_bolt.context.base_context.BaseContext.actor_team_id" href="base_context.html#slack_bolt.context.base_context.BaseContext.actor_team_id">actor_team_id</a></code></li>
<li><code><a title="slack_bolt.context.base_context.BaseContext.actor_user_id" href="base_context.html#slack_bolt.context.base_context.BaseContext.actor_user_id">actor_user_id</a></code></li>
<li><code><a title="slack_bolt.context.base_context.BaseContext.authorize_result" href="base_context.html#slack_bolt.context.base_context.BaseContext.authorize_result">authorize_result</a></code></li>
<li><code><a title="slack_bolt.context.base_context.BaseContext.bot_id" href="base_context.html#slack_bolt.context.base_context.BaseContext.bot_id">bot_id</a></code></li>
<li><code><a title="slack_bolt.context.base_context.BaseContext.bot_token" href="base_context.html#slack_bolt.context.base_context.BaseContext.bot_token">bot_token</a></code></li>
<li><code><a title="slack_bolt.context.base_context.BaseContext.bot_user_id" href="base_context.html#slack_bolt.context.base_context.BaseContext.bot_user_id">bot_user_id</a></code></li>
<li><code><a title="slack_bolt.context.base_context.BaseContext.channel_id" href="base_context.html#slack_bolt.context.base_context.BaseContext.channel_id">channel_id</a></code></li>
<li><code><a title="slack_bolt.context.base_context.BaseContext.copyable_standard_property_names" href="base_context.html#slack_bolt.context.base_context.BaseContext.copyable_standard_property_names">copyable_standard_property_names</a></code></li>
<li><code><a title="slack_bolt.context.base_context.BaseContext.enterprise_id" href="base_context.html#slack_bolt.context.base_context.BaseContext.enterprise_id">enterprise_id</a></code></li>
<li><code><a title="slack_bolt.context.base_context.BaseContext.function_bot_access_token" href="base_context.html#slack_bolt.context.base_context.BaseContext.function_bot_access_token">function_bot_access_token</a></code></li>
<li><code><a title="slack_bolt.context.base_context.BaseContext.function_execution_id" href="base_context.html#slack_bolt.context.base_context.BaseContext.function_execution_id">function_execution_id</a></code></li>
<li><code><a title="slack_bolt.context.base_context.BaseContext.inputs" href="base_context.html#slack_bolt.context.base_context.BaseContext.inputs">inputs</a></code></li>
<li><code><a title="slack_bolt.context.base_context.BaseContext.is_enterprise_install" href="base_context.html#slack_bolt.context.base_context.BaseContext.is_enterprise_install">is_enterprise_install</a></code></li>
<li><code><a title="slack_bolt.context.base_context.BaseContext.logger" href="base_context.html#slack_bolt.context.base_context.BaseContext.logger">logger</a></code></li>
<li><code><a title="slack_bolt.context.base_context.BaseContext.matches" href="base_context.html#slack_bolt.context.base_context.BaseContext.matches">matches</a></code></li>
<li><code><a title="slack_bolt.context.base_context.BaseContext.non_copyable_standard_property_names" href="base_context.html#slack_bolt.context.base_context.BaseContext.non_copyable_standard_property_names">non_copyable_standard_property_names</a></code></li>
<li><code><a title="slack_bolt.context.base_context.BaseContext.response_url" href="base_context.html#slack_bolt.context.base_context.BaseContext.response_url">response_url</a></code></li>
<li><code><a title="slack_bolt.context.base_context.BaseContext.standard_property_names" href="base_context.html#slack_bolt.context.base_context.BaseContext.standard_property_names">standard_property_names</a></code></li>
<li><code><a title="slack_bolt.context.base_context.BaseContext.team_id" href="base_context.html#slack_bolt.context.base_context.BaseContext.team_id">team_id</a></code></li>
<li><code><a title="slack_bolt.context.base_context.BaseContext.thread_ts" href="base_context.html#slack_bolt.context.base_context.BaseContext.thread_ts">thread_ts</a></code></li>
<li><code><a title="slack_bolt.context.base_context.BaseContext.token" href="base_context.html#slack_bolt.context.base_context.BaseContext.token">token</a></code></li>
<li><code><a title="slack_bolt.context.base_context.BaseContext.user_id" href="base_context.html#slack_bolt.context.base_context.BaseContext.user_id">user_id</a></code></li>
<li><code><a title="slack_bolt.context.base_context.BaseContext.user_token" href="base_context.html#slack_bolt.context.base_context.BaseContext.user_token">user_token</a></code></li>
<nav id="sidebar">
<div class="toc">
<ul id="index">
<li><h3>Super-module</h3>
<li><code><a title="slack_bolt.context" href="index.html">slack_bolt.context</a></code></li>
<li><h3><a href="#header-classes">Classes</a></h3>
<h4><code><a title="slack_bolt.context.async_context.AsyncBoltContext" href="#slack_bolt.context.async_context.AsyncBoltContext">AsyncBoltContext</a></code></h4>
<ul class="">
<li><code><a title="slack_bolt.context.async_context.AsyncBoltContext.ack" href="#slack_bolt.context.async_context.AsyncBoltContext.ack">ack</a></code></li>
<li><code><a title="slack_bolt.context.async_context.AsyncBoltContext.client" href="#slack_bolt.context.async_context.AsyncBoltContext.client">client</a></code></li>
<li><code><a title="slack_bolt.context.async_context.AsyncBoltContext.complete" href="#slack_bolt.context.async_context.AsyncBoltContext.complete">complete</a></code></li>
<li><code><a title="slack_bolt.context.async_context.AsyncBoltContext.fail" href="#slack_bolt.context.async_context.AsyncBoltContext.fail">fail</a></code></li>
<li><code><a title="slack_bolt.context.async_context.AsyncBoltContext.get_thread_context" href="#slack_bolt.context.async_context.AsyncBoltContext.get_thread_context">get_thread_context</a></code></li>
<li><code><a title="slack_bolt.context.async_context.AsyncBoltContext.listener_runner" href="#slack_bolt.context.async_context.AsyncBoltContext.listener_runner">listener_runner</a></code></li>
<li><code><a title="slack_bolt.context.async_context.AsyncBoltContext.respond" href="#slack_bolt.context.async_context.AsyncBoltContext.respond">respond</a></code></li>
<li><code><a title="slack_bolt.context.async_context.AsyncBoltContext.save_thread_context" href="#slack_bolt.context.async_context.AsyncBoltContext.save_thread_context">save_thread_context</a></code></li>
<li><code><a title="slack_bolt.context.async_context.AsyncBoltContext.say" href="#slack_bolt.context.async_context.AsyncBoltContext.say">say</a></code></li>
<li><code><a title="slack_bolt.context.async_context.AsyncBoltContext.say_stream" href="#slack_bolt.context.async_context.AsyncBoltContext.say_stream">say_stream</a></code></li>
<li><code><a title="slack_bolt.context.async_context.AsyncBoltContext.set_status" href="#slack_bolt.context.async_context.AsyncBoltContext.set_status">set_status</a></code></li>
<li><code><a title="slack_bolt.context.async_context.AsyncBoltContext.set_suggested_prompts" href="#slack_bolt.context.async_context.AsyncBoltContext.set_suggested_prompts">set_suggested_prompts</a></code></li>
<li><code><a title="slack_bolt.context.async_context.AsyncBoltContext.set_title" href="#slack_bolt.context.async_context.AsyncBoltContext.set_title">set_title</a></code></li>
<li><code><a title="slack_bolt.context.async_context.AsyncBoltContext.to_copyable" href="#slack_bolt.context.async_context.AsyncBoltContext.to_copyable">to_copyable</a></code></li>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.6</a>.</p>
Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

async_context.html

Latest commit

History

async_context.html

File metadata and controls
