https://github.com/dangernoodle-io/slack-bot-api
slack-bot-api
https://github.com/dangernoodle-io/slack-bot-api
java8 slack
Last synced: 8 months ago
JSON representation
slack-bot-api
- Host: GitHub
- URL: https://github.com/dangernoodle-io/slack-bot-api
- Owner: dangernoodle-io
- License: apache-2.0
- Archived: true
- Created: 2016-09-22T18:45:39.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-02-06T21:42:56.000Z (over 9 years ago)
- Last Synced: 2025-07-26T23:54:28.851Z (11 months ago)
- Topics: java8, slack
- Language: Java
- Size: 234 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# slack-bot-api
[](https://travis-ci.org/dangernoodle-io/slack-bot-api)
[](https://coveralls.io/github/dangernoodle-io/slack-bot-api?branch=master)
The `slack-bot-api` is a `java 8` library that can used to interface with [Slack](https://slack.com)'s
[Real Time Messaging API](https://api.slack.com/rtm) to create your own bot.
## Getting Started
### WebSocket Clients
Two different `WebSocket` client implementations are available for use.
**Project Tyrus**
```xml
io.dangernoodle
slack-bot-api-tyrus
${slack-bot-api.version}
```
**Jetty**
```xml
io.dangernoodle
slack-bot-api-jetty
${slack-bot-api.version}
```
## Usage
### Basic
```java
SlackClientSettings settings = new SlackClientSettings(AUTH_TOKEN);
SlackClient slackClient = SlackClientBuilder.createClient(settings);
SlackObserverRegistry regsitry = slackClient.getObserverRegistry();
registry.addChannelJoinedObserver((event, client) -> {
logger.debug("channel joined event: " + event);
});
registry.addChannelLeftObserver((event, client) -> {
logger.info("channel joined event: " + event);
});
...
slackClient.connect();
```
### Sending Messages
**Simple Messages**
Simple text messages can be sent directly over the websocket connection.
```java
slackClient.send("simple text message");
```
**Complex Messages**
Details to follow...
## Special Acknowledgement
This library was inspired by the excellent [simple-slack-api](https://github.com/Ullink/simple-slack-api)
library. If you are looking to create a slack bot and are unable to use `java 8`, the `simple-slack-api`
is highly recommend as an alternative.