diff --git a/.github/maintainers_guide.md b/.github/maintainers_guide.md index 85b4e13be..69026d602 100644 --- a/.github/maintainers_guide.md +++ b/.github/maintainers_guide.md @@ -157,10 +157,12 @@ password: {your password} - Commit with a message including the new version number. For example `1.2.3` & Push the commit to a branch and create a PR to sanity check. - `git checkout -b v1.2.3` - `git commit -a -m 'version 1.2.3'` + - `git push -u origin HEAD` - Open a PR and merge after receiving at least one approval from other maintainers. 2. Distribute the release - Use the latest stable Python runtime + - `git checkout main && git pull` - `python --version` - `python -m venv .venv` - `./scripts/deploy_to_pypi_org.sh` diff --git a/docs/reference/adapter/aiohttp/index.html b/docs/reference/adapter/aiohttp/index.html index 879b7a023..7d7ceedbe 100644 --- a/docs/reference/adapter/aiohttp/index.html +++ b/docs/reference/adapter/aiohttp/index.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.aiohttp API documentation @@ -122,7 +122,7 @@

Functions

diff --git a/docs/reference/adapter/asgi/aiohttp/index.html b/docs/reference/adapter/asgi/aiohttp/index.html index d598dc6cb..a6aa7c92d 100644 --- a/docs/reference/adapter/asgi/aiohttp/index.html +++ b/docs/reference/adapter/asgi/aiohttp/index.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.asgi.aiohttp API documentation @@ -158,7 +158,7 @@

diff --git a/docs/reference/adapter/asgi/async_handler.html b/docs/reference/adapter/asgi/async_handler.html index 9ecdb6fd3..23433ffce 100644 --- a/docs/reference/adapter/asgi/async_handler.html +++ b/docs/reference/adapter/asgi/async_handler.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.asgi.async_handler API documentation @@ -158,7 +158,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/asgi/base_handler.html b/docs/reference/adapter/asgi/base_handler.html index 2e194b12b..b8a6da68f 100644 --- a/docs/reference/adapter/asgi/base_handler.html +++ b/docs/reference/adapter/asgi/base_handler.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.asgi.base_handler API documentation @@ -204,7 +204,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/asgi/builtin/index.html b/docs/reference/adapter/asgi/builtin/index.html index 4a0d0c777..9147380c5 100644 --- a/docs/reference/adapter/asgi/builtin/index.html +++ b/docs/reference/adapter/asgi/builtin/index.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.asgi.builtin API documentation @@ -159,7 +159,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/asgi/http_request.html b/docs/reference/adapter/asgi/http_request.html index 38ab574da..062ac7ca2 100644 --- a/docs/reference/adapter/asgi/http_request.html +++ b/docs/reference/adapter/asgi/http_request.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.asgi.http_request API documentation @@ -250,7 +250,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/asgi/http_response.html b/docs/reference/adapter/asgi/http_response.html index 93c929224..86e368f6e 100644 --- a/docs/reference/adapter/asgi/http_response.html +++ b/docs/reference/adapter/asgi/http_response.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.asgi.http_response API documentation @@ -252,7 +252,7 @@

diff --git a/docs/reference/adapter/asgi/index.html b/docs/reference/adapter/asgi/index.html index 295ead704..0f2abec74 100644 --- a/docs/reference/adapter/asgi/index.html +++ b/docs/reference/adapter/asgi/index.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.asgi API documentation @@ -201,7 +201,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/asgi/utils.html b/docs/reference/adapter/asgi/utils.html index 031deda6c..8eb2a24f1 100644 --- a/docs/reference/adapter/asgi/utils.html +++ b/docs/reference/adapter/asgi/utils.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.asgi.utils API documentation @@ -60,7 +60,7 @@

Module slack_bolt.adapter.asgi.utils

diff --git a/docs/reference/adapter/aws_lambda/chalice_handler.html b/docs/reference/adapter/aws_lambda/chalice_handler.html index e8bd162ec..28c75ea6a 100644 --- a/docs/reference/adapter/aws_lambda/chalice_handler.html +++ b/docs/reference/adapter/aws_lambda/chalice_handler.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.aws_lambda.chalice_handler API documentation @@ -278,7 +278,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/aws_lambda/chalice_lazy_listener_runner.html b/docs/reference/adapter/aws_lambda/chalice_lazy_listener_runner.html index 8bd6428c1..f27e09c93 100644 --- a/docs/reference/adapter/aws_lambda/chalice_lazy_listener_runner.html +++ b/docs/reference/adapter/aws_lambda/chalice_lazy_listener_runner.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.aws_lambda.chalice_lazy_listener_runner API documentation @@ -124,7 +124,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/aws_lambda/handler.html b/docs/reference/adapter/aws_lambda/handler.html index 48fd279c2..08e4ac9b7 100644 --- a/docs/reference/adapter/aws_lambda/handler.html +++ b/docs/reference/adapter/aws_lambda/handler.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.aws_lambda.handler API documentation @@ -281,7 +281,7 @@

diff --git a/docs/reference/adapter/aws_lambda/index.html b/docs/reference/adapter/aws_lambda/index.html index 023c9b6eb..0aae2c31a 100644 --- a/docs/reference/adapter/aws_lambda/index.html +++ b/docs/reference/adapter/aws_lambda/index.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.aws_lambda API documentation @@ -249,7 +249,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/aws_lambda/internals.html b/docs/reference/adapter/aws_lambda/internals.html index 94fa2be46..bbbe281b0 100644 --- a/docs/reference/adapter/aws_lambda/internals.html +++ b/docs/reference/adapter/aws_lambda/internals.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.aws_lambda.internals API documentation @@ -60,7 +60,7 @@

Module slack_bolt.adapter.aws_lambda.internals diff --git a/docs/reference/adapter/aws_lambda/lambda_s3_oauth_flow.html b/docs/reference/adapter/aws_lambda/lambda_s3_oauth_flow.html index 067ad846d..11845c902 100644 --- a/docs/reference/adapter/aws_lambda/lambda_s3_oauth_flow.html +++ b/docs/reference/adapter/aws_lambda/lambda_s3_oauth_flow.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.aws_lambda.lambda_s3_oauth_flow API documentation @@ -204,7 +204,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/aws_lambda/lazy_listener_runner.html b/docs/reference/adapter/aws_lambda/lazy_listener_runner.html index 4fbebcd4e..df53f5f22 100644 --- a/docs/reference/adapter/aws_lambda/lazy_listener_runner.html +++ b/docs/reference/adapter/aws_lambda/lazy_listener_runner.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.aws_lambda.lazy_listener_runner API documentation @@ -116,7 +116,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/aws_lambda/local_lambda_client.html b/docs/reference/adapter/aws_lambda/local_lambda_client.html index 1441fb2b7..45ee0510b 100644 --- a/docs/reference/adapter/aws_lambda/local_lambda_client.html +++ b/docs/reference/adapter/aws_lambda/local_lambda_client.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.aws_lambda.local_lambda_client API documentation @@ -134,7 +134,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/bottle/handler.html b/docs/reference/adapter/bottle/handler.html index e14b2da44..fe6f8ae1a 100644 --- a/docs/reference/adapter/bottle/handler.html +++ b/docs/reference/adapter/bottle/handler.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.bottle.handler API documentation @@ -186,7 +186,7 @@

diff --git a/docs/reference/adapter/bottle/index.html b/docs/reference/adapter/bottle/index.html index 0ceecb7f7..f240d52bc 100644 --- a/docs/reference/adapter/bottle/index.html +++ b/docs/reference/adapter/bottle/index.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.bottle API documentation @@ -153,7 +153,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/cherrypy/handler.html b/docs/reference/adapter/cherrypy/handler.html index 735786296..d41f00148 100644 --- a/docs/reference/adapter/cherrypy/handler.html +++ b/docs/reference/adapter/cherrypy/handler.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.cherrypy.handler API documentation @@ -228,7 +228,7 @@

diff --git a/docs/reference/adapter/cherrypy/index.html b/docs/reference/adapter/cherrypy/index.html index a1c121e05..5a322fd7a 100644 --- a/docs/reference/adapter/cherrypy/index.html +++ b/docs/reference/adapter/cherrypy/index.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.cherrypy API documentation @@ -157,7 +157,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/django/handler.html b/docs/reference/adapter/django/handler.html index a2de8c99d..4fe9e359a 100644 --- a/docs/reference/adapter/django/handler.html +++ b/docs/reference/adapter/django/handler.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.django.handler API documentation @@ -382,7 +382,7 @@

diff --git a/docs/reference/adapter/django/index.html b/docs/reference/adapter/django/index.html index ed9f43658..dfb6af63f 100644 --- a/docs/reference/adapter/django/index.html +++ b/docs/reference/adapter/django/index.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.django API documentation @@ -194,7 +194,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/falcon/async_resource.html b/docs/reference/adapter/falcon/async_resource.html index 07d432390..f43ab11ef 100644 --- a/docs/reference/adapter/falcon/async_resource.html +++ b/docs/reference/adapter/falcon/async_resource.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.falcon.async_resource API documentation @@ -87,7 +87,7 @@

Classes

resp.status = "404" # Falcon 4.x w/ mypy fails to correctly infer the str type here - resp.body = "The page is not found..." # type: ignore[assignment] + resp.body = "The page is not found..." async def on_post(self, req: Request, resp: Response): bolt_req = await self._to_bolt_request(req) @@ -151,7 +151,7 @@

Methods

resp.status = "404" # Falcon 4.x w/ mypy fails to correctly infer the str type here - resp.body = "The page is not found..." # type: ignore[assignment] + resp.body = "The page is not found..."
@@ -200,7 +200,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/falcon/index.html b/docs/reference/adapter/falcon/index.html index 50874f7b8..82a2a57e2 100644 --- a/docs/reference/adapter/falcon/index.html +++ b/docs/reference/adapter/falcon/index.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.falcon API documentation @@ -93,7 +93,7 @@

Classes

resp.status = "404" # Falcon 4.x w/ mypy fails to correctly infer the str type here - resp.body = "The page is not found..." # type: ignore[assignment] + resp.body = "The page is not found..." def on_post(self, req: Request, resp: Response): bolt_req = self._to_bolt_request(req) @@ -110,7 +110,7 @@

Classes

def _write_response(self, bolt_resp: BoltResponse, resp: Response): if falcon_version.__version__.startswith("2."): # Falcon 4.x w/ mypy fails to correctly infer the str type here - resp.body = bolt_resp.body # type: ignore[assignment] + resp.body = bolt_resp.body else: resp.text = bolt_resp.body @@ -161,7 +161,7 @@

Methods

resp.status = "404" # Falcon 4.x w/ mypy fails to correctly infer the str type here - resp.body = "The page is not found..." # type: ignore[assignment] + resp.body = "The page is not found..."
@@ -216,7 +216,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/falcon/resource.html b/docs/reference/adapter/falcon/resource.html index b999b290c..73860adc1 100644 --- a/docs/reference/adapter/falcon/resource.html +++ b/docs/reference/adapter/falcon/resource.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.falcon.resource API documentation @@ -82,7 +82,7 @@

Classes

resp.status = "404" # Falcon 4.x w/ mypy fails to correctly infer the str type here - resp.body = "The page is not found..." # type: ignore[assignment] + resp.body = "The page is not found..." def on_post(self, req: Request, resp: Response): bolt_req = self._to_bolt_request(req) @@ -99,7 +99,7 @@

Classes

def _write_response(self, bolt_resp: BoltResponse, resp: Response): if falcon_version.__version__.startswith("2."): # Falcon 4.x w/ mypy fails to correctly infer the str type here - resp.body = bolt_resp.body # type: ignore[assignment] + resp.body = bolt_resp.body else: resp.text = bolt_resp.body @@ -150,7 +150,7 @@

Methods

resp.status = "404" # Falcon 4.x w/ mypy fails to correctly infer the str type here - resp.body = "The page is not found..." # type: ignore[assignment] + resp.body = "The page is not found..."
@@ -199,7 +199,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/fastapi/async_handler.html b/docs/reference/adapter/fastapi/async_handler.html index 0056ce305..6f6205e51 100644 --- a/docs/reference/adapter/fastapi/async_handler.html +++ b/docs/reference/adapter/fastapi/async_handler.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.fastapi.async_handler API documentation @@ -149,7 +149,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/fastapi/index.html b/docs/reference/adapter/fastapi/index.html index 49b91a814..6ffb52f35 100644 --- a/docs/reference/adapter/fastapi/index.html +++ b/docs/reference/adapter/fastapi/index.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.fastapi API documentation @@ -153,7 +153,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/flask/handler.html b/docs/reference/adapter/flask/handler.html index 1b3952603..489b80a90 100644 --- a/docs/reference/adapter/flask/handler.html +++ b/docs/reference/adapter/flask/handler.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.flask.handler API documentation @@ -179,7 +179,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/flask/index.html b/docs/reference/adapter/flask/index.html index 7d4b60292..ee765fa1e 100644 --- a/docs/reference/adapter/flask/index.html +++ b/docs/reference/adapter/flask/index.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.flask API documentation @@ -145,7 +145,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/google_cloud_functions/handler.html b/docs/reference/adapter/google_cloud_functions/handler.html index 0b48a26a4..1d9b0da7f 100644 --- a/docs/reference/adapter/google_cloud_functions/handler.html +++ b/docs/reference/adapter/google_cloud_functions/handler.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.google_cloud_functions.handler API documentation @@ -170,7 +170,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/google_cloud_functions/index.html b/docs/reference/adapter/google_cloud_functions/index.html index 3ad305b8d..790d210be 100644 --- a/docs/reference/adapter/google_cloud_functions/index.html +++ b/docs/reference/adapter/google_cloud_functions/index.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.google_cloud_functions API documentation @@ -147,7 +147,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/index.html b/docs/reference/adapter/index.html index 78ef4a2f7..646c0ac81 100644 --- a/docs/reference/adapter/index.html +++ b/docs/reference/adapter/index.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter API documentation @@ -148,7 +148,7 @@

Sub-modules

diff --git a/docs/reference/adapter/pyramid/handler.html b/docs/reference/adapter/pyramid/handler.html index 2f26bbc38..4a4a68849 100644 --- a/docs/reference/adapter/pyramid/handler.html +++ b/docs/reference/adapter/pyramid/handler.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.pyramid.handler API documentation @@ -195,7 +195,7 @@

diff --git a/docs/reference/adapter/pyramid/index.html b/docs/reference/adapter/pyramid/index.html index 30d3685e8..7f0903cb6 100644 --- a/docs/reference/adapter/pyramid/index.html +++ b/docs/reference/adapter/pyramid/index.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.pyramid API documentation @@ -151,7 +151,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/sanic/async_handler.html b/docs/reference/adapter/sanic/async_handler.html index 37945775c..adabe53be 100644 --- a/docs/reference/adapter/sanic/async_handler.html +++ b/docs/reference/adapter/sanic/async_handler.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.sanic.async_handler API documentation @@ -210,7 +210,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/sanic/index.html b/docs/reference/adapter/sanic/index.html index 1ae23450c..558bb321c 100644 --- a/docs/reference/adapter/sanic/index.html +++ b/docs/reference/adapter/sanic/index.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.sanic API documentation @@ -153,7 +153,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/socket_mode/aiohttp/index.html b/docs/reference/adapter/socket_mode/aiohttp/index.html index f9d240874..cc91a3d06 100644 --- a/docs/reference/adapter/socket_mode/aiohttp/index.html +++ b/docs/reference/adapter/socket_mode/aiohttp/index.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.socket_mode.aiohttp API documentation @@ -239,7 +239,7 @@

diff --git a/docs/reference/adapter/socket_mode/async_base_handler.html b/docs/reference/adapter/socket_mode/async_base_handler.html index 31b681b3c..b00420c11 100644 --- a/docs/reference/adapter/socket_mode/async_base_handler.html +++ b/docs/reference/adapter/socket_mode/async_base_handler.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.socket_mode.async_base_handler API documentation @@ -240,7 +240,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/socket_mode/async_handler.html b/docs/reference/adapter/socket_mode/async_handler.html index 5093f1281..447ecf0ea 100644 --- a/docs/reference/adapter/socket_mode/async_handler.html +++ b/docs/reference/adapter/socket_mode/async_handler.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.socket_mode.async_handler API documentation @@ -142,7 +142,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/socket_mode/async_internals.html b/docs/reference/adapter/socket_mode/async_internals.html index 5b7769483..d2e300efa 100644 --- a/docs/reference/adapter/socket_mode/async_internals.html +++ b/docs/reference/adapter/socket_mode/async_internals.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.socket_mode.async_internals API documentation @@ -121,7 +121,7 @@

Functions

diff --git a/docs/reference/adapter/socket_mode/base_handler.html b/docs/reference/adapter/socket_mode/base_handler.html index b57156928..450f9ac0e 100644 --- a/docs/reference/adapter/socket_mode/base_handler.html +++ b/docs/reference/adapter/socket_mode/base_handler.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.socket_mode.base_handler API documentation @@ -252,7 +252,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/socket_mode/builtin/index.html b/docs/reference/adapter/socket_mode/builtin/index.html index ab1837ae3..fc66eb203 100644 --- a/docs/reference/adapter/socket_mode/builtin/index.html +++ b/docs/reference/adapter/socket_mode/builtin/index.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.socket_mode.builtin API documentation @@ -200,7 +200,7 @@

diff --git a/docs/reference/adapter/socket_mode/index.html b/docs/reference/adapter/socket_mode/index.html index cb26a212a..511ef4840 100644 --- a/docs/reference/adapter/socket_mode/index.html +++ b/docs/reference/adapter/socket_mode/index.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.socket_mode API documentation @@ -260,7 +260,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/socket_mode/internals.html b/docs/reference/adapter/socket_mode/internals.html index 7c1a7a81f..55d96b054 100644 --- a/docs/reference/adapter/socket_mode/internals.html +++ b/docs/reference/adapter/socket_mode/internals.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.socket_mode.internals API documentation @@ -119,7 +119,7 @@

Functions

diff --git a/docs/reference/adapter/socket_mode/websocket_client/index.html b/docs/reference/adapter/socket_mode/websocket_client/index.html index d6a4b50b4..e837ef19b 100644 --- a/docs/reference/adapter/socket_mode/websocket_client/index.html +++ b/docs/reference/adapter/socket_mode/websocket_client/index.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.socket_mode.websocket_client API documentation @@ -190,7 +190,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/socket_mode/websockets/index.html b/docs/reference/adapter/socket_mode/websockets/index.html index 2b7e9f493..7f96f0021 100644 --- a/docs/reference/adapter/socket_mode/websockets/index.html +++ b/docs/reference/adapter/socket_mode/websockets/index.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.socket_mode.websockets API documentation @@ -239,7 +239,7 @@

diff --git a/docs/reference/adapter/starlette/async_handler.html b/docs/reference/adapter/starlette/async_handler.html index e8e596f2a..91345eba3 100644 --- a/docs/reference/adapter/starlette/async_handler.html +++ b/docs/reference/adapter/starlette/async_handler.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.starlette.async_handler API documentation @@ -213,7 +213,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/starlette/handler.html b/docs/reference/adapter/starlette/handler.html index 5171240fd..5c74b71da 100644 --- a/docs/reference/adapter/starlette/handler.html +++ b/docs/reference/adapter/starlette/handler.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.starlette.handler API documentation @@ -205,7 +205,7 @@

diff --git a/docs/reference/adapter/starlette/index.html b/docs/reference/adapter/starlette/index.html index 3af382537..bdf5bf42a 100644 --- a/docs/reference/adapter/starlette/index.html +++ b/docs/reference/adapter/starlette/index.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.starlette API documentation @@ -158,7 +158,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/tornado/async_handler.html b/docs/reference/adapter/tornado/async_handler.html index b7d813420..c274429de 100644 --- a/docs/reference/adapter/tornado/async_handler.html +++ b/docs/reference/adapter/tornado/async_handler.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.tornado.async_handler API documentation @@ -242,7 +242,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/tornado/handler.html b/docs/reference/adapter/tornado/handler.html index 1149311a9..a69adb987 100644 --- a/docs/reference/adapter/tornado/handler.html +++ b/docs/reference/adapter/tornado/handler.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.tornado.handler API documentation @@ -273,7 +273,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/tornado/index.html b/docs/reference/adapter/tornado/index.html index dac1b6b78..a5bec4ffb 100644 --- a/docs/reference/adapter/tornado/index.html +++ b/docs/reference/adapter/tornado/index.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.tornado API documentation @@ -234,7 +234,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/wsgi/handler.html b/docs/reference/adapter/wsgi/handler.html index 8369cb636..204499a05 100644 --- a/docs/reference/adapter/wsgi/handler.html +++ b/docs/reference/adapter/wsgi/handler.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.wsgi.handler API documentation @@ -230,7 +230,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/wsgi/http_request.html b/docs/reference/adapter/wsgi/http_request.html index c4495e440..fa845dd93 100644 --- a/docs/reference/adapter/wsgi/http_request.html +++ b/docs/reference/adapter/wsgi/http_request.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.wsgi.http_request API documentation @@ -373,7 +373,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/wsgi/http_response.html b/docs/reference/adapter/wsgi/http_response.html index 3ddc2350c..da7dc33f0 100644 --- a/docs/reference/adapter/wsgi/http_response.html +++ b/docs/reference/adapter/wsgi/http_response.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.wsgi.http_response API documentation @@ -191,7 +191,7 @@

diff --git a/docs/reference/adapter/wsgi/index.html b/docs/reference/adapter/wsgi/index.html index 49ab0d930..c3cfafea1 100644 --- a/docs/reference/adapter/wsgi/index.html +++ b/docs/reference/adapter/wsgi/index.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.wsgi API documentation @@ -257,7 +257,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/adapter/wsgi/internals.html b/docs/reference/adapter/wsgi/internals.html index addbae583..7fdfa267f 100644 --- a/docs/reference/adapter/wsgi/internals.html +++ b/docs/reference/adapter/wsgi/internals.html @@ -3,7 +3,7 @@ - + slack_bolt.adapter.wsgi.internals API documentation @@ -60,7 +60,7 @@

Module slack_bolt.adapter.wsgi.internals

diff --git a/docs/reference/app/app.html b/docs/reference/app/app.html index 02fc5b036..d1224dd5d 100644 --- a/docs/reference/app/app.html +++ b/docs/reference/app/app.html @@ -3,7 +3,7 @@ - + slack_bolt.app.app API documentation @@ -675,7 +675,7 @@

Classes

""" Deprecated: Steps from apps for legacy workflows are now deprecated. - Use new custom steps: https://docs.slack.dev/workflows/workflow-steps + Use new custom steps: https://api.slack.com/automation/functions/custom-bolt Registers a new step from app listener. @@ -693,7 +693,7 @@

Classes

# Pass Step to set up listeners app.step(ws) - Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details of steps from apps. + Refer to https://api.slack.com/workflows/steps for details of steps from apps. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -710,7 +710,7 @@

Classes

warnings.warn( ( "Steps from apps for legacy workflows are now deprecated. " - "Use new custom steps: https://docs.slack.dev/workflows/workflow-steps" + "Use new custom steps: https://api.slack.com/automation/functions/custom-bolt" ), category=DeprecationWarning, ) @@ -787,7 +787,7 @@

Classes

# Pass a function to this method app.event("team_join")(ask_for_introduction) - Refer to https://docs.slack.dev/apis/events-api/ for details of Events API. + Refer to https://api.slack.com/apis/connections/events-api for details of Events API. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -825,7 +825,7 @@

Classes

# Pass a function to this method app.message(":wave:")(say_hello) - Refer to https://docs.slack.dev/reference/events/message for details of `message` events. + Refer to https://api.slack.com/events/message for details of `message` events. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -871,6 +871,7 @@

Classes

matchers: Optional[Sequence[Callable[..., bool]]] = None, middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, auto_acknowledge: bool = True, + ack_timeout: int = 3, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new Function listener. This method can be used as either a decorator or a method. @@ -899,13 +900,17 @@

Classes

Only when all the middleware call `next()` method, the listener function can be invoked. """ + if auto_acknowledge is True: + if ack_timeout != 3: + self._framework_logger.warning(warning_ack_timeout_has_no_effect(callback_id, ack_timeout)) + matchers = list(matchers) if matchers else [] middleware = list(middleware) if middleware else [] def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) primary_matcher = builtin_matchers.function_executed(callback_id=callback_id, base_logger=self._base_logger) - return self._register_listener(functions, primary_matcher, matchers, middleware, auto_acknowledge) + return self._register_listener(functions, primary_matcher, matchers, middleware, auto_acknowledge, ack_timeout) return __call__ @@ -931,7 +936,7 @@

Classes

# Pass a function to this method app.command("/echo")(repeat_text) - Refer to https://docs.slack.dev/interactivity/implementing-slash-commands for details of Slash Commands. + Refer to https://api.slack.com/interactivity/slash-commands for details of Slash Commands. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -978,7 +983,7 @@

Classes

# Pass a function to this method app.shortcut("open_modal")(open_modal) - Refer to https://docs.slack.dev/interactivity/implementing-shortcuts for details about Shortcuts. + Refer to https://api.slack.com/interactivity/shortcuts for details about Shortcuts. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -1046,9 +1051,9 @@

Classes

# Pass a function to this method app.action("approve_button")(update_message) - * Refer to https://docs.slack.dev/reference/interaction-payloads/block_actions-payload for actions in `blocks`. - * Refer to https://docs.slack.dev/legacy/legacy-messaging/legacy-message-buttons for actions in `attachments`. - * Refer to https://docs.slack.dev/legacy/legacy-dialogs for actions in dialogs. + * Refer to https://api.slack.com/reference/interaction-payloads/block-actions for actions in `blocks`. + * Refer to https://api.slack.com/legacy/message-buttons for actions in `attachments`. + * Refer to https://api.slack.com/dialogs for actions in dialogs. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -1074,7 +1079,7 @@

Classes

middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `block_actions` action listener. - Refer to https://docs.slack.dev/reference/interaction-payloads/block_actions-payload for details. + Refer to https://api.slack.com/reference/interaction-payloads/block-actions for details. """ def __call__(*args, **kwargs): @@ -1091,7 +1096,7 @@

Classes

middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `interactive_message` action listener. - Refer to https://docs.slack.dev/legacy/legacy-messaging/legacy-message-buttons for details.""" + Refer to https://api.slack.com/legacy/message-buttons for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1107,7 +1112,7 @@

Classes

middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `dialog_submission` listener. - Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.""" + Refer to https://api.slack.com/dialogs for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1123,7 +1128,7 @@

Classes

middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `dialog_cancellation` listener. - Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.""" + Refer to https://api.slack.com/dialogs for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1164,7 +1169,7 @@

Classes

# Pass a function to this method app.view("view_1")(handle_submission) - Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload for details of payloads. + Refer to https://api.slack.com/reference/interaction-payloads/views for details of payloads. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -1190,7 +1195,7 @@

Classes

middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `view_submission` listener. - Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload#view_submission for details.""" + Refer to https://api.slack.com/reference/interaction-payloads/views#view_submission for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1206,7 +1211,7 @@

Classes

middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `view_closed` listener. - Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload#view_closed for details.""" + Refer to https://api.slack.com/reference/interaction-payloads/views#view_closed for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1247,7 +1252,8 @@

Classes

Refer to the following documents for details: - * https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element#external_multi_select + * https://api.slack.com/reference/block-kit/block-elements#external_select + * https://api.slack.com/reference/block-kit/block-elements#external_multi_select To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -1287,7 +1293,7 @@

Classes

middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `dialog_suggestion` listener. - Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.""" + Refer to https://api.slack.com/dialogs for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1380,6 +1386,7 @@

Classes

matchers: Optional[Sequence[Callable[..., bool]]], middleware: Optional[Sequence[Union[Callable, Middleware]]], auto_acknowledgement: bool = False, + ack_timeout: int = 3, ) -> Optional[Callable[..., Optional[BoltResponse]]]: value_to_return = None if not isinstance(functions, list): @@ -1406,10 +1413,11 @@

Classes

CustomListener( app_name=self.name, ack_function=functions.pop(0), - lazy_functions=functions, + lazy_functions=functions, # type:ignore[arg-type] matchers=listener_matchers, middleware=listener_middleware, auto_acknowledgement=auto_acknowledgement, + ack_timeout=ack_timeout, base_logger=self._base_logger, ) ) @@ -1629,9 +1637,9 @@

Methods

# Pass a function to this method app.action("approve_button")(update_message) - * Refer to https://docs.slack.dev/reference/interaction-payloads/block_actions-payload for actions in `blocks`. - * Refer to https://docs.slack.dev/legacy/legacy-messaging/legacy-message-buttons for actions in `attachments`. - * Refer to https://docs.slack.dev/legacy/legacy-dialogs for actions in dialogs. + * Refer to https://api.slack.com/reference/interaction-payloads/block-actions for actions in `blocks`. + * Refer to https://api.slack.com/legacy/message-buttons for actions in `attachments`. + * Refer to https://api.slack.com/dialogs for actions in dialogs. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -1660,9 +1668,9 @@

Methods

app.action("approve_button")(update_message)

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.args's API document.

Args

@@ -1705,7 +1713,7 @@

Args

middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `interactive_message` action listener. - Refer to https://docs.slack.dev/legacy/legacy-messaging/legacy-message-buttons for details.""" + Refer to https://api.slack.com/legacy/message-buttons for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1715,7 +1723,7 @@

Args

return __call__

Registers a new interactive_message action listener. -Refer to https://docs.slack.dev/legacy/legacy-messaging/legacy-message-buttons for details.

+Refer to https://api.slack.com/legacy/message-buttons for details.

def block_action(self,
constraints: str | Pattern | Dict[str, str | Pattern],
matchers: Sequence[Callable[..., bool]] | None = None,
middleware: Sequence[Callable | Middleware] | None = None) ‑> Callable[..., Callable[..., BoltResponse | None] | None] @@ -1732,7 +1740,7 @@

Args

middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `block_actions` action listener. - Refer to https://docs.slack.dev/reference/interaction-payloads/block_actions-payload for details. + Refer to https://api.slack.com/reference/interaction-payloads/block-actions for details. """ def __call__(*args, **kwargs): @@ -1743,7 +1751,7 @@

Args

return __call__

Registers a new block_actions action listener. -Refer to https://docs.slack.dev/reference/interaction-payloads/block_actions-payload for details.

+Refer to https://api.slack.com/reference/interaction-payloads/block-actions for details.

def block_suggestion(self,
action_id: str | Pattern,
matchers: Sequence[Callable[..., bool]] | None = None,
middleware: Sequence[Callable | Middleware] | None = None) ‑> Callable[..., Callable[..., BoltResponse | None] | None] @@ -1797,7 +1805,7 @@

Args

# Pass a function to this method app.command("/echo")(repeat_text) - Refer to https://docs.slack.dev/interactivity/implementing-slash-commands for details of Slash Commands. + Refer to https://api.slack.com/interactivity/slash-commands for details of Slash Commands. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -1828,7 +1836,7 @@

Args

# Pass a function to this method app.command("/echo")(repeat_text) -

Refer to https://docs.slack.dev/interactivity/implementing-slash-commands for details of Slash Commands.

+

Refer to https://api.slack.com/interactivity/slash-commands for details of Slash Commands.

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.args's API document.

Args

@@ -1891,7 +1899,7 @@

Args

middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `dialog_cancellation` listener. - Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.""" + Refer to https://api.slack.com/dialogs for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1901,7 +1909,7 @@

Args

return __call__

Registers a new dialog_cancellation listener. -Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.

+Refer to https://api.slack.com/dialogs for details.

def dialog_submission(self,
callback_id: str | Pattern,
matchers: Sequence[Callable[..., bool]] | None = None,
middleware: Sequence[Callable | Middleware] | None = None) ‑> Callable[..., Callable[..., BoltResponse | None] | None] @@ -1918,7 +1926,7 @@

Args

middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `dialog_submission` listener. - Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.""" + Refer to https://api.slack.com/dialogs for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1928,7 +1936,7 @@

Args

return __call__

Registers a new dialog_submission listener. -Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.

+Refer to https://api.slack.com/dialogs for details.

def dialog_suggestion(self,
callback_id: str | Pattern,
matchers: Sequence[Callable[..., bool]] | None = None,
middleware: Sequence[Callable | Middleware] | None = None) ‑> Callable[..., Callable[..., BoltResponse | None] | None] @@ -1945,7 +1953,7 @@

Args

middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `dialog_suggestion` listener. - Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.""" + Refer to https://api.slack.com/dialogs for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1955,7 +1963,7 @@

Args

return __call__

Registers a new dialog_suggestion listener. -Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.

+Refer to https://api.slack.com/dialogs for details.

def dispatch(self,
req: BoltRequest) ‑> BoltResponse @@ -2181,7 +2189,7 @@

Args

# Pass a function to this method app.event("team_join")(ask_for_introduction) - Refer to https://docs.slack.dev/apis/events-api/ for details of Events API. + Refer to https://api.slack.com/apis/connections/events-api for details of Events API. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -2213,7 +2221,7 @@

Args

# Pass a function to this method app.event("team_join")(ask_for_introduction) -

Refer to https://docs.slack.dev/apis/events-api/ for details of Events API.

+

Refer to https://api.slack.com/apis/connections/events-api for details of Events API.

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.args's API document.

Args

@@ -2229,7 +2237,7 @@

Args

-def function(self,
callback_id: str | Pattern,
matchers: Sequence[Callable[..., bool]] | None = None,
middleware: Sequence[Callable | Middleware] | None = None,
auto_acknowledge: bool = True) ‑> Callable[..., Callable[..., BoltResponse | None] | None] +def function(self,
callback_id: str | Pattern,
matchers: Sequence[Callable[..., bool]] | None = None,
middleware: Sequence[Callable | Middleware] | None = None,
auto_acknowledge: bool = True,
ack_timeout: int = 3) ‑> Callable[..., Callable[..., BoltResponse | None] | None]
@@ -2242,6 +2250,7 @@

Args

matchers: Optional[Sequence[Callable[..., bool]]] = None, middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, auto_acknowledge: bool = True, + ack_timeout: int = 3, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new Function listener. This method can be used as either a decorator or a method. @@ -2270,13 +2279,17 @@

Args

Only when all the middleware call `next()` method, the listener function can be invoked. """ + if auto_acknowledge is True: + if ack_timeout != 3: + self._framework_logger.warning(warning_ack_timeout_has_no_effect(callback_id, ack_timeout)) + matchers = list(matchers) if matchers else [] middleware = list(middleware) if middleware else [] def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) primary_matcher = builtin_matchers.function_executed(callback_id=callback_id, base_logger=self._base_logger) - return self._register_listener(functions, primary_matcher, matchers, middleware, auto_acknowledge) + return self._register_listener(functions, primary_matcher, matchers, middleware, auto_acknowledge, ack_timeout) return __call__
@@ -2360,7 +2373,7 @@

Args

# Pass a function to this method app.message(":wave:")(say_hello) - Refer to https://docs.slack.dev/reference/events/message for details of `message` events. + Refer to https://api.slack.com/events/message for details of `message` events. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -2411,7 +2424,7 @@

Args

# Pass a function to this method app.message(":wave:")(say_hello) -

Refer to https://docs.slack.dev/reference/events/message for details of message events.

+

Refer to https://api.slack.com/events/message for details of message events.

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.args's API document.

Args

@@ -2554,7 +2567,8 @@

Args

Refer to the following documents for details: - * https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element#external_multi_select + * https://api.slack.com/reference/block-kit/block-elements#external_select + * https://api.slack.com/reference/block-kit/block-elements#external_multi_select To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -2594,7 +2608,8 @@

Args

Refer to the following documents for details:

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.args's API document.

Args

@@ -2640,7 +2655,7 @@

Args

# Pass a function to this method app.shortcut("open_modal")(open_modal) - Refer to https://docs.slack.dev/interactivity/implementing-shortcuts for details about Shortcuts. + Refer to https://api.slack.com/interactivity/shortcuts for details about Shortcuts. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -2677,7 +2692,7 @@

Args

# Pass a function to this method app.shortcut("open_modal")(open_modal) -

Refer to https://docs.slack.dev/interactivity/implementing-shortcuts for details about Shortcuts.

+

Refer to https://api.slack.com/interactivity/shortcuts for details about Shortcuts.

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.args's API document.

Args

@@ -2763,7 +2778,7 @@

Args

""" Deprecated: Steps from apps for legacy workflows are now deprecated. - Use new custom steps: https://docs.slack.dev/workflows/workflow-steps + Use new custom steps: https://api.slack.com/automation/functions/custom-bolt Registers a new step from app listener. @@ -2781,7 +2796,7 @@

Args

# Pass Step to set up listeners app.step(ws) - Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details of steps from apps. + Refer to https://api.slack.com/workflows/steps for details of steps from apps. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -2798,7 +2813,7 @@

Args

warnings.warn( ( "Steps from apps for legacy workflows are now deprecated. " - "Use new custom steps: https://docs.slack.dev/workflows/workflow-steps" + "Use new custom steps: https://api.slack.com/automation/functions/custom-bolt" ), category=DeprecationWarning, ) @@ -2820,7 +2835,7 @@

Args

Deprecated

Steps from apps for legacy workflows are now deprecated. -Use new custom steps: https://docs.slack.dev/workflows/workflow-steps

+Use new custom steps: https://api.slack.com/automation/functions/custom-bolt

Registers a new step from app listener.

Unlike others, this method doesn't behave as a decorator. If you want to register a step from app by a decorator, use WorkflowStepBuilder's methods.

@@ -2835,7 +2850,7 @@

Args

# Pass Step to set up listeners app.step(ws) -

Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details of steps from apps.

+

Refer to https://api.slack.com/workflows/steps for details of steps from apps.

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.args's API document.

For further information about WorkflowStep specific function arguments such as configure, update, complete, and fail, @@ -2906,7 +2921,7 @@

Args

# Pass a function to this method app.view("view_1")(handle_submission) - Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload for details of payloads. + Refer to https://api.slack.com/reference/interaction-payloads/views for details of payloads. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -2947,7 +2962,7 @@

Args

# Pass a function to this method app.view("view_1")(handle_submission) -

Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload for details of payloads.

+

Refer to https://api.slack.com/reference/interaction-payloads/views for details of payloads.

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.args's API document.

Args

@@ -2976,7 +2991,7 @@

Args

middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `view_closed` listener. - Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload#view_closed for details.""" + Refer to https://api.slack.com/reference/interaction-payloads/views#view_closed for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -2986,7 +3001,7 @@

Args

return __call__

Registers a new view_closed listener. -Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload#view_closed for details.

+Refer to https://api.slack.com/reference/interaction-payloads/views#view_closed for details.

def view_submission(self,
constraints: str | Pattern,
matchers: Sequence[Callable[..., bool]] | None = None,
middleware: Sequence[Callable | Middleware] | None = None) ‑> Callable[..., Callable[..., BoltResponse | None] | None] @@ -3003,7 +3018,7 @@

Args

middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `view_submission` listener. - Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload#view_submission for details.""" + Refer to https://api.slack.com/reference/interaction-payloads/views#view_submission for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -3013,7 +3028,7 @@

Args

return __call__

Registers a new view_submission listener. -Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload#view_submission for details.

+Refer to https://api.slack.com/reference/interaction-payloads/views#view_submission for details.

@@ -3264,7 +3279,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/app/async_app.html b/docs/reference/app/async_app.html index 66af8f038..b6634710a 100644 --- a/docs/reference/app/async_app.html +++ b/docs/reference/app/async_app.html @@ -3,7 +3,7 @@ - + slack_bolt.app.async_app API documentation @@ -687,7 +687,7 @@

Classes

""" Deprecated: Steps from apps for legacy workflows are now deprecated. - Use new custom steps: https://docs.slack.dev/workflows/workflow-steps + Use new custom steps: https://api.slack.com/automation/functions/custom-bolt Registers a new step from app listener. @@ -705,7 +705,7 @@

Classes

# Pass Step to set up listeners app.step(ws) - Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details of steps from apps. + Refer to https://api.slack.com/workflows/steps for details of steps from apps. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.async_args`'s API document. For further information about AsyncWorkflowStep specific function arguments @@ -721,7 +721,7 @@

Classes

warnings.warn( ( "Steps from apps for legacy workflows are now deprecated. " - "Use new custom steps: https://docs.slack.dev/workflows/workflow-steps" + "Use new custom steps: https://api.slack.com/automation/functions/custom-bolt" ), category=DeprecationWarning, ) @@ -803,7 +803,7 @@

Classes

# Pass a function to this method app.event("team_join")(ask_for_introduction) - Refer to https://docs.slack.dev/apis/events-api/ for details of Events API. + Refer to https://api.slack.com/apis/connections/events-api for details of Events API. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.async_args`'s API document. @@ -841,7 +841,7 @@

Classes

# Pass a function to this method app.message(":wave:")(say_hello) - Refer to https://docs.slack.dev/reference/events/message for details of `message` events. + Refer to https://api.slack.com/events/message for details of `message` events. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.async_args`'s API document. @@ -890,6 +890,7 @@

Classes

matchers: Optional[Sequence[Callable[..., Awaitable[bool]]]] = None, middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None, auto_acknowledge: bool = True, + ack_timeout: int = 3, ) -> Callable[..., Optional[Callable[..., Awaitable[BoltResponse]]]]: """Registers a new Function listener. This method can be used as either a decorator or a method. @@ -917,6 +918,9 @@

Classes

middleware: A list of lister middleware functions. Only when all the middleware call `next()` method, the listener function can be invoked. """ + if auto_acknowledge is True: + if ack_timeout != 3: + self._framework_logger.warning(warning_ack_timeout_has_no_effect(callback_id, ack_timeout)) matchers = list(matchers) if matchers else [] middleware = list(middleware) if middleware else [] @@ -926,7 +930,7 @@

Classes

primary_matcher = builtin_matchers.function_executed( callback_id=callback_id, base_logger=self._base_logger, asyncio=True ) - return self._register_listener(functions, primary_matcher, matchers, middleware, auto_acknowledge) + return self._register_listener(functions, primary_matcher, matchers, middleware, auto_acknowledge, ack_timeout) return __call__ @@ -952,7 +956,7 @@

Classes

# Pass a function to this method app.command("/echo")(repeat_text) - Refer to https://docs.slack.dev/interactivity/implementing-slash-commands for details of Slash Commands. + Refer to https://api.slack.com/interactivity/slash-commands for details of Slash Commands. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.async_args`'s API document. @@ -999,7 +1003,7 @@

Classes

# Pass a function to this method app.shortcut("open_modal")(open_modal) - Refer to https://docs.slack.dev/interactivity/implementing-shortcuts for details about Shortcuts. + Refer to https://api.slack.com/interactivity/shortcuts for details about Shortcuts. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.async_args`'s API document. @@ -1067,9 +1071,9 @@

Classes

# Pass a function to this method app.action("approve_button")(update_message) - * Refer to https://docs.slack.dev/reference/interaction-payloads/block_actions-payload for actions in `blocks`. - * Refer to https://docs.slack.dev/legacy/legacy-messaging/legacy-message-buttons for actions in `attachments`. - * Refer to https://docs.slack.dev/legacy/legacy-dialogs for actions in dialogs. + * Refer to https://api.slack.com/reference/interaction-payloads/block-actions for actions in `blocks`. + * Refer to https://api.slack.com/legacy/message-buttons for actions in `attachments`. + * Refer to https://api.slack.com/dialogs for actions in dialogs. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.async_args`'s API document. @@ -1095,7 +1099,7 @@

Classes

middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None, ) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]: """Registers a new `block_actions` action listener. - Refer to https://docs.slack.dev/reference/interaction-payloads/block_actions-payload for details. + Refer to https://api.slack.com/reference/interaction-payloads/block-actions for details. """ def __call__(*args, **kwargs): @@ -1112,7 +1116,7 @@

Classes

middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None, ) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]: """Registers a new `interactive_message` action listener. - Refer to https://docs.slack.dev/legacy/legacy-messaging/legacy-message-buttons for details.""" + Refer to https://api.slack.com/legacy/message-buttons for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1128,7 +1132,7 @@

Classes

middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None, ) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]: """Registers a new `dialog_submission` listener. - Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.""" + Refer to https://api.slack.com/dialogs for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1144,7 +1148,7 @@

Classes

middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None, ) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]: """Registers a new `dialog_submission` listener. - Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.""" + Refer to https://api.slack.com/dialogs for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1185,7 +1189,7 @@

Classes

# Pass a function to this method app.view("view_1")(handle_submission) - Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload for details of payloads. + Refer to https://api.slack.com/reference/interaction-payloads/views for details of payloads. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.async_args`'s API document. @@ -1211,7 +1215,7 @@

Classes

middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None, ) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]: """Registers a new `view_submission` listener. - Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload#view_submission for details.""" + Refer to https://api.slack.com/reference/interaction-payloads/views#view_submission for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1227,7 +1231,7 @@

Classes

middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None, ) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]: """Registers a new `view_closed` listener. - Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload#view_closed for details.""" + Refer to https://api.slack.com/reference/interaction-payloads/views#view_closed for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1268,7 +1272,8 @@

Classes

Refer to the following documents for details: - * https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element#external_multi_select + * https://api.slack.com/reference/block-kit/block-elements#external_select + * https://api.slack.com/reference/block-kit/block-elements#external_multi_select To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.async_args`'s API document. @@ -1308,7 +1313,7 @@

Classes

middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None, ) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]: """Registers a new `dialog_suggestion` listener. - Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.""" + Refer to https://api.slack.com/dialogs for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1405,6 +1410,7 @@

Classes

matchers: Optional[Sequence[Callable[..., Awaitable[bool]]]], middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]], auto_acknowledgement: bool = False, + ack_timeout: int = 3, ) -> Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]: value_to_return = None if not isinstance(functions, list): @@ -1436,10 +1442,11 @@

Classes

AsyncCustomListener( app_name=self.name, ack_function=functions.pop(0), - lazy_functions=functions, + lazy_functions=functions, # type:ignore[arg-type] matchers=listener_matchers, middleware=listener_middleware, auto_acknowledgement=auto_acknowledgement, + ack_timeout=ack_timeout, base_logger=self._base_logger, ) ) @@ -1662,9 +1669,9 @@

Methods

# Pass a function to this method app.action("approve_button")(update_message) - * Refer to https://docs.slack.dev/reference/interaction-payloads/block_actions-payload for actions in `blocks`. - * Refer to https://docs.slack.dev/legacy/legacy-messaging/legacy-message-buttons for actions in `attachments`. - * Refer to https://docs.slack.dev/legacy/legacy-dialogs for actions in dialogs. + * Refer to https://api.slack.com/reference/interaction-payloads/block-actions for actions in `blocks`. + * Refer to https://api.slack.com/legacy/message-buttons for actions in `attachments`. + * Refer to https://api.slack.com/dialogs for actions in dialogs. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.async_args`'s API document. @@ -1693,9 +1700,9 @@

Methods

app.action("approve_button")(update_message)

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.async_args's API document.

Args

@@ -1866,7 +1873,7 @@

Returns

middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None, ) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]: """Registers a new `interactive_message` action listener. - Refer to https://docs.slack.dev/legacy/legacy-messaging/legacy-message-buttons for details.""" + Refer to https://api.slack.com/legacy/message-buttons for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1876,7 +1883,7 @@

Returns

return __call__

Registers a new interactive_message action listener. -Refer to https://docs.slack.dev/legacy/legacy-messaging/legacy-message-buttons for details.

+Refer to https://api.slack.com/legacy/message-buttons for details.

def block_action(self,
constraints: str | Pattern | Dict[str, str | Pattern],
matchers: Sequence[Callable[..., Awaitable[bool]]] | None = None,
middleware: Sequence[Callable | AsyncMiddleware] | None = None) ‑> Callable[..., Callable[..., Awaitable[BoltResponse | None]] | None] @@ -1893,7 +1900,7 @@

Returns

middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None, ) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]: """Registers a new `block_actions` action listener. - Refer to https://docs.slack.dev/reference/interaction-payloads/block_actions-payload for details. + Refer to https://api.slack.com/reference/interaction-payloads/block-actions for details. """ def __call__(*args, **kwargs): @@ -1904,7 +1911,7 @@

Returns

return __call__

Registers a new block_actions action listener. -Refer to https://docs.slack.dev/reference/interaction-payloads/block_actions-payload for details.

+Refer to https://api.slack.com/reference/interaction-payloads/block-actions for details.

def block_suggestion(self,
action_id: str | Pattern,
matchers: Sequence[Callable[..., Awaitable[bool]]] | None = None,
middleware: Sequence[Callable | AsyncMiddleware] | None = None) ‑> Callable[..., Callable[..., Awaitable[BoltResponse | None]] | None] @@ -1958,7 +1965,7 @@

Returns

# Pass a function to this method app.command("/echo")(repeat_text) - Refer to https://docs.slack.dev/interactivity/implementing-slash-commands for details of Slash Commands. + Refer to https://api.slack.com/interactivity/slash-commands for details of Slash Commands. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.async_args`'s API document. @@ -1989,7 +1996,7 @@

Returns

# Pass a function to this method app.command("/echo")(repeat_text) -

Refer to https://docs.slack.dev/interactivity/implementing-slash-commands for details of Slash Commands.

+

Refer to https://api.slack.com/interactivity/slash-commands for details of Slash Commands.

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.async_args's API document.

Args

@@ -2052,7 +2059,7 @@

Args

middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None, ) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]: """Registers a new `dialog_submission` listener. - Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.""" + Refer to https://api.slack.com/dialogs for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -2062,7 +2069,7 @@

Args

return __call__

Registers a new dialog_submission listener. -Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.

+Refer to https://api.slack.com/dialogs for details.

def dialog_submission(self,
callback_id: str | Pattern,
matchers: Sequence[Callable[..., Awaitable[bool]]] | None = None,
middleware: Sequence[Callable | AsyncMiddleware] | None = None) ‑> Callable[..., Callable[..., Awaitable[BoltResponse | None]] | None] @@ -2079,7 +2086,7 @@

Args

middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None, ) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]: """Registers a new `dialog_submission` listener. - Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.""" + Refer to https://api.slack.com/dialogs for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -2089,7 +2096,7 @@

Args

return __call__

Registers a new dialog_submission listener. -Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.

+Refer to https://api.slack.com/dialogs for details.

def dialog_suggestion(self,
callback_id: str | Pattern,
matchers: Sequence[Callable[..., Awaitable[bool]]] | None = None,
middleware: Sequence[Callable | AsyncMiddleware] | None = None) ‑> Callable[..., Callable[..., Awaitable[BoltResponse | None]] | None] @@ -2106,7 +2113,7 @@

Args

middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None, ) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]: """Registers a new `dialog_suggestion` listener. - Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.""" + Refer to https://api.slack.com/dialogs for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -2116,7 +2123,7 @@

Args

return __call__

Registers a new dialog_suggestion listener. -Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.

+Refer to https://api.slack.com/dialogs for details.

def enable_token_revocation_listeners(self) ‑> None @@ -2222,7 +2229,7 @@

Args

# Pass a function to this method app.event("team_join")(ask_for_introduction) - Refer to https://docs.slack.dev/apis/events-api/ for details of Events API. + Refer to https://api.slack.com/apis/connections/events-api for details of Events API. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.async_args`'s API document. @@ -2254,7 +2261,7 @@

Args

# Pass a function to this method app.event("team_join")(ask_for_introduction) -

Refer to https://docs.slack.dev/apis/events-api/ for details of Events API.

+

Refer to https://api.slack.com/apis/connections/events-api for details of Events API.

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.async_args's API document.

Args

@@ -2270,7 +2277,7 @@

Args

-def function(self,
callback_id: str | Pattern,
matchers: Sequence[Callable[..., Awaitable[bool]]] | None = None,
middleware: Sequence[Callable | AsyncMiddleware] | None = None,
auto_acknowledge: bool = True) ‑> Callable[..., Callable[..., Awaitable[BoltResponse]] | None] +def function(self,
callback_id: str | Pattern,
matchers: Sequence[Callable[..., Awaitable[bool]]] | None = None,
middleware: Sequence[Callable | AsyncMiddleware] | None = None,
auto_acknowledge: bool = True,
ack_timeout: int = 3) ‑> Callable[..., Callable[..., Awaitable[BoltResponse]] | None]
@@ -2283,6 +2290,7 @@

Args

matchers: Optional[Sequence[Callable[..., Awaitable[bool]]]] = None, middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None, auto_acknowledge: bool = True, + ack_timeout: int = 3, ) -> Callable[..., Optional[Callable[..., Awaitable[BoltResponse]]]]: """Registers a new Function listener. This method can be used as either a decorator or a method. @@ -2310,6 +2318,9 @@

Args

middleware: A list of lister middleware functions. Only when all the middleware call `next()` method, the listener function can be invoked. """ + if auto_acknowledge is True: + if ack_timeout != 3: + self._framework_logger.warning(warning_ack_timeout_has_no_effect(callback_id, ack_timeout)) matchers = list(matchers) if matchers else [] middleware = list(middleware) if middleware else [] @@ -2319,7 +2330,7 @@

Args

primary_matcher = builtin_matchers.function_executed( callback_id=callback_id, base_logger=self._base_logger, asyncio=True ) - return self._register_listener(functions, primary_matcher, matchers, middleware, auto_acknowledge) + return self._register_listener(functions, primary_matcher, matchers, middleware, auto_acknowledge, ack_timeout) return __call__
@@ -2403,7 +2414,7 @@

Args

# Pass a function to this method app.message(":wave:")(say_hello) - Refer to https://docs.slack.dev/reference/events/message for details of `message` events. + Refer to https://api.slack.com/events/message for details of `message` events. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.async_args`'s API document. @@ -2457,7 +2468,7 @@

Args

# Pass a function to this method app.message(":wave:")(say_hello) -

Refer to https://docs.slack.dev/reference/events/message for details of message events.

+

Refer to https://api.slack.com/events/message for details of message events.

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.async_args's API document.

Args

@@ -2597,7 +2608,8 @@

Args

Refer to the following documents for details: - * https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element#external_multi_select + * https://api.slack.com/reference/block-kit/block-elements#external_select + * https://api.slack.com/reference/block-kit/block-elements#external_multi_select To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.async_args`'s API document. @@ -2637,7 +2649,8 @@

Args

Refer to the following documents for details:

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.async_args's API document.

Args

@@ -2726,7 +2739,7 @@

Args

# Pass a function to this method app.shortcut("open_modal")(open_modal) - Refer to https://docs.slack.dev/interactivity/implementing-shortcuts for details about Shortcuts. + Refer to https://api.slack.com/interactivity/shortcuts for details about Shortcuts. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.async_args`'s API document. @@ -2763,7 +2776,7 @@

Args

# Pass a function to this method app.shortcut("open_modal")(open_modal) -

Refer to https://docs.slack.dev/interactivity/implementing-shortcuts for details about Shortcuts.

+

Refer to https://api.slack.com/interactivity/shortcuts for details about Shortcuts.

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.async_args's API document.

Args

@@ -2826,7 +2839,7 @@

Args

