Skip to content

Commit 0b28dfe

Browse files
committed
version 1.6.1
1 parent e6079cd commit 0b28dfe

File tree

17 files changed

+93
-34
lines changed

17 files changed

+93
-34
lines changed

docs/api-docs/slack_bolt/adapter/aws_lambda/handler.html

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,12 @@ <h1 class="title">Module <code>slack_bolt.adapter.aws_lambda.handler</code></h1>
103103

104104

105105
def to_bolt_request(event) -&gt; BoltRequest:
106+
&#34;&#34;&#34;Note that this handler supports only the payload format 2.0.
107+
This means you can use this with HTTP API while REST API is not supported.
108+
109+
Read https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html
110+
for more details.
111+
&#34;&#34;&#34;
106112
body = event.get(&#34;body&#34;, &#34;&#34;)
107113
if event[&#34;isBase64Encoded&#34;]:
108114
body = base64.b64decode(body).decode(&#34;utf-8&#34;)
@@ -177,12 +183,21 @@ <h2 class="section-title" id="header-functions">Functions</h2>
177183
<span>def <span class="ident">to_bolt_request</span></span>(<span>event) ‑> <a title="slack_bolt.request.request.BoltRequest" href="../../request/request.html#slack_bolt.request.request.BoltRequest">BoltRequest</a></span>
178184
</code></dt>
179185
<dd>
180-
<div class="desc"></div>
186+
<div class="desc"><p>Note that this handler supports only the payload format 2.0.
187+
This means you can use this with HTTP API while REST API is not supported.</p>
188+
<p>Read <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html">https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html</a>
189+
for more details.</p></div>
181190
<details class="source">
182191
<summary>
183192
<span>Expand source code</span>
184193
</summary>
185194
<pre><code class="python">def to_bolt_request(event) -&gt; BoltRequest:
195+
&#34;&#34;&#34;Note that this handler supports only the payload format 2.0.
196+
This means you can use this with HTTP API while REST API is not supported.
197+
198+
Read https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html
199+
for more details.
200+
&#34;&#34;&#34;
186201
body = event.get(&#34;body&#34;, &#34;&#34;)
187202
if event[&#34;isBase64Encoded&#34;]:
188203
body = base64.b64decode(body).decode(&#34;utf-8&#34;)

docs/api-docs/slack_bolt/context/ack/ack.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ <h1 class="title">Module <code>slack_bolt.context.ack.ack</code></h1>
4747
text: Union[str, dict] = &#34;&#34;, # text: str or whole_response: dict
4848
blocks: Optional[Sequence[Union[dict, Block]]] = None,
4949
attachments: Optional[Sequence[Union[dict, Attachment]]] = None,
50+
unfurl_links: Optional[bool] = None,
51+
unfurl_media: Optional[bool] = None,
5052
response_type: Optional[str] = None, # in_channel / ephemeral
5153
# block_suggestion / dialog_suggestion
5254
options: Optional[Sequence[Union[dict, Option]]] = None,
@@ -61,6 +63,8 @@ <h1 class="title">Module <code>slack_bolt.context.ack.ack</code></h1>
6163
text_or_whole_response=text,
6264
blocks=blocks,
6365
attachments=attachments,
66+
unfurl_links=unfurl_links,
67+
unfurl_media=unfurl_media,
6468
response_type=response_type,
6569
options=options,
6670
option_groups=option_groups,
@@ -99,6 +103,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
99103
text: Union[str, dict] = &#34;&#34;, # text: str or whole_response: dict
100104
blocks: Optional[Sequence[Union[dict, Block]]] = None,
101105
attachments: Optional[Sequence[Union[dict, Attachment]]] = None,
106+
unfurl_links: Optional[bool] = None,
107+
unfurl_media: Optional[bool] = None,
102108
response_type: Optional[str] = None, # in_channel / ephemeral
103109
# block_suggestion / dialog_suggestion
104110
options: Optional[Sequence[Union[dict, Option]]] = None,
@@ -113,6 +119,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
113119
text_or_whole_response=text,
114120
blocks=blocks,
115121
attachments=attachments,
122+
unfurl_links=unfurl_links,
123+
unfurl_media=unfurl_media,
116124
response_type=response_type,
117125
options=options,
118126
option_groups=option_groups,

docs/api-docs/slack_bolt/context/ack/async_ack.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ <h1 class="title">Module <code>slack_bolt.context.ack.async_ack</code></h1>
4747
text: Union[str, dict] = &#34;&#34;, # text: str or whole_response: dict
4848
blocks: Optional[Sequence[Union[dict, Block]]] = None,
4949
attachments: Optional[Sequence[Union[dict, Attachment]]] = None,
50+
unfurl_links: Optional[bool] = None,
51+
unfurl_media: Optional[bool] = None,
5052
response_type: Optional[str] = None, # in_channel / ephemeral
5153
# block_suggestion / dialog_suggestion
5254
options: Optional[Sequence[Union[dict, Option]]] = None,
@@ -61,6 +63,8 @@ <h1 class="title">Module <code>slack_bolt.context.ack.async_ack</code></h1>
6163
text_or_whole_response=text,
6264
blocks=blocks,
6365
attachments=attachments,
66+
unfurl_links=unfurl_links,
67+
unfurl_media=unfurl_media,
6468
response_type=response_type,
6569
options=options,
6670
option_groups=option_groups,
@@ -99,6 +103,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
99103
text: Union[str, dict] = &#34;&#34;, # text: str or whole_response: dict
100104
blocks: Optional[Sequence[Union[dict, Block]]] = None,
101105
attachments: Optional[Sequence[Union[dict, Attachment]]] = None,
106+
unfurl_links: Optional[bool] = None,
107+
unfurl_media: Optional[bool] = None,
102108
response_type: Optional[str] = None, # in_channel / ephemeral
103109
# block_suggestion / dialog_suggestion
104110
options: Optional[Sequence[Union[dict, Option]]] = None,
@@ -113,6 +119,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
113119
text_or_whole_response=text,
114120
blocks=blocks,
115121
attachments=attachments,
122+
unfurl_links=unfurl_links,
123+
unfurl_media=unfurl_media,
116124
response_type=response_type,
117125
options=options,
118126
option_groups=option_groups,

docs/api-docs/slack_bolt/context/ack/internals.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ <h1 class="title">Module <code>slack_bolt.context.ack.internals</code></h1>
4242
text_or_whole_response: Union[str, dict] = &#34;&#34;,
4343
blocks: Optional[Sequence[Union[dict, Block]]] = None,
4444
attachments: Optional[Sequence[Union[dict, Attachment]]] = None,
45+
unfurl_links: Optional[bool] = None,
46+
unfurl_media: Optional[bool] = None,
4547
response_type: Optional[str] = None, # in_channel / ephemeral
4648
# block_suggestion / dialog_suggestion
4749
options: Optional[Sequence[Union[dict, Option]]] = None,
@@ -56,6 +58,10 @@ <h1 class="title">Module <code>slack_bolt.context.ack.internals</code></h1>
5658
body = {&#34;text&#34;: text}
5759
if response_type:
5860
body[&#34;response_type&#34;] = response_type
61+
if unfurl_links is not None:
62+
body[&#34;unfurl_links&#34;] = unfurl_links
63+
if unfurl_media is not None:
64+
body[&#34;unfurl_media&#34;] = unfurl_media
5965
if attachments and len(attachments) &gt; 0:
6066
body.update(
6167
{&#34;text&#34;: text, &#34;attachments&#34;: convert_to_dict_list(attachments)}

docs/api-docs/slack_bolt/context/respond/async_respond.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ <h1 class="title">Module <code>slack_bolt.context.respond.async_respond</code></
4949
response_type: Optional[str] = None,
5050
replace_original: Optional[bool] = None,
5151
delete_original: Optional[bool] = None,
52+
unfurl_links: Optional[bool] = None,
53+
unfurl_media: Optional[bool] = None,
5254
) -&gt; WebhookResponse:
5355
if self.response_url is not None:
5456
client = AsyncWebhookClient(self.response_url)
@@ -61,6 +63,8 @@ <h1 class="title">Module <code>slack_bolt.context.respond.async_respond</code></
6163
response_type=response_type,
6264
replace_original=replace_original,
6365
delete_original=delete_original,
66+
unfurl_links=unfurl_links,
67+
unfurl_media=unfurl_media,
6468
)
6569
return await client.send_dict(message)
6670
elif isinstance(text_or_whole_response, dict):
@@ -106,6 +110,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
106110
response_type: Optional[str] = None,
107111
replace_original: Optional[bool] = None,
108112
delete_original: Optional[bool] = None,
113+
unfurl_links: Optional[bool] = None,
114+
unfurl_media: Optional[bool] = None,
109115
) -&gt; WebhookResponse:
110116
if self.response_url is not None:
111117
client = AsyncWebhookClient(self.response_url)
@@ -118,6 +124,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
118124
response_type=response_type,
119125
replace_original=replace_original,
120126
delete_original=delete_original,
127+
unfurl_links=unfurl_links,
128+
unfurl_media=unfurl_media,
121129
)
122130
return await client.send_dict(message)
123131
elif isinstance(text_or_whole_response, dict):

docs/api-docs/slack_bolt/context/respond/internals.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ <h1 class="title">Module <code>slack_bolt.context.respond.internals</code></h1>
4141
response_type: Optional[str] = None,
4242
replace_original: Optional[bool] = None,
4343
delete_original: Optional[bool] = None,
44+
unfurl_links: Optional[bool] = None,
45+
unfurl_media: Optional[bool] = None,
4446
) -&gt; Dict[str, Any]:
4547
message = {&#34;text&#34;: text}
4648
if blocks is not None and len(blocks) &gt; 0:
@@ -53,6 +55,10 @@ <h1 class="title">Module <code>slack_bolt.context.respond.internals</code></h1>
5355
message[&#34;replace_original&#34;] = replace_original
5456
if delete_original is not None:
5557
message[&#34;delete_original&#34;] = delete_original
58+
if unfurl_links is not None:
59+
message[&#34;unfurl_links&#34;] = unfurl_links
60+
if unfurl_media is not None:
61+
message[&#34;unfurl_media&#34;] = unfurl_media
5662
return message</code></pre>
5763
</details>
5864
</section>

docs/api-docs/slack_bolt/context/respond/respond.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ <h1 class="title">Module <code>slack_bolt.context.respond.respond</code></h1>
4949
response_type: Optional[str] = None,
5050
replace_original: Optional[bool] = None,
5151
delete_original: Optional[bool] = None,
52+
unfurl_links: Optional[bool] = None,
53+
unfurl_media: Optional[bool] = None,
5254
) -&gt; WebhookResponse:
5355
if self.response_url is not None:
5456
client = WebhookClient(self.response_url)
@@ -62,6 +64,8 @@ <h1 class="title">Module <code>slack_bolt.context.respond.respond</code></h1>
6264
response_type=response_type,
6365
replace_original=replace_original,
6466
delete_original=delete_original,
67+
unfurl_links=unfurl_links,
68+
unfurl_media=unfurl_media,
6569
)
6670
return client.send_dict(message)
6771
elif isinstance(text_or_whole_response, dict):
@@ -108,6 +112,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
108112
response_type: Optional[str] = None,
109113
replace_original: Optional[bool] = None,
110114
delete_original: Optional[bool] = None,
115+
unfurl_links: Optional[bool] = None,
116+
unfurl_media: Optional[bool] = None,
111117
) -&gt; WebhookResponse:
112118
if self.response_url is not None:
113119
client = WebhookClient(self.response_url)
@@ -121,6 +127,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
121127
response_type=response_type,
122128
replace_original=replace_original,
123129
delete_original=delete_original,
130+
unfurl_links=unfurl_links,
131+
unfurl_media=unfurl_media,
124132
)
125133
return client.send_dict(message)
126134
elif isinstance(text_or_whole_response, dict):

docs/api-docs/slack_bolt/context/say/async_say.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,8 @@ <h1 class="title">Module <code>slack_bolt.context.say.async_say</code></h1>
5454
attachments: Optional[Sequence[Union[Dict, Attachment]]] = None,
5555
channel: Optional[str] = None,
5656
thread_ts: Optional[str] = None,
57+
unfurl_links: Optional[bool] = None,
58+
unfurl_media: Optional[bool] = None,
5759
**kwargs,
5860
) -&gt; AsyncSlackResponse:
5961
if _can_say(self, channel):
@@ -66,6 +68,8 @@ <h1 class="title">Module <code>slack_bolt.context.say.async_say</code></h1>
6668
blocks=blocks,
6769
attachments=attachments,
6870
thread_ts=thread_ts,
71+
unfurl_links=unfurl_links,
72+
unfurl_media=unfurl_media,
6973
**kwargs,
7074
)
7175
elif isinstance(text_or_whole_response, dict):
@@ -119,6 +123,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
119123
attachments: Optional[Sequence[Union[Dict, Attachment]]] = None,
120124
channel: Optional[str] = None,
121125
thread_ts: Optional[str] = None,
126+
unfurl_links: Optional[bool] = None,
127+
unfurl_media: Optional[bool] = None,
122128
**kwargs,
123129
) -&gt; AsyncSlackResponse:
124130
if _can_say(self, channel):
@@ -131,6 +137,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
131137
blocks=blocks,
132138
attachments=attachments,
133139
thread_ts=thread_ts,
140+
unfurl_links=unfurl_links,
141+
unfurl_media=unfurl_media,
134142
**kwargs,
135143
)
136144
elif isinstance(text_or_whole_response, dict):

docs/api-docs/slack_bolt/context/say/say.html

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ <h1 class="title">Module <code>slack_bolt.context.say.say</code></h1>
5555
attachments: Optional[Sequence[Union[Dict, Attachment]]] = None,
5656
channel: Optional[str] = None,
5757
thread_ts: Optional[str] = None,
58+
unfurl_links: Optional[bool] = None,
59+
unfurl_media: Optional[bool] = None,
5860
**kwargs,
5961
) -&gt; SlackResponse:
6062
if _can_say(self, channel):
@@ -67,6 +69,8 @@ <h1 class="title">Module <code>slack_bolt.context.say.say</code></h1>
6769
blocks=blocks,
6870
attachments=attachments,
6971
thread_ts=thread_ts,
72+
unfurl_links=unfurl_links,
73+
unfurl_media=unfurl_media,
7074
**kwargs,
7175
)
7276
elif isinstance(text_or_whole_response, dict):
@@ -120,6 +124,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
120124
attachments: Optional[Sequence[Union[Dict, Attachment]]] = None,
121125
channel: Optional[str] = None,
122126
thread_ts: Optional[str] = None,
127+
unfurl_links: Optional[bool] = None,
128+
unfurl_media: Optional[bool] = None,
123129
**kwargs,
124130
) -&gt; SlackResponse:
125131
if _can_say(self, channel):
@@ -132,6 +138,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
132138
blocks=blocks,
133139
attachments=attachments,
134140
thread_ts=thread_ts,
141+
unfurl_links=unfurl_links,
142+
unfurl_media=unfurl_media,
135143
**kwargs,
136144
)
137145
elif isinstance(text_or_whole_response, dict):

docs/api-docs/slack_bolt/kwargs_injection/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8">
55
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
66
<meta name="generator" content="pdoc 0.9.2" />
7-
<title>slack_bolt.the API documentation</title>
7+
<title>slack_bolt.kwargs_injection API documentation</title>
88
<meta name="description" content="For middleware/listener arguments, Bolt does flexible data injection in accordance with their names …" />
99
<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>
1010
<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>

0 commit comments

Comments
 (0)