You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/english/concepts/message-sending.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -54,7 +54,7 @@ The `say_stream` utility streamlines calling the Python Slack SDK's [`WebClient.
54
54
| `recipient_team_id` | Sourced from the event `team_id` (`enterprise_id` if the app is installed on an org).
55
55
| `recipient_user_id` | Sourced from the `user_id` of the event.
56
56
57
-
If neither a `channel_id` or `thread_ts`can be sourced, then the utility will be `None`.
57
+
If either `channel_id` or `thread_ts`cannot be sourced, the utility will be `None`.
58
58
59
59
For information on calling the `chat_*Stream` API methods directly, see the [_Sending streaming messages_](/tools/python-slack-sdk/web#sending-streaming-messages) section of the Python Slack SDK docs.
Copy file name to clipboardExpand all lines: docs/english/concepts/updating-pushing-views.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Updating & pushing views
2
2
3
-
Modals contain a stack of views. When you call [`views_open`](https://api./reference/methods/views.open/slack.com/methods/views.open), you add the root view to the modal. After the initial call, you can dynamically update a view by calling [`views_update`](/reference/methods/views.update/), or stack a new view on top of the root view by calling [`views_push`](/reference/methods/views.push/)
3
+
Modals contain a stack of views. When you call [`views_open`](/reference/methods/views.open/), you add the root view to the modal. After the initial call, you can dynamically update a view by calling [`views_update`](/reference/methods/views.update/), or stack a new view on top of the root view by calling [`views_push`](/reference/methods/views.push/)
Copy file name to clipboardExpand all lines: docs/english/concepts/using-the-assistant-class.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -51,7 +51,7 @@ You _could_ go it alone and [listen](/tools/bolt-python/concepts/event-listening
51
51
52
52
While the `assistant_thread_started` and `assistant_thread_context_changed` events do provide Slack-client thread context information, the `message.im` event does not. Any subsequent user message events won't contain thread context data. For that reason, Bolt not only provides a way to store thread context — the `threadContextStore` property — but it also provides a `DefaultThreadContextStore` instance that is utilized by default. This implementation relies on storing and retrieving [message metadata](/messaging/message-metadata/) as the user interacts with the app.
53
53
54
-
If you do provide your own `threadContextStore` property, it must feature `get` and `save` methods.
54
+
If you do provide your own `threadContextStore` property, it must feature `find` and `save` methods.
55
55
56
56
:::tip[Refer to the [reference docs](https://docs.slack.dev/tools/bolt-python/reference/kwargs_injection/args.html) to learn the available listener arguments.]
57
57
:::
@@ -138,10 +138,10 @@ Messages sent to the app do not contain a [subtype](/reference/events/message#su
138
138
139
139
There are three utilities that are particularly useful in curating the user experience:
Bolt for Python includes experimental features still under active development. These features may be fleeting, may not be perfectly polished, and should be thought of as available for use "at your own risk."
3
+
Bolt for Python occasionally includes experimental features still under active development. These features may be fleeting, may not be perfectly polished, and should be thought of as available for use "at your own risk."
4
4
5
5
Experimental features are categorized as `semver:patch` until the experimental status is removed.
6
6
7
7
We love feedback from our community, so we encourage you to explore and interact with the [GitHub repo](https://github.com/slackapi/bolt-python). Contributions, bug reports, and any feedback are all helpful; let us nurture the Slack CLI together to help make building Slack apps more pleasant for everyone.
8
8
9
9
## Available experiments
10
-
*[Agent listener argument](#agent)
11
10
12
-
## Agent listener argument {#agent}
13
-
14
-
The `agent: BoltAgent` listener argument provides access to AI agent-related features.
15
-
16
-
The `BoltAgent` and `AsyncBoltAgent` classes offer a `chat_stream()` method that comes pre-configured with event context defaults: `channel_id`, `thread_ts`, `team_id`, and `user_id` fields.
17
-
18
-
The listener argument is wired into the Bolt `kwargs` injection system, so listeners can declare it as a parameter or access it via the `context.agent` property.
19
-
20
-
### Example
21
-
22
-
```python
23
-
from slack_bolt import BoltAgent
24
-
25
-
@app.event("app_mention")
26
-
defhandle_mention(agent: BoltAgent):
27
-
stream = agent.chat_stream()
28
-
stream.append(markdown_text="Hello!")
29
-
stream.stop()
30
-
```
11
+
There are currently no active experiments. We're steadily staying stable.
Copy file name to clipboardExpand all lines: docs/english/tutorial/custom-steps-workflow-builder-existing/custom-steps-workflow-builder-existing.md
+2-3Lines changed: 2 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ In this tutorial we will:
14
14
15
15
## Prerequisites {#prereqs}
16
16
17
-
The custom steps feature is compatible with Bolt version 1.20.0 and above. First, update your `package.json` file to reflect version 1.20.0 of Bolt, then run the following command in your terminal:
17
+
The custom steps feature is compatible with Bolt version 1.20.0 and above. First, update your `requirements.txt` file to reflect version 1.20.0 of Bolt (e.g., `slack-bolt>=1.20.0`), then run the following commands in your terminal:
Copy file name to clipboardExpand all lines: docs/english/tutorial/custom-steps-workflow-builder-new/custom-steps-workflow-builder-new.md
+5-3Lines changed: 5 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,7 +47,9 @@ You can also open a terminal window from inside VSCode like this: `Ctrl` + `~`
47
47
Once in VSCode, open the terminal. Let's install our package dependencies: run the following command(s) in the terminal inside VSCode:
48
48
49
49
```sh
50
-
npm install
50
+
python3 -m venv .venv
51
+
source .venv/bin/activate
52
+
pip install -r requirements.txt
51
53
```
52
54
53
55
We now have a Bolt app ready for development! Open the `manifest.json` file and copy its contents; you'll need this in the next step.
@@ -99,7 +101,7 @@ You will then have a bot token. Again, copy that value and save it somewhere acc
99
101
100
102
## Starting your local development server {#local}
101
103
102
-
While building your app, you can see your changes appear in your workspace in real-time with `npm start`. Soon we'll start our local development server and see what our sample code is all about! But first, we need to store those tokens we gathered as environment variables.
104
+
While building your app, you can see your changes appear in your workspace in real-time with `python app.py`. Soon we'll start our local development server and see what our sample code is all about! But first, we need to store those tokens we gathered as environment variables.
103
105
104
106
Navigate back to VSCode. Rename the `.env.sample` file to `.env`. Open this file and update `SLACK_APP_TOKEN` and `SLACK_BOT_TOKEN` with the values you previously saved. It will look like this, with your actual token values where you see `<your_app_token>` and `<your_bot_token>`:
You'll know the local development server is up and running successfully when it emits a bunch of `[DEBUG]` statements to your terminal, the last one containing `connected:ready`.
@@ -226,7 +226,7 @@ The second argument is the callback function, or the logic that will run when yo
226
226
Field | Description
227
227
------|------------
228
228
`client` | A `WebClient` instance used to make things happen in Slack. From sending messages to opening modals, `client` makes it all happen. For a full list of available methods, refer to the [Web API methods](/reference/methods). Read more about the `WebClient` for Bolt Python [here](https://docs.slack.dev/tools/bolt-python/concepts/web-api/).
229
-
`complete` | A utility method that invokes `functions.completeSuccess`. This method indicates to Slack that a step has completed successfully without issue. When called, `complete`requires you include an`outputs` object that matches your step definition in [`output_parameters`](#inputs-outputs).
229
+
`complete` | A utility method that invokes `functions.completeSuccess`. This method indicates to Slack that a step has completed successfully without issue. When called, `complete`accepts an optional`outputs` object that matches your step definition in [`output_parameters`](#inputs-outputs).
230
230
`fail` | A utility method that invokes `functions.completeError`. True to its name, this method signals to Slack that a step has failed to complete. The `fail` method requires an argument of `error` to be sent along with it, which is used to help users understand what went wrong.
231
231
`inputs` | An alias for the `input_parameters` that were provided to the step upon execution.
0 commit comments