com.github.seratch.jslack.shortcut.impl

Class ShortcutImpl

java.lang.Object

com.github.seratch.jslack.shortcut.impl.ShortcutImpl

All Implemented Interfaces:

Shortcut

public class ShortcutImpl
extends Object
implements Shortcut

Constructor Summary

Constructors

Constructor and Description
ShortcutImpl(Slack slack)
ShortcutImpl(Slack slack, ApiToken apiToken)

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.
List<Message>	findRecentMessagesByName(ChannelName name, int limit)
ChatPostMessageResponse	post(ChannelName channel, List<LayoutBlock> blocks) Posts a message to a given channel.
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, List<LayoutBlock> blocks)
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ShortcutImpl

public ShortcutImpl(Slack slack)

ShortcutImpl

public ShortcutImpl(Slack slack,
                    ApiToken apiToken)

Method Detail

findChannelIdByName

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

Description copied from interface: Shortcut

Returns ChannelId corresponding to a given channel name if exists.

Specified by:

findChannelIdByName in interface Shortcut

Throws:

IOException

SlackApiException

findChannelNameById

public Optional<ChannelName> findChannelNameById(ChannelId channelId)

Description copied from interface: Shortcut

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

Specified by:

findChannelNameById in interface Shortcut

findRecentMessagesByName

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

Description copied from interface: Shortcut

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

Specified by:

findRecentMessagesByName in interface Shortcut

Throws:

IOException

SlackApiException

findRecentMessagesByName

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

Specified by:

findRecentMessagesByName in interface Shortcut

Throws:

IOException

SlackApiException

addReaction

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

Description copied from interface: Shortcut

Adds a reaction to a specified message.

Specified by:

addReaction in interface Shortcut

Throws:

IOException

SlackApiException

search

public SearchAllResponse search(String query)
                         throws IOException,
                                SlackApiException

Description copied from interface: Shortcut

Returns search result by a given query.

Specified by:

search in interface Shortcut

Throws:

IOException

SlackApiException

post

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

Description copied from interface: Shortcut

Posts a message to a given channel.

Specified by:

post in interface Shortcut

Throws:

IOException

SlackApiException

postAsBot

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

Specified by:

postAsBot in interface Shortcut

Throws:

IOException

SlackApiException

post

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

Description copied from interface: Shortcut

Posts a message to a given channel.

Specified by:

post in interface Shortcut

Throws:

IOException

SlackApiException

postAsBot

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

Specified by:

postAsBot in interface Shortcut

Throws:

IOException

SlackApiException

post

public ChatPostMessageResponse post(ChannelName channel,
                                    List<LayoutBlock> blocks)
                             throws IOException,
                                    SlackApiException

Description copied from interface: Shortcut

Posts a message to a given channel.

Specified by:

post in interface Shortcut

Throws:

IOException

SlackApiException

postAsBot

public ChatPostMessageResponse postAsBot(ChannelName channel,
                                         List<LayoutBlock> blocks)
                                  throws IOException,
                                         SlackApiException

Specified by:

postAsBot in interface Shortcut

Throws:

IOException

SlackApiException

updateChannelsCache

public void updateChannelsCache()
                         throws IOException,
                                SlackApiException

Description copied from interface: Shortcut

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

Specified by:

updateChannelsCache in interface Shortcut

Throws:

IOException

SlackApiException