""" Deprecated: Steps from apps for legacy workflows are now deprecated. - Use new custom steps: https://docs.slack.dev/workflows/workflow-steps + Use new custom steps: https://api.slack.com/automation/functions/custom-bolt Registers a new step from app listener. @@ -2844,7 +2857,7 @@

Args

# Pass Step to set up listeners app.step(ws) - Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details of steps from apps. + Refer to https://api.slack.com/workflows/steps for details of steps from apps. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.async_args`'s API document. For further information about AsyncWorkflowStep specific function arguments @@ -2860,7 +2873,7 @@

Args

warnings.warn( ( "Steps from apps for legacy workflows are now deprecated. " - "Use new custom steps: https://docs.slack.dev/workflows/workflow-steps" + "Use new custom steps: https://api.slack.com/automation/functions/custom-bolt" ), category=DeprecationWarning, ) @@ -2882,7 +2895,7 @@

Args

Deprecated

Steps from apps for legacy workflows are now deprecated. -Use new custom steps: https://docs.slack.dev/workflows/workflow-steps

+Use new custom steps: https://api.slack.com/automation/functions/custom-bolt

Registers a new step from app listener.

Unlike others, this method doesn't behave as a decorator. If you want to register a step from app by a decorator, use AsyncWorkflowStepBuilder's methods.

@@ -2897,7 +2910,7 @@

Args

# Pass Step to set up listeners app.step(ws) -

Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details of steps from apps.

+

Refer to https://api.slack.com/workflows/steps for details of steps from apps.

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.async_args's API document. For further information about AsyncWorkflowStep specific function arguments such as configure, update, complete, and fail, @@ -2965,7 +2978,7 @@

Args

# Pass a function to this method app.view("view_1")(handle_submission) - Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload for details of payloads. + Refer to https://api.slack.com/reference/interaction-payloads/views for details of payloads. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.async_args`'s API document. @@ -3006,7 +3019,7 @@

Args

# Pass a function to this method app.view("view_1")(handle_submission) -

Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload for details of payloads.

+

Refer to https://api.slack.com/reference/interaction-payloads/views for details of payloads.

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.async_args's API document.

Args

@@ -3035,7 +3048,7 @@

Args

middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None, ) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]: """Registers a new `view_closed` listener. - Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload#view_closed for details.""" + Refer to https://api.slack.com/reference/interaction-payloads/views#view_closed for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -3045,7 +3058,7 @@

Args

return __call__

Registers a new view_closed listener. -Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload#view_closed for details.

+Refer to https://api.slack.com/reference/interaction-payloads/views#view_closed for details.

def view_submission(self,
constraints: str | Pattern,
matchers: Sequence[Callable[..., Awaitable[bool]]] | None = None,
middleware: Sequence[Callable | AsyncMiddleware] | None = None) ‑> Callable[..., Callable[..., Awaitable[BoltResponse | None]] | None] @@ -3062,7 +3075,7 @@

Args

middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None, ) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]: """Registers a new `view_submission` listener. - Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload#view_submission for details.""" + Refer to https://api.slack.com/reference/interaction-payloads/views#view_submission for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -3072,7 +3085,7 @@

Args

return __call__

Registers a new view_submission listener. -Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload#view_submission for details.

+Refer to https://api.slack.com/reference/interaction-payloads/views#view_submission for details.

def web_app(self, path: str = '/slack/events', port: int = 3000) ‑> aiohttp.web_app.Application @@ -3192,7 +3205,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/app/async_server.html b/docs/reference/app/async_server.html index 25d28fed1..b95b8a2b3 100644 --- a/docs/reference/app/async_server.html +++ b/docs/reference/app/async_server.html @@ -3,7 +3,7 @@ - + slack_bolt.app.async_server API documentation @@ -270,7 +270,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/app/index.html b/docs/reference/app/index.html index f1a7e9655..857fb22c8 100644 --- a/docs/reference/app/index.html +++ b/docs/reference/app/index.html @@ -3,7 +3,7 @@ - + slack_bolt.app API documentation @@ -694,7 +694,7 @@

Classes

""" Deprecated: Steps from apps for legacy workflows are now deprecated. - Use new custom steps: https://docs.slack.dev/workflows/workflow-steps + Use new custom steps: https://api.slack.com/automation/functions/custom-bolt Registers a new step from app listener. @@ -712,7 +712,7 @@

Classes

# Pass Step to set up listeners app.step(ws) - Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details of steps from apps. + Refer to https://api.slack.com/workflows/steps for details of steps from apps. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -729,7 +729,7 @@

Classes

warnings.warn( ( "Steps from apps for legacy workflows are now deprecated. " - "Use new custom steps: https://docs.slack.dev/workflows/workflow-steps" + "Use new custom steps: https://api.slack.com/automation/functions/custom-bolt" ), category=DeprecationWarning, ) @@ -806,7 +806,7 @@

Classes

# Pass a function to this method app.event("team_join")(ask_for_introduction) - Refer to https://docs.slack.dev/apis/events-api/ for details of Events API. + Refer to https://api.slack.com/apis/connections/events-api for details of Events API. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -844,7 +844,7 @@

Classes

# Pass a function to this method app.message(":wave:")(say_hello) - Refer to https://docs.slack.dev/reference/events/message for details of `message` events. + Refer to https://api.slack.com/events/message for details of `message` events. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -890,6 +890,7 @@

Classes

matchers: Optional[Sequence[Callable[..., bool]]] = None, middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, auto_acknowledge: bool = True, + ack_timeout: int = 3, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new Function listener. This method can be used as either a decorator or a method. @@ -918,13 +919,17 @@

Classes

Only when all the middleware call `next()` method, the listener function can be invoked. """ + if auto_acknowledge is True: + if ack_timeout != 3: + self._framework_logger.warning(warning_ack_timeout_has_no_effect(callback_id, ack_timeout)) + matchers = list(matchers) if matchers else [] middleware = list(middleware) if middleware else [] def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) primary_matcher = builtin_matchers.function_executed(callback_id=callback_id, base_logger=self._base_logger) - return self._register_listener(functions, primary_matcher, matchers, middleware, auto_acknowledge) + return self._register_listener(functions, primary_matcher, matchers, middleware, auto_acknowledge, ack_timeout) return __call__ @@ -950,7 +955,7 @@

Classes

# Pass a function to this method app.command("/echo")(repeat_text) - Refer to https://docs.slack.dev/interactivity/implementing-slash-commands for details of Slash Commands. + Refer to https://api.slack.com/interactivity/slash-commands for details of Slash Commands. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -997,7 +1002,7 @@

Classes

# Pass a function to this method app.shortcut("open_modal")(open_modal) - Refer to https://docs.slack.dev/interactivity/implementing-shortcuts for details about Shortcuts. + Refer to https://api.slack.com/interactivity/shortcuts for details about Shortcuts. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -1065,9 +1070,9 @@

Classes

# Pass a function to this method app.action("approve_button")(update_message) - * Refer to https://docs.slack.dev/reference/interaction-payloads/block_actions-payload for actions in `blocks`. - * Refer to https://docs.slack.dev/legacy/legacy-messaging/legacy-message-buttons for actions in `attachments`. - * Refer to https://docs.slack.dev/legacy/legacy-dialogs for actions in dialogs. + * Refer to https://api.slack.com/reference/interaction-payloads/block-actions for actions in `blocks`. + * Refer to https://api.slack.com/legacy/message-buttons for actions in `attachments`. + * Refer to https://api.slack.com/dialogs for actions in dialogs. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -1093,7 +1098,7 @@

Classes

middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `block_actions` action listener. - Refer to https://docs.slack.dev/reference/interaction-payloads/block_actions-payload for details. + Refer to https://api.slack.com/reference/interaction-payloads/block-actions for details. """ def __call__(*args, **kwargs): @@ -1110,7 +1115,7 @@

Classes

middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `interactive_message` action listener. - Refer to https://docs.slack.dev/legacy/legacy-messaging/legacy-message-buttons for details.""" + Refer to https://api.slack.com/legacy/message-buttons for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1126,7 +1131,7 @@

Classes

middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `dialog_submission` listener. - Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.""" + Refer to https://api.slack.com/dialogs for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1142,7 +1147,7 @@

Classes

middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `dialog_cancellation` listener. - Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.""" + Refer to https://api.slack.com/dialogs for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1183,7 +1188,7 @@

Classes

# Pass a function to this method app.view("view_1")(handle_submission) - Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload for details of payloads. + Refer to https://api.slack.com/reference/interaction-payloads/views for details of payloads. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -1209,7 +1214,7 @@

Classes

middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `view_submission` listener. - Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload#view_submission for details.""" + Refer to https://api.slack.com/reference/interaction-payloads/views#view_submission for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1225,7 +1230,7 @@

Classes

middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `view_closed` listener. - Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload#view_closed for details.""" + Refer to https://api.slack.com/reference/interaction-payloads/views#view_closed for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1266,7 +1271,8 @@

Classes

Refer to the following documents for details: - * https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element#external_multi_select + * https://api.slack.com/reference/block-kit/block-elements#external_select + * https://api.slack.com/reference/block-kit/block-elements#external_multi_select To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -1306,7 +1312,7 @@

Classes

middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `dialog_suggestion` listener. - Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.""" + Refer to https://api.slack.com/dialogs for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1399,6 +1405,7 @@

Classes

matchers: Optional[Sequence[Callable[..., bool]]], middleware: Optional[Sequence[Union[Callable, Middleware]]], auto_acknowledgement: bool = False, + ack_timeout: int = 3, ) -> Optional[Callable[..., Optional[BoltResponse]]]: value_to_return = None if not isinstance(functions, list): @@ -1425,10 +1432,11 @@

Classes

CustomListener( app_name=self.name, ack_function=functions.pop(0), - lazy_functions=functions, + lazy_functions=functions, # type:ignore[arg-type] matchers=listener_matchers, middleware=listener_middleware, auto_acknowledgement=auto_acknowledgement, + ack_timeout=ack_timeout, base_logger=self._base_logger, ) ) @@ -1648,9 +1656,9 @@

Methods

# Pass a function to this method app.action("approve_button")(update_message) - * Refer to https://docs.slack.dev/reference/interaction-payloads/block_actions-payload for actions in `blocks`. - * Refer to https://docs.slack.dev/legacy/legacy-messaging/legacy-message-buttons for actions in `attachments`. - * Refer to https://docs.slack.dev/legacy/legacy-dialogs for actions in dialogs. + * Refer to https://api.slack.com/reference/interaction-payloads/block-actions for actions in `blocks`. + * Refer to https://api.slack.com/legacy/message-buttons for actions in `attachments`. + * Refer to https://api.slack.com/dialogs for actions in dialogs. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -1679,9 +1687,9 @@

Methods

app.action("approve_button")(update_message)

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.args's API document.

Args

@@ -1724,7 +1732,7 @@

Args

middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `interactive_message` action listener. - Refer to https://docs.slack.dev/legacy/legacy-messaging/legacy-message-buttons for details.""" + Refer to https://api.slack.com/legacy/message-buttons for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1734,7 +1742,7 @@

Args

return __call__

Registers a new interactive_message action listener. -Refer to https://docs.slack.dev/legacy/legacy-messaging/legacy-message-buttons for details.

+Refer to https://api.slack.com/legacy/message-buttons for details.

def block_action(self,
constraints: str | Pattern | Dict[str, str | Pattern],
matchers: Sequence[Callable[..., bool]] | None = None,
middleware: Sequence[Callable | Middleware] | None = None) ‑> Callable[..., Callable[..., BoltResponse | None] | None] @@ -1751,7 +1759,7 @@

Args

middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `block_actions` action listener. - Refer to https://docs.slack.dev/reference/interaction-payloads/block_actions-payload for details. + Refer to https://api.slack.com/reference/interaction-payloads/block-actions for details. """ def __call__(*args, **kwargs): @@ -1762,7 +1770,7 @@

Args

return __call__

Registers a new block_actions action listener. -Refer to https://docs.slack.dev/reference/interaction-payloads/block_actions-payload for details.

+Refer to https://api.slack.com/reference/interaction-payloads/block-actions for details.

def block_suggestion(self,
action_id: str | Pattern,
matchers: Sequence[Callable[..., bool]] | None = None,
middleware: Sequence[Callable | Middleware] | None = None) ‑> Callable[..., Callable[..., BoltResponse | None] | None] @@ -1816,7 +1824,7 @@

Args

# Pass a function to this method app.command("/echo")(repeat_text) - Refer to https://docs.slack.dev/interactivity/implementing-slash-commands for details of Slash Commands. + Refer to https://api.slack.com/interactivity/slash-commands for details of Slash Commands. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -1847,7 +1855,7 @@

Args

# Pass a function to this method app.command("/echo")(repeat_text) -

Refer to https://docs.slack.dev/interactivity/implementing-slash-commands for details of Slash Commands.

+

Refer to https://api.slack.com/interactivity/slash-commands for details of Slash Commands.

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.args's API document.

Args

@@ -1910,7 +1918,7 @@

Args

middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `dialog_cancellation` listener. - Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.""" + Refer to https://api.slack.com/dialogs for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1920,7 +1928,7 @@

Args

return __call__

Registers a new dialog_cancellation listener. -Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.

+Refer to https://api.slack.com/dialogs for details.

def dialog_submission(self,
callback_id: str | Pattern,
matchers: Sequence[Callable[..., bool]] | None = None,
middleware: Sequence[Callable | Middleware] | None = None) ‑> Callable[..., Callable[..., BoltResponse | None] | None] @@ -1937,7 +1945,7 @@

Args

middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `dialog_submission` listener. - Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.""" + Refer to https://api.slack.com/dialogs for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1947,7 +1955,7 @@

Args

return __call__

Registers a new dialog_submission listener. -Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.

+Refer to https://api.slack.com/dialogs for details.

def dialog_suggestion(self,
callback_id: str | Pattern,
matchers: Sequence[Callable[..., bool]] | None = None,
middleware: Sequence[Callable | Middleware] | None = None) ‑> Callable[..., Callable[..., BoltResponse | None] | None] @@ -1964,7 +1972,7 @@

Args

middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `dialog_suggestion` listener. - Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.""" + Refer to https://api.slack.com/dialogs for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1974,7 +1982,7 @@

Args

return __call__

Registers a new dialog_suggestion listener. -Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.

+Refer to https://api.slack.com/dialogs for details.

def dispatch(self,
req: BoltRequest) ‑> BoltResponse @@ -2200,7 +2208,7 @@

Args

# Pass a function to this method app.event("team_join")(ask_for_introduction) - Refer to https://docs.slack.dev/apis/events-api/ for details of Events API. + Refer to https://api.slack.com/apis/connections/events-api for details of Events API. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -2232,7 +2240,7 @@

Args

# Pass a function to this method app.event("team_join")(ask_for_introduction) -

Refer to https://docs.slack.dev/apis/events-api/ for details of Events API.

+

Refer to https://api.slack.com/apis/connections/events-api for details of Events API.

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.args's API document.

Args

@@ -2248,7 +2256,7 @@

Args

-def function(self,
callback_id: str | Pattern,
matchers: Sequence[Callable[..., bool]] | None = None,
middleware: Sequence[Callable | Middleware] | None = None,
auto_acknowledge: bool = True) ‑> Callable[..., Callable[..., BoltResponse | None] | None] +def function(self,
callback_id: str | Pattern,
matchers: Sequence[Callable[..., bool]] | None = None,
middleware: Sequence[Callable | Middleware] | None = None,
auto_acknowledge: bool = True,
ack_timeout: int = 3) ‑> Callable[..., Callable[..., BoltResponse | None] | None]
@@ -2261,6 +2269,7 @@

Args

matchers: Optional[Sequence[Callable[..., bool]]] = None, middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, auto_acknowledge: bool = True, + ack_timeout: int = 3, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new Function listener. This method can be used as either a decorator or a method. @@ -2289,13 +2298,17 @@

Args

Only when all the middleware call `next()` method, the listener function can be invoked. """ + if auto_acknowledge is True: + if ack_timeout != 3: + self._framework_logger.warning(warning_ack_timeout_has_no_effect(callback_id, ack_timeout)) + matchers = list(matchers) if matchers else [] middleware = list(middleware) if middleware else [] def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) primary_matcher = builtin_matchers.function_executed(callback_id=callback_id, base_logger=self._base_logger) - return self._register_listener(functions, primary_matcher, matchers, middleware, auto_acknowledge) + return self._register_listener(functions, primary_matcher, matchers, middleware, auto_acknowledge, ack_timeout) return __call__
@@ -2379,7 +2392,7 @@

Args

# Pass a function to this method app.message(":wave:")(say_hello) - Refer to https://docs.slack.dev/reference/events/message for details of `message` events. + Refer to https://api.slack.com/events/message for details of `message` events. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -2430,7 +2443,7 @@

Args

# Pass a function to this method app.message(":wave:")(say_hello) -

Refer to https://docs.slack.dev/reference/events/message for details of message events.

+

Refer to https://api.slack.com/events/message for details of message events.

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.args's API document.

Args

@@ -2573,7 +2586,8 @@

Args

Refer to the following documents for details: - * https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element#external_multi_select + * https://api.slack.com/reference/block-kit/block-elements#external_select + * https://api.slack.com/reference/block-kit/block-elements#external_multi_select To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -2613,7 +2627,8 @@

Args

Refer to the following documents for details:

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.args's API document.

Args

@@ -2659,7 +2674,7 @@

Args

# Pass a function to this method app.shortcut("open_modal")(open_modal) - Refer to https://docs.slack.dev/interactivity/implementing-shortcuts for details about Shortcuts. + Refer to https://api.slack.com/interactivity/shortcuts for details about Shortcuts. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -2696,7 +2711,7 @@

Args

# Pass a function to this method app.shortcut("open_modal")(open_modal) -

Refer to https://docs.slack.dev/interactivity/implementing-shortcuts for details about Shortcuts.

+

Refer to https://api.slack.com/interactivity/shortcuts for details about Shortcuts.

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.args's API document.

Args

@@ -2782,7 +2797,7 @@

Args

""" Deprecated: Steps from apps for legacy workflows are now deprecated. - Use new custom steps: https://docs.slack.dev/workflows/workflow-steps + Use new custom steps: https://api.slack.com/automation/functions/custom-bolt Registers a new step from app listener. @@ -2800,7 +2815,7 @@

Args

# Pass Step to set up listeners app.step(ws) - Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details of steps from apps. + Refer to https://api.slack.com/workflows/steps for details of steps from apps. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -2817,7 +2832,7 @@

Args

warnings.warn( ( "Steps from apps for legacy workflows are now deprecated. " - "Use new custom steps: https://docs.slack.dev/workflows/workflow-steps" + "Use new custom steps: https://api.slack.com/automation/functions/custom-bolt" ), category=DeprecationWarning, ) @@ -2839,7 +2854,7 @@

Args

Deprecated

Steps from apps for legacy workflows are now deprecated. -Use new custom steps: https://docs.slack.dev/workflows/workflow-steps

+Use new custom steps: https://api.slack.com/automation/functions/custom-bolt

Registers a new step from app listener.

Unlike others, this method doesn't behave as a decorator. If you want to register a step from app by a decorator, use WorkflowStepBuilder's methods.

@@ -2854,7 +2869,7 @@

Args

# Pass Step to set up listeners app.step(ws) -

Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details of steps from apps.

+

Refer to https://api.slack.com/workflows/steps for details of steps from apps.

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.args's API document.

For further information about WorkflowStep specific function arguments such as configure, update, complete, and fail, @@ -2925,7 +2940,7 @@

Args

# Pass a function to this method app.view("view_1")(handle_submission) - Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload for details of payloads. + Refer to https://api.slack.com/reference/interaction-payloads/views for details of payloads. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -2966,7 +2981,7 @@

Args

# Pass a function to this method app.view("view_1")(handle_submission) -

Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload for details of payloads.

+

Refer to https://api.slack.com/reference/interaction-payloads/views for details of payloads.

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.args's API document.

Args

@@ -2995,7 +3010,7 @@

Args

middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `view_closed` listener. - Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload#view_closed for details.""" + Refer to https://api.slack.com/reference/interaction-payloads/views#view_closed for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -3005,7 +3020,7 @@

Args

return __call__

Registers a new view_closed listener. -Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload#view_closed for details.

+Refer to https://api.slack.com/reference/interaction-payloads/views#view_closed for details.

def view_submission(self,
constraints: str | Pattern,
matchers: Sequence[Callable[..., bool]] | None = None,
middleware: Sequence[Callable | Middleware] | None = None) ‑> Callable[..., Callable[..., BoltResponse | None] | None] @@ -3022,7 +3037,7 @@

Args

middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `view_submission` listener. - Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload#view_submission for details.""" + Refer to https://api.slack.com/reference/interaction-payloads/views#view_submission for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -3032,7 +3047,7 @@

Args

return __call__

Registers a new view_submission listener. -Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload#view_submission for details.

+Refer to https://api.slack.com/reference/interaction-payloads/views#view_submission for details.

@@ -3104,7 +3119,7 @@

App diff --git a/docs/reference/async_app.html b/docs/reference/async_app.html index c067aeb5e..07c1f3627 100644 --- a/docs/reference/async_app.html +++ b/docs/reference/async_app.html @@ -3,7 +3,7 @@ - + slack_bolt.async_app API documentation @@ -778,7 +778,7 @@

Class variables

""" Deprecated: Steps from apps for legacy workflows are now deprecated. - Use new custom steps: https://docs.slack.dev/workflows/workflow-steps + Use new custom steps: https://api.slack.com/automation/functions/custom-bolt Registers a new step from app listener. @@ -796,7 +796,7 @@

Class variables

# Pass Step to set up listeners app.step(ws) - Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details of steps from apps. + Refer to https://api.slack.com/workflows/steps for details of steps from apps. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.async_args`'s API document. For further information about AsyncWorkflowStep specific function arguments @@ -812,7 +812,7 @@

Class variables

warnings.warn( ( "Steps from apps for legacy workflows are now deprecated. " - "Use new custom steps: https://docs.slack.dev/workflows/workflow-steps" + "Use new custom steps: https://api.slack.com/automation/functions/custom-bolt" ), category=DeprecationWarning, ) @@ -894,7 +894,7 @@

Class variables

# Pass a function to this method app.event("team_join")(ask_for_introduction) - Refer to https://docs.slack.dev/apis/events-api/ for details of Events API. + Refer to https://api.slack.com/apis/connections/events-api for details of Events API. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.async_args`'s API document. @@ -932,7 +932,7 @@

Class variables

# Pass a function to this method app.message(":wave:")(say_hello) - Refer to https://docs.slack.dev/reference/events/message for details of `message` events. + Refer to https://api.slack.com/events/message for details of `message` events. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.async_args`'s API document. @@ -981,6 +981,7 @@

Class variables

matchers: Optional[Sequence[Callable[..., Awaitable[bool]]]] = None, middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None, auto_acknowledge: bool = True, + ack_timeout: int = 3, ) -> Callable[..., Optional[Callable[..., Awaitable[BoltResponse]]]]: """Registers a new Function listener. This method can be used as either a decorator or a method. @@ -1008,6 +1009,9 @@

Class variables

middleware: A list of lister middleware functions. Only when all the middleware call `next()` method, the listener function can be invoked. """ + if auto_acknowledge is True: + if ack_timeout != 3: + self._framework_logger.warning(warning_ack_timeout_has_no_effect(callback_id, ack_timeout)) matchers = list(matchers) if matchers else [] middleware = list(middleware) if middleware else [] @@ -1017,7 +1021,7 @@

Class variables

primary_matcher = builtin_matchers.function_executed( callback_id=callback_id, base_logger=self._base_logger, asyncio=True ) - return self._register_listener(functions, primary_matcher, matchers, middleware, auto_acknowledge) + return self._register_listener(functions, primary_matcher, matchers, middleware, auto_acknowledge, ack_timeout) return __call__ @@ -1043,7 +1047,7 @@

Class variables

# Pass a function to this method app.command("/echo")(repeat_text) - Refer to https://docs.slack.dev/interactivity/implementing-slash-commands for details of Slash Commands. + Refer to https://api.slack.com/interactivity/slash-commands for details of Slash Commands. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.async_args`'s API document. @@ -1090,7 +1094,7 @@

Class variables

# Pass a function to this method app.shortcut("open_modal")(open_modal) - Refer to https://docs.slack.dev/interactivity/implementing-shortcuts for details about Shortcuts. + Refer to https://api.slack.com/interactivity/shortcuts for details about Shortcuts. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.async_args`'s API document. @@ -1158,9 +1162,9 @@

Class variables

# Pass a function to this method app.action("approve_button")(update_message) - * Refer to https://docs.slack.dev/reference/interaction-payloads/block_actions-payload for actions in `blocks`. - * Refer to https://docs.slack.dev/legacy/legacy-messaging/legacy-message-buttons for actions in `attachments`. - * Refer to https://docs.slack.dev/legacy/legacy-dialogs for actions in dialogs. + * Refer to https://api.slack.com/reference/interaction-payloads/block-actions for actions in `blocks`. + * Refer to https://api.slack.com/legacy/message-buttons for actions in `attachments`. + * Refer to https://api.slack.com/dialogs for actions in dialogs. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.async_args`'s API document. @@ -1186,7 +1190,7 @@

Class variables

middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None, ) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]: """Registers a new `block_actions` action listener. - Refer to https://docs.slack.dev/reference/interaction-payloads/block_actions-payload for details. + Refer to https://api.slack.com/reference/interaction-payloads/block-actions for details. """ def __call__(*args, **kwargs): @@ -1203,7 +1207,7 @@

Class variables

middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None, ) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]: """Registers a new `interactive_message` action listener. - Refer to https://docs.slack.dev/legacy/legacy-messaging/legacy-message-buttons for details.""" + Refer to https://api.slack.com/legacy/message-buttons for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1219,7 +1223,7 @@

Class variables

middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None, ) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]: """Registers a new `dialog_submission` listener. - Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.""" + Refer to https://api.slack.com/dialogs for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1235,7 +1239,7 @@

Class variables

middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None, ) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]: """Registers a new `dialog_submission` listener. - Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.""" + Refer to https://api.slack.com/dialogs for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1276,7 +1280,7 @@

Class variables

# Pass a function to this method app.view("view_1")(handle_submission) - Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload for details of payloads. + Refer to https://api.slack.com/reference/interaction-payloads/views for details of payloads. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.async_args`'s API document. @@ -1302,7 +1306,7 @@

Class variables

middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None, ) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]: """Registers a new `view_submission` listener. - Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload#view_submission for details.""" + Refer to https://api.slack.com/reference/interaction-payloads/views#view_submission for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1318,7 +1322,7 @@

Class variables

middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None, ) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]: """Registers a new `view_closed` listener. - Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload#view_closed for details.""" + Refer to https://api.slack.com/reference/interaction-payloads/views#view_closed for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1359,7 +1363,8 @@

Class variables

Refer to the following documents for details: - * https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element#external_multi_select + * https://api.slack.com/reference/block-kit/block-elements#external_select + * https://api.slack.com/reference/block-kit/block-elements#external_multi_select To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.async_args`'s API document. @@ -1399,7 +1404,7 @@

Class variables

middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None, ) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]: """Registers a new `dialog_suggestion` listener. - Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.""" + Refer to https://api.slack.com/dialogs for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1496,6 +1501,7 @@

Class variables

matchers: Optional[Sequence[Callable[..., Awaitable[bool]]]], middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]], auto_acknowledgement: bool = False, + ack_timeout: int = 3, ) -> Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]: value_to_return = None if not isinstance(functions, list): @@ -1527,10 +1533,11 @@

Class variables

