Network.Linklater

Here's a /jpgto bot! If you run this program and then tell Slack about your server (incoming hook and custom slash command) and then type /jpgto baby corgi in one of your channels, you'll get the image from http://baby.corgi.jpg.to.

https://github.com/hlian/linklater/blob/master/examples/JointPhotographicExpertsGroupTonga.hs

One /jpgto baby corgi, et voila.

Types

data Channel

Where slash commands come from and where Messages go.

Constructors

Channel !ChannelID !Text

Instances

Eq Channel

Methods

(==) :: Channel -> Channel -> Bool

(/=) :: Channel -> Channel -> Bool

Ord Channel

Methods

compare :: Channel -> Channel -> Ordering

(<) :: Channel -> Channel -> Bool

(<=) :: Channel -> Channel -> Bool

(>) :: Channel -> Channel -> Bool

(>=) :: Channel -> Channel -> Bool

max :: Channel -> Channel -> Channel

min :: Channel -> Channel -> Channel

Show Channel

Methods

showsPrec :: Int -> Channel -> ShowS

show :: Channel -> String

showList :: [Channel] -> ShowS

ToJSON Channel

Methods

toJSON :: Channel -> Value

toEncoding :: Channel -> Encoding

toJSONList :: [Channel] -> Value

toEncodingList :: [Channel] -> Encoding

newtype User

A username: no at-signs, just text!

Constructors

User Text

Instances

Eq User

Methods

(==) :: User -> User -> Bool

(/=) :: User -> User -> Bool

Ord User

Methods

compare :: User -> User -> Ordering

(<) :: User -> User -> Bool

(<=) :: User -> User -> Bool

(>) :: User -> User -> Bool

(>=) :: User -> User -> Bool

max :: User -> User -> User

min :: User -> User -> User

Show User

Methods

showsPrec :: Int -> User -> ShowS

show :: User -> String

showList :: [User] -> ShowS

data Message

Here's how you talk: you make one of these and pass it to say. Before the day is done, Linklater will convert this to a JSON blob using Aeson.

• Simple messages are parsed by Slack with parse=full (i.e. as if you had typed it into the input box).
• Complex messages are parsed according to Slack formatting. See Format.

Constructors

SimpleMessage !Icon !Text !Channel !Text

FormattedMessage !Icon !Text !Channel ![Format]

Instances

ToJSON Message

Methods

toJSON :: Message -> Value

toEncoding :: Message -> Encoding

toJSONList :: [Message] -> Value

toEncodingList :: [Message] -> Encoding

data Config

Like a curiosity about the world, you'll need one of these to say something.

Constructors

Config

Fields

• _configHookURL :: !Text

  This is the incoming web hook URL that Slack gave you. It's usually https://hooks.slack.com/services/....

data Command

Incoming HTTP requests to the slash function get parsed into one of these babies.

Constructors

Command

Fields

• _commandName :: !Text

  The command name.

• _commandUser :: !User

  Who ran your slash command.

• _commandChannel :: !Channel

  Where the person ran your slash command.

• _commandText :: !(Maybe Text)

  Text for the slash command, if any.

Instances

Eq Command

Methods

(==) :: Command -> Command -> Bool

(/=) :: Command -> Command -> Bool

Ord Command

Methods

compare :: Command -> Command -> Ordering

(<) :: Command -> Command -> Bool

(<=) :: Command -> Command -> Bool

(>) :: Command -> Command -> Bool

(>=) :: Command -> Command -> Bool

max :: Command -> Command -> Command

min :: Command -> Command -> Command

Show Command

Methods

showsPrec :: Int -> Command -> ShowS

show :: Command -> String

showList :: [Command] -> ShowS

newtype Icon

The icon next to the messages you say. (Images unsupported right now, sorry.)

Constructors

EmojiIcon Text

For example, ":stars2:".

Instances

Eq Icon

Methods

(==) :: Icon -> Icon -> Bool

(/=) :: Icon -> Icon -> Bool

Ord Icon

Methods

compare :: Icon -> Icon -> Ordering

(<) :: Icon -> Icon -> Bool

(<=) :: Icon -> Icon -> Bool

(>) :: Icon -> Icon -> Bool

(>=) :: Icon -> Icon -> Bool

max :: Icon -> Icon -> Icon

min :: Icon -> Icon -> Icon

Show Icon

Methods

showsPrec :: Int -> Icon -> ShowS

show :: Icon -> String

showList :: [Icon] -> ShowS

data Format

A little DSL for Slack formatting.

Constructors

FormatAt !User

"<@user|user>"

FormatUser !User !Text

"<@user|user did this and that>"

FormatLink !Text !Text

"<http://example.com|user did this and that>"

FormatString !Text

"user did this & that"

API calls

say :: (MonadError RequestError m, MonadIO m) => Message -> Config -> m ()

I POST a Message to Slack and return the HTTP response. However, I need a Config (containing an incoming hook configured through Slack administration) first.

Guaranted to not throw an unchecked exception.

startRTM :: (MonadError RequestError m, MonadIO m) => APIToken -> m URI

I GET a WebSocket URI from Slack's real-time messaging endpoint. However, I need an APIToken (configured through Slack administration) first.

Guaranted to not throw an unchecked exception.

startRTMWithOptions :: (MonadError RequestError m, MonadIO m) => Options -> m URI

HTTP bot servers

slash :: (Command -> Application) -> Application

A bot server! As if by magic. This acts like a WAI middleware: Linklater wraps around your application. (Really, it just gives you a Command to work with instead of a raw HTTP request.)

slashSimple :: (Command -> IO Text) -> Application

A bot server for people who are in a hurry. Make a function that takes a Command and returns some Text in IO world, and we'll convert it into a WAI application. If you want more control over the request and respond, see slash.