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/guides/app-distribution.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,6 +30,7 @@ All your app needs to do to properly handle OAuth Flow are:
30
30
* Provide the endpoints to navigate installers for the completion/cancellation of the installation flow
31
31
* The URLs are usually somewhere else but Bolt has simple functionality to serve them
32
32
33
+
---
33
34
## Examples
34
35
35
36
Here is a Bolt app demonstrating how to implement OAuth flow. As the OAuth flow handling features are unnecessary for many custom apps, those are disabled by default. **App** instances need to explicitly call `asOAuthApp(true)` to turn on them.
Copy file name to clipboardExpand all lines: docs/guides/app-home.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,6 +31,7 @@ All your app needs to do to provide Home tabs to your app users are:
31
31
32
32
Most commonly, [`"app_home_opened"`](https://api.slack.com/events/app_home_opened) events would be used as the trigger to call the [**views.publish**](https://api.slack.com/methods/views.publish) method. Subscribing this event type is useful particularly for the initial Home tab creation. But it's also fine to publish Home tabs by any other means.
33
33
34
+
---
34
35
## Examples
35
36
36
37
**NOTE**: If you're a beginner to using Bolt for Slack App development, consult [Getting Started with Bolt]({{ site.url | append: site.baseurl }}/guides/getting-started-with-bolt), first.
Copy file name to clipboardExpand all lines: docs/guides/audit-logs-api.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,6 +12,7 @@ The Audit Logs API can be used by security information and event management (SIE
12
12
13
13
Follow the instructions in [the API document](https://api.slack.com/docs/audit-logs-api) to get a valid token for using Audit Logs API. Your Slack app for Audit Logs API needs to be installed on the Enterprise Grid Organization, not an individual workspace within the organization.
14
14
15
+
---
15
16
## Call Audit Logs API in Java
16
17
17
18
It's straight-forward to call Audit Logs API using **slack-api-client** library.
Copy file name to clipboardExpand all lines: docs/guides/bolt-basics.md
+10Lines changed: 10 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,6 +10,7 @@ lang: en
10
10
11
11
This guide covers all the basics of Bolt app development. If you're not yet familiar with Slack app development in general, we recommend reading [An introduction to Slack apps](https://api.slack.com/start/overview).
12
12
13
+
---
13
14
## Start with the App class
14
15
15
16
The **App** class is a place to write only essential parts of your Slack app without being bothered by trifles.
Here is the list of the available methods to dispatch events.
@@ -45,6 +47,7 @@ Here is the list of the available methods to dispatch events.
45
47
|**app.dialogCancellation**|callback_id **String**\|**Pattern**|**Dialogs**: Responds to the events where users close dialogs by clicking Cancel buttons.|
46
48
|**app.attachmentAction**|callback_id: **String**\|**Pattern**|**Legacy Messaging**: Responds to user actions in **attachments**. These events can be triggered in only messages.|
47
49
50
+
---
48
51
## Development Guides by Feature
49
52
50
53
On these guide pages, you'll find a more concrete example code for each.
@@ -57,6 +60,7 @@ On these guide pages, you'll find a more concrete example code for each.
*[**App Distribution (OAuth Flow)**]({{ site.url | append: site.baseurl }}/guides/app-distribution)
59
62
63
+
---
60
64
## Acknowledge Incoming Requests
61
65
62
66
Actions, commands, and options events must always be acknowledged using the `ack()` method. All such utility methods are available as the instance methods of a **Context** object.
Are you already familiar with `response_url`? If not, we recommend reading [this guide](https://api.slack.com/interactivity/handling#message_responses) first.
When you need to call some Slack Web APIs in Bolt apps, use `ctx.client()` for it. The **MethodsClient** created by the method already holds a valid bot token. So, you don't need to give a token to it. Just calling a method with parameters as below works for you.
You can access [SLF4J](http://www.slf4j.org/) logger in **Context** objects.
@@ -204,6 +211,7 @@ If you use the [**ch.qos.logback:logback-classic**](https://search.maven.org/art
204
211
</configuration>
205
212
```
206
213
214
+
---
207
215
## Middleware
208
216
209
217
Bolt offers chaining middleware supports. You can customize **App** behavior by weaving a kind of filter to all events.
@@ -264,10 +272,12 @@ A set of the built-in middleware precedes your custom middleware. So, if the app
264
272
265
273
The most common would be the case where a request has been denied by **RequestVerification** middleware. After the denial, any middleware won't be executed, so that the above middleware also doesn't work for the case.
266
274
275
+
---
267
276
## Supported Web Frameworks
268
277
269
278
Refer to [this page]({{ site.url | append: site.baseurl }}/guides/supported-web-frameworks) for more details.
270
279
280
+
---
271
281
## Deployments
272
282
273
283
[We're planning](https://github.com/slackapi/java-slack-sdk/issues/348) to have some guide documents for deployments.
Copy file name to clipboardExpand all lines: docs/guides/composing-messages.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,6 +10,7 @@ This section shows how to build Slack messages using **slack-api-client** librar
10
10
11
11
Also, before jumping into Java code, we recommend developing an understand of composing Slack messages. [Read the API documentation](https://api.slack.com/messaging/composing) for more information.
12
12
13
+
---
13
14
## Text Formatting
14
15
15
16
Composing a text message is the simplest way to post a message to Slack conversations.
@@ -32,6 +33,7 @@ ChatPostMessageResponse response = slack.methods(token).chatPostMessage(req -> r
32
33
33
34
As you see, using `text` is fairly simple. The only thing to know is to give a string value with a valid format. Consult [Basic formatting with `mrkdwn`](https://api.slack.com/reference/surfaces/formatting#basics) for understanding the markup language.
34
35
36
+
---
35
37
## Building Blocks for Rich Message Layouts
36
38
37
39
[Block Kit](https://api.slack.com/block-kit) is a UI framework for Slack apps that offers a balance of control and flexibility when building experiences in messages and other [surfaces](https://api.slack.com/surfaces).
Copy file name to clipboardExpand all lines: docs/guides/events-api.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,6 +31,7 @@ All you need to do to handle Events API requests are:
31
31
32
32
Your app has to respond to the request within 3 seconds by `ack()` method. Otherwise, the Slack Platform may retry after a while.
33
33
34
+
---
34
35
## Examples
35
36
36
37
**NOTE**: If you're a beginner to using Bolt for Slack App development, consult [Getting Started with Bolt]({{ site.url | append: site.baseurl }}/guides/getting-started-with-bolt), first.
Copy file name to clipboardExpand all lines: docs/guides/getting-started-with-bolt.md
+1-3Lines changed: 1 addition & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,6 @@ This guide explains how to start your first-ever Bolt app.
25
25
If you're not yet familiar with Slack app development in general, we recommend reading [An introduction to Slack apps](https://api.slack.com/start/overview).
26
26
27
27
---
28
-
29
28
## Project Setup
30
29
31
30
Let's start building a Slack app with Bolt! This guide shows how to set up a Bolt project with Maven, and Gradle.
@@ -70,7 +69,6 @@ dependencies {
70
69
```
71
70
72
71
---
73
-
74
72
## Run Your Bolt App in 3 Minutes
75
73
76
74
### Use **bolt-jetty**
@@ -230,7 +228,6 @@ public class SlackAppController extends SlackAppServlet {
230
228
Check [the detailed guide here]({{ site.url | append: site.baseurl }}/guides/supported-web-frameworks) for further information.
231
229
232
230
---
233
-
234
231
## Getting Started in Kotlin
235
232
236
233
For code simplicity, [Kotlin](https://kotlinlang.org/) language would be a great option for writing Bolt apps. In this section, you'll learn how to set up a Kotlin project for Bolt apps.
@@ -308,6 +305,7 @@ From here, all you need to do is write code and restart the app. Enjoy Bolt app
308
305
309
306
**Pro tip**: We strongly recommend using [IntelliJ IDEA](https://www.jetbrains.com/idea/) here even if you don't prefer using IDEs. The IDE is the smoothest way to try Kotlin application development.
310
307
308
+
---
311
309
## Next Steps
312
310
313
311
Read the [Bolt Basics]({{ site.url | append: site.baseurl }}/guides/bolt-basics) for further information.
Copy file name to clipboardExpand all lines: docs/guides/interactive-components.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,6 +29,7 @@ All your app needs to do to handle Slack requests by user interactions are:
29
29
30
30
Your app has to respond to the request within 3 seconds by `ack()` method. Otherwise, the user will see the timeout error on Slack. For some of the requests including external selects, having valid parameters to the method may be required.
31
31
32
+
---
32
33
## Examples
33
34
34
35
**NOTE**: If you're a beginner to using Bolt for Slack App development, consult [Getting Started with Bolt]({{ site.url | append: site.baseurl }}/guides/getting-started-with-bolt), first.
0 commit comments