Safe Haskell	Safe-Inferred

Network.Haskbot.Types

Contents

Slack types
Native types
- Channel

Description

This provides wrappers for the various types of data supplied by the Slack API, so that any processing of the API data remains type-safe. No constructors are directly exported to allow for flexibility with the currently-beta Slack API.

Synopsis

Slack types

Token

data Token Source

Instances

Eq Token
Show Token

getToken :: Token -> Text Source

get the text of a token

setToken :: Text -> Token Source

make a token of the given text

Team ID

data TeamID Source

Instances

Eq TeamID
Show TeamID

getTeamID :: TeamID -> Text Source

get the text value of a team ID

setTeamID :: Text -> TeamID Source

make a team ID of the given text value

Channel ID

data ChannelID Source

Instances

Eq ChannelID
Show ChannelID

getChanID :: ChannelID -> Text Source

get the text value of a channel ID

setChanID :: Text -> ChannelID Source

make a channel ID of the given text value

Channel name

data ChannelName Source

Instances

Eq ChannelName
Show ChannelName

getChanName :: ChannelName -> Text Source

get the text value of a channel name

getPoundChan :: ChannelName -> Text Source

get the text value of a channel name, prefixed with a #

setChanName :: Text -> ChannelName Source

make a channel name of the given text value

User ID

data UserID Source

Instances

Eq UserID
Show UserID

getUserID :: UserID -> Text Source

get the text value of a user ID

setUserID :: Text -> UserID Source

make a user ID of the given text value

User name

data UserName Source

Instances

Eq UserName
Show UserName

getUserName :: UserName -> Text Source

get the text value of a username

getAtUserName :: UserName -> Text Source

get the text value of a username prefixed with a @

setUserName :: Text -> UserName Source

make a username of given text value

Command

data Command Source

Instances

Eq Command
Show Command

getCommand :: Command -> Text Source

get the text name of a command

getSlashCom :: Command -> Text Source

get the text name of a command prefixed with a /

setCommand :: Text -> Command Source

make a command with the given name

Native types

Channel

data Channel Source

Slack channels are either regular channels or direct messages to users

Constructors

DirectMsg !UserName
Channel !ChannelName

Instances

Eq Channel
Show Channel

getAddress :: Channel -> Text Source

Get the text representation of a channel, with the appropriate prefix required by Slack