Package com.slack.api
Class SlackConfig
java.lang.Object
com.slack.api.SlackConfig
public class SlackConfig extends Object
The basic configuration of this SDK. Some settings can be propagated to sub modules such as Bolt.
-
Field Summary
Fields Modifier and Type Field Description static SlackConfigDEFAULTThe default instance is immutable. -
Constructor Summary
Constructors Constructor Description SlackConfig() -
Method Summary
Modifier and Type Method Description protected booleancanEqual(Object other)booleanequals(Object o)AuditConfiggetAuditConfig()StringgetAuditEndpointUrlPrefix()IntegergetHttpClientCallTimeoutMillis()The underlying HTTP client's call timeout (in milliseconds).IntegergetHttpClientReadTimeoutMillis()The underlying HTTP client's read timeout (in milliseconds).List<HttpResponseListener>getHttpClientResponseHandlers()IntegergetHttpClientWriteTimeoutMillis()The underlying HTTP client's write timeout (in milliseconds).StringgetLegacyStatusEndpointUrlPrefix()MethodsConfiggetMethodsConfig()StringgetMethodsEndpointUrlPrefix()Map<String,String>getProxyHeaders()Additional headers for proxy (e.g., Proxy-Authorization)StringgetProxyUrl()The proxy server URL supposed to be used for all api calls.SCIMConfiggetSCIMConfig()StringgetScimEndpointUrlPrefix()StringgetStatusEndpointUrlPrefix()inthashCode()booleanisFailOnUnknownProperties()If you would like to detect unknown properties by throwing exceptions, set this flag as true.booleanisLibraryMaintainerMode()Don't enable this flag in production.booleanisPrettyResponseLoggingEnabled()booleanisTokenExistenceVerificationEnabled()Slack Web API client verifies the existence of tokens before sending HTTP requests to Slack servers.voidsetAuditConfig(AuditConfig auditConfig)voidsetAuditEndpointUrlPrefix(String auditEndpointUrlPrefix)voidsetFailOnUnknownProperties(boolean failOnUnknownProperties)If you would like to detect unknown properties by throwing exceptions, set this flag as true.voidsetHttpClientCallTimeoutMillis(Integer httpClientCallTimeoutMillis)The underlying HTTP client's call timeout (in milliseconds).voidsetHttpClientReadTimeoutMillis(Integer httpClientReadTimeoutMillis)The underlying HTTP client's read timeout (in milliseconds).voidsetHttpClientResponseHandlers(List<HttpResponseListener> httpClientResponseHandlers)voidsetHttpClientWriteTimeoutMillis(Integer httpClientWriteTimeoutMillis)The underlying HTTP client's write timeout (in milliseconds).voidsetLegacyStatusEndpointUrlPrefix(String legacyStatusEndpointUrlPrefix)voidsetLibraryMaintainerMode(boolean libraryMaintainerMode)Don't enable this flag in production.voidsetMethodsConfig(MethodsConfig methodsConfig)voidsetMethodsEndpointUrlPrefix(String methodsEndpointUrlPrefix)voidsetPrettyResponseLoggingEnabled(boolean prettyResponseLoggingEnabled)voidsetProxyHeaders(Map<String,String> proxyHeaders)Additional headers for proxy (e.g., Proxy-Authorization)voidsetProxyUrl(String proxyUrl)The proxy server URL supposed to be used for all api calls.voidsetSCIMConfig(SCIMConfig sCIMConfig)voidsetScimEndpointUrlPrefix(String scimEndpointUrlPrefix)voidsetStatusEndpointUrlPrefix(String statusEndpointUrlPrefix)voidsetTokenExistenceVerificationEnabled(boolean tokenExistenceVerificationEnabled)Slack Web API client verifies the existence of tokens before sending HTTP requests to Slack servers.StringtoString()
-
Field Details
-
DEFAULT
The default instance is immutable. It's not allowed to modify the value runtime for any reasons.
-
-
Constructor Details
-
SlackConfig
public SlackConfig()
-
-
Method Details
-
getHttpClientReadTimeoutMillis
The underlying HTTP client's read timeout (in milliseconds). The default is 10 seconds. https://square.github.io/okhttp/4.x/okhttp/okhttp3/-ok-http-client/read-timeout-millis/ -
getHttpClientWriteTimeoutMillis
The underlying HTTP client's write timeout (in milliseconds). The default is 10 seconds. https://square.github.io/okhttp/4.x/okhttp/okhttp3/-ok-http-client/write-timeout-millis/ -
getHttpClientCallTimeoutMillis
The underlying HTTP client's call timeout (in milliseconds). By default there is no timeout for complete calls, but there is for the connect, write, and read actions within a call. https://square.github.io/okhttp/4.x/okhttp/okhttp3/-ok-http-client/call-timeout-millis/ -
getProxyUrl
The proxy server URL supposed to be used for all api calls. -
getProxyHeaders
Additional headers for proxy (e.g., Proxy-Authorization) -
isPrettyResponseLoggingEnabled
public boolean isPrettyResponseLoggingEnabled() -
isLibraryMaintainerMode
public boolean isLibraryMaintainerMode()Don't enable this flag in production. This flag enables some validation features for development. -
isFailOnUnknownProperties
public boolean isFailOnUnknownProperties()If you would like to detect unknown properties by throwing exceptions, set this flag as true. -
isTokenExistenceVerificationEnabled
public boolean isTokenExistenceVerificationEnabled()Slack Web API client verifies the existence of tokens before sending HTTP requests to Slack servers. -
getHttpClientResponseHandlers
-
getAuditEndpointUrlPrefix
-
getMethodsEndpointUrlPrefix
-
getScimEndpointUrlPrefix
-
getStatusEndpointUrlPrefix
-
getLegacyStatusEndpointUrlPrefix
-
getMethodsConfig
-
getAuditConfig
-
getSCIMConfig
-
setHttpClientReadTimeoutMillis
The underlying HTTP client's read timeout (in milliseconds). The default is 10 seconds. https://square.github.io/okhttp/4.x/okhttp/okhttp3/-ok-http-client/read-timeout-millis/ -
setHttpClientWriteTimeoutMillis
The underlying HTTP client's write timeout (in milliseconds). The default is 10 seconds. https://square.github.io/okhttp/4.x/okhttp/okhttp3/-ok-http-client/write-timeout-millis/ -
setHttpClientCallTimeoutMillis
The underlying HTTP client's call timeout (in milliseconds). By default there is no timeout for complete calls, but there is for the connect, write, and read actions within a call. https://square.github.io/okhttp/4.x/okhttp/okhttp3/-ok-http-client/call-timeout-millis/ -
setProxyUrl
The proxy server URL supposed to be used for all api calls. -
setProxyHeaders
Additional headers for proxy (e.g., Proxy-Authorization) -
setPrettyResponseLoggingEnabled
public void setPrettyResponseLoggingEnabled(boolean prettyResponseLoggingEnabled) -
setLibraryMaintainerMode
public void setLibraryMaintainerMode(boolean libraryMaintainerMode)Don't enable this flag in production. This flag enables some validation features for development. -
setFailOnUnknownProperties
public void setFailOnUnknownProperties(boolean failOnUnknownProperties)If you would like to detect unknown properties by throwing exceptions, set this flag as true. -
setTokenExistenceVerificationEnabled
public void setTokenExistenceVerificationEnabled(boolean tokenExistenceVerificationEnabled)Slack Web API client verifies the existence of tokens before sending HTTP requests to Slack servers. -
setHttpClientResponseHandlers
-
setAuditEndpointUrlPrefix
-
setMethodsEndpointUrlPrefix
-
setScimEndpointUrlPrefix
-
setStatusEndpointUrlPrefix
-
setLegacyStatusEndpointUrlPrefix
-
setMethodsConfig
-
setAuditConfig
-
setSCIMConfig
-
equals
-
canEqual
-
hashCode
public int hashCode() -
toString
-