AsyncCustomListener( app_name=self.name, ack_function=functions.pop(0), - lazy_functions=functions, + lazy_functions=functions, # type:ignore[arg-type] matchers=listener_matchers, middleware=listener_middleware, auto_acknowledgement=auto_acknowledgement, + ack_timeout=ack_timeout, base_logger=self._base_logger, ) ) @@ -1753,9 +1760,9 @@

Methods

# Pass a function to this method app.action("approve_button")(update_message) - * Refer to https://docs.slack.dev/reference/interaction-payloads/block_actions-payload for actions in `blocks`. - * Refer to https://docs.slack.dev/legacy/legacy-messaging/legacy-message-buttons for actions in `attachments`. - * Refer to https://docs.slack.dev/legacy/legacy-dialogs for actions in dialogs. + * Refer to https://api.slack.com/reference/interaction-payloads/block-actions for actions in `blocks`. + * Refer to https://api.slack.com/legacy/message-buttons for actions in `attachments`. + * Refer to https://api.slack.com/dialogs for actions in dialogs. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.async_args`'s API document. @@ -1784,9 +1791,9 @@

Methods

app.action("approve_button")(update_message)

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.async_args's API document.

Args

@@ -1957,7 +1964,7 @@

Returns

middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None, ) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]: """Registers a new `interactive_message` action listener. - Refer to https://docs.slack.dev/legacy/legacy-messaging/legacy-message-buttons for details.""" + Refer to https://api.slack.com/legacy/message-buttons for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1967,7 +1974,7 @@

Returns

return __call__

Registers a new interactive_message action listener. -Refer to https://docs.slack.dev/legacy/legacy-messaging/legacy-message-buttons for details.

+Refer to https://api.slack.com/legacy/message-buttons for details.

def block_action(self,
constraints: str | Pattern | Dict[str, str | Pattern],
matchers: Sequence[Callable[..., Awaitable[bool]]] | None = None,
middleware: Sequence[Callable | AsyncMiddleware] | None = None) ‑> Callable[..., Callable[..., Awaitable[BoltResponse | None]] | None] @@ -1984,7 +1991,7 @@

Returns

middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None, ) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]: """Registers a new `block_actions` action listener. - Refer to https://docs.slack.dev/reference/interaction-payloads/block_actions-payload for details. + Refer to https://api.slack.com/reference/interaction-payloads/block-actions for details. """ def __call__(*args, **kwargs): @@ -1995,7 +2002,7 @@

Returns

return __call__

Registers a new block_actions action listener. -Refer to https://docs.slack.dev/reference/interaction-payloads/block_actions-payload for details.

+Refer to https://api.slack.com/reference/interaction-payloads/block-actions for details.

def block_suggestion(self,
action_id: str | Pattern,
matchers: Sequence[Callable[..., Awaitable[bool]]] | None = None,
middleware: Sequence[Callable | AsyncMiddleware] | None = None) ‑> Callable[..., Callable[..., Awaitable[BoltResponse | None]] | None] @@ -2049,7 +2056,7 @@

Returns

# Pass a function to this method app.command("/echo")(repeat_text) - Refer to https://docs.slack.dev/interactivity/implementing-slash-commands for details of Slash Commands. + Refer to https://api.slack.com/interactivity/slash-commands for details of Slash Commands. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.async_args`'s API document. @@ -2080,7 +2087,7 @@

Returns

# Pass a function to this method app.command("/echo")(repeat_text) -

Refer to https://docs.slack.dev/interactivity/implementing-slash-commands for details of Slash Commands.

+

Refer to https://api.slack.com/interactivity/slash-commands for details of Slash Commands.

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.async_args's API document.

Args

@@ -2143,7 +2150,7 @@

Args

middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None, ) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]: """Registers a new `dialog_submission` listener. - Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.""" + Refer to https://api.slack.com/dialogs for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -2153,7 +2160,7 @@

Args

return __call__

Registers a new dialog_submission listener. -Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.

+Refer to https://api.slack.com/dialogs for details.

def dialog_submission(self,
callback_id: str | Pattern,
matchers: Sequence[Callable[..., Awaitable[bool]]] | None = None,
middleware: Sequence[Callable | AsyncMiddleware] | None = None) ‑> Callable[..., Callable[..., Awaitable[BoltResponse | None]] | None] @@ -2170,7 +2177,7 @@

Args

middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None, ) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]: """Registers a new `dialog_submission` listener. - Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.""" + Refer to https://api.slack.com/dialogs for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -2180,7 +2187,7 @@

Args

return __call__

Registers a new dialog_submission listener. -Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.

+Refer to https://api.slack.com/dialogs for details.

def dialog_suggestion(self,
callback_id: str | Pattern,
matchers: Sequence[Callable[..., Awaitable[bool]]] | None = None,
middleware: Sequence[Callable | AsyncMiddleware] | None = None) ‑> Callable[..., Callable[..., Awaitable[BoltResponse | None]] | None] @@ -2197,7 +2204,7 @@

Args

middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None, ) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]: """Registers a new `dialog_suggestion` listener. - Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.""" + Refer to https://api.slack.com/dialogs for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -2207,7 +2214,7 @@

Args

return __call__

Registers a new dialog_suggestion listener. -Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.

+Refer to https://api.slack.com/dialogs for details.

def enable_token_revocation_listeners(self) ‑> None @@ -2313,7 +2320,7 @@

Args

# Pass a function to this method app.event("team_join")(ask_for_introduction) - Refer to https://docs.slack.dev/apis/events-api/ for details of Events API. + Refer to https://api.slack.com/apis/connections/events-api for details of Events API. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.async_args`'s API document. @@ -2345,7 +2352,7 @@

Args

# Pass a function to this method app.event("team_join")(ask_for_introduction) -

Refer to https://docs.slack.dev/apis/events-api/ for details of Events API.

+

Refer to https://api.slack.com/apis/connections/events-api for details of Events API.

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.async_args's API document.

Args

@@ -2361,7 +2368,7 @@

Args

-def function(self,
callback_id: str | Pattern,
matchers: Sequence[Callable[..., Awaitable[bool]]] | None = None,
middleware: Sequence[Callable | AsyncMiddleware] | None = None,
auto_acknowledge: bool = True) ‑> Callable[..., Callable[..., Awaitable[BoltResponse]] | None] +def function(self,
callback_id: str | Pattern,
matchers: Sequence[Callable[..., Awaitable[bool]]] | None = None,
middleware: Sequence[Callable | AsyncMiddleware] | None = None,
auto_acknowledge: bool = True,
ack_timeout: int = 3) ‑> Callable[..., Callable[..., Awaitable[BoltResponse]] | None]
@@ -2374,6 +2381,7 @@

Args

matchers: Optional[Sequence[Callable[..., Awaitable[bool]]]] = None, middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None, auto_acknowledge: bool = True, + ack_timeout: int = 3, ) -> Callable[..., Optional[Callable[..., Awaitable[BoltResponse]]]]: """Registers a new Function listener. This method can be used as either a decorator or a method. @@ -2401,6 +2409,9 @@

Args

middleware: A list of lister middleware functions. Only when all the middleware call `next()` method, the listener function can be invoked. """ + if auto_acknowledge is True: + if ack_timeout != 3: + self._framework_logger.warning(warning_ack_timeout_has_no_effect(callback_id, ack_timeout)) matchers = list(matchers) if matchers else [] middleware = list(middleware) if middleware else [] @@ -2410,7 +2421,7 @@

Args

primary_matcher = builtin_matchers.function_executed( callback_id=callback_id, base_logger=self._base_logger, asyncio=True ) - return self._register_listener(functions, primary_matcher, matchers, middleware, auto_acknowledge) + return self._register_listener(functions, primary_matcher, matchers, middleware, auto_acknowledge, ack_timeout) return __call__
@@ -2494,7 +2505,7 @@

Args

# Pass a function to this method app.message(":wave:")(say_hello) - Refer to https://docs.slack.dev/reference/events/message for details of `message` events. + Refer to https://api.slack.com/events/message for details of `message` events. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.async_args`'s API document. @@ -2548,7 +2559,7 @@

Args

# Pass a function to this method app.message(":wave:")(say_hello) -

Refer to https://docs.slack.dev/reference/events/message for details of message events.

+

Refer to https://api.slack.com/events/message for details of message events.

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.async_args's API document.

Args

@@ -2688,7 +2699,8 @@

Args

Refer to the following documents for details: - * https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element#external_multi_select + * https://api.slack.com/reference/block-kit/block-elements#external_select + * https://api.slack.com/reference/block-kit/block-elements#external_multi_select To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.async_args`'s API document. @@ -2728,7 +2740,8 @@

Args

Refer to the following documents for details:

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.async_args's API document.

Args

@@ -2817,7 +2830,7 @@

Args

# Pass a function to this method app.shortcut("open_modal")(open_modal) - Refer to https://docs.slack.dev/interactivity/implementing-shortcuts for details about Shortcuts. + Refer to https://api.slack.com/interactivity/shortcuts for details about Shortcuts. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.async_args`'s API document. @@ -2854,7 +2867,7 @@

Args

# Pass a function to this method app.shortcut("open_modal")(open_modal) -

Refer to https://docs.slack.dev/interactivity/implementing-shortcuts for details about Shortcuts.

+

Refer to https://api.slack.com/interactivity/shortcuts for details about Shortcuts.

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.async_args's API document.

Args

@@ -2917,7 +2930,7 @@

Args

""" Deprecated: Steps from apps for legacy workflows are now deprecated. - Use new custom steps: https://docs.slack.dev/workflows/workflow-steps + Use new custom steps: https://api.slack.com/automation/functions/custom-bolt Registers a new step from app listener. @@ -2935,7 +2948,7 @@

Args

# Pass Step to set up listeners app.step(ws) - Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details of steps from apps. + Refer to https://api.slack.com/workflows/steps for details of steps from apps. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.async_args`'s API document. For further information about AsyncWorkflowStep specific function arguments @@ -2951,7 +2964,7 @@

Args

warnings.warn( ( "Steps from apps for legacy workflows are now deprecated. " - "Use new custom steps: https://docs.slack.dev/workflows/workflow-steps" + "Use new custom steps: https://api.slack.com/automation/functions/custom-bolt" ), category=DeprecationWarning, ) @@ -2973,7 +2986,7 @@

Args

Deprecated

Steps from apps for legacy workflows are now deprecated. -Use new custom steps: https://docs.slack.dev/workflows/workflow-steps

+Use new custom steps: https://api.slack.com/automation/functions/custom-bolt

Registers a new step from app listener.

Unlike others, this method doesn't behave as a decorator. If you want to register a step from app by a decorator, use AsyncWorkflowStepBuilder's methods.

@@ -2988,7 +3001,7 @@

Args

# Pass Step to set up listeners app.step(ws) -

Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details of steps from apps.

+

Refer to https://api.slack.com/workflows/steps for details of steps from apps.

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.async_args's API document. For further information about AsyncWorkflowStep specific function arguments such as configure, update, complete, and fail, @@ -3056,7 +3069,7 @@

Args

# Pass a function to this method app.view("view_1")(handle_submission) - Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload for details of payloads. + Refer to https://api.slack.com/reference/interaction-payloads/views for details of payloads. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.async_args`'s API document. @@ -3097,7 +3110,7 @@

Args

# Pass a function to this method app.view("view_1")(handle_submission) -

Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload for details of payloads.

+

Refer to https://api.slack.com/reference/interaction-payloads/views for details of payloads.

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.async_args's API document.

Args

@@ -3126,7 +3139,7 @@

Args

middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None, ) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]: """Registers a new `view_closed` listener. - Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload#view_closed for details.""" + Refer to https://api.slack.com/reference/interaction-payloads/views#view_closed for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -3136,7 +3149,7 @@

Args

return __call__

Registers a new view_closed listener. -Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload#view_closed for details.

+Refer to https://api.slack.com/reference/interaction-payloads/views#view_closed for details.

def view_submission(self,
constraints: str | Pattern,
matchers: Sequence[Callable[..., Awaitable[bool]]] | None = None,
middleware: Sequence[Callable | AsyncMiddleware] | None = None) ‑> Callable[..., Callable[..., Awaitable[BoltResponse | None]] | None] @@ -3153,7 +3166,7 @@

Args

middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None, ) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]: """Registers a new `view_submission` listener. - Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload#view_submission for details.""" + Refer to https://api.slack.com/reference/interaction-payloads/views#view_submission for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -3163,7 +3176,7 @@

Args

return __call__

Registers a new view_submission listener. -Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload#view_submission for details.

+Refer to https://api.slack.com/reference/interaction-payloads/views#view_submission for details.

def web_app(self, path: str = '/slack/events', port: int = 3000) ‑> aiohttp.web_app.Application @@ -4779,6 +4792,7 @@

Class variables

ack_function: Callable[..., Awaitable[BoltResponse]] lazy_functions: Sequence[Callable[..., Awaitable[None]]] auto_acknowledgement: bool + ack_timeout: int async def async_matches( self, @@ -4844,6 +4858,10 @@

Class variables

The type of the None singleton.

+
var ack_timeout : int
+
+

The type of the None singleton.

+
var auto_acknowledgement : bool

The type of the None singleton.

@@ -5497,6 +5515,7 @@

AsyncListener

  • ack_function
    • +
  • ack_timeout
  • async_matches
  • auto_acknowledgement
  • lazy_functions
    • @@ -5561,7 +5580,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/authorization/async_authorize.html b/docs/reference/authorization/async_authorize.html index 0a0640780..b4dfa2682 100644 --- a/docs/reference/authorization/async_authorize.html +++ b/docs/reference/authorization/async_authorize.html @@ -3,7 +3,7 @@ - + slack_bolt.authorization.async_authorize API documentation @@ -518,7 +518,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/authorization/async_authorize_args.html b/docs/reference/authorization/async_authorize_args.html index 642b35f93..5de20f757 100644 --- a/docs/reference/authorization/async_authorize_args.html +++ b/docs/reference/authorization/async_authorize_args.html @@ -3,7 +3,7 @@ - + slack_bolt.authorization.async_authorize_args API documentation @@ -158,7 +158,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/authorization/authorize.html b/docs/reference/authorization/authorize.html index 255c87196..33b50be02 100644 --- a/docs/reference/authorization/authorize.html +++ b/docs/reference/authorization/authorize.html @@ -3,7 +3,7 @@ - + slack_bolt.authorization.authorize API documentation @@ -516,7 +516,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/authorization/authorize_args.html b/docs/reference/authorization/authorize_args.html index 660ac17eb..78423fc40 100644 --- a/docs/reference/authorization/authorize_args.html +++ b/docs/reference/authorization/authorize_args.html @@ -3,7 +3,7 @@ - + slack_bolt.authorization.authorize_args API documentation @@ -158,7 +158,7 @@

    diff --git a/docs/reference/authorization/authorize_result.html b/docs/reference/authorization/authorize_result.html index 3bddc0a35..6eac3724d 100644 --- a/docs/reference/authorization/authorize_result.html +++ b/docs/reference/authorization/authorize_result.html @@ -3,7 +3,7 @@ - + slack_bolt.authorization.authorize_result API documentation @@ -292,7 +292,7 @@

    diff --git a/docs/reference/authorization/index.html b/docs/reference/authorization/index.html index eaa267d29..64ca14f0e 100644 --- a/docs/reference/authorization/index.html +++ b/docs/reference/authorization/index.html @@ -3,7 +3,7 @@ - + slack_bolt.authorization API documentation @@ -328,7 +328,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/ack/ack.html b/docs/reference/context/ack/ack.html index e1b71bcb9..a8b808d86 100644 --- a/docs/reference/context/ack/ack.html +++ b/docs/reference/context/ack/ack.html @@ -3,7 +3,7 @@ - + slack_bolt.context.ack.ack API documentation @@ -127,7 +127,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/ack/async_ack.html b/docs/reference/context/ack/async_ack.html index 0f2989e9f..f744d5693 100644 --- a/docs/reference/context/ack/async_ack.html +++ b/docs/reference/context/ack/async_ack.html @@ -3,7 +3,7 @@ - + slack_bolt.context.ack.async_ack API documentation @@ -127,7 +127,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/ack/index.html b/docs/reference/context/ack/index.html index 230da5d99..89f0600e8 100644 --- a/docs/reference/context/ack/index.html +++ b/docs/reference/context/ack/index.html @@ -3,7 +3,7 @@ - + slack_bolt.context.ack API documentation @@ -149,7 +149,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/ack/internals.html b/docs/reference/context/ack/internals.html index 2fa3d8028..f7f776241 100644 --- a/docs/reference/context/ack/internals.html +++ b/docs/reference/context/ack/internals.html @@ -3,7 +3,7 @@ - + slack_bolt.context.ack.internals API documentation @@ -60,7 +60,7 @@

    Module slack_bolt.context.ack.internals

    diff --git a/docs/reference/context/assistant/assistant_utilities.html b/docs/reference/context/assistant/assistant_utilities.html index 7bfeeeee9..d446b3c02 100644 --- a/docs/reference/context/assistant/assistant_utilities.html +++ b/docs/reference/context/assistant/assistant_utilities.html @@ -3,7 +3,7 @@ - + slack_bolt.context.assistant.assistant_utilities API documentation @@ -289,7 +289,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/assistant/async_assistant_utilities.html b/docs/reference/context/assistant/async_assistant_utilities.html index b4af582a7..fc3cbbe8b 100644 --- a/docs/reference/context/assistant/async_assistant_utilities.html +++ b/docs/reference/context/assistant/async_assistant_utilities.html @@ -3,7 +3,7 @@ - + slack_bolt.context.assistant.async_assistant_utilities API documentation @@ -283,7 +283,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/assistant/index.html b/docs/reference/context/assistant/index.html index 73dcff282..d442e26cf 100644 --- a/docs/reference/context/assistant/index.html +++ b/docs/reference/context/assistant/index.html @@ -3,7 +3,7 @@ - + slack_bolt.context.assistant API documentation @@ -92,7 +92,7 @@

    Sub-modules

    diff --git a/docs/reference/context/assistant/internals.html b/docs/reference/context/assistant/internals.html index b1558b9d2..242bd6f19 100644 --- a/docs/reference/context/assistant/internals.html +++ b/docs/reference/context/assistant/internals.html @@ -3,7 +3,7 @@ - + slack_bolt.context.assistant.internals API documentation @@ -89,7 +89,7 @@

    Functions

    diff --git a/docs/reference/context/assistant/thread_context/index.html b/docs/reference/context/assistant/thread_context/index.html index 7d1232b1d..f3767a1cf 100644 --- a/docs/reference/context/assistant/thread_context/index.html +++ b/docs/reference/context/assistant/thread_context/index.html @@ -3,7 +3,7 @@ - + slack_bolt.context.assistant.thread_context API documentation @@ -126,7 +126,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/assistant/thread_context_store/async_store.html b/docs/reference/context/assistant/thread_context_store/async_store.html index f5045739f..64f4e53ed 100644 --- a/docs/reference/context/assistant/thread_context_store/async_store.html +++ b/docs/reference/context/assistant/thread_context_store/async_store.html @@ -3,7 +3,7 @@ - + slack_bolt.context.assistant.thread_context_store.async_store API documentation @@ -124,7 +124,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/assistant/thread_context_store/default_async_store.html b/docs/reference/context/assistant/thread_context_store/default_async_store.html index 8344971de..f6cd66060 100644 --- a/docs/reference/context/assistant/thread_context_store/default_async_store.html +++ b/docs/reference/context/assistant/thread_context_store/default_async_store.html @@ -3,7 +3,7 @@ - + slack_bolt.context.assistant.thread_context_store.default_async_store API documentation @@ -190,7 +190,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/assistant/thread_context_store/default_store.html b/docs/reference/context/assistant/thread_context_store/default_store.html index d647b9c78..1594c5d38 100644 --- a/docs/reference/context/assistant/thread_context_store/default_store.html +++ b/docs/reference/context/assistant/thread_context_store/default_store.html @@ -3,7 +3,7 @@ - + slack_bolt.context.assistant.thread_context_store.default_store API documentation @@ -188,7 +188,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/assistant/thread_context_store/file/index.html b/docs/reference/context/assistant/thread_context_store/file/index.html index 4190a948f..4a5d944e1 100644 --- a/docs/reference/context/assistant/thread_context_store/file/index.html +++ b/docs/reference/context/assistant/thread_context_store/file/index.html @@ -3,7 +3,7 @@ - + slack_bolt.context.assistant.thread_context_store.file API documentation @@ -159,7 +159,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/assistant/thread_context_store/index.html b/docs/reference/context/assistant/thread_context_store/index.html index 400b3c37a..3083275d9 100644 --- a/docs/reference/context/assistant/thread_context_store/index.html +++ b/docs/reference/context/assistant/thread_context_store/index.html @@ -3,7 +3,7 @@ - + slack_bolt.context.assistant.thread_context_store API documentation @@ -92,7 +92,7 @@

    Sub-modules

    diff --git a/docs/reference/context/assistant/thread_context_store/store.html b/docs/reference/context/assistant/thread_context_store/store.html index fde47afc9..a0a177b09 100644 --- a/docs/reference/context/assistant/thread_context_store/store.html +++ b/docs/reference/context/assistant/thread_context_store/store.html @@ -3,7 +3,7 @@ - + slack_bolt.context.assistant.thread_context_store.store API documentation @@ -125,7 +125,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/async_context.html b/docs/reference/context/async_context.html index 76ac8c5de..9ce4ebd9e 100644 --- a/docs/reference/context/async_context.html +++ b/docs/reference/context/async_context.html @@ -3,7 +3,7 @@ - + slack_bolt.context.async_context API documentation @@ -706,7 +706,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/base_context.html b/docs/reference/context/base_context.html index 54617176b..4a177f8dc 100644 --- a/docs/reference/context/base_context.html +++ b/docs/reference/context/base_context.html @@ -3,7 +3,7 @@ - + slack_bolt.context.base_context API documentation @@ -640,7 +640,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/complete/async_complete.html b/docs/reference/context/complete/async_complete.html index e6ce03d74..36cf1f92f 100644 --- a/docs/reference/context/complete/async_complete.html +++ b/docs/reference/context/complete/async_complete.html @@ -3,7 +3,7 @@ - + slack_bolt.context.complete.async_complete API documentation @@ -127,7 +127,7 @@

    diff --git a/docs/reference/context/complete/complete.html b/docs/reference/context/complete/complete.html index ef6c6c78f..b1f01ea1a 100644 --- a/docs/reference/context/complete/complete.html +++ b/docs/reference/context/complete/complete.html @@ -3,7 +3,7 @@ - + slack_bolt.context.complete.complete API documentation @@ -125,7 +125,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/complete/index.html b/docs/reference/context/complete/index.html index f476fa258..7665622b6 100644 --- a/docs/reference/context/complete/index.html +++ b/docs/reference/context/complete/index.html @@ -3,7 +3,7 @@ - + slack_bolt.context.complete API documentation @@ -142,7 +142,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/context.html b/docs/reference/context/context.html index c1ae2789e..615432502 100644 --- a/docs/reference/context/context.html +++ b/docs/reference/context/context.html @@ -3,7 +3,7 @@ - + slack_bolt.context.context API documentation @@ -708,7 +708,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/fail/async_fail.html b/docs/reference/context/fail/async_fail.html index 91497eff9..6b3e4f1df 100644 --- a/docs/reference/context/fail/async_fail.html +++ b/docs/reference/context/fail/async_fail.html @@ -3,7 +3,7 @@ - + slack_bolt.context.fail.async_fail API documentation @@ -125,7 +125,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/fail/fail.html b/docs/reference/context/fail/fail.html index 20d44d1d5..0152561d8 100644 --- a/docs/reference/context/fail/fail.html +++ b/docs/reference/context/fail/fail.html @@ -3,7 +3,7 @@ - + slack_bolt.context.fail.fail API documentation @@ -125,7 +125,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/fail/index.html b/docs/reference/context/fail/index.html index 2b14ac772..eb2653106 100644 --- a/docs/reference/context/fail/index.html +++ b/docs/reference/context/fail/index.html @@ -3,7 +3,7 @@ - + slack_bolt.context.fail API documentation @@ -142,7 +142,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/get_thread_context/async_get_thread_context.html b/docs/reference/context/get_thread_context/async_get_thread_context.html index 66500752e..1c3fc4d6c 100644 --- a/docs/reference/context/get_thread_context/async_get_thread_context.html +++ b/docs/reference/context/get_thread_context/async_get_thread_context.html @@ -3,7 +3,7 @@ - + slack_bolt.context.get_thread_context.async_get_thread_context API documentation @@ -154,7 +154,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/get_thread_context/get_thread_context.html b/docs/reference/context/get_thread_context/get_thread_context.html index a6777da30..4ac274368 100644 --- a/docs/reference/context/get_thread_context/get_thread_context.html +++ b/docs/reference/context/get_thread_context/get_thread_context.html @@ -3,7 +3,7 @@ - + slack_bolt.context.get_thread_context.get_thread_context API documentation @@ -154,7 +154,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/get_thread_context/index.html b/docs/reference/context/get_thread_context/index.html index ffd095911..13dcd1388 100644 --- a/docs/reference/context/get_thread_context/index.html +++ b/docs/reference/context/get_thread_context/index.html @@ -3,7 +3,7 @@ - + slack_bolt.context.get_thread_context API documentation @@ -171,7 +171,7 @@

    diff --git a/docs/reference/context/index.html b/docs/reference/context/index.html index 4d3f472cc..65cb8054c 100644 --- a/docs/reference/context/index.html +++ b/docs/reference/context/index.html @@ -3,7 +3,7 @@ - + slack_bolt.context API documentation @@ -790,7 +790,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/respond/async_respond.html b/docs/reference/context/respond/async_respond.html index 148e1607e..ed071afaf 100644 --- a/docs/reference/context/respond/async_respond.html +++ b/docs/reference/context/respond/async_respond.html @@ -3,7 +3,7 @@ - + slack_bolt.context.respond.async_respond API documentation @@ -160,7 +160,7 @@

    diff --git a/docs/reference/context/respond/index.html b/docs/reference/context/respond/index.html index 94693dccf..8c116c956 100644 --- a/docs/reference/context/respond/index.html +++ b/docs/reference/context/respond/index.html @@ -3,7 +3,7 @@ - + slack_bolt.context.respond API documentation @@ -182,7 +182,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/respond/internals.html b/docs/reference/context/respond/internals.html index 295a793a3..e61988ef6 100644 --- a/docs/reference/context/respond/internals.html +++ b/docs/reference/context/respond/internals.html @@ -3,7 +3,7 @@ - + slack_bolt.context.respond.internals API documentation @@ -60,7 +60,7 @@

    Module slack_bolt.context.respond.internals

    diff --git a/docs/reference/context/respond/respond.html b/docs/reference/context/respond/respond.html index 5fb010d20..af2271eb6 100644 --- a/docs/reference/context/respond/respond.html +++ b/docs/reference/context/respond/respond.html @@ -3,7 +3,7 @@ - + slack_bolt.context.respond.respond API documentation @@ -160,7 +160,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/save_thread_context/async_save_thread_context.html b/docs/reference/context/save_thread_context/async_save_thread_context.html index 796970dd7..f57291c3c 100644 --- a/docs/reference/context/save_thread_context/async_save_thread_context.html +++ b/docs/reference/context/save_thread_context/async_save_thread_context.html @@ -3,7 +3,7 @@ - + slack_bolt.context.save_thread_context.async_save_thread_context API documentation @@ -123,7 +123,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/save_thread_context/index.html b/docs/reference/context/save_thread_context/index.html index 8b974a213..01f63ecd8 100644 --- a/docs/reference/context/save_thread_context/index.html +++ b/docs/reference/context/save_thread_context/index.html @@ -3,7 +3,7 @@ - + slack_bolt.context.save_thread_context API documentation @@ -140,7 +140,7 @@

    diff --git a/docs/reference/context/save_thread_context/save_thread_context.html b/docs/reference/context/save_thread_context/save_thread_context.html index 17c147505..328441034 100644 --- a/docs/reference/context/save_thread_context/save_thread_context.html +++ b/docs/reference/context/save_thread_context/save_thread_context.html @@ -3,7 +3,7 @@ - + slack_bolt.context.save_thread_context.save_thread_context API documentation @@ -123,7 +123,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/say/async_say.html b/docs/reference/context/say/async_say.html index 78d0b83a6..8547a1188 100644 --- a/docs/reference/context/say/async_say.html +++ b/docs/reference/context/say/async_say.html @@ -3,7 +3,7 @@ - + slack_bolt.context.say.async_say API documentation @@ -183,7 +183,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/say/index.html b/docs/reference/context/say/index.html index 5e2897f38..7a5850760 100644 --- a/docs/reference/context/say/index.html +++ b/docs/reference/context/say/index.html @@ -3,7 +3,7 @@ - + slack_bolt.context.say API documentation @@ -214,7 +214,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/say/internals.html b/docs/reference/context/say/internals.html index ac349a4b5..861065203 100644 --- a/docs/reference/context/say/internals.html +++ b/docs/reference/context/say/internals.html @@ -3,7 +3,7 @@ - + slack_bolt.context.say.internals API documentation @@ -60,7 +60,7 @@

    Module slack_bolt.context.say.internals

    diff --git a/docs/reference/context/say/say.html b/docs/reference/context/say/say.html index 20ad41c0e..5db4f24ba 100644 --- a/docs/reference/context/say/say.html +++ b/docs/reference/context/say/say.html @@ -3,7 +3,7 @@ - + slack_bolt.context.say.say API documentation @@ -192,7 +192,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/set_status/async_set_status.html b/docs/reference/context/set_status/async_set_status.html index d22fb3aa8..6a15d70ae 100644 --- a/docs/reference/context/set_status/async_set_status.html +++ b/docs/reference/context/set_status/async_set_status.html @@ -3,7 +3,7 @@ - + slack_bolt.context.set_status.async_set_status API documentation @@ -123,7 +123,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/set_status/index.html b/docs/reference/context/set_status/index.html index 5a2e8be48..9e53da9a5 100644 --- a/docs/reference/context/set_status/index.html +++ b/docs/reference/context/set_status/index.html @@ -3,7 +3,7 @@ - + slack_bolt.context.set_status API documentation @@ -140,7 +140,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/set_status/set_status.html b/docs/reference/context/set_status/set_status.html index 337fbf576..0ec8df5da 100644 --- a/docs/reference/context/set_status/set_status.html +++ b/docs/reference/context/set_status/set_status.html @@ -3,7 +3,7 @@ - + slack_bolt.context.set_status.set_status API documentation @@ -123,7 +123,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/set_suggested_prompts/async_set_suggested_prompts.html b/docs/reference/context/set_suggested_prompts/async_set_suggested_prompts.html index ee7458fbc..449a72117 100644 --- a/docs/reference/context/set_suggested_prompts/async_set_suggested_prompts.html +++ b/docs/reference/context/set_suggested_prompts/async_set_suggested_prompts.html @@ -3,7 +3,7 @@ - + slack_bolt.context.set_suggested_prompts.async_set_suggested_prompts API documentation @@ -135,7 +135,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/set_suggested_prompts/index.html b/docs/reference/context/set_suggested_prompts/index.html index f3084288a..ee5371cea 100644 --- a/docs/reference/context/set_suggested_prompts/index.html +++ b/docs/reference/context/set_suggested_prompts/index.html @@ -3,7 +3,7 @@ - + slack_bolt.context.set_suggested_prompts API documentation @@ -152,7 +152,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/set_suggested_prompts/set_suggested_prompts.html b/docs/reference/context/set_suggested_prompts/set_suggested_prompts.html index bdb31a3ca..133d3a55a 100644 --- a/docs/reference/context/set_suggested_prompts/set_suggested_prompts.html +++ b/docs/reference/context/set_suggested_prompts/set_suggested_prompts.html @@ -3,7 +3,7 @@ - + slack_bolt.context.set_suggested_prompts.set_suggested_prompts API documentation @@ -135,7 +135,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/set_title/async_set_title.html b/docs/reference/context/set_title/async_set_title.html index 9c195664c..e7db1ca1c 100644 --- a/docs/reference/context/set_title/async_set_title.html +++ b/docs/reference/context/set_title/async_set_title.html @@ -3,7 +3,7 @@ - + slack_bolt.context.set_title.async_set_title API documentation @@ -123,7 +123,7 @@

    diff --git a/docs/reference/context/set_title/index.html b/docs/reference/context/set_title/index.html index 4c88c8539..7ae070fe8 100644 --- a/docs/reference/context/set_title/index.html +++ b/docs/reference/context/set_title/index.html @@ -3,7 +3,7 @@ - + slack_bolt.context.set_title API documentation @@ -140,7 +140,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/context/set_title/set_title.html b/docs/reference/context/set_title/set_title.html index 59a4498bf..cd4d1e27e 100644 --- a/docs/reference/context/set_title/set_title.html +++ b/docs/reference/context/set_title/set_title.html @@ -3,7 +3,7 @@ - + slack_bolt.context.set_title.set_title API documentation @@ -123,7 +123,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/error/index.html b/docs/reference/error/index.html index 8e578eb61..f57d690e9 100644 --- a/docs/reference/error/index.html +++ b/docs/reference/error/index.html @@ -3,7 +3,7 @@ - + slack_bolt.error API documentation @@ -160,7 +160,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/index.html b/docs/reference/index.html index 6aae1d55a..430e36813 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -3,7 +3,7 @@ - + slack_bolt API documentation @@ -815,7 +815,7 @@

    Class variables

    """ Deprecated: Steps from apps for legacy workflows are now deprecated. - Use new custom steps: https://docs.slack.dev/workflows/workflow-steps + Use new custom steps: https://api.slack.com/automation/functions/custom-bolt Registers a new step from app listener. @@ -833,7 +833,7 @@

    Class variables

    # Pass Step to set up listeners app.step(ws) - Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details of steps from apps. + Refer to https://api.slack.com/workflows/steps for details of steps from apps. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -850,7 +850,7 @@

    Class variables

    warnings.warn( ( "Steps from apps for legacy workflows are now deprecated. " - "Use new custom steps: https://docs.slack.dev/workflows/workflow-steps" + "Use new custom steps: https://api.slack.com/automation/functions/custom-bolt" ), category=DeprecationWarning, ) @@ -927,7 +927,7 @@

    Class variables

    # Pass a function to this method app.event("team_join")(ask_for_introduction) - Refer to https://docs.slack.dev/apis/events-api/ for details of Events API. + Refer to https://api.slack.com/apis/connections/events-api for details of Events API. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -965,7 +965,7 @@

    Class variables

    # Pass a function to this method app.message(":wave:")(say_hello) - Refer to https://docs.slack.dev/reference/events/message for details of `message` events. + Refer to https://api.slack.com/events/message for details of `message` events. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -1011,6 +1011,7 @@

    Class variables

    matchers: Optional[Sequence[Callable[..., bool]]] = None, middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, auto_acknowledge: bool = True, + ack_timeout: int = 3, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new Function listener. This method can be used as either a decorator or a method. @@ -1039,13 +1040,17 @@

    Class variables

    Only when all the middleware call `next()` method, the listener function can be invoked. """ + if auto_acknowledge is True: + if ack_timeout != 3: + self._framework_logger.warning(warning_ack_timeout_has_no_effect(callback_id, ack_timeout)) + matchers = list(matchers) if matchers else [] middleware = list(middleware) if middleware else [] def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) primary_matcher = builtin_matchers.function_executed(callback_id=callback_id, base_logger=self._base_logger) - return self._register_listener(functions, primary_matcher, matchers, middleware, auto_acknowledge) + return self._register_listener(functions, primary_matcher, matchers, middleware, auto_acknowledge, ack_timeout) return __call__ @@ -1071,7 +1076,7 @@

    Class variables

    # Pass a function to this method app.command("/echo")(repeat_text) - Refer to https://docs.slack.dev/interactivity/implementing-slash-commands for details of Slash Commands. + Refer to https://api.slack.com/interactivity/slash-commands for details of Slash Commands. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -1118,7 +1123,7 @@

    Class variables

    # Pass a function to this method app.shortcut("open_modal")(open_modal) - Refer to https://docs.slack.dev/interactivity/implementing-shortcuts for details about Shortcuts. + Refer to https://api.slack.com/interactivity/shortcuts for details about Shortcuts. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -1186,9 +1191,9 @@

    Class variables

    # Pass a function to this method app.action("approve_button")(update_message) - * Refer to https://docs.slack.dev/reference/interaction-payloads/block_actions-payload for actions in `blocks`. - * Refer to https://docs.slack.dev/legacy/legacy-messaging/legacy-message-buttons for actions in `attachments`. - * Refer to https://docs.slack.dev/legacy/legacy-dialogs for actions in dialogs. + * Refer to https://api.slack.com/reference/interaction-payloads/block-actions for actions in `blocks`. + * Refer to https://api.slack.com/legacy/message-buttons for actions in `attachments`. + * Refer to https://api.slack.com/dialogs for actions in dialogs. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -1214,7 +1219,7 @@

    Class variables

    middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `block_actions` action listener. - Refer to https://docs.slack.dev/reference/interaction-payloads/block_actions-payload for details. + Refer to https://api.slack.com/reference/interaction-payloads/block-actions for details. """ def __call__(*args, **kwargs): @@ -1231,7 +1236,7 @@

    Class variables

    middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `interactive_message` action listener. - Refer to https://docs.slack.dev/legacy/legacy-messaging/legacy-message-buttons for details.""" + Refer to https://api.slack.com/legacy/message-buttons for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1247,7 +1252,7 @@

    Class variables

    middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `dialog_submission` listener. - Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.""" + Refer to https://api.slack.com/dialogs for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1263,7 +1268,7 @@

    Class variables

    middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `dialog_cancellation` listener. - Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.""" + Refer to https://api.slack.com/dialogs for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1304,7 +1309,7 @@

    Class variables

    # Pass a function to this method app.view("view_1")(handle_submission) - Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload for details of payloads. + Refer to https://api.slack.com/reference/interaction-payloads/views for details of payloads. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -1330,7 +1335,7 @@

    Class variables

    middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `view_submission` listener. - Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload#view_submission for details.""" + Refer to https://api.slack.com/reference/interaction-payloads/views#view_submission for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1346,7 +1351,7 @@

    Class variables

    middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `view_closed` listener. - Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload#view_closed for details.""" + Refer to https://api.slack.com/reference/interaction-payloads/views#view_closed for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1387,7 +1392,8 @@

    Class variables

    Refer to the following documents for details: - * https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element#external_multi_select + * https://api.slack.com/reference/block-kit/block-elements#external_select + * https://api.slack.com/reference/block-kit/block-elements#external_multi_select To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -1427,7 +1433,7 @@

    Class variables

    middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `dialog_suggestion` listener. - Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.""" + Refer to https://api.slack.com/dialogs for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1520,6 +1526,7 @@

    Class variables

    matchers: Optional[Sequence[Callable[..., bool]]], middleware: Optional[Sequence[Union[Callable, Middleware]]], auto_acknowledgement: bool = False, + ack_timeout: int = 3, ) -> Optional[Callable[..., Optional[BoltResponse]]]: value_to_return = None if not isinstance(functions, list): @@ -1546,10 +1553,11 @@

    Class variables

    CustomListener( app_name=self.name, ack_function=functions.pop(0), - lazy_functions=functions, + lazy_functions=functions, # type:ignore[arg-type] matchers=listener_matchers, middleware=listener_middleware, auto_acknowledgement=auto_acknowledgement, + ack_timeout=ack_timeout, base_logger=self._base_logger, ) ) @@ -1769,9 +1777,9 @@

    Methods

    # Pass a function to this method app.action("approve_button")(update_message) - * Refer to https://docs.slack.dev/reference/interaction-payloads/block_actions-payload for actions in `blocks`. - * Refer to https://docs.slack.dev/legacy/legacy-messaging/legacy-message-buttons for actions in `attachments`. - * Refer to https://docs.slack.dev/legacy/legacy-dialogs for actions in dialogs. + * Refer to https://api.slack.com/reference/interaction-payloads/block-actions for actions in `blocks`. + * Refer to https://api.slack.com/legacy/message-buttons for actions in `attachments`. + * Refer to https://api.slack.com/dialogs for actions in dialogs. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -1800,9 +1808,9 @@

    Methods

    app.action("approve_button")(update_message)

    To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.args's API document.

    Args

    @@ -1845,7 +1853,7 @@

    Args

    middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `interactive_message` action listener. - Refer to https://docs.slack.dev/legacy/legacy-messaging/legacy-message-buttons for details.""" + Refer to https://api.slack.com/legacy/message-buttons for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -1855,7 +1863,7 @@

    Args

    return __call__

    Registers a new interactive_message action listener. -Refer to https://docs.slack.dev/legacy/legacy-messaging/legacy-message-buttons for details.

    +Refer to https://api.slack.com/legacy/message-buttons for details.

