Web.Slack

This module exposes functionality to write bots which responds to Events sent by the RTM API. By using the user state parameter s complicated interactions can be established.

This basic example echos every message the bot recieves. Other examples can be found in the examples directory.

myConfig :: SlackConfig
myConfig = SlackConfig
        { _slackApiToken = "..." -- Specify your API token here
        }

-- type SlackBot s = Event -> Slack s ()
echoBot :: SlackBot ()
echoBot (Message cid _ msg _ _ _) = sendMessage cid msg
echoBot _ = return ()

main :: IO ()
main = runBot myConfig echoBot ()

Documentation

runBot :: forall s. SlackConfig -> SlackBot s -> s -> IO ()

Run a SlackBot. The supplied bot will respond to all events sent by the Slack RTM API.

Be warned that this function will throw an IOError if the connection to the Slack API fails.

newtype Slack s a

Constructors

Slack

Fields

• runSlack :: StateT (SlackState s) IO a

Instances

Monad (Slack s)

Methods

(>>=) :: Slack s a -> (a -> Slack s b) -> Slack s b

(>>) :: Slack s a -> Slack s b -> Slack s b

return :: a -> Slack s a

fail :: String -> Slack s a

Functor (Slack s)

Methods

fmap :: (a -> b) -> Slack s a -> Slack s b

(<$) :: a -> Slack s b -> Slack s a

Applicative (Slack s)

Methods

pure :: a -> Slack s a

(<*>) :: Slack s (a -> b) -> Slack s a -> Slack s b

(*>) :: Slack s a -> Slack s b -> Slack s b

(<*) :: Slack s a -> Slack s b -> Slack s a

MonadIO (Slack s)

Methods

liftIO :: IO a -> Slack s a

MonadState (SlackState s) (Slack s)

Methods

get :: Slack s (SlackState s)

put :: SlackState s -> Slack s ()

state :: (SlackState s -> (a, SlackState s)) -> Slack s a

type SlackBot s = Event -> Slack s ()

data SlackState s

Constructors

SlackState

Fields

• _meta :: Metainfo

  Information about the connection

• _session :: SlackSession

  Information about the session at the start of the connection

• _userState :: s

  User defined state

• _config :: SlackConfig

  A copy of the initial configuration

Instances

Show s => Show (SlackState s)

Methods

showsPrec :: Int -> SlackState s -> ShowS

show :: SlackState s -> String

showList :: [SlackState s] -> ShowS

MonadState (SlackState s) (Slack s)

Methods

get :: Slack s (SlackState s)

put :: SlackState s -> Slack s ()

state :: (SlackState s -> (a, SlackState s)) -> Slack s a

userState :: forall s s. Lens (SlackState s) (SlackState s) s s

session :: forall s. Lens' (SlackState s) SlackSession

module Web.Slack.Types

data SlackConfig

Configuration options needed to connect to the Slack API

Constructors

SlackConfig

Fields

• _slackApiToken :: String

  API Token for Bot

Instances

Show SlackConfig

Methods

showsPrec :: Int -> SlackConfig -> ShowS

show :: SlackConfig -> String

showList :: [SlackConfig] -> ShowS