com.github.seratch.jslack.shortcut

Interface Shortcut

All Known Implementing Classes:

ShortcutImpl

public interface Shortcut

Shortcut is an original API provided by this library. As the name tells you, the module provides you more handy APIs than the official API methods.

Method Summary

Modifier and Type	Method and Description
ReactionsAddResponse	addReaction(Message message, ReactionName reactionName) Adds a reaction to a specified message.
Optional<ChannelId>	findChannelIdByName(ChannelName name) Returns ChannelId corresponding to a given channel name if exists.
Optional<ChannelName>	findChannelNameById(ChannelId channelId) Returns a channel's human readable name corresponding to a given channel id if exists.
List<Message>	findRecentMessagesByName(ChannelName name) Returns a list of messages in the channel a given name matches.
ChatPostMessageResponse	post(ChannelName channel, String text) Posts a message to a given channel.
ChatPostMessageResponse	post(ChannelName channel, String text, List<Attachment> attachments) Posts a message to a given channel.
ChatPostMessageResponse	postAsBot(ChannelName channel, String text)
ChatPostMessageResponse	postAsBot(ChannelName channel, String text, List<Attachment> attachments)
SearchAllResponse	search(String query) Returns search result by a given query.
void	updateChannelsCache() Shortcut internally has a cache for channels API response.

Method Detail

updateChannelsCache

void updateChannelsCache()
                  throws IOException,
                         SlackApiException

Shortcut internally has a cache for channels API response. This method refreshes the cache immediately.

Throws:

IOException

SlackApiException

findChannelIdByName

Optional<ChannelId> findChannelIdByName(ChannelName name)
                                 throws IOException,
                                        SlackApiException

Returns ChannelId corresponding to a given channel name if exists.

Throws:

IOException

SlackApiException

findChannelNameById

Optional<ChannelName> findChannelNameById(ChannelId channelId)

Returns a channel's human readable name corresponding to a given channel id if exists.

findRecentMessagesByName

List<Message> findRecentMessagesByName(ChannelName name)
                                throws IOException,
                                       SlackApiException

Returns a list of messages in the channel a given name matches.

Throws:

IOException

SlackApiException

addReaction

ReactionsAddResponse addReaction(Message message,
                                 ReactionName reactionName)
                          throws IOException,
                                 SlackApiException

Adds a reaction to a specified message.

Throws:

IOException

SlackApiException

search

SearchAllResponse search(String query)
                  throws IOException,
                         SlackApiException

Returns search result by a given query.

Throws:

IOException

SlackApiException

post

ChatPostMessageResponse post(ChannelName channel,
                             String text)
                      throws IOException,
                             SlackApiException

Posts a message to a given channel.

Throws:

IOException

SlackApiException

postAsBot

ChatPostMessageResponse postAsBot(ChannelName channel,
                                  String text)
                           throws IOException,
                                  SlackApiException

Throws:

IOException

SlackApiException

post

ChatPostMessageResponse post(ChannelName channel,
                             String text,
                             List<Attachment> attachments)
                      throws IOException,
                             SlackApiException

Posts a message to a given channel.

Throws:

IOException

SlackApiException

postAsBot

ChatPostMessageResponse postAsBot(ChannelName channel,
                                  String text,
                                  List<Attachment> attachments)
                           throws IOException,
                                  SlackApiException

Throws:

IOException

SlackApiException