def block_action(self,
constraints: str | Pattern | Dict[str, str | Pattern],
matchers: Sequence[Callable[..., bool]] | None = None,
middleware: Sequence[Callable | Middleware] | None = None) ‑> Callable[..., Callable[..., BoltResponse | None] | None] @@ -1872,7 +1880,7 @@

Args

middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `block_actions` action listener. - Refer to https://docs.slack.dev/reference/interaction-payloads/block_actions-payload for details. + Refer to https://api.slack.com/reference/interaction-payloads/block-actions for details. """ def __call__(*args, **kwargs): @@ -1883,7 +1891,7 @@

Args

return __call__

Registers a new block_actions action listener. -Refer to https://docs.slack.dev/reference/interaction-payloads/block_actions-payload for details.

+Refer to https://api.slack.com/reference/interaction-payloads/block-actions for details.

def block_suggestion(self,
action_id: str | Pattern,
matchers: Sequence[Callable[..., bool]] | None = None,
middleware: Sequence[Callable | Middleware] | None = None) ‑> Callable[..., Callable[..., BoltResponse | None] | None] @@ -1937,7 +1945,7 @@

Args

# Pass a function to this method app.command("/echo")(repeat_text) - Refer to https://docs.slack.dev/interactivity/implementing-slash-commands for details of Slash Commands. + Refer to https://api.slack.com/interactivity/slash-commands for details of Slash Commands. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -1968,7 +1976,7 @@

Args

# Pass a function to this method app.command("/echo")(repeat_text) -

Refer to https://docs.slack.dev/interactivity/implementing-slash-commands for details of Slash Commands.

+

Refer to https://api.slack.com/interactivity/slash-commands for details of Slash Commands.

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.args's API document.

Args

@@ -2031,7 +2039,7 @@

Args

middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `dialog_cancellation` listener. - Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.""" + Refer to https://api.slack.com/dialogs for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -2041,7 +2049,7 @@

Args

return __call__

Registers a new dialog_cancellation listener. -Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.

+Refer to https://api.slack.com/dialogs for details.

def dialog_submission(self,
callback_id: str | Pattern,
matchers: Sequence[Callable[..., bool]] | None = None,
middleware: Sequence[Callable | Middleware] | None = None) ‑> Callable[..., Callable[..., BoltResponse | None] | None] @@ -2058,7 +2066,7 @@

Args

middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `dialog_submission` listener. - Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.""" + Refer to https://api.slack.com/dialogs for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -2068,7 +2076,7 @@

Args

return __call__

Registers a new dialog_submission listener. -Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.

+Refer to https://api.slack.com/dialogs for details.

def dialog_suggestion(self,
callback_id: str | Pattern,
matchers: Sequence[Callable[..., bool]] | None = None,
middleware: Sequence[Callable | Middleware] | None = None) ‑> Callable[..., Callable[..., BoltResponse | None] | None] @@ -2085,7 +2093,7 @@

Args

middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `dialog_suggestion` listener. - Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.""" + Refer to https://api.slack.com/dialogs for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -2095,7 +2103,7 @@

Args

return __call__

Registers a new dialog_suggestion listener. -Refer to https://docs.slack.dev/legacy/legacy-dialogs for details.

+Refer to https://api.slack.com/dialogs for details.

def dispatch(self,
req: BoltRequest) ‑> BoltResponse @@ -2321,7 +2329,7 @@

Args

# Pass a function to this method app.event("team_join")(ask_for_introduction) - Refer to https://docs.slack.dev/apis/events-api/ for details of Events API. + Refer to https://api.slack.com/apis/connections/events-api for details of Events API. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -2353,7 +2361,7 @@

Args

# Pass a function to this method app.event("team_join")(ask_for_introduction) -

Refer to https://docs.slack.dev/apis/events-api/ for details of Events API.

+

Refer to https://api.slack.com/apis/connections/events-api for details of Events API.

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.args's API document.

Args

@@ -2369,7 +2377,7 @@

Args

-def function(self,
callback_id: str | Pattern,
matchers: Sequence[Callable[..., bool]] | None = None,
middleware: Sequence[Callable | Middleware] | None = None,
auto_acknowledge: bool = True) ‑> Callable[..., Callable[..., BoltResponse | None] | None] +def function(self,
callback_id: str | Pattern,
matchers: Sequence[Callable[..., bool]] | None = None,
middleware: Sequence[Callable | Middleware] | None = None,
auto_acknowledge: bool = True,
ack_timeout: int = 3) ‑> Callable[..., Callable[..., BoltResponse | None] | None]
@@ -2382,6 +2390,7 @@

Args

matchers: Optional[Sequence[Callable[..., bool]]] = None, middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, auto_acknowledge: bool = True, + ack_timeout: int = 3, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new Function listener. This method can be used as either a decorator or a method. @@ -2410,13 +2419,17 @@

Args

Only when all the middleware call `next()` method, the listener function can be invoked. """ + if auto_acknowledge is True: + if ack_timeout != 3: + self._framework_logger.warning(warning_ack_timeout_has_no_effect(callback_id, ack_timeout)) + matchers = list(matchers) if matchers else [] middleware = list(middleware) if middleware else [] def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) primary_matcher = builtin_matchers.function_executed(callback_id=callback_id, base_logger=self._base_logger) - return self._register_listener(functions, primary_matcher, matchers, middleware, auto_acknowledge) + return self._register_listener(functions, primary_matcher, matchers, middleware, auto_acknowledge, ack_timeout) return __call__
@@ -2500,7 +2513,7 @@

Args

# Pass a function to this method app.message(":wave:")(say_hello) - Refer to https://docs.slack.dev/reference/events/message for details of `message` events. + Refer to https://api.slack.com/events/message for details of `message` events. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -2551,7 +2564,7 @@

Args

# Pass a function to this method app.message(":wave:")(say_hello) -

Refer to https://docs.slack.dev/reference/events/message for details of message events.

+

Refer to https://api.slack.com/events/message for details of message events.

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.args's API document.

Args

@@ -2694,7 +2707,8 @@

Args

Refer to the following documents for details: - * https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element#external_multi_select + * https://api.slack.com/reference/block-kit/block-elements#external_select + * https://api.slack.com/reference/block-kit/block-elements#external_multi_select To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -2734,7 +2748,8 @@

Args

Refer to the following documents for details:

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.args's API document.

Args

@@ -2780,7 +2795,7 @@

Args

# Pass a function to this method app.shortcut("open_modal")(open_modal) - Refer to https://docs.slack.dev/interactivity/implementing-shortcuts for details about Shortcuts. + Refer to https://api.slack.com/interactivity/shortcuts for details about Shortcuts. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -2817,7 +2832,7 @@

Args

# Pass a function to this method app.shortcut("open_modal")(open_modal) -

Refer to https://docs.slack.dev/interactivity/implementing-shortcuts for details about Shortcuts.

+

Refer to https://api.slack.com/interactivity/shortcuts for details about Shortcuts.

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.args's API document.

Args

@@ -2903,7 +2918,7 @@

Args

""" Deprecated: Steps from apps for legacy workflows are now deprecated. - Use new custom steps: https://docs.slack.dev/workflows/workflow-steps + Use new custom steps: https://api.slack.com/automation/functions/custom-bolt Registers a new step from app listener. @@ -2921,7 +2936,7 @@

Args

# Pass Step to set up listeners app.step(ws) - Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details of steps from apps. + Refer to https://api.slack.com/workflows/steps for details of steps from apps. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -2938,7 +2953,7 @@

Args

warnings.warn( ( "Steps from apps for legacy workflows are now deprecated. " - "Use new custom steps: https://docs.slack.dev/workflows/workflow-steps" + "Use new custom steps: https://api.slack.com/automation/functions/custom-bolt" ), category=DeprecationWarning, ) @@ -2960,7 +2975,7 @@

Args

Deprecated

Steps from apps for legacy workflows are now deprecated. -Use new custom steps: https://docs.slack.dev/workflows/workflow-steps

+Use new custom steps: https://api.slack.com/automation/functions/custom-bolt

Registers a new step from app listener.

Unlike others, this method doesn't behave as a decorator. If you want to register a step from app by a decorator, use WorkflowStepBuilder's methods.

@@ -2975,7 +2990,7 @@

Args

# Pass Step to set up listeners app.step(ws) -

Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details of steps from apps.

+

Refer to https://api.slack.com/workflows/steps for details of steps from apps.

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.args's API document.

For further information about WorkflowStep specific function arguments such as configure, update, complete, and fail, @@ -3046,7 +3061,7 @@

Args

# Pass a function to this method app.view("view_1")(handle_submission) - Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload for details of payloads. + Refer to https://api.slack.com/reference/interaction-payloads/views for details of payloads. To learn available arguments for middleware/listeners, see `slack_bolt.kwargs_injection.args`'s API document. @@ -3087,7 +3102,7 @@

Args

# Pass a function to this method app.view("view_1")(handle_submission) -

Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload for details of payloads.

+

Refer to https://api.slack.com/reference/interaction-payloads/views for details of payloads.

To learn available arguments for middleware/listeners, see slack_bolt.kwargs_injection.args's API document.

Args

@@ -3116,7 +3131,7 @@

Args

middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `view_closed` listener. - Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload#view_closed for details.""" + Refer to https://api.slack.com/reference/interaction-payloads/views#view_closed for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -3126,7 +3141,7 @@

Args

return __call__

Registers a new view_closed listener. -Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload#view_closed for details.

+Refer to https://api.slack.com/reference/interaction-payloads/views#view_closed for details.

def view_submission(self,
constraints: str | Pattern,
matchers: Sequence[Callable[..., bool]] | None = None,
middleware: Sequence[Callable | Middleware] | None = None) ‑> Callable[..., Callable[..., BoltResponse | None] | None] @@ -3143,7 +3158,7 @@

Args

middleware: Optional[Sequence[Union[Callable, Middleware]]] = None, ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]: """Registers a new `view_submission` listener. - Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload#view_submission for details.""" + Refer to https://api.slack.com/reference/interaction-payloads/views#view_submission for details.""" def __call__(*args, **kwargs): functions = self._to_listener_functions(kwargs) if kwargs else list(args) @@ -3153,7 +3168,7 @@

Args

return __call__

Registers a new view_submission listener. -Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload#view_submission for details.

+Refer to https://api.slack.com/reference/interaction-payloads/views#view_submission for details.

@@ -5307,6 +5322,7 @@

Methods

ack_function: Callable[..., BoltResponse] lazy_functions: Sequence[Callable[..., None]] auto_acknowledgement: bool + ack_timeout: int = 3 def matches( self, @@ -5372,6 +5388,10 @@

Class variables

The type of the None singleton.

+
var ack_timeout : int
+
+

The type of the None singleton.

+
var auto_acknowledgement : bool

The type of the None singleton.

@@ -6115,6 +6135,7 @@

Listener

  • ack_function
    • +
  • ack_timeout
  • auto_acknowledgement
  • lazy_functions
  • matchers
    • @@ -6180,7 +6201,7 @@

    SetTitle diff --git a/docs/reference/kwargs_injection/args.html b/docs/reference/kwargs_injection/args.html index 9d2eb2c40..4d03687d1 100644 --- a/docs/reference/kwargs_injection/args.html +++ b/docs/reference/kwargs_injection/args.html @@ -3,7 +3,7 @@ - + slack_bolt.kwargs_injection.args API documentation @@ -404,7 +404,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/kwargs_injection/async_args.html b/docs/reference/kwargs_injection/async_args.html index 65a14c2d1..959f35a43 100644 --- a/docs/reference/kwargs_injection/async_args.html +++ b/docs/reference/kwargs_injection/async_args.html @@ -3,7 +3,7 @@ - + slack_bolt.kwargs_injection.async_args API documentation @@ -401,7 +401,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/kwargs_injection/async_utils.html b/docs/reference/kwargs_injection/async_utils.html index 6f433ddca..80952518d 100644 --- a/docs/reference/kwargs_injection/async_utils.html +++ b/docs/reference/kwargs_injection/async_utils.html @@ -3,7 +3,7 @@ - + slack_bolt.kwargs_injection.async_utils API documentation @@ -171,7 +171,7 @@

    Functions

    diff --git a/docs/reference/kwargs_injection/index.html b/docs/reference/kwargs_injection/index.html index 4132bbaba..de7ef4a0a 100644 --- a/docs/reference/kwargs_injection/index.html +++ b/docs/reference/kwargs_injection/index.html @@ -3,7 +3,7 @@ - + slack_bolt.kwargs_injection API documentation @@ -544,7 +544,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/kwargs_injection/utils.html b/docs/reference/kwargs_injection/utils.html index a589350c9..2e6ecd001 100644 --- a/docs/reference/kwargs_injection/utils.html +++ b/docs/reference/kwargs_injection/utils.html @@ -3,7 +3,7 @@ - + slack_bolt.kwargs_injection.utils API documentation @@ -170,7 +170,7 @@

    Functions

    diff --git a/docs/reference/lazy_listener/async_internals.html b/docs/reference/lazy_listener/async_internals.html index 19becac19..9d86a02e5 100644 --- a/docs/reference/lazy_listener/async_internals.html +++ b/docs/reference/lazy_listener/async_internals.html @@ -3,7 +3,7 @@ - + slack_bolt.lazy_listener.async_internals API documentation @@ -102,7 +102,7 @@

    Functions

    diff --git a/docs/reference/lazy_listener/async_runner.html b/docs/reference/lazy_listener/async_runner.html index e58b0a044..701f1640a 100644 --- a/docs/reference/lazy_listener/async_runner.html +++ b/docs/reference/lazy_listener/async_runner.html @@ -3,7 +3,7 @@ - + slack_bolt.lazy_listener.async_runner API documentation @@ -184,7 +184,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/lazy_listener/asyncio_runner.html b/docs/reference/lazy_listener/asyncio_runner.html index d05a4c9ac..2fdcf8ffe 100644 --- a/docs/reference/lazy_listener/asyncio_runner.html +++ b/docs/reference/lazy_listener/asyncio_runner.html @@ -3,7 +3,7 @@ - + slack_bolt.lazy_listener.asyncio_runner API documentation @@ -113,7 +113,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/lazy_listener/index.html b/docs/reference/lazy_listener/index.html index 374164af8..c2eb1c9b0 100644 --- a/docs/reference/lazy_listener/index.html +++ b/docs/reference/lazy_listener/index.html @@ -3,7 +3,7 @@ - + slack_bolt.lazy_listener API documentation @@ -295,7 +295,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/lazy_listener/internals.html b/docs/reference/lazy_listener/internals.html index 96c04a56c..1801abafd 100644 --- a/docs/reference/lazy_listener/internals.html +++ b/docs/reference/lazy_listener/internals.html @@ -3,7 +3,7 @@ - + slack_bolt.lazy_listener.internals API documentation @@ -102,7 +102,7 @@

    Functions

    diff --git a/docs/reference/lazy_listener/runner.html b/docs/reference/lazy_listener/runner.html index 56216c9c8..ff4f449a0 100644 --- a/docs/reference/lazy_listener/runner.html +++ b/docs/reference/lazy_listener/runner.html @@ -3,7 +3,7 @@ - + slack_bolt.lazy_listener.runner API documentation @@ -185,7 +185,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/lazy_listener/thread_runner.html b/docs/reference/lazy_listener/thread_runner.html index 19e6ff29e..b4ca0711a 100644 --- a/docs/reference/lazy_listener/thread_runner.html +++ b/docs/reference/lazy_listener/thread_runner.html @@ -3,7 +3,7 @@ - + slack_bolt.lazy_listener.thread_runner API documentation @@ -119,7 +119,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/listener/async_builtins.html b/docs/reference/listener/async_builtins.html index 61e6fcd9f..015dd94b3 100644 --- a/docs/reference/listener/async_builtins.html +++ b/docs/reference/listener/async_builtins.html @@ -3,7 +3,7 @@ - + slack_bolt.listener.async_builtins API documentation @@ -168,7 +168,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/listener/async_listener.html b/docs/reference/listener/async_listener.html index 52da6d342..a3d1a7fef 100644 --- a/docs/reference/listener/async_listener.html +++ b/docs/reference/listener/async_listener.html @@ -3,7 +3,7 @@ - + slack_bolt.listener.async_listener API documentation @@ -48,7 +48,7 @@

    Classes

    class AsyncCustomListener -(*,
    app_name: str,
    ack_function: Callable[..., Awaitable[BoltResponse | None]],
    lazy_functions: Sequence[Callable[..., Awaitable[None]]],
    matchers: Sequence[AsyncListenerMatcher],
    middleware: Sequence[AsyncMiddleware],
    auto_acknowledgement: bool = False,
    base_logger: logging.Logger | None = None)     +(*,
    app_name: str,
    ack_function: Callable[..., Awaitable[BoltResponse | None]],
    lazy_functions: Sequence[Callable[..., Awaitable[None]]],
    matchers: Sequence[AsyncListenerMatcher],
    middleware: Sequence[AsyncMiddleware],
    auto_acknowledgement: bool = False,
    ack_timeout: int = 3,
    base_logger: logging.Logger | None = None)
    @@ -62,6 +62,7 @@

    Classes

    matchers: Sequence[AsyncListenerMatcher] middleware: Sequence[AsyncMiddleware] auto_acknowledgement: bool + ack_timeout: int arg_names: MutableSequence[str] logger: Logger @@ -74,6 +75,7 @@

    Classes

    matchers: Sequence[AsyncListenerMatcher], middleware: Sequence[AsyncMiddleware], auto_acknowledgement: bool = False, + ack_timeout: int = 3, base_logger: Optional[Logger] = None, ): self.app_name = app_name @@ -82,6 +84,7 @@

    Classes

    self.matchers = matchers self.middleware = middleware self.auto_acknowledgement = auto_acknowledgement + self.ack_timeout = ack_timeout self.arg_names = get_arg_names_of_callable(ack_function) self.logger = get_bolt_app_logger(app_name, self.ack_function, base_logger) @@ -112,6 +115,10 @@

    Class variables

    The type of the None singleton.

    +
    var ack_timeout : int
    +
    +

    The type of the None singleton.

    +
    var app_name : str

    The type of the None singleton.

    @@ -182,7 +189,7 @@

    Returns

    class cls -(*,
    app_name: str,
    ack_function: Callable[..., Awaitable[BoltResponse | None]],
    lazy_functions: Sequence[Callable[..., Awaitable[None]]],
    matchers: Sequence[AsyncListenerMatcher],
    middleware: Sequence[AsyncMiddleware],
    auto_acknowledgement: bool = False,
    base_logger: logging.Logger | None = None)     +(*,
    app_name: str,
    ack_function: Callable[..., Awaitable[BoltResponse | None]],
    lazy_functions: Sequence[Callable[..., Awaitable[None]]],
    matchers: Sequence[AsyncListenerMatcher],
    middleware: Sequence[AsyncMiddleware],
    auto_acknowledgement: bool = False,
    ack_timeout: int = 3,
    base_logger: logging.Logger | None = None)
    @@ -196,6 +203,7 @@

    Returns

    matchers: Sequence[AsyncListenerMatcher] middleware: Sequence[AsyncMiddleware] auto_acknowledgement: bool + ack_timeout: int arg_names: MutableSequence[str] logger: Logger @@ -208,6 +216,7 @@

    Returns

    matchers: Sequence[AsyncListenerMatcher], middleware: Sequence[AsyncMiddleware], auto_acknowledgement: bool = False, + ack_timeout: int = 3, base_logger: Optional[Logger] = None, ): self.app_name = app_name @@ -216,6 +225,7 @@

    Returns

    self.matchers = matchers self.middleware = middleware self.auto_acknowledgement = auto_acknowledgement + self.ack_timeout = ack_timeout self.arg_names = get_arg_names_of_callable(ack_function) self.logger = get_bolt_app_logger(app_name, self.ack_function, base_logger) @@ -260,6 +270,7 @@

    Inherited members

  • AsyncListener:
    • ack_function
      • +
    • ack_timeout
    • auto_acknowledgement
    • lazy_functions
    • matchers
      • @@ -284,6 +295,7 @@

      Inherited members

      ack_function: Callable[..., Awaitable[BoltResponse]] lazy_functions: Sequence[Callable[..., Awaitable[None]]] auto_acknowledgement: bool + ack_timeout: int async def async_matches( self, @@ -349,6 +361,10 @@

      Class variables

      The type of the None singleton.

      +
      var ack_timeout : int
      +
      +

      The type of the None singleton.

      +
      var auto_acknowledgement : bool

      The type of the None singleton.

      @@ -490,6 +506,7 @@

      Returns

      AsyncCustomListener

      • ack_function
        • +
      • ack_timeout
      • app_name
      • arg_names
      • auto_acknowledgement
        • @@ -512,6 +529,7 @@

        AsyncListener

        • ack_function
          • +
        • ack_timeout
        • async_matches
        • auto_acknowledgement
        • lazy_functions
          • @@ -527,7 +545,7 @@

          -

          Generated by pdoc 0.11.5.

          +

          Generated by pdoc 0.11.6.

          diff --git a/docs/reference/listener/async_listener_completion_handler.html b/docs/reference/listener/async_listener_completion_handler.html index 2a05e0213..6cde66b93 100644 --- a/docs/reference/listener/async_listener_completion_handler.html +++ b/docs/reference/listener/async_listener_completion_handler.html @@ -3,7 +3,7 @@ - + slack_bolt.listener.async_listener_completion_handler API documentation @@ -220,7 +220,7 @@

          -

          Generated by pdoc 0.11.5.

          +

          Generated by pdoc 0.11.6.

          diff --git a/docs/reference/listener/async_listener_error_handler.html b/docs/reference/listener/async_listener_error_handler.html index 9600a2cfd..1f3789c40 100644 --- a/docs/reference/listener/async_listener_error_handler.html +++ b/docs/reference/listener/async_listener_error_handler.html @@ -3,7 +3,7 @@ - + slack_bolt.listener.async_listener_error_handler API documentation @@ -234,7 +234,7 @@

          -

          Generated by pdoc 0.11.5.

          +

          Generated by pdoc 0.11.6.

          diff --git a/docs/reference/listener/async_listener_start_handler.html b/docs/reference/listener/async_listener_start_handler.html index 23ada5e08..80b25eb29 100644 --- a/docs/reference/listener/async_listener_start_handler.html +++ b/docs/reference/listener/async_listener_start_handler.html @@ -3,7 +3,7 @@ - + slack_bolt.listener.async_listener_start_handler API documentation @@ -220,7 +220,7 @@

          -

          Generated by pdoc 0.11.5.

          +

          Generated by pdoc 0.11.6.

          diff --git a/docs/reference/listener/asyncio_runner.html b/docs/reference/listener/asyncio_runner.html index 8262667f0..4d71a88a7 100644 --- a/docs/reference/listener/asyncio_runner.html +++ b/docs/reference/listener/asyncio_runner.html @@ -3,7 +3,7 @@ - + slack_bolt.listener.asyncio_runner API documentation @@ -180,7 +180,7 @@

          Classes

          self._start_lazy_function(lazy_func, request) # await for the completion of ack() in the async listener execution - while ack.response is None and time.time() - starting_time <= 3: + while ack.response is None and time.time() - starting_time <= listener.ack_timeout: await asyncio.sleep(0.01) if response is None and ack.response is None: @@ -359,7 +359,7 @@

          Methods

          self._start_lazy_function(lazy_func, request) # await for the completion of ack() in the async listener execution - while ack.response is None and time.time() - starting_time <= 3: + while ack.response is None and time.time() - starting_time <= listener.ack_timeout: await asyncio.sleep(0.01) if response is None and ack.response is None: @@ -414,7 +414,7 @@

          diff --git a/docs/reference/listener/builtins.html b/docs/reference/listener/builtins.html index 75f8ca620..5f3759658 100644 --- a/docs/reference/listener/builtins.html +++ b/docs/reference/listener/builtins.html @@ -3,7 +3,7 @@ - + slack_bolt.listener.builtins API documentation @@ -168,7 +168,7 @@

          diff --git a/docs/reference/listener/custom_listener.html b/docs/reference/listener/custom_listener.html index 1cd261379..1f18502f2 100644 --- a/docs/reference/listener/custom_listener.html +++ b/docs/reference/listener/custom_listener.html @@ -3,7 +3,7 @@ - + slack_bolt.listener.custom_listener API documentation @@ -48,7 +48,7 @@

          Classes

          class CustomListener -(*,
          app_name: str,
          ack_function: Callable[..., BoltResponse | None],
          lazy_functions: Sequence[Callable[..., None]],
          matchers: Sequence[ListenerMatcher],
          middleware: Sequence[Middleware],
          auto_acknowledgement: bool = False,
          base_logger: logging.Logger | None = None)           +(*,
          app_name: str,
          ack_function: Callable[..., BoltResponse | None],
          lazy_functions: Sequence[Callable[..., None]],
          matchers: Sequence[ListenerMatcher],
          middleware: Sequence[Middleware],
          auto_acknowledgement: bool = False,
          ack_timeout: int = 3,
          base_logger: logging.Logger | None = None)
          @@ -62,6 +62,7 @@

          Classes

          matchers: Sequence[ListenerMatcher] middleware: Sequence[Middleware] auto_acknowledgement: bool + ack_timeout: int = 3 arg_names: MutableSequence[str] logger: Logger @@ -74,6 +75,7 @@

          Classes

          matchers: Sequence[ListenerMatcher], middleware: Sequence[Middleware], auto_acknowledgement: bool = False, + ack_timeout: int = 3, base_logger: Optional[Logger] = None, ): self.app_name = app_name @@ -82,6 +84,7 @@

          Classes

          self.matchers = matchers self.middleware = middleware self.auto_acknowledgement = auto_acknowledgement + self.ack_timeout = ack_timeout self.arg_names = get_arg_names_of_callable(ack_function) self.logger = get_bolt_app_logger(app_name, self.ack_function, base_logger) @@ -126,6 +129,7 @@

          Inherited members

        • Listener:
          • ack_function
            • +
          • ack_timeout
          • auto_acknowledgement
          • lazy_functions
          • matchers
            • @@ -165,7 +169,7 @@

            -

            Generated by pdoc 0.11.5.

            +

            Generated by pdoc 0.11.6.

            diff --git a/docs/reference/listener/index.html b/docs/reference/listener/index.html index 677147e21..f31264cac 100644 --- a/docs/reference/listener/index.html +++ b/docs/reference/listener/index.html @@ -3,7 +3,7 @@ - + slack_bolt.listener API documentation @@ -107,7 +107,7 @@

            Classes

            class CustomListener -(*,
            app_name: str,
            ack_function: Callable[..., BoltResponse | None],
            lazy_functions: Sequence[Callable[..., None]],
            matchers: Sequence[ListenerMatcher],
            middleware: Sequence[Middleware],
            auto_acknowledgement: bool = False,
            base_logger: logging.Logger | None = None)             +(*,
            app_name: str,
            ack_function: Callable[..., BoltResponse | None],
            lazy_functions: Sequence[Callable[..., None]],
            matchers: Sequence[ListenerMatcher],
            middleware: Sequence[Middleware],
            auto_acknowledgement: bool = False,
            ack_timeout: int = 3,
            base_logger: logging.Logger | None = None)
            @@ -121,6 +121,7 @@

            Classes

            matchers: Sequence[ListenerMatcher] middleware: Sequence[Middleware] auto_acknowledgement: bool + ack_timeout: int = 3 arg_names: MutableSequence[str] logger: Logger @@ -133,6 +134,7 @@

            Classes

            matchers: Sequence[ListenerMatcher], middleware: Sequence[Middleware], auto_acknowledgement: bool = False, + ack_timeout: int = 3, base_logger: Optional[Logger] = None, ): self.app_name = app_name @@ -141,6 +143,7 @@

            Classes

            self.matchers = matchers self.middleware = middleware self.auto_acknowledgement = auto_acknowledgement + self.ack_timeout = ack_timeout self.arg_names = get_arg_names_of_callable(ack_function) self.logger = get_bolt_app_logger(app_name, self.ack_function, base_logger) @@ -185,6 +188,7 @@

            Inherited members

          • Listener:
            • ack_function
              • +
            • ack_timeout
            • auto_acknowledgement
            • lazy_functions
            • matchers
              • @@ -209,6 +213,7 @@

              Inherited members

              ack_function: Callable[..., BoltResponse] lazy_functions: Sequence[Callable[..., None]] auto_acknowledgement: bool + ack_timeout: int = 3 def matches( self, @@ -274,6 +279,10 @@

              Class variables

              The type of the None singleton.

              +
              var ack_timeout : int
              +
              +

              The type of the None singleton.

              +
              var auto_acknowledgement : bool

              The type of the None singleton.

              @@ -440,6 +449,7 @@

              Listener

              • ack_function
                • +
              • ack_timeout
              • auto_acknowledgement
              • lazy_functions
              • matchers
                • @@ -455,7 +465,7 @@

                -

                Generated by pdoc 0.11.5.

                +

                Generated by pdoc 0.11.6.

                diff --git a/docs/reference/listener/listener.html b/docs/reference/listener/listener.html index 743fb2ceb..034dbe67f 100644 --- a/docs/reference/listener/listener.html +++ b/docs/reference/listener/listener.html @@ -3,7 +3,7 @@ - + slack_bolt.listener.listener API documentation @@ -60,6 +60,7 @@

                Classes

                ack_function: Callable[..., BoltResponse] lazy_functions: Sequence[Callable[..., None]] auto_acknowledgement: bool + ack_timeout: int = 3 def matches( self, @@ -125,6 +126,10 @@

                Class variables

                The type of the None singleton.

                +
                var ack_timeout : int
                +
                +

                The type of the None singleton.

                +
                var auto_acknowledgement : bool

                The type of the None singleton.

                @@ -266,6 +271,7 @@

                Returns

                Listener

                • ack_function
                  • +
                • ack_timeout
                • auto_acknowledgement
                • lazy_functions
                • matchers
                  • @@ -281,7 +287,7 @@

                  -

                  Generated by pdoc 0.11.5.

                  +

                  Generated by pdoc 0.11.6.

                  diff --git a/docs/reference/listener/listener_completion_handler.html b/docs/reference/listener/listener_completion_handler.html index 35b2fe8cd..42b1b5413 100644 --- a/docs/reference/listener/listener_completion_handler.html +++ b/docs/reference/listener/listener_completion_handler.html @@ -3,7 +3,7 @@ - + slack_bolt.listener.listener_completion_handler API documentation @@ -221,7 +221,7 @@

                  -

                  Generated by pdoc 0.11.5.

                  +

                  Generated by pdoc 0.11.6.

                  diff --git a/docs/reference/listener/listener_error_handler.html b/docs/reference/listener/listener_error_handler.html index fc49894d2..c9f7c2ccd 100644 --- a/docs/reference/listener/listener_error_handler.html +++ b/docs/reference/listener/listener_error_handler.html @@ -3,7 +3,7 @@ - + slack_bolt.listener.listener_error_handler API documentation @@ -234,7 +234,7 @@

                  -

                  Generated by pdoc 0.11.5.

                  +

                  Generated by pdoc 0.11.6.

                  diff --git a/docs/reference/listener/listener_start_handler.html b/docs/reference/listener/listener_start_handler.html index 63cb98b91..d60c1b9dc 100644 --- a/docs/reference/listener/listener_start_handler.html +++ b/docs/reference/listener/listener_start_handler.html @@ -3,7 +3,7 @@ - + slack_bolt.listener.listener_start_handler API documentation @@ -232,7 +232,7 @@

                  -

                  Generated by pdoc 0.11.5.

                  +

                  Generated by pdoc 0.11.6.

                  diff --git a/docs/reference/listener/thread_runner.html b/docs/reference/listener/thread_runner.html index b6fafae99..5415f9ada 100644 --- a/docs/reference/listener/thread_runner.html +++ b/docs/reference/listener/thread_runner.html @@ -3,7 +3,7 @@ - + slack_bolt.listener.thread_runner API documentation @@ -148,7 +148,7 @@

                  Classes

                  if not request.lazy_only: # start the listener function asynchronously def run_ack_function_asynchronously(): - nonlocal ack, request, response + nonlocal response try: self.listener_start_handler.handle( request=request, @@ -197,7 +197,7 @@

                  Classes

                  self._start_lazy_function(lazy_func, request) # await for the completion of ack() in the async listener execution - while ack.response is None and time.time() - starting_time <= 3: + while ack.response is None and time.time() - starting_time <= listener.ack_timeout: time.sleep(0.01) if response is None and ack.response is None: @@ -346,7 +346,7 @@

                  Methods

                  if not request.lazy_only: # start the listener function asynchronously def run_ack_function_asynchronously(): - nonlocal ack, request, response + nonlocal response try: self.listener_start_handler.handle( request=request, @@ -395,7 +395,7 @@

                  Methods

                  self._start_lazy_function(lazy_func, request) # await for the completion of ack() in the async listener execution - while ack.response is None and time.time() - starting_time <= 3: + while ack.response is None and time.time() - starting_time <= listener.ack_timeout: time.sleep(0.01) if response is None and ack.response is None: @@ -451,7 +451,7 @@

                  diff --git a/docs/reference/listener_matcher/async_builtins.html b/docs/reference/listener_matcher/async_builtins.html index b99d07c82..0df1215de 100644 --- a/docs/reference/listener_matcher/async_builtins.html +++ b/docs/reference/listener_matcher/async_builtins.html @@ -3,7 +3,7 @@ - + slack_bolt.listener_matcher.async_builtins API documentation @@ -112,7 +112,7 @@

                  -

                  Generated by pdoc 0.11.5.

                  +

                  Generated by pdoc 0.11.6.

                  diff --git a/docs/reference/listener_matcher/async_listener_matcher.html b/docs/reference/listener_matcher/async_listener_matcher.html index bc8676302..1366da4e2 100644 --- a/docs/reference/listener_matcher/async_listener_matcher.html +++ b/docs/reference/listener_matcher/async_listener_matcher.html @@ -3,7 +3,7 @@ - + slack_bolt.listener_matcher.async_listener_matcher API documentation @@ -311,7 +311,7 @@

                  -

                  Generated by pdoc 0.11.5.

                  +

                  Generated by pdoc 0.11.6.

                  diff --git a/docs/reference/listener_matcher/builtins.html b/docs/reference/listener_matcher/builtins.html index 29af67f6c..d951deada 100644 --- a/docs/reference/listener_matcher/builtins.html +++ b/docs/reference/listener_matcher/builtins.html @@ -3,7 +3,7 @@ - + slack_bolt.listener_matcher.builtins API documentation @@ -80,7 +80,7 @@

                  Functions

                  return dialog_submission(constraints["callback_id"], asyncio) if action_type == "dialog_cancellation": return dialog_cancellation(constraints["callback_id"], asyncio) - # https://docs.slack.dev/legacy/legacy-steps-from-apps/ + # https://api.slack.com/workflows/steps if action_type == "workflow_step_edit": return workflow_step_edit(constraints["callback_id"], asyncio) @@ -692,7 +692,7 @@

                  diff --git a/docs/reference/listener_matcher/custom_listener_matcher.html b/docs/reference/listener_matcher/custom_listener_matcher.html index 8009e84a1..087d36907 100644 --- a/docs/reference/listener_matcher/custom_listener_matcher.html +++ b/docs/reference/listener_matcher/custom_listener_matcher.html @@ -3,7 +3,7 @@ - + slack_bolt.listener_matcher.custom_listener_matcher API documentation @@ -141,7 +141,7 @@

                  -

                  Generated by pdoc 0.11.5.

                  +

                  Generated by pdoc 0.11.6.

                  diff --git a/docs/reference/listener_matcher/index.html b/docs/reference/listener_matcher/index.html index 622a5e9d9..a93c86d98 100644 --- a/docs/reference/listener_matcher/index.html +++ b/docs/reference/listener_matcher/index.html @@ -3,7 +3,7 @@ - + slack_bolt.listener_matcher API documentation @@ -247,7 +247,7 @@

                  -

                  Generated by pdoc 0.11.5.

                  +

                  Generated by pdoc 0.11.6.

                  diff --git a/docs/reference/listener_matcher/listener_matcher.html b/docs/reference/listener_matcher/listener_matcher.html index a20816088..0618f7e4e 100644 --- a/docs/reference/listener_matcher/listener_matcher.html +++ b/docs/reference/listener_matcher/listener_matcher.html @@ -3,7 +3,7 @@ - + slack_bolt.listener_matcher.listener_matcher API documentation @@ -137,7 +137,7 @@

                  -

                  Generated by pdoc 0.11.5.

                  +

                  Generated by pdoc 0.11.6.

                  diff --git a/docs/reference/logger/index.html b/docs/reference/logger/index.html index c9defacdb..d0b2ef33f 100644 --- a/docs/reference/logger/index.html +++ b/docs/reference/logger/index.html @@ -3,7 +3,7 @@ - + slack_bolt.logger API documentation @@ -121,7 +121,7 @@

                  Functions

                  diff --git a/docs/reference/logger/messages.html b/docs/reference/logger/messages.html index c3ff45156..3c8d67a31 100644 --- a/docs/reference/logger/messages.html +++ b/docs/reference/logger/messages.html @@ -3,7 +3,7 @@ - + slack_bolt.logger.messages API documentation @@ -308,6 +308,20 @@

                  Functions

            • +
            +def warning_ack_timeout_has_no_effect(identifier: str | re.Pattern, ack_timeout: int) ‑> str +
            +
            +
            + +Expand source code + +
            def warning_ack_timeout_has_no_effect(identifier: Union[str, Pattern], ack_timeout: int) -> str:
+    handler_example = f'@app.function("{identifier}")' if isinstance(identifier, str) else f"@app.function({identifier})"
+    return f"On {handler_example}, as `auto_acknowledge` is `True`, " f"`ack_timeout={ack_timeout}` you gave will be unused"
            +
            +
            +
            def warning_bot_only_conflicts() ‑> str
            @@ -591,6 +605,7 @@

            Functions

          • error_token_required
          • error_unexpected_listener_middleware
          • info_default_oauth_settings_loaded
            • +
          • warning_ack_timeout_has_no_effect
          • warning_bot_only_conflicts
          • warning_client_prioritized_and_token_skipped
          • warning_did_not_call_ack
            • @@ -605,7 +620,7 @@

            Functions

            diff --git a/docs/reference/middleware/assistant/assistant.html b/docs/reference/middleware/assistant/assistant.html index 76e5dff76..d1184c407 100644 --- a/docs/reference/middleware/assistant/assistant.html +++ b/docs/reference/middleware/assistant/assistant.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.assistant.assistant API documentation @@ -647,7 +647,7 @@

            -

            Generated by pdoc 0.11.5.

            +

            Generated by pdoc 0.11.6.

            diff --git a/docs/reference/middleware/assistant/async_assistant.html b/docs/reference/middleware/assistant/async_assistant.html index 260d493ac..2faf0e34b 100644 --- a/docs/reference/middleware/assistant/async_assistant.html +++ b/docs/reference/middleware/assistant/async_assistant.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.assistant.async_assistant API documentation @@ -707,7 +707,7 @@

            -

            Generated by pdoc 0.11.5.

            +

            Generated by pdoc 0.11.6.

            diff --git a/docs/reference/middleware/assistant/index.html b/docs/reference/middleware/assistant/index.html index 857240adb..92f405cad 100644 --- a/docs/reference/middleware/assistant/index.html +++ b/docs/reference/middleware/assistant/index.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.assistant API documentation @@ -664,7 +664,7 @@

            -

            Generated by pdoc 0.11.5.

            +

            Generated by pdoc 0.11.6.

            diff --git a/docs/reference/middleware/async_builtins.html b/docs/reference/middleware/async_builtins.html index eb46581bb..7528dc0bb 100644 --- a/docs/reference/middleware/async_builtins.html +++ b/docs/reference/middleware/async_builtins.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.async_builtins API documentation @@ -205,7 +205,7 @@

            Inherited members

            """Verifies an incoming request by checking the validity of `x-slack-signature`, `x-slack-request-timestamp`, and its body data. - Refer to https://docs.slack.dev/authentication/verifying-requests-from-slack for details. + Refer to https://api.slack.com/authentication/verifying-requests-from-slack for details. """ async def async_process( @@ -232,10 +232,10 @@

            Inherited members

          • Verifies an incoming request by checking the validity of x-slack-signature, x-slack-request-timestamp, and its body data.

          -

          Refer to https://docs.slack.dev/authentication/verifying-requests-from-slack for details.

          +

          Refer to https://api.slack.com/authentication/verifying-requests-from-slack for details.

          Verifies an incoming request by checking the validity of x-slack-signature, x-slack-request-timestamp, and its body data.

          -

          Refer to https://docs.slack.dev/authentication/verifying-requests-from-slack for details.

          +

          Refer to https://api.slack.com/authentication/verifying-requests-from-slack for details.

          Args

          signing_secret
          @@ -293,12 +293,12 @@

          Inherited members

    • A middleware can process request data before other middleware and listener functions.

    Handles ssl_check requests. -Refer to https://docs.slack.dev/interactivity/implementing-slash-commands for details.

    +Refer to https://api.slack.com/interactivity/slash-commands for details.

    Args

    verification_token
    The verification token to check -(optional as it's already deprecated - https://docs.slack.dev/authentication/verifying-requests-from-slack#verification_token_deprecation)
    +(optional as it's already deprecated - https://api.slack.com/authentication/verifying-requests-from-slack#verification_token_deprecation)
    base_logger
    The base logger
    @@ -352,7 +352,7 @@

    Inherited members

    A middleware can process request data before other middleware and listener functions.

    Handles url_verification requests.

    -

    Refer to https://docs.slack.dev/reference/events/url_verification for details.

    +

    Refer to https://api.slack.com/events/url_verification for details.

    Args

    base_logger
    @@ -418,7 +418,7 @@

    diff --git a/docs/reference/middleware/async_custom_middleware.html b/docs/reference/middleware/async_custom_middleware.html index 6ef00baaf..d985458ed 100644 --- a/docs/reference/middleware/async_custom_middleware.html +++ b/docs/reference/middleware/async_custom_middleware.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.async_custom_middleware API documentation @@ -166,7 +166,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/middleware/async_middleware.html b/docs/reference/middleware/async_middleware.html index e0e38cf9c..33b4273e7 100644 --- a/docs/reference/middleware/async_middleware.html +++ b/docs/reference/middleware/async_middleware.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.async_middleware API documentation @@ -232,7 +232,7 @@

    diff --git a/docs/reference/middleware/async_middleware_error_handler.html b/docs/reference/middleware/async_middleware_error_handler.html index 617e490c7..e7cd8bb32 100644 --- a/docs/reference/middleware/async_middleware_error_handler.html +++ b/docs/reference/middleware/async_middleware_error_handler.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.async_middleware_error_handler API documentation @@ -234,7 +234,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/middleware/attaching_function_token/async_attaching_function_token.html b/docs/reference/middleware/attaching_function_token/async_attaching_function_token.html index ab8b609a2..1becac04e 100644 --- a/docs/reference/middleware/attaching_function_token/async_attaching_function_token.html +++ b/docs/reference/middleware/attaching_function_token/async_attaching_function_token.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.attaching_function_token.async_attaching_function_token API documentation @@ -107,7 +107,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/middleware/attaching_function_token/attaching_function_token.html b/docs/reference/middleware/attaching_function_token/attaching_function_token.html index f005e8ac1..8eea36647 100644 --- a/docs/reference/middleware/attaching_function_token/attaching_function_token.html +++ b/docs/reference/middleware/attaching_function_token/attaching_function_token.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.attaching_function_token.attaching_function_token API documentation @@ -107,7 +107,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/middleware/attaching_function_token/index.html b/docs/reference/middleware/attaching_function_token/index.html index 107ae09d6..44efd27a2 100644 --- a/docs/reference/middleware/attaching_function_token/index.html +++ b/docs/reference/middleware/attaching_function_token/index.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.attaching_function_token API documentation @@ -124,7 +124,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/middleware/authorization/async_authorization.html b/docs/reference/middleware/authorization/async_authorization.html index aef0b3cd7..9f38ea711 100644 --- a/docs/reference/middleware/authorization/async_authorization.html +++ b/docs/reference/middleware/authorization/async_authorization.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.authorization.async_authorization API documentation @@ -102,7 +102,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/middleware/authorization/async_internals.html b/docs/reference/middleware/authorization/async_internals.html index 483e8c81f..22b709799 100644 --- a/docs/reference/middleware/authorization/async_internals.html +++ b/docs/reference/middleware/authorization/async_internals.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.authorization.async_internals API documentation @@ -60,7 +60,7 @@

    Module slack_bolt.middleware.authorization.async_interna diff --git a/docs/reference/middleware/authorization/async_multi_teams_authorization.html b/docs/reference/middleware/authorization/async_multi_teams_authorization.html index b9bfa138f..50b529f33 100644 --- a/docs/reference/middleware/authorization/async_multi_teams_authorization.html +++ b/docs/reference/middleware/authorization/async_multi_teams_authorization.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.authorization.async_multi_teams_authorization API documentation @@ -216,7 +216,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/middleware/authorization/async_single_team_authorization.html b/docs/reference/middleware/authorization/async_single_team_authorization.html index 2b3c40369..a167d1c68 100644 --- a/docs/reference/middleware/authorization/async_single_team_authorization.html +++ b/docs/reference/middleware/authorization/async_single_team_authorization.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.authorization.async_single_team_authorization API documentation @@ -157,7 +157,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/middleware/authorization/authorization.html b/docs/reference/middleware/authorization/authorization.html index 6922ca354..7ddd4ce41 100644 --- a/docs/reference/middleware/authorization/authorization.html +++ b/docs/reference/middleware/authorization/authorization.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.authorization.authorization API documentation @@ -101,7 +101,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/middleware/authorization/index.html b/docs/reference/middleware/authorization/index.html index f97cc17bb..9f5c3f393 100644 --- a/docs/reference/middleware/authorization/index.html +++ b/docs/reference/middleware/authorization/index.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.authorization API documentation @@ -398,7 +398,7 @@

    diff --git a/docs/reference/middleware/authorization/internals.html b/docs/reference/middleware/authorization/internals.html index 62db9d31e..c64a7e0f3 100644 --- a/docs/reference/middleware/authorization/internals.html +++ b/docs/reference/middleware/authorization/internals.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.authorization.internals API documentation @@ -60,7 +60,7 @@

    Module slack_bolt.middleware.authorization.internals diff --git a/docs/reference/middleware/authorization/multi_teams_authorization.html b/docs/reference/middleware/authorization/multi_teams_authorization.html index 1414820c6..c2a6a7964 100644 --- a/docs/reference/middleware/authorization/multi_teams_authorization.html +++ b/docs/reference/middleware/authorization/multi_teams_authorization.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.authorization.multi_teams_authorization API documentation @@ -213,7 +213,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/middleware/authorization/single_team_authorization.html b/docs/reference/middleware/authorization/single_team_authorization.html index 535b18532..7687be155 100644 --- a/docs/reference/middleware/authorization/single_team_authorization.html +++ b/docs/reference/middleware/authorization/single_team_authorization.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.authorization.single_team_authorization API documentation @@ -171,7 +171,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/middleware/custom_middleware.html b/docs/reference/middleware/custom_middleware.html index 4364973a6..aba9dc14b 100644 --- a/docs/reference/middleware/custom_middleware.html +++ b/docs/reference/middleware/custom_middleware.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.custom_middleware API documentation @@ -156,7 +156,7 @@

    diff --git a/docs/reference/middleware/ignoring_self_events/async_ignoring_self_events.html b/docs/reference/middleware/ignoring_self_events/async_ignoring_self_events.html index 5b0f31653..4d48b16b9 100644 --- a/docs/reference/middleware/ignoring_self_events/async_ignoring_self_events.html +++ b/docs/reference/middleware/ignoring_self_events/async_ignoring_self_events.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.ignoring_self_events.async_ignoring_self_events API documentation @@ -125,7 +125,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/middleware/ignoring_self_events/ignoring_self_events.html b/docs/reference/middleware/ignoring_self_events/ignoring_self_events.html index 2c1a5eff3..111c096c4 100644 --- a/docs/reference/middleware/ignoring_self_events/ignoring_self_events.html +++ b/docs/reference/middleware/ignoring_self_events/ignoring_self_events.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.ignoring_self_events.ignoring_self_events API documentation @@ -170,7 +170,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/middleware/ignoring_self_events/index.html b/docs/reference/middleware/ignoring_self_events/index.html index 9c37fbb89..f81603f4a 100644 --- a/docs/reference/middleware/ignoring_self_events/index.html +++ b/docs/reference/middleware/ignoring_self_events/index.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.ignoring_self_events API documentation @@ -187,7 +187,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/middleware/index.html b/docs/reference/middleware/index.html index 7c8daecd1..98aa15c5d 100644 --- a/docs/reference/middleware/index.html +++ b/docs/reference/middleware/index.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware API documentation @@ -639,7 +639,7 @@

    Inherited members

    """Verifies an incoming request by checking the validity of `x-slack-signature`, `x-slack-request-timestamp`, and its body data. - Refer to https://docs.slack.dev/authentication/verifying-requests-from-slack for details. + Refer to https://api.slack.com/authentication/verifying-requests-from-slack for details. Args: signing_secret: The signing secret @@ -688,7 +688,7 @@

    Inherited members

    A middleware can process request data before other middleware and listener functions.

    Verifies an incoming request by checking the validity of x-slack-signature, x-slack-request-timestamp, and its body data.

    -

    Refer to https://docs.slack.dev/authentication/verifying-requests-from-slack for details.

    +

    Refer to https://api.slack.com/authentication/verifying-requests-from-slack for details.

    Args

    signing_secret
    @@ -834,11 +834,11 @@

    Inherited members

    base_logger: Optional[Logger] = None, ): """Handles `ssl_check` requests. - Refer to https://docs.slack.dev/interactivity/implementing-slash-commands for details. + Refer to https://api.slack.com/interactivity/slash-commands for details. Args: verification_token: The verification token to check - (optional as it's already deprecated - https://docs.slack.dev/authentication/verifying-requests-from-slack#verification_token_deprecation) + (optional as it's already deprecated - https://api.slack.com/authentication/verifying-requests-from-slack#verification_token_deprecation) base_logger: The base logger """ # noqa: E501 self.verification_token = verification_token @@ -880,12 +880,12 @@

    Inherited members

    A middleware can process request data before other middleware and listener functions.

    Handles slack_bolt.middleware.ssl_check requests. -Refer to https://docs.slack.dev/interactivity/implementing-slash-commands for details.

    +Refer to https://api.slack.com/interactivity/slash-commands for details.

    Args

    verification_token
    The verification token to check -(optional as it's already deprecated - https://docs.slack.dev/authentication/verifying-requests-from-slack#verification_token_deprecation)
    +(optional as it's already deprecated - https://api.slack.com/authentication/verifying-requests-from-slack#verification_token_deprecation)

base_logger
The base logger
@@ -931,7 +931,7 @@

Inherited members

def __init__(self, base_logger: Optional[Logger] = None): """Handles url_verification requests. - Refer to https://docs.slack.dev/reference/events/url_verification for details. + Refer to https://api.slack.com/events/url_verification for details. Args: base_logger: The base logger @@ -965,7 +965,7 @@

Inherited members

A middleware can process request data before other middleware and listener functions.

Handles url_verification requests.

-

Refer to https://docs.slack.dev/reference/events/url_verification for details.

+

Refer to https://api.slack.com/events/url_verification for details.

Args

base_logger
@@ -1077,7 +1077,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/middleware/message_listener_matches/async_message_listener_matches.html b/docs/reference/middleware/message_listener_matches/async_message_listener_matches.html index 790669551..9cbee09ca 100644 --- a/docs/reference/middleware/message_listener_matches/async_message_listener_matches.html +++ b/docs/reference/middleware/message_listener_matches/async_message_listener_matches.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.message_listener_matches.async_message_listener_matches API documentation @@ -124,7 +124,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/middleware/message_listener_matches/index.html b/docs/reference/middleware/message_listener_matches/index.html index 340bfca8b..29dfbb861 100644 --- a/docs/reference/middleware/message_listener_matches/index.html +++ b/docs/reference/middleware/message_listener_matches/index.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.message_listener_matches API documentation @@ -141,7 +141,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/middleware/message_listener_matches/message_listener_matches.html b/docs/reference/middleware/message_listener_matches/message_listener_matches.html index 67481a683..35b5bfa7a 100644 --- a/docs/reference/middleware/message_listener_matches/message_listener_matches.html +++ b/docs/reference/middleware/message_listener_matches/message_listener_matches.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.message_listener_matches.message_listener_matches API documentation @@ -124,7 +124,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/middleware/middleware.html b/docs/reference/middleware/middleware.html index f2940d31b..fb05fd3cc 100644 --- a/docs/reference/middleware/middleware.html +++ b/docs/reference/middleware/middleware.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.middleware API documentation @@ -232,7 +232,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/middleware/middleware_error_handler.html b/docs/reference/middleware/middleware_error_handler.html index 8dcce6026..168fd0409 100644 --- a/docs/reference/middleware/middleware_error_handler.html +++ b/docs/reference/middleware/middleware_error_handler.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.middleware_error_handler API documentation @@ -234,7 +234,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/middleware/request_verification/async_request_verification.html b/docs/reference/middleware/request_verification/async_request_verification.html index dfa1b22bf..dc2b20908 100644 --- a/docs/reference/middleware/request_verification/async_request_verification.html +++ b/docs/reference/middleware/request_verification/async_request_verification.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.request_verification.async_request_verification API documentation @@ -59,7 +59,7 @@

Classes

"""Verifies an incoming request by checking the validity of `x-slack-signature`, `x-slack-request-timestamp`, and its body data. - Refer to https://docs.slack.dev/authentication/verifying-requests-from-slack for details. + Refer to https://api.slack.com/authentication/verifying-requests-from-slack for details. """ async def async_process( @@ -86,10 +86,10 @@

Classes

Verifies an incoming request by checking the validity of x-slack-signature, x-slack-request-timestamp, and its body data.

-

Refer to https://docs.slack.dev/authentication/verifying-requests-from-slack for details.

+

Refer to https://api.slack.com/authentication/verifying-requests-from-slack for details.

Verifies an incoming request by checking the validity of x-slack-signature, x-slack-request-timestamp, and its body data.

-

Refer to https://docs.slack.dev/authentication/verifying-requests-from-slack for details.

+

Refer to https://api.slack.com/authentication/verifying-requests-from-slack for details.

Args

signing_secret
@@ -142,7 +142,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/middleware/request_verification/index.html b/docs/reference/middleware/request_verification/index.html index c841a74dc..ec8e6b941 100644 --- a/docs/reference/middleware/request_verification/index.html +++ b/docs/reference/middleware/request_verification/index.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.request_verification API documentation @@ -71,7 +71,7 @@

Classes

"""Verifies an incoming request by checking the validity of `x-slack-signature`, `x-slack-request-timestamp`, and its body data. - Refer to https://docs.slack.dev/authentication/verifying-requests-from-slack for details. + Refer to https://api.slack.com/authentication/verifying-requests-from-slack for details. Args: signing_secret: The signing secret @@ -120,7 +120,7 @@

Classes

A middleware can process request data before other middleware and listener functions.

Verifies an incoming request by checking the validity of x-slack-signature, x-slack-request-timestamp, and its body data.

-

Refer to https://docs.slack.dev/authentication/verifying-requests-from-slack for details.

+

Refer to https://api.slack.com/authentication/verifying-requests-from-slack for details.

Args

signing_secret
@@ -176,7 +176,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/middleware/request_verification/request_verification.html b/docs/reference/middleware/request_verification/request_verification.html index 4c778807a..aa5da095f 100644 --- a/docs/reference/middleware/request_verification/request_verification.html +++ b/docs/reference/middleware/request_verification/request_verification.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.request_verification.request_verification API documentation @@ -60,7 +60,7 @@

Classes

"""Verifies an incoming request by checking the validity of `x-slack-signature`, `x-slack-request-timestamp`, and its body data. - Refer to https://docs.slack.dev/authentication/verifying-requests-from-slack for details. + Refer to https://api.slack.com/authentication/verifying-requests-from-slack for details. Args: signing_secret: The signing secret @@ -109,7 +109,7 @@

Classes

A middleware can process request data before other middleware and listener functions.

Verifies an incoming request by checking the validity of x-slack-signature, x-slack-request-timestamp, and its body data.

-

Refer to https://docs.slack.dev/authentication/verifying-requests-from-slack for details.

+

Refer to https://api.slack.com/authentication/verifying-requests-from-slack for details.

Args

signing_secret
@@ -159,7 +159,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/middleware/ssl_check/async_ssl_check.html b/docs/reference/middleware/ssl_check/async_ssl_check.html index a8d6bbfcd..eaacf0846 100644 --- a/docs/reference/middleware/ssl_check/async_ssl_check.html +++ b/docs/reference/middleware/ssl_check/async_ssl_check.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.ssl_check.async_ssl_check API documentation @@ -75,12 +75,12 @@

Classes

A middleware can process request data before other middleware and listener functions.

Handles ssl_check requests. -Refer to https://docs.slack.dev/interactivity/implementing-slash-commands for details.

+Refer to https://api.slack.com/interactivity/slash-commands for details.

Args

verification_token
The verification token to check -(optional as it's already deprecated - https://docs.slack.dev/authentication/verifying-requests-from-slack#verification_token_deprecation)
+(optional as it's already deprecated - https://api.slack.com/authentication/verifying-requests-from-slack#verification_token_deprecation)
base_logger
The base logger
@@ -131,7 +131,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/middleware/ssl_check/index.html b/docs/reference/middleware/ssl_check/index.html index fd800326a..6a6477071 100644 --- a/docs/reference/middleware/ssl_check/index.html +++ b/docs/reference/middleware/ssl_check/index.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.ssl_check API documentation @@ -76,11 +76,11 @@

Classes

base_logger: Optional[Logger] = None, ): """Handles `ssl_check` requests. - Refer to https://docs.slack.dev/interactivity/implementing-slash-commands for details. + Refer to https://api.slack.com/interactivity/slash-commands for details. Args: verification_token: The verification token to check - (optional as it's already deprecated - https://docs.slack.dev/authentication/verifying-requests-from-slack#verification_token_deprecation) + (optional as it's already deprecated - https://api.slack.com/authentication/verifying-requests-from-slack#verification_token_deprecation) base_logger: The base logger """ # noqa: E501 self.verification_token = verification_token @@ -122,12 +122,12 @@

Classes

A middleware can process request data before other middleware and listener functions.

Handles slack_bolt.middleware.ssl_check.ssl_check requests. -Refer to https://docs.slack.dev/interactivity/implementing-slash-commands for details.

+Refer to https://api.slack.com/interactivity/slash-commands for details.

Args

verification_token
The verification token to check -(optional as it's already deprecated - https://docs.slack.dev/authentication/verifying-requests-from-slack#verification_token_deprecation)
+(optional as it's already deprecated - https://api.slack.com/authentication/verifying-requests-from-slack#verification_token_deprecation)
base_logger
The base logger
@@ -194,7 +194,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/middleware/ssl_check/ssl_check.html b/docs/reference/middleware/ssl_check/ssl_check.html index 5d34eb280..72b98724a 100644 --- a/docs/reference/middleware/ssl_check/ssl_check.html +++ b/docs/reference/middleware/ssl_check/ssl_check.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.ssl_check.ssl_check API documentation @@ -65,11 +65,11 @@

Classes

base_logger: Optional[Logger] = None, ): """Handles `ssl_check` requests. - Refer to https://docs.slack.dev/interactivity/implementing-slash-commands for details. + Refer to https://api.slack.com/interactivity/slash-commands for details. Args: verification_token: The verification token to check - (optional as it's already deprecated - https://docs.slack.dev/authentication/verifying-requests-from-slack#verification_token_deprecation) + (optional as it's already deprecated - https://api.slack.com/authentication/verifying-requests-from-slack#verification_token_deprecation) base_logger: The base logger """ # noqa: E501 self.verification_token = verification_token @@ -111,12 +111,12 @@

Classes

A middleware can process request data before other middleware and listener functions.

Handles ssl_check requests. -Refer to https://docs.slack.dev/interactivity/implementing-slash-commands for details.

+Refer to https://api.slack.com/interactivity/slash-commands for details.

Args

verification_token
The verification token to check -(optional as it's already deprecated - https://docs.slack.dev/authentication/verifying-requests-from-slack#verification_token_deprecation)
+(optional as it's already deprecated - https://api.slack.com/authentication/verifying-requests-from-slack#verification_token_deprecation)
base_logger
The base logger
@@ -177,7 +177,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/middleware/url_verification/async_url_verification.html b/docs/reference/middleware/url_verification/async_url_verification.html index 460aecf4d..e7fbb82fe 100644 --- a/docs/reference/middleware/url_verification/async_url_verification.html +++ b/docs/reference/middleware/url_verification/async_url_verification.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.url_verification.async_url_verification API documentation @@ -73,7 +73,7 @@

Classes

A middleware can process request data before other middleware and listener functions.

Handles url_verification requests.

-

Refer to https://docs.slack.dev/reference/events/url_verification for details.

+

Refer to https://api.slack.com/events/url_verification for details.

Args

base_logger
@@ -124,7 +124,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/middleware/url_verification/index.html b/docs/reference/middleware/url_verification/index.html index e3e98f95f..9e08c1699 100644 --- a/docs/reference/middleware/url_verification/index.html +++ b/docs/reference/middleware/url_verification/index.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.url_verification API documentation @@ -70,7 +70,7 @@

Classes

def __init__(self, base_logger: Optional[Logger] = None): """Handles url_verification requests. - Refer to https://docs.slack.dev/reference/events/url_verification for details. + Refer to https://api.slack.com/events/url_verification for details. Args: base_logger: The base logger @@ -104,7 +104,7 @@

Classes

A middleware can process request data before other middleware and listener functions.

Handles url_verification requests.

-

Refer to https://docs.slack.dev/reference/events/url_verification for details.

+

Refer to https://api.slack.com/events/url_verification for details.

Args

base_logger
@@ -158,7 +158,7 @@

diff --git a/docs/reference/middleware/url_verification/url_verification.html b/docs/reference/middleware/url_verification/url_verification.html index 32dc64d49..e90bf0395 100644 --- a/docs/reference/middleware/url_verification/url_verification.html +++ b/docs/reference/middleware/url_verification/url_verification.html @@ -3,7 +3,7 @@ - + slack_bolt.middleware.url_verification.url_verification API documentation @@ -59,7 +59,7 @@

Classes

def __init__(self, base_logger: Optional[Logger] = None): """Handles url_verification requests. - Refer to https://docs.slack.dev/reference/events/url_verification for details. + Refer to https://api.slack.com/events/url_verification for details. Args: base_logger: The base logger @@ -93,7 +93,7 @@

Classes

A middleware can process request data before other middleware and listener functions.

Handles url_verification requests.

-

Refer to https://docs.slack.dev/reference/events/url_verification for details.

+

Refer to https://api.slack.com/events/url_verification for details.

Args

base_logger
@@ -141,7 +141,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/oauth/async_callback_options.html b/docs/reference/oauth/async_callback_options.html index 40ae06c1f..822867ea8 100644 --- a/docs/reference/oauth/async_callback_options.html +++ b/docs/reference/oauth/async_callback_options.html @@ -3,7 +3,7 @@ - + slack_bolt.oauth.async_callback_options API documentation @@ -279,7 +279,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/oauth/async_internals.html b/docs/reference/oauth/async_internals.html index ba6a31642..2b35a69c9 100644 --- a/docs/reference/oauth/async_internals.html +++ b/docs/reference/oauth/async_internals.html @@ -3,7 +3,7 @@ - + slack_bolt.oauth.async_internals API documentation @@ -120,7 +120,7 @@

Functions

diff --git a/docs/reference/oauth/async_oauth_flow.html b/docs/reference/oauth/async_oauth_flow.html index 182973db5..3ccdfd6f0 100644 --- a/docs/reference/oauth/async_oauth_flow.html +++ b/docs/reference/oauth/async_oauth_flow.html @@ -3,7 +3,7 @@ - + slack_bolt.oauth.async_oauth_flow API documentation @@ -803,7 +803,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/oauth/async_oauth_settings.html b/docs/reference/oauth/async_oauth_settings.html index 18b108491..5e6a543c4 100644 --- a/docs/reference/oauth/async_oauth_settings.html +++ b/docs/reference/oauth/async_oauth_settings.html @@ -3,7 +3,7 @@ - + slack_bolt.oauth.async_oauth_settings API documentation @@ -417,7 +417,7 @@

diff --git a/docs/reference/oauth/callback_options.html b/docs/reference/oauth/callback_options.html index ac2a200b1..7ad3734b3 100644 --- a/docs/reference/oauth/callback_options.html +++ b/docs/reference/oauth/callback_options.html @@ -3,7 +3,7 @@ - + slack_bolt.oauth.callback_options API documentation @@ -299,7 +299,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/oauth/index.html b/docs/reference/oauth/index.html index 6281fbcc1..d118a5e72 100644 --- a/docs/reference/oauth/index.html +++ b/docs/reference/oauth/index.html @@ -3,7 +3,7 @@ - + slack_bolt.oauth API documentation @@ -856,7 +856,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/oauth/internals.html b/docs/reference/oauth/internals.html index e1b239782..3f1b43a7e 100644 --- a/docs/reference/oauth/internals.html +++ b/docs/reference/oauth/internals.html @@ -3,7 +3,7 @@ - + slack_bolt.oauth.internals API documentation @@ -225,7 +225,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/oauth/oauth_flow.html b/docs/reference/oauth/oauth_flow.html index abae18cb5..75aa3cb88 100644 --- a/docs/reference/oauth/oauth_flow.html +++ b/docs/reference/oauth/oauth_flow.html @@ -3,7 +3,7 @@ - + slack_bolt.oauth.oauth_flow API documentation @@ -807,7 +807,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/oauth/oauth_settings.html b/docs/reference/oauth/oauth_settings.html index 0555b761c..1eb2ab7dd 100644 --- a/docs/reference/oauth/oauth_settings.html +++ b/docs/reference/oauth/oauth_settings.html @@ -3,7 +3,7 @@ - + slack_bolt.oauth.oauth_settings API documentation @@ -415,7 +415,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/request/async_internals.html b/docs/reference/request/async_internals.html index 635bdf586..35a250c8d 100644 --- a/docs/reference/request/async_internals.html +++ b/docs/reference/request/async_internals.html @@ -3,7 +3,7 @@ - + slack_bolt.request.async_internals API documentation @@ -129,7 +129,7 @@

Functions

diff --git a/docs/reference/request/async_request.html b/docs/reference/request/async_request.html index c08c47ec9..a3658710a 100644 --- a/docs/reference/request/async_request.html +++ b/docs/reference/request/async_request.html @@ -3,7 +3,7 @@ - + slack_bolt.request.async_request API documentation @@ -238,7 +238,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/request/index.html b/docs/reference/request/index.html index 61908105d..06d9b4933 100644 --- a/docs/reference/request/index.html +++ b/docs/reference/request/index.html @@ -3,7 +3,7 @@ - + slack_bolt.request API documentation @@ -37,7 +37,7 @@

Module slack_bolt.request

Incoming request from Slack through either HTTP request or Socket Mode connection.

-

Refer to https://docs.slack.dev/apis/events-api/ for the two types of connections. +

Refer to https://api.slack.com/apis/connections for the two types of connections. This interface encapsulates the difference between the two.

@@ -272,7 +272,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/request/internals.html b/docs/reference/request/internals.html index 68fa34dae..bc13932ec 100644 --- a/docs/reference/request/internals.html +++ b/docs/reference/request/internals.html @@ -3,7 +3,7 @@ - + slack_bolt.request.internals API documentation @@ -601,7 +601,7 @@

Functions

diff --git a/docs/reference/request/payload_utils.html b/docs/reference/request/payload_utils.html index 21490bdc8..4fe75fd81 100644 --- a/docs/reference/request/payload_utils.html +++ b/docs/reference/request/payload_utils.html @@ -3,7 +3,7 @@ - + slack_bolt.request.payload_utils API documentation @@ -622,7 +622,7 @@

Functions

diff --git a/docs/reference/request/request.html b/docs/reference/request/request.html index dfd0fa3f1..870b65f08 100644 --- a/docs/reference/request/request.html +++ b/docs/reference/request/request.html @@ -3,7 +3,7 @@ - + slack_bolt.request.request API documentation @@ -237,7 +237,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/response/index.html b/docs/reference/response/index.html index bc86a6770..c986c7150 100644 --- a/docs/reference/response/index.html +++ b/docs/reference/response/index.html @@ -3,7 +3,7 @@ - + slack_bolt.response API documentation @@ -39,7 +39,7 @@

Module slack_bolt.response

This interface represents Bolt's synchronous response to Slack.

In Socket Mode, the response data can be transformed to a WebSocket message. In the HTTP endpoint mode, the response data becomes an HTTP response data.

-

Refer to https://docs.slack.dev/apis/events-api/ for the two types of connections.

+

Refer to https://api.slack.com/apis/connections for the two types of connections.

Sub-modules

@@ -227,7 +227,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/response/response.html b/docs/reference/response/response.html index 65151cf64..5044254e8 100644 --- a/docs/reference/response/response.html +++ b/docs/reference/response/response.html @@ -3,7 +3,7 @@ - + slack_bolt.response.response API documentation @@ -211,7 +211,7 @@

-

Generated by pdoc 0.11.5.

+

Generated by pdoc 0.11.6.

diff --git a/docs/reference/util/async_utils.html b/docs/reference/util/async_utils.html index f7ce77489..f74d8f0ac 100644 --- a/docs/reference/util/async_utils.html +++ b/docs/reference/util/async_utils.html @@ -3,7 +3,7 @@ - + slack_bolt.util.async_utils API documentation @@ -85,7 +85,7 @@

Functions

diff --git a/docs/reference/util/index.html b/docs/reference/util/index.html index 54f1dbd8d..6eadaacb9 100644 --- a/docs/reference/util/index.html +++ b/docs/reference/util/index.html @@ -3,7 +3,7 @@ - + slack_bolt.util API documentation @@ -78,7 +78,7 @@

Sub-modules

diff --git a/docs/reference/util/utils.html b/docs/reference/util/utils.html index d22c1f581..33e6b1de2 100644 --- a/docs/reference/util/utils.html +++ b/docs/reference/util/utils.html @@ -3,7 +3,7 @@ - + slack_bolt.util.utils API documentation @@ -268,7 +268,7 @@

Returns

diff --git a/docs/reference/version.html b/docs/reference/version.html index 404f38d79..c4a0f9b83 100644 --- a/docs/reference/version.html +++ b/docs/reference/version.html @@ -3,7 +3,7 @@ - + slack_bolt.version API documentation @@ -61,7 +61,7 @@

Module slack_bolt.version

diff --git a/docs/reference/workflows/index.html b/docs/reference/workflows/index.html index 3e43b0701..caaffe74d 100644 --- a/docs/reference/workflows/index.html +++ b/docs/reference/workflows/index.html @@ -3,7 +3,7 @@ - + slack_bolt.workflows API documentation @@ -43,7 +43,7 @@

Module slack_bolt.workflows

  • slack_bolt.workflows.step.utilities
  • slack_bolt.workflows.step.async_step (if you use asyncio-based AsyncApp)
    • -

    Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details.

    +

    Refer to https://api.slack.com/workflows/steps for details.

    Sub-modules

    @@ -80,7 +80,7 @@

    Sub-modules

    diff --git a/docs/reference/workflows/step/async_step.html b/docs/reference/workflows/step/async_step.html index 0c08a9707..3bf597134 100644 --- a/docs/reference/workflows/step/async_step.html +++ b/docs/reference/workflows/step/async_step.html @@ -3,7 +3,7 @@ - + slack_bolt.workflows.step.async_step API documentation @@ -78,7 +78,7 @@

    Classes

    """ Deprecated: Steps from apps for legacy workflows are now deprecated. - Use new custom steps: https://docs.slack.dev/workflows/workflow-steps + Use new custom steps: https://api.slack.com/automation/functions/custom-bolt Args: callback_id: The callback_id for this step from app @@ -124,7 +124,7 @@

    Classes

    """ Deprecated: Steps from apps for legacy workflows are now deprecated. - Use new custom steps: https://docs.slack.dev/workflows/workflow-steps + Use new custom steps: https://api.slack.com/automation/functions/custom-bolt """ return AsyncWorkflowStepBuilder(callback_id, base_logger=base_logger) @@ -200,7 +200,7 @@

    Classes

    Deprecated

    Steps from apps for legacy workflows are now deprecated. -Use new custom steps: https://docs.slack.dev/workflows/workflow-steps

    +Use new custom steps: https://api.slack.com/automation/functions/custom-bolt

    Args

    callback_id
    @@ -252,7 +252,7 @@

    Static methods

    Deprecated

    Steps from apps for legacy workflows are now deprecated. -Use new custom steps: https://docs.slack.dev/workflows/workflow-steps

    +Use new custom steps: https://api.slack.com/automation/functions/custom-bolt

    @@ -267,7 +267,7 @@

    Static methods

    class AsyncWorkflowStepBuilder:
     """Steps from apps
-    Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details.
+    Refer to https://api.slack.com/workflows/steps for details.
     """
 
     callback_id: Union[str, Pattern]
@@ -285,7 +285,7 @@ 
    Static methods
    
         """
         Deprecated:
             Steps from apps for legacy workflows are now deprecated.
-            Use new custom steps: https://docs.slack.dev/workflows/workflow-steps
+            Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
 
         This builder is supposed to be used as decorator.
 
@@ -327,7 +327,7 @@ 
    Static methods
    
         """
         Deprecated:
             Steps from apps for legacy workflows are now deprecated.
-            Use new custom steps: https://docs.slack.dev/workflows/workflow-steps
+            Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
 
         Registers a new edit listener with details.
 
@@ -380,7 +380,7 @@ 
    Static methods
    
         """
         Deprecated:
             Steps from apps for legacy workflows are now deprecated.
-            Use new custom steps: https://docs.slack.dev/workflows/workflow-steps
+            Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
 
         Registers a new save listener with details.
 
@@ -433,7 +433,7 @@ 
    Static methods
    
         """
         Deprecated:
             Steps from apps for legacy workflows are now deprecated.
-            Use new custom steps: https://docs.slack.dev/workflows/workflow-steps
+            Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
 
         Registers a new execute listener with details.
 
@@ -480,7 +480,7 @@ 
    Static methods
    
         """
         Deprecated:
             Steps from apps for legacy workflows are now deprecated.
-            Use new custom steps: https://docs.slack.dev/workflows/workflow-steps
+            Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
 
         Constructs a WorkflowStep object. This method may raise an exception
         if the builder doesn't have enough configurations to build the object.
@@ -555,10 +555,10 @@ 
    Static methods
    
         return _middleware

    Steps from apps -Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details.

    +Refer to https://api.slack.com/workflows/steps for details.

    Deprecated

    Steps from apps for legacy workflows are now deprecated. -Use new custom steps: https://docs.slack.dev/workflows/workflow-steps

    +Use new custom steps: https://api.slack.com/automation/functions/custom-bolt

    This builder is supposed to be used as decorator.

    my_step = AsyncWorkflowStep.builder("my_step")
 @my_step.edit
@@ -659,7 +659,7 @@ 
    Methods
    
     """
     Deprecated:
         Steps from apps for legacy workflows are now deprecated.
-        Use new custom steps: https://docs.slack.dev/workflows/workflow-steps
+        Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
 
     Constructs a WorkflowStep object. This method may raise an exception
     if the builder doesn't have enough configurations to build the object.
@@ -685,7 +685,7 @@ 
    Methods
    
 
 
    Deprecated
    
 
    Steps from apps for legacy workflows are now deprecated.
-Use new custom steps: https://docs.slack.dev/workflows/workflow-steps
    
+Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
    
 
    Constructs a WorkflowStep object. This method may raise an exception
 if the builder doesn't have enough configurations to build the object.
    
 
    Returns
    
@@ -709,7 +709,7 @@ 
    Returns
    
     """
     Deprecated:
         Steps from apps for legacy workflows are now deprecated.
-        Use new custom steps: https://docs.slack.dev/workflows/workflow-steps
+        Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
 
     Registers a new edit listener with details.
 
@@ -754,7 +754,7 @@ 
    Returns
    
 
 
    Deprecated
    
 
    Steps from apps for legacy workflows are now deprecated.
-Use new custom steps: https://docs.slack.dev/workflows/workflow-steps
    
+Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
    
 
    Registers a new edit listener with details.
    
 
    You can use this method as decorator as well.
    
 
    @my_step.edit
@@ -799,7 +799,7 @@ 
    Args
    
     """
     Deprecated:
         Steps from apps for legacy workflows are now deprecated.
-        Use new custom steps: https://docs.slack.dev/workflows/workflow-steps
+        Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
 
     Registers a new execute listener with details.
 
@@ -844,7 +844,7 @@ 
    Args
    
 
 
    Deprecated
    
 
    Steps from apps for legacy workflows are now deprecated.
-Use new custom steps: https://docs.slack.dev/workflows/workflow-steps
    
+Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
    
 
    Registers a new execute listener with details.
    
 
    You can use this method as decorator as well.
    
 
    @my_step.execute
@@ -889,7 +889,7 @@ 
    Args
    
     """
     Deprecated:
         Steps from apps for legacy workflows are now deprecated.
-        Use new custom steps: https://docs.slack.dev/workflows/workflow-steps
+        Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
 
     Registers a new save listener with details.
 
@@ -934,7 +934,7 @@ 
    Args
    
 
 
    Deprecated
    
 
    Steps from apps for legacy workflows are now deprecated.
-Use new custom steps: https://docs.slack.dev/workflows/workflow-steps
    
+Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
    
 
    Registers a new save listener with details.
    
 
    You can use this method as decorator as well.
    
 
    @my_step.save
@@ -1007,7 +1007,7 @@ 
    
-
    Generated by pdoc 0.11.5.
    
+
    Generated by pdoc 0.11.6.
    
 
 
 
diff --git a/docs/reference/workflows/step/async_step_middleware.html b/docs/reference/workflows/step/async_step_middleware.html
index fff1cda5c..a174b9c11 100644
--- a/docs/reference/workflows/step/async_step_middleware.html
+++ b/docs/reference/workflows/step/async_step_middleware.html
@@ -3,7 +3,7 @@
 
 
 
-
+
 slack_bolt.workflows.step.async_step_middleware API documentation
 
 
@@ -140,7 +140,7 @@ 
    
-
    Generated by pdoc 0.11.5.
    
+
    Generated by pdoc 0.11.6.
    
 
 
 
diff --git a/docs/reference/workflows/step/index.html b/docs/reference/workflows/step/index.html
index ce29a210f..62d989976 100644
--- a/docs/reference/workflows/step/index.html
+++ b/docs/reference/workflows/step/index.html
@@ -3,7 +3,7 @@
 
 
 
-
+
 slack_bolt.workflows.step API documentation
 
 
@@ -103,7 +103,7 @@ 
    Classes
    
         app.step(ws)
 
     This utility is a thin wrapper of workflows.stepCompleted API method.
-    Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details.
+    Refer to https://api.slack.com/methods/workflows.stepCompleted for details.
     """
 
     def __init__(self, *, client: WebClient, body: dict):
@@ -135,7 +135,7 @@ 
    Classes
    
 app.step(ws)
 
    
 
    This utility is a thin wrapper of workflows.stepCompleted API method.
-Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details.
    
+Refer to https://api.slack.com/methods/workflows.stepCompleted for details.
    
 
 
    
 class Configure
@@ -174,7 +174,7 @@ 
    Classes
    
         )
         app.step(ws)
 
-    Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details.
+    Refer to https://api.slack.com/workflows/steps for details.
     """
 
     def __init__(self, *, callback_id: str, client: WebClient, body: dict):
@@ -219,7 +219,7 @@ 
    Classes
    
 )
 app.step(ws)
 
    
-
    Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details.
    
+
    Refer to https://api.slack.com/workflows/steps for details.
    
 
 
    
 class Fail
@@ -248,7 +248,7 @@ 
    Classes
    
         app.step(ws)
 
     This utility is a thin wrapper of workflows.stepFailed API method.
-    Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details.
+    Refer to https://api.slack.com/methods/workflows.stepFailed for details.
     """
 
     def __init__(self, *, client: WebClient, body: dict):
@@ -281,7 +281,7 @@ 
    Classes
    
 app.step(ws)

    This utility is a thin wrapper of workflows.stepFailed API method. -Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details.

    +Refer to https://api.slack.com/methods/workflows.stepFailed for details.

    class Update @@ -329,7 +329,7 @@

    Classes

    app.step(ws) This utility is a thin wrapper of workflows.stepFailed API method. - Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details. + Refer to https://api.slack.com/methods/workflows.updateStep for details. """ def __init__(self, *, client: WebClient, body: dict): @@ -377,7 +377,7 @@

    Classes

    app.step(ws)

    This utility is a thin wrapper of workflows.stepFailed API method. -Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details.

    +Refer to https://api.slack.com/methods/workflows.updateStep for details.

    class WorkflowStep @@ -411,7 +411,7 @@

    Classes

    """ Deprecated: Steps from apps for legacy workflows are now deprecated. - Use new custom steps: https://docs.slack.dev/workflows/workflow-steps + Use new custom steps: https://api.slack.com/automation/functions/custom-bolt Args: callback_id: The callback_id for this step from app @@ -453,7 +453,7 @@

    Classes

    """ Deprecated: Steps from apps for legacy workflows are now deprecated. - Use new custom steps: https://docs.slack.dev/workflows/workflow-steps + Use new custom steps: https://api.slack.com/automation/functions/custom-bolt """ return WorkflowStepBuilder( callback_id, @@ -546,7 +546,7 @@

    Classes

    Deprecated

    Steps from apps for legacy workflows are now deprecated. -Use new custom steps: https://docs.slack.dev/workflows/workflow-steps

    +Use new custom steps: https://api.slack.com/automation/functions/custom-bolt

    Args

    callback_id
    @@ -598,7 +598,7 @@

    Static methods

    Deprecated

    Steps from apps for legacy workflows are now deprecated. -Use new custom steps: https://docs.slack.dev/workflows/workflow-steps

    +Use new custom steps: https://api.slack.com/automation/functions/custom-bolt

    @@ -732,7 +732,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/workflows/step/internals.html b/docs/reference/workflows/step/internals.html index f2067677f..c5fda1012 100644 --- a/docs/reference/workflows/step/internals.html +++ b/docs/reference/workflows/step/internals.html @@ -3,7 +3,7 @@ - + slack_bolt.workflows.step.internals API documentation @@ -60,7 +60,7 @@

    Module slack_bolt.workflows.step.internals

    diff --git a/docs/reference/workflows/step/step.html b/docs/reference/workflows/step/step.html index efaaad899..6e1567bd6 100644 --- a/docs/reference/workflows/step/step.html +++ b/docs/reference/workflows/step/step.html @@ -3,7 +3,7 @@ - + slack_bolt.workflows.step.step API documentation @@ -78,7 +78,7 @@

    Classes

    """ Deprecated: Steps from apps for legacy workflows are now deprecated. - Use new custom steps: https://docs.slack.dev/workflows/workflow-steps + Use new custom steps: https://api.slack.com/automation/functions/custom-bolt Args: callback_id: The callback_id for this step from app @@ -120,7 +120,7 @@

    Classes

    """ Deprecated: Steps from apps for legacy workflows are now deprecated. - Use new custom steps: https://docs.slack.dev/workflows/workflow-steps + Use new custom steps: https://api.slack.com/automation/functions/custom-bolt """ return WorkflowStepBuilder( callback_id, @@ -213,7 +213,7 @@

    Classes

    Deprecated

    Steps from apps for legacy workflows are now deprecated. -Use new custom steps: https://docs.slack.dev/workflows/workflow-steps

    +Use new custom steps: https://api.slack.com/automation/functions/custom-bolt

    Args

    callback_id
    @@ -265,7 +265,7 @@

    Static methods

    Deprecated

    Steps from apps for legacy workflows are now deprecated. -Use new custom steps: https://docs.slack.dev/workflows/workflow-steps

    +Use new custom steps: https://api.slack.com/automation/functions/custom-bolt

    @@ -280,7 +280,7 @@

    Static methods

    class WorkflowStepBuilder:
     """Steps from apps
-    Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details.
+    Refer to https://api.slack.com/workflows/steps for details.
     """
 
     callback_id: Union[str, Pattern]
@@ -298,7 +298,7 @@ 
    Static methods
    
         """
         Deprecated:
             Steps from apps for legacy workflows are now deprecated.
-            Use new custom steps: https://docs.slack.dev/workflows/workflow-steps
+            Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
 
         This builder is supposed to be used as decorator.
 
@@ -340,7 +340,7 @@ 
    Static methods
    
         """
         Deprecated:
             Steps from apps for legacy workflows are now deprecated.
-            Use new custom steps: https://docs.slack.dev/workflows/workflow-steps
+            Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
 
         Registers a new edit listener with details.
 
@@ -394,7 +394,7 @@ 
    Static methods
    
         """
         Deprecated:
             Steps from apps for legacy workflows are now deprecated.
-            Use new custom steps: https://docs.slack.dev/workflows/workflow-steps
+            Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
 
         Registers a new save listener with details.
 
@@ -447,7 +447,7 @@ 
    Static methods
    
         """
         Deprecated:
             Steps from apps for legacy workflows are now deprecated.
-            Use new custom steps: https://docs.slack.dev/workflows/workflow-steps
+            Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
 
         Registers a new execute listener with details.
 
@@ -494,7 +494,7 @@ 
    Static methods
    
         """
         Deprecated:
             Steps from apps for legacy workflows are now deprecated.
-            Use new custom steps: https://docs.slack.dev/workflows/workflow-steps
+            Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
 
         Constructs a WorkflowStep object. This method may raise an exception
         if the builder doesn't have enough configurations to build the object.
@@ -584,10 +584,10 @@ 
    Static methods
    
         return _middleware

    Steps from apps -Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details.

    +Refer to https://api.slack.com/workflows/steps for details.

    Deprecated

    Steps from apps for legacy workflows are now deprecated. -Use new custom steps: https://docs.slack.dev/workflows/workflow-steps

    +Use new custom steps: https://api.slack.com/automation/functions/custom-bolt

    This builder is supposed to be used as decorator.

    my_step = WorkflowStep.builder("my_step")
 @my_step.edit
@@ -703,7 +703,7 @@ 
    Methods
    
     """
     Deprecated:
         Steps from apps for legacy workflows are now deprecated.
-        Use new custom steps: https://docs.slack.dev/workflows/workflow-steps
+        Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
 
     Constructs a WorkflowStep object. This method may raise an exception
     if the builder doesn't have enough configurations to build the object.
@@ -729,7 +729,7 @@ 
    Methods
    
 
 
    Deprecated
    
 
    Steps from apps for legacy workflows are now deprecated.
-Use new custom steps: https://docs.slack.dev/workflows/workflow-steps
    
+Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
    
 
    Constructs a WorkflowStep object. This method may raise an exception
 if the builder doesn't have enough configurations to build the object.
    
 
    Returns
    
@@ -753,7 +753,7 @@ 
    Returns
    
     """
     Deprecated:
         Steps from apps for legacy workflows are now deprecated.
-        Use new custom steps: https://docs.slack.dev/workflows/workflow-steps
+        Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
 
     Registers a new edit listener with details.
 
@@ -799,7 +799,7 @@ 
    Returns
    
 
 
    Deprecated
    
 
    Steps from apps for legacy workflows are now deprecated.
-Use new custom steps: https://docs.slack.dev/workflows/workflow-steps
    
+Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
    
 
    Registers a new edit listener with details.
    
 
    You can use this method as decorator as well.
    
 
    @my_step.edit
@@ -844,7 +844,7 @@ 
    Args
    
     """
     Deprecated:
         Steps from apps for legacy workflows are now deprecated.
-        Use new custom steps: https://docs.slack.dev/workflows/workflow-steps
+        Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
 
     Registers a new execute listener with details.
 
@@ -889,7 +889,7 @@ 
    Args
    
 
 
    Deprecated
    
 
    Steps from apps for legacy workflows are now deprecated.
-Use new custom steps: https://docs.slack.dev/workflows/workflow-steps
    
+Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
    
 
    Registers a new execute listener with details.
    
 
    You can use this method as decorator as well.
    
 
    @my_step.execute
@@ -934,7 +934,7 @@ 
    Args
    
     """
     Deprecated:
         Steps from apps for legacy workflows are now deprecated.
-        Use new custom steps: https://docs.slack.dev/workflows/workflow-steps
+        Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
 
     Registers a new save listener with details.
 
@@ -979,7 +979,7 @@ 
    Args
    
 
 
    Deprecated
    
 
    Steps from apps for legacy workflows are now deprecated.
-Use new custom steps: https://docs.slack.dev/workflows/workflow-steps
    
+Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
    
 
    Registers a new save listener with details.
    
 
    You can use this method as decorator as well.
    
 
    @my_step.save
@@ -1052,7 +1052,7 @@ 
    
-
    Generated by pdoc 0.11.5.
    
+
    Generated by pdoc 0.11.6.
    
 
 
 
diff --git a/docs/reference/workflows/step/step_middleware.html b/docs/reference/workflows/step/step_middleware.html
index 58a1c6194..2ac62dd93 100644
--- a/docs/reference/workflows/step/step_middleware.html
+++ b/docs/reference/workflows/step/step_middleware.html
@@ -3,7 +3,7 @@
 
 
 
-
+
 slack_bolt.workflows.step.step_middleware API documentation
 
 
@@ -143,7 +143,7 @@ 
    
-
    Generated by pdoc 0.11.5.
    
+
    Generated by pdoc 0.11.6.
    
 
 
 
diff --git a/docs/reference/workflows/step/utilities/async_complete.html b/docs/reference/workflows/step/utilities/async_complete.html
index 8a8790900..8e95cc267 100644
--- a/docs/reference/workflows/step/utilities/async_complete.html
+++ b/docs/reference/workflows/step/utilities/async_complete.html
@@ -3,7 +3,7 @@
 
 
 
-
+
 slack_bolt.workflows.step.utilities.async_complete API documentation
 
 
@@ -76,7 +76,7 @@ 
    Classes
    
         app.step(ws)
 
     This utility is a thin wrapper of workflows.stepCompleted API method.
-    Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details.
+    Refer to https://api.slack.com/methods/workflows.stepCompleted for details.
     """
 
     def __init__(self, *, client: AsyncWebClient, body: dict):
@@ -108,7 +108,7 @@ 
    Classes
    
 app.step(ws)
 
    
 
    This utility is a thin wrapper of workflows.stepCompleted API method.
-Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details.
    
+Refer to https://api.slack.com/methods/workflows.stepCompleted for details.

    @@ -134,7 +134,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/workflows/step/utilities/async_configure.html b/docs/reference/workflows/step/utilities/async_configure.html index 3151e71bd..008c35ab5 100644 --- a/docs/reference/workflows/step/utilities/async_configure.html +++ b/docs/reference/workflows/step/utilities/async_configure.html @@ -3,7 +3,7 @@ - + slack_bolt.workflows.step.utilities.async_configure API documentation @@ -83,7 +83,7 @@

    Classes

    ) app.step(ws) - Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details. + Refer to https://api.slack.com/workflows/steps for details. """ def __init__(self, *, callback_id: str, client: AsyncWebClient, body: dict): @@ -131,7 +131,7 @@

    Classes

    ) app.step(ws)     -

    Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details.

    +

    Refer to https://api.slack.com/workflows/steps for details.

    @@ -157,7 +157,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/workflows/step/utilities/async_fail.html b/docs/reference/workflows/step/utilities/async_fail.html index 1206c45a6..b27c36251 100644 --- a/docs/reference/workflows/step/utilities/async_fail.html +++ b/docs/reference/workflows/step/utilities/async_fail.html @@ -3,7 +3,7 @@ - + slack_bolt.workflows.step.utilities.async_fail API documentation @@ -73,7 +73,7 @@

    Classes

    app.step(ws) This utility is a thin wrapper of workflows.stepFailed API method. - Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details. + Refer to https://api.slack.com/methods/workflows.stepFailed for details. """ def __init__(self, *, client: AsyncWebClient, body: dict): @@ -106,7 +106,7 @@

    Classes

    app.step(ws)

    This utility is a thin wrapper of workflows.stepFailed API method. -Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details.

    +Refer to https://api.slack.com/methods/workflows.stepFailed for details.

    @@ -132,7 +132,7 @@

    diff --git a/docs/reference/workflows/step/utilities/async_update.html b/docs/reference/workflows/step/utilities/async_update.html index 0d1cad162..bfb210fc3 100644 --- a/docs/reference/workflows/step/utilities/async_update.html +++ b/docs/reference/workflows/step/utilities/async_update.html @@ -3,7 +3,7 @@ - + slack_bolt.workflows.step.utilities.async_update API documentation @@ -92,7 +92,7 @@

    Classes

    app.step(ws) This utility is a thin wrapper of workflows.stepFailed API method. - Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details. + Refer to https://api.slack.com/methods/workflows.updateStep for details. """ def __init__(self, *, client: AsyncWebClient, body: dict): @@ -140,7 +140,7 @@

    Classes

    app.step(ws)

    This utility is a thin wrapper of workflows.stepFailed API method. -Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details.

    +Refer to https://api.slack.com/methods/workflows.updateStep for details.

    @@ -166,7 +166,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/workflows/step/utilities/complete.html b/docs/reference/workflows/step/utilities/complete.html index c15d51e9c..f1cf11f56 100644 --- a/docs/reference/workflows/step/utilities/complete.html +++ b/docs/reference/workflows/step/utilities/complete.html @@ -3,7 +3,7 @@ - + slack_bolt.workflows.step.utilities.complete API documentation @@ -76,7 +76,7 @@

    Classes

    app.step(ws) This utility is a thin wrapper of workflows.stepCompleted API method. - Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details. + Refer to https://api.slack.com/methods/workflows.stepCompleted for details. """ def __init__(self, *, client: WebClient, body: dict): @@ -108,7 +108,7 @@

    Classes

    app.step(ws)

    This utility is a thin wrapper of workflows.stepCompleted API method. -Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details.

    +Refer to https://api.slack.com/methods/workflows.stepCompleted for details.

    @@ -134,7 +134,7 @@

    diff --git a/docs/reference/workflows/step/utilities/configure.html b/docs/reference/workflows/step/utilities/configure.html index 2c1aeadbf..26d646cf2 100644 --- a/docs/reference/workflows/step/utilities/configure.html +++ b/docs/reference/workflows/step/utilities/configure.html @@ -3,7 +3,7 @@ - + slack_bolt.workflows.step.utilities.configure API documentation @@ -83,7 +83,7 @@

    Classes

    ) app.step(ws) - Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details. + Refer to https://api.slack.com/workflows/steps for details. """ def __init__(self, *, callback_id: str, client: WebClient, body: dict): @@ -128,7 +128,7 @@

    Classes

    ) app.step(ws)     -

    Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details.

    +

    Refer to https://api.slack.com/workflows/steps for details.

    @@ -154,7 +154,7 @@

    diff --git a/docs/reference/workflows/step/utilities/fail.html b/docs/reference/workflows/step/utilities/fail.html index 4c4091fd5..00d0be83d 100644 --- a/docs/reference/workflows/step/utilities/fail.html +++ b/docs/reference/workflows/step/utilities/fail.html @@ -3,7 +3,7 @@ - + slack_bolt.workflows.step.utilities.fail API documentation @@ -73,7 +73,7 @@

    Classes

    app.step(ws) This utility is a thin wrapper of workflows.stepFailed API method. - Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details. + Refer to https://api.slack.com/methods/workflows.stepFailed for details. """ def __init__(self, *, client: WebClient, body: dict): @@ -106,7 +106,7 @@

    Classes

    app.step(ws)

    This utility is a thin wrapper of workflows.stepFailed API method. -Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details.

    +Refer to https://api.slack.com/methods/workflows.stepFailed for details.

    @@ -132,7 +132,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/docs/reference/workflows/step/utilities/index.html b/docs/reference/workflows/step/utilities/index.html index 1594bacb6..54261ea96 100644 --- a/docs/reference/workflows/step/utilities/index.html +++ b/docs/reference/workflows/step/utilities/index.html @@ -3,7 +3,7 @@ - + slack_bolt.workflows.step.utilities API documentation @@ -127,7 +127,7 @@

    Sub-modules

    diff --git a/docs/reference/workflows/step/utilities/update.html b/docs/reference/workflows/step/utilities/update.html index c93fc7f21..9899448f9 100644 --- a/docs/reference/workflows/step/utilities/update.html +++ b/docs/reference/workflows/step/utilities/update.html @@ -3,7 +3,7 @@ - + slack_bolt.workflows.step.utilities.update API documentation @@ -92,7 +92,7 @@

    Classes

    app.step(ws) This utility is a thin wrapper of workflows.stepFailed API method. - Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details. + Refer to https://api.slack.com/methods/workflows.updateStep for details. """ def __init__(self, *, client: WebClient, body: dict): @@ -140,7 +140,7 @@

    Classes

    app.step(ws)

    This utility is a thin wrapper of workflows.stepFailed API method. -Refer to https://docs.slack.dev/legacy/legacy-steps-from-apps/ for details.

    +Refer to https://api.slack.com/methods/workflows.updateStep for details.

    @@ -166,7 +166,7 @@

    -

    Generated by pdoc 0.11.5.

    +

    Generated by pdoc 0.11.6.

    diff --git a/scripts/generate_api_docs.sh b/scripts/generate_api_docs.sh index 459476122..f8ea39d0d 100755 --- a/scripts/generate_api_docs.sh +++ b/scripts/generate_api_docs.sh @@ -6,5 +6,9 @@ cd ${script_dir}/.. pip install -U pdoc3 rm -rf docs/reference -pdoc reference --html -o docs + +pdoc slack_bolt --html -o docs/reference +cp -R docs/reference/slack_bolt/* docs/reference/ +rm -rf docs/reference/slack_bolt + open docs/reference/index.html diff --git a/slack_bolt/version.py b/slack_bolt/version.py index 03d768130..b996e1572 100644 --- a/slack_bolt/version.py +++ b/slack_bolt/version.py @@ -1,3 +1,3 @@ """Check the latest version at https://pypi.org/project/slack-bolt/""" -__version__ = "1.23.0" +__version__ = "1.24.0"