Package com.slack.api
Class Slack
java.lang.Object
com.slack.api.Slack
- All Implemented Interfaces:
AutoCloseable
This class is a kind of facade of a variety of Slack API clients offered by this SDK.
Any objects of this class and all the APIs this class provides are thread-safe.
We recommend sharing an instance across your application.
This class internally uses the OkHttpClient and the client has its own daemon thread for realizing its optimal resource management. When your app needs to close all the threads when shutting down etc, call #close() method to terminate those threads.
If your application depends on the Gson library for JSON manipulation as with this SDK and the app uses the latest version for some reasons, just in case, you may need to check the binary-compatibility among their releases. We don't think any issues happened before but in general, some libraries may break bin-compatibility among major/minor releases.
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaudit()
Creates a Audit Logs API client.auditAsync
(String token) auditStats
(String enterpriseId) auditStats
(String executorName, String enterpriseId) void
close()
static Slack
static Slack
getInstance
(SlackConfig config) static Slack
getInstance
(SlackConfig config, SlackHttpClient httpClient) static Slack
getInstance
(SlackHttpClient httpClient) issueSocketModeUrl
(String appToken) methods()
Creates a Methods API client.methodsAsync
(String token) methodsAsync
(String token, String teamId) methodsStats
(String teamId) methodsStats
(String executorName, String teamId) Creates an RTM API client.rtmConnect
(String apiToken) Creates an RTM API client using `/rtm.connect`.rtmConnect
(String apiToken, boolean fullUserInfoRequired) Creates an RTM API client using `/rtm.connect`.Deprecated.Use #rtmConnect() insteadDeprecated.Use #rtmConnect() insteadscim()
Creates a SCIM API client.Send a data to Incoming Webhook endpoint.Send a raw JSON body to Incoming Webhook endpoint.socketMode
(String appToken) socketMode
(String appToken, SocketModeClient.Backend backend) status()
Creates a Status API client.
-
Constructor Details
-
Slack
public Slack()
-
-
Method Details
-
getInstance
-
getInstance
-
getInstance
-
getInstance
-
getConfig
-
getHttpClient
-
close
- Specified by:
close
in interfaceAutoCloseable
- Throws:
Exception
-
send
Send a data to Incoming Webhook endpoint.- Throws:
IOException
-
send
Send a raw JSON body to Incoming Webhook endpoint.- Throws:
IOException
-
socketMode
- Throws:
IOException
-
socketMode
public SocketModeClient socketMode(String appToken, SocketModeClient.Backend backend) throws IOException - Throws:
IOException
-
issueSocketModeUrl
- Throws:
IOException
-
rtm
Creates an RTM API client.- Throws:
IOException
- See Also:
-
rtmConnect
Creates an RTM API client using `/rtm.connect`.- Throws:
IOException
- See Also:
-
rtmConnect
Creates an RTM API client using `/rtm.connect`.- Throws:
IOException
- See Also:
-
rtmStart
Deprecated.Use #rtmConnect() insteadCreates an RTM API client using `/rtm.start`.- Throws:
IOException
- See Also:
-
rtmStart
@Deprecated public RTMClient rtmStart(String apiToken, boolean fullUserInfoRequired) throws IOException Deprecated.Use #rtmConnect() insteadCreates an RTM API client using `/rtm.start`.- Throws:
IOException
- See Also:
-
statusLegacy
Creates a Status API client. -
status
-
scim
Creates a SCIM API client. -
scim
-
scimAsync
-
scimStats
-
scimStats
-
audit
Creates a Audit Logs API client. -
audit
-
auditAsync
-
auditStats
-
auditStats
-
methods
Creates a Methods API client. -
methods
-
methods
-
methodsAsync
-
methodsAsync
-
methodsAsync
-
methodsStats
-
methodsStats
-