Package com.slack.api.bolt

Class AppConfig.AppConfigBuilder

java.lang.Object
com.slack.api.bolt.AppConfig.AppConfigBuilder
Enclosing class:
AppConfig
public static class AppConfig.AppConfigBuilder extends Object

  • Method Details

    • slack

      public AppConfig.AppConfigBuilder slack(Slack slack)
      Returns:
      this.

    • executorServiceProvider

      public AppConfig.AppConfigBuilder executorServiceProvider(ExecutorServiceProvider executorServiceProvider)
      Returns:
      this.

    • singleTeamBotToken

      public AppConfig.AppConfigBuilder singleTeamBotToken(String singleTeamBotToken)
      Returns:
      this.

    • signingSecret

      public AppConfig.AppConfigBuilder signingSecret(String signingSecret)
      Returns:
      this.

    • verificationToken

      @Deprecated public AppConfig.AppConfigBuilder verificationToken(String verificationToken)
      Deprecated.
      Returns:
      this.

    • oAuthInstallPathEnabled

      public AppConfig.AppConfigBuilder oAuthInstallPathEnabled(boolean oAuthInstallPathEnabled)
      Returns:
      this.

    • oAuthStartEnabled

      @Deprecated public AppConfig.AppConfigBuilder oAuthStartEnabled(boolean oAuthStartEnabled)
      Deprecated.
      Returns:
      this.

    • openIDConnectEnabled

      public AppConfig.AppConfigBuilder openIDConnectEnabled(boolean openIDConnectEnabled)
      Returns:
      this.

    • oAuthRedirectUriPathEnabled

      public AppConfig.AppConfigBuilder oAuthRedirectUriPathEnabled(boolean oAuthRedirectUriPathEnabled)
      Returns:
      this.

    • oAuthCallbackEnabled

      @Deprecated public AppConfig.AppConfigBuilder oAuthCallbackEnabled(boolean oAuthCallbackEnabled)
      Deprecated.
      Returns:
      this.

    • oAuthInstallPageRenderingEnabled

      public AppConfig.AppConfigBuilder oAuthInstallPageRenderingEnabled(boolean oAuthInstallPageRenderingEnabled)
      If you prefer the behavior in v1.0 - 1.3, set this flag as false
      Returns:
      this.

    • oAuthInstallPageRenderer

      public AppConfig.AppConfigBuilder oAuthInstallPageRenderer(OAuthInstallPageRenderer oAuthInstallPageRenderer)
      Renders the web page content to display to installers.
      Returns:
      this.

    • oAuthRedirectUriPageRenderer

      public AppConfig.AppConfigBuilder oAuthRedirectUriPageRenderer(OAuthRedirectUriPageRenderer oAuthRedirectUriPageRenderer)
      Renders the web page content to display to installers.
      Returns:
      this.

    • unmatchedRequestHandler

      public AppConfig.AppConfigBuilder unmatchedRequestHandler(UnmatchedRequestHandler unmatchedRequestHandler)
      Handles unmatched requests (default behavior is simply returning 404 Not Found).
      Returns:
      this.

    • authTestCacheEnabled

      public AppConfig.AppConfigBuilder authTestCacheEnabled(boolean authTestCacheEnabled)
      Returns true if auth.test call result cache in MultiTeamsAuthorization middleware is enabled. The default is false.
      Returns:
      this.

    • authTestCacheExpirationMillis

      public AppConfig.AppConfigBuilder authTestCacheExpirationMillis(long authTestCacheExpirationMillis)
      Returns the millisecond value to keep cached auth.test response in cache. Negative value indicates the cache is permanent. The default is 10 minutes.
      Returns:
      this.

    • classicAppPermissionsEnabled

      public AppConfig.AppConfigBuilder classicAppPermissionsEnabled(boolean classicAppPermissionsEnabled)
      Returns:
      this.

    • threadPoolSize

      public AppConfig.AppConfigBuilder threadPoolSize(int threadPoolSize)
      The thread pool size for the built-in handy executor service.
      Returns:
      this.

    • clientId

      public AppConfig.AppConfigBuilder clientId(String clientId)
      Returns:
      this.

    • clientSecret

      public AppConfig.AppConfigBuilder clientSecret(String clientSecret)
      Returns:
      this.

    • redirectUri

      public AppConfig.AppConfigBuilder redirectUri(String redirectUri)
      Returns:
      this.

    • scope

      public AppConfig.AppConfigBuilder scope(String scope)
      Returns:
      this.

    • userScope

      public AppConfig.AppConfigBuilder userScope(String userScope)
      Returns:
      this.

    • tokenRotationExpirationMillis

      public AppConfig.AppConfigBuilder tokenRotationExpirationMillis(long tokenRotationExpirationMillis)
      Returns:
      this.

    • appPath

      public AppConfig.AppConfigBuilder appPath(String appPath)
      Returns:
      this.

    • oauthStartPath

      @Deprecated public AppConfig.AppConfigBuilder oauthStartPath(String oauthStartPath)
      Deprecated.
      Returns:
      this.

    • oauthInstallPath

      public AppConfig.AppConfigBuilder oauthInstallPath(String oauthInstallPath)
      Returns:
      this.

    • oauthCallbackPath

      @Deprecated public AppConfig.AppConfigBuilder oauthCallbackPath(String oauthCallbackPath)
      Deprecated.
      Returns:
      this.

    • oauthRedirectUriPath

      public AppConfig.AppConfigBuilder oauthRedirectUriPath(String oauthRedirectUriPath)
      Returns:
      this.

    • stateValidationEnabled

      public AppConfig.AppConfigBuilder stateValidationEnabled(boolean stateValidationEnabled)
      Enables validation of the state parameter in the OAuth flow. It is highly recommended to enable this validation for better security. A valid exception is when Enterprise Grid Org admins install apps from the app management page.
      Returns:
      this.

    • oauthCancellationUrl

      public AppConfig.AppConfigBuilder oauthCancellationUrl(String oauthCancellationUrl)
      Returns:
      this.

    • oauthCompletionUrl

      public AppConfig.AppConfigBuilder oauthCompletionUrl(String oauthCompletionUrl)
      Returns:
      this.

    • alwaysRequestUserTokenNeeded

      public AppConfig.AppConfigBuilder alwaysRequestUserTokenNeeded(boolean alwaysRequestUserTokenNeeded)
      Returns:
      this.

    • appInitializersEnabled

      public AppConfig.AppConfigBuilder appInitializersEnabled(boolean appInitializersEnabled)
      Returns:
      this.

    • subtypedMessageEventsAutoAckEnabled

      public AppConfig.AppConfigBuilder subtypedMessageEventsAutoAckEnabled(boolean subtypedMessageEventsAutoAckEnabled)
      Automatically acknowledge message events that have subtype if true. Find the list of available subtypes at https://docs.slack.dev/reference/events/message#subtypes
      Returns:
      this.

    • allEventsApiAutoAckEnabled

      public AppConfig.AppConfigBuilder allEventsApiAutoAckEnabled(boolean allEventsApiAutoAckEnabled)
      Automatically acknowledge all Event API events if true. This behavior is compatible with bolt-js.
      Returns:
      this.

    • attachingFunctionTokenEnabled

      public AppConfig.AppConfigBuilder attachingFunctionTokenEnabled(boolean attachingFunctionTokenEnabled)
      When true, the framework automatically attaches context#functionBotAccessToken to context#client instead of context#botToken. Enabling this behavior only affects function_executed event handlers and app.action/app.view handlers associated with the function token.
      Returns:
      this.

    • sslCheckEnabled

      public AppConfig.AppConfigBuilder sslCheckEnabled(boolean sslCheckEnabled)
      Returns:
      this.

    • requestVerificationEnabled

      public AppConfig.AppConfigBuilder requestVerificationEnabled(boolean requestVerificationEnabled)
      Returns:
      this.

    • ignoringSelfEventsEnabled

      public AppConfig.AppConfigBuilder ignoringSelfEventsEnabled(boolean ignoringSelfEventsEnabled)
      Returns:
      this.

    • ignoringSelfAssistantMessageEventsEnabled

      public AppConfig.AppConfigBuilder ignoringSelfAssistantMessageEventsEnabled(boolean ignoringSelfAssistantMessageEventsEnabled)
      Returns:
      this.

    • build

      public AppConfig build()

    • toString

      public String toString()
      Overrides:
      toString in class Object