Package com.slack.api.bolt

Class App

java.lang.Object

com.slack.api.bolt.App

public class App
extends Object

A Slack App instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	App.AppBuilder
static class	App.Status

Constructor Summary

Constructors

Constructor	Description
App()
App(AppConfig appConfig)
App(AppConfig appConfig, Slack slack, List<Middleware> middlewareList)
App(AppConfig appConfig, ExecutorService executorService, List<Middleware> middlewareList, App.Status status, InstallationService installationService, DefaultTokensRevokedEventHandler tokensRevokedEventHandler, DefaultAppUninstalledEventHandler appUninstalledEventHandler, OAuthStateService oAuthStateService, OpenIDConnectNonceService openIDConnectNonceService, OAuthSuccessHandler oAuthSuccessHandler, OAuthV2SuccessHandler oAuthV2SuccessHandler, OpenIDConnectSuccessHandler openIDConnectSuccessHandler, OAuthErrorHandler oAuthErrorHandler, OAuthAccessErrorHandler oAuthAccessErrorHandler, OAuthV2AccessErrorHandler oAuthV2AccessErrorHandler, OpenIDConnectErrorHandler openIDConnectErrorHandler, OAuthStateErrorHandler oAuthStateErrorHandler, OAuthExceptionHandler oAuthExceptionHandler, OAuthCallbackService oAuthCallbackService)
App(AppConfig appConfig, List<Middleware> middlewareList)

Method Summary

Modifier and Type	Method	Description
App	asOAuthApp(boolean enabled)
App	asOpenIDConnectApp(boolean enabled)
App	attachmentAction(String callbackId, AttachmentActionHandler handler)
App	attachmentAction(Pattern callbackId, AttachmentActionHandler handler)
App	blockAction(String actionId, BlockActionHandler handler)
App	blockAction(Pattern actionId, BlockActionHandler handler)
App	blockSuggestion(String actionId, BlockSuggestionHandler handler)
App	blockSuggestion(Pattern actionId, BlockSuggestionHandler handler)
String	buildAuthorizeUrl(String state)	Get the Slack URL for beginning the OAuth flow, including the query params necessary to identify this application to Slack.
String	buildAuthorizeUrl(String state, String nonce)
protected List<Middleware>	buildDefaultMiddlewareList(AppConfig config)
static App.AppBuilder	builder()
MethodsClient	client()
App	command(String command, SlashCommandHandler handler)
App	command(Pattern command, SlashCommandHandler handler)
AppConfig	config()
BoltEventHandler<AppUninstalledEvent>	defaultAppUninstalledEventHandler()
BoltEventHandler<TokensRevokedEvent>	defaultTokensRevokedEventHandler()
App	dialogCancellation(String callbackId, DialogCancellationHandler handler)
App	dialogCancellation(Pattern callbackId, DialogCancellationHandler handler)
App	dialogSubmission(String callbackId, DialogSubmissionHandler handler)
App	dialogSubmission(Pattern callbackId, DialogSubmissionHandler handler)
App	dialogSuggestion(String callbackId, DialogSuggestionHandler handler)
App	dialogSuggestion(Pattern callbackId, DialogSuggestionHandler handler)
App	enableTokenRevocationHandlers()
App	endpoint(WebEndpoint.Method method, String path, WebEndpointHandler handler)
App	endpoint(String path, WebEndpointHandler handler)
App	endpoint(String method, String path, WebEndpointHandler handler)
App	event(EventHandler<?> handler)
protected <E extends Event> App	event(Class<E> eventClass, boolean allowMultipleEventHandlers, BoltEventHandler<E> handler)
<E extends Event> App	event(Class<E> eventClass, BoltEventHandler<E> handler)
ExecutorService	executorService()	The built-in handy way to run operations asynchronously.
MethodsClient	getClient()	The default Web API client without any tokens.
String	getOauthInstallationUrl(String state)	Deprecated.
Slack	getSlack()	Slack instance and its configurations to be used for API calls.
Map<WebEndpoint,WebEndpointHandler>	getWebEndpointHandlers()
App	globalShortcut(String callbackId, GlobalShortcutHandler handler)
App	globalShortcut(Pattern callbackId, GlobalShortcutHandler handler)
void	initialize()
App	initializer(String name, Initializer initializer)
App	message(String pattern, BoltEventHandler<MessageEvent> messageHandler)
App	message(Pattern pattern, BoltEventHandler<MessageEvent> messageHandler)
App	messageShortcut(String callbackId, MessageShortcutHandler handler)
App	messageShortcut(Pattern callbackId, MessageShortcutHandler handler)
App	oauthCallback(OAuthSuccessHandler handler)
App	oauthCallback(OAuthV2SuccessHandler handler)
App	oauthCallbackAccessError(OAuthAccessErrorHandler handler)
App	oauthCallbackAccessError(OAuthV2AccessErrorHandler handler)
App	oauthCallbackError(OAuthErrorHandler handler)
App	oauthCallbackException(OAuthExceptionHandler handler)
App	oauthCallbackStateError(OAuthStateErrorHandler handler)
App	oauthPersistenceCallback(OAuthV2SuccessPersistenceCallback persistenceCallback)
App	oauthPersistenceErrorCallback(OAuthV2SuccessPersistenceErrorCallback persistenceErrorCallback)
App	openIDConnectError(OpenIDConnectErrorHandler handler)
App	openIDConnectSuccess(OpenIDConnectSuccessHandler handler)
Response	run(Request request)
protected Response	runHandler(Request slackRequest)
protected Response	runMiddleware(Request request, Response response, Middleware current, LinkedList<Middleware> remaining)
App	service(InstallationService installationService)
App	service(OAuthCallbackService oAuthCallbackService)
App	service(OAuthStateService oAuthStateService)
App	service(OpenIDConnectNonceService openIDConnectNonceService)
Slack	slack()
App	start()
App.Status	status()
App	step(WorkflowStep step)
App	stop()
App.AppBuilder	toBuilder()
App	toOAuthCallbackApp()	Deprecated.
App	toOAuthInstallPathEnabledApp()
App	toOAuthRedirectUriPathEnabledApp()
App	toOAuthStartApp()	Deprecated.
App	use(Middleware middleware)
App	viewClosed(String callbackId, ViewClosedHandler handler)
App	viewClosed(Pattern callbackId, ViewClosedHandler handler)
App	viewSubmission(String callbackId, ViewSubmissionHandler handler)
App	viewSubmission(Pattern callbackId, ViewSubmissionHandler handler)
App	workflowStepEdit(String callbackId, WorkflowStepEditHandler handler)
App	workflowStepEdit(Pattern callbackId, WorkflowStepEditHandler handler)
App	workflowStepExecute(String pattern, WorkflowStepExecuteHandler handler)
App	workflowStepExecute(Pattern pattern, WorkflowStepExecuteHandler handler)
App	workflowStepSave(String callbackId, WorkflowStepSaveHandler handler)
App	workflowStepSave(Pattern callbackId, WorkflowStepSaveHandler handler)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

App

public App()

App

public App(AppConfig appConfig)

App

public App(AppConfig appConfig,
           List<Middleware> middlewareList)

App

public App(AppConfig appConfig,
           Slack slack,
           List<Middleware> middlewareList)

App

public App(AppConfig appConfig,
           ExecutorService executorService,
           List<Middleware> middlewareList,
           App.Status status,
           InstallationService installationService,
           DefaultTokensRevokedEventHandler tokensRevokedEventHandler,
           DefaultAppUninstalledEventHandler appUninstalledEventHandler,
           OAuthStateService oAuthStateService,
           OpenIDConnectNonceService openIDConnectNonceService,
           OAuthSuccessHandler oAuthSuccessHandler,
           OAuthV2SuccessHandler oAuthV2SuccessHandler,
           OpenIDConnectSuccessHandler openIDConnectSuccessHandler,
           OAuthErrorHandler oAuthErrorHandler,
           OAuthAccessErrorHandler oAuthAccessErrorHandler,
           OAuthV2AccessErrorHandler oAuthV2AccessErrorHandler,
           OpenIDConnectErrorHandler openIDConnectErrorHandler,
           OAuthStateErrorHandler oAuthStateErrorHandler,
           OAuthExceptionHandler oAuthExceptionHandler,
           OAuthCallbackService oAuthCallbackService)

Method Detail

getSlack

public Slack getSlack()

Slack instance and its configurations to be used for API calls.

getClient

public MethodsClient getClient()

The default Web API client without any tokens.

buildDefaultMiddlewareList

protected List<Middleware> buildDefaultMiddlewareList(AppConfig config)

defaultTokensRevokedEventHandler

public BoltEventHandler<TokensRevokedEvent> defaultTokensRevokedEventHandler()

defaultAppUninstalledEventHandler

public BoltEventHandler<AppUninstalledEvent> defaultAppUninstalledEventHandler()

enableTokenRevocationHandlers

public App enableTokenRevocationHandlers()

buildAuthorizeUrl

public String buildAuthorizeUrl(String state)

Get the Slack URL for beginning the OAuth flow, including the query params necessary to identify this application to Slack.

Appends the optional `redirect_uri` query param based on the provided AppConfig to ensure that the correct OAuth redirect URI is selected in cases where a Slack application may have multiple redirect URIs associated with it.

Parameters:

state - The OAuth state param

Returns:

The Slack URL to redirect users to for beginning the OAuth flow

buildAuthorizeUrl

public String buildAuthorizeUrl(String state,
                                String nonce)

Parameters:

state - The OAuth state param

nonce - The OAUth nonce param

Returns:

getOauthInstallationUrl

@Deprecated
public String getOauthInstallationUrl(String state)

Deprecated.

Use #buildAuthorizeUrl(String) instead (this method will be removed in v2.0)

getWebEndpointHandlers

public Map<WebEndpoint,WebEndpointHandler> getWebEndpointHandlers()

config

public AppConfig config()

slack

public Slack slack()

client

public MethodsClient client()

executorService

public ExecutorService executorService()

The built-in handy way to run operations asynchronously. It's totally fine to use your own one instead.

status

public App.Status status()

initializer

public App initializer(String name,
                       Initializer initializer)

initialize

public void initialize()

start

public App start()

stop

public App stop()

run

public Response run(Request request)
             throws Exception

Throws:

Exception

use

public App use(Middleware middleware)

event

public <E extends Event> App event(Class<E> eventClass,
                                   BoltEventHandler<E> handler)

event

protected <E extends Event> App event(Class<E> eventClass,
                                      boolean allowMultipleEventHandlers,
                                      BoltEventHandler<E> handler)

event

public App event(EventHandler<?> handler)

message

public App message(String pattern,
                   BoltEventHandler<MessageEvent> messageHandler)

message

public App message(Pattern pattern,
                   BoltEventHandler<MessageEvent> messageHandler)

command

public App command(String command,
                   SlashCommandHandler handler)

command

public App command(Pattern command,
                   SlashCommandHandler handler)

blockAction

public App blockAction(String actionId,
                       BlockActionHandler handler)

blockAction

public App blockAction(Pattern actionId,
                       BlockActionHandler handler)

blockSuggestion

public App blockSuggestion(String actionId,
                           BlockSuggestionHandler handler)

blockSuggestion

public App blockSuggestion(Pattern actionId,
                           BlockSuggestionHandler handler)

globalShortcut

public App globalShortcut(String callbackId,
                          GlobalShortcutHandler handler)

globalShortcut

public App globalShortcut(Pattern callbackId,
                          GlobalShortcutHandler handler)

messageShortcut

public App messageShortcut(String callbackId,
                           MessageShortcutHandler handler)

messageShortcut

public App messageShortcut(Pattern callbackId,
                           MessageShortcutHandler handler)

viewSubmission

public App viewSubmission(String callbackId,
                          ViewSubmissionHandler handler)

viewSubmission

public App viewSubmission(Pattern callbackId,
                          ViewSubmissionHandler handler)

viewClosed

public App viewClosed(String callbackId,
                      ViewClosedHandler handler)

viewClosed

public App viewClosed(Pattern callbackId,
                      ViewClosedHandler handler)

step

public App step(WorkflowStep step)

workflowStepEdit

public App workflowStepEdit(String callbackId,
                            WorkflowStepEditHandler handler)

workflowStepEdit

public App workflowStepEdit(Pattern callbackId,
                            WorkflowStepEditHandler handler)

workflowStepSave

public App workflowStepSave(String callbackId,
                            WorkflowStepSaveHandler handler)

workflowStepSave

public App workflowStepSave(Pattern callbackId,
                            WorkflowStepSaveHandler handler)

workflowStepExecute

public App workflowStepExecute(String pattern,
                               WorkflowStepExecuteHandler handler)

workflowStepExecute

public App workflowStepExecute(Pattern pattern,
                               WorkflowStepExecuteHandler handler)

attachmentAction

public App attachmentAction(String callbackId,
                            AttachmentActionHandler handler)

attachmentAction

public App attachmentAction(Pattern callbackId,
                            AttachmentActionHandler handler)

dialogSubmission

public App dialogSubmission(String callbackId,
                            DialogSubmissionHandler handler)

dialogSubmission

public App dialogSubmission(Pattern callbackId,
                            DialogSubmissionHandler handler)

dialogSuggestion

public App dialogSuggestion(String callbackId,
                            DialogSuggestionHandler handler)

dialogSuggestion

public App dialogSuggestion(Pattern callbackId,
                            DialogSuggestionHandler handler)

dialogCancellation

public App dialogCancellation(String callbackId,
                              DialogCancellationHandler handler)

dialogCancellation

public App dialogCancellation(Pattern callbackId,
                              DialogCancellationHandler handler)

asOAuthApp

public App asOAuthApp(boolean enabled)

asOpenIDConnectApp

public App asOpenIDConnectApp(boolean enabled)

service

public App service(OAuthCallbackService oAuthCallbackService)

service

public App service(OAuthStateService oAuthStateService)

service

public App service(OpenIDConnectNonceService openIDConnectNonceService)

service

public App service(InstallationService installationService)

oauthCallback

public App oauthCallback(OAuthSuccessHandler handler)

oauthCallback

public App oauthCallback(OAuthV2SuccessHandler handler)

oauthPersistenceCallback

public App oauthPersistenceCallback(OAuthV2SuccessPersistenceCallback persistenceCallback)

oauthPersistenceErrorCallback

public App oauthPersistenceErrorCallback(OAuthV2SuccessPersistenceErrorCallback persistenceErrorCallback)

oauthCallbackError

public App oauthCallbackError(OAuthErrorHandler handler)

oauthCallbackStateError

public App oauthCallbackStateError(OAuthStateErrorHandler handler)

oauthCallbackAccessError

public App oauthCallbackAccessError(OAuthAccessErrorHandler handler)

oauthCallbackAccessError

public App oauthCallbackAccessError(OAuthV2AccessErrorHandler handler)

openIDConnectSuccess

public App openIDConnectSuccess(OpenIDConnectSuccessHandler handler)

openIDConnectError

public App openIDConnectError(OpenIDConnectErrorHandler handler)

oauthCallbackException

public App oauthCallbackException(OAuthExceptionHandler handler)

toOAuthStartApp

@Deprecated
public App toOAuthStartApp()

Deprecated.

toOAuthInstallPathEnabledApp

public App toOAuthInstallPathEnabledApp()

toOAuthCallbackApp

@Deprecated
public App toOAuthCallbackApp()

Deprecated.

toOAuthRedirectUriPathEnabledApp

public App toOAuthRedirectUriPathEnabledApp()

endpoint

public App endpoint(String path,
                    WebEndpointHandler handler)

endpoint

public App endpoint(String method,
                    String path,
                    WebEndpointHandler handler)

endpoint

public App endpoint(WebEndpoint.Method method,
                    String path,
                    WebEndpointHandler handler)

runMiddleware

protected Response runMiddleware(Request request,
                                 Response response,
                                 Middleware current,
                                 LinkedList<Middleware> remaining)
                          throws Exception

Throws:

Exception

runHandler

protected Response runHandler(Request slackRequest)
                       throws IOException,
                              SlackApiException

Throws:

IOException

SlackApiException

builder

public static App.AppBuilder builder()

toBuilder

public App.AppBuilder toBuilder()