Web.Slack

Documentation

data SlackConfig

Implements the HasManager and HasToken typeclasses.

Constructors

SlackConfig

Fields

• slackConfigManager :: Manager
• slackConfigToken :: Text

Instances

HasToken SlackConfig

Defined in Web.Slack

Methods

getToken :: SlackConfig -> Text

HasManager SlackConfig

Defined in Web.Slack

Methods

getManager :: SlackConfig -> Manager

mkSlackConfig :: Text -> IO SlackConfig

Prepare a SlackConfig from a slack token. You can then call the other functions providing this in a reader context.

apiTest :: (MonadReader env m, HasManager env, MonadIO m) => TestReq -> m (Response TestRsp)

Check API calling code.

https://api.slack.com/methods/api.test

authTest :: (MonadReader env m, HasManager env, HasToken env, MonadIO m) => m (Response TestRsp)

Check authentication and identity.

https://api.slack.com/methods/auth.test

chatPostMessage :: (MonadReader env m, HasManager env, HasToken env, MonadIO m) => PostMsgReq -> m (Response PostMsgRsp)

Send a message to a channel.

https://api.slack.com/methods/chat.postMessage

channelsCreate :: (MonadReader env m, HasManager env, HasToken env, MonadIO m) => CreateReq -> m (Response CreateRsp)

Create a channel.

https://api.slack.com/methods/channels.create

channelsList :: (MonadReader env m, HasManager env, HasToken env, MonadIO m) => ListReq -> m (Response ListRsp)

Retrieve channel list.

https://api.slack.com/methods/channels.list

channelsHistory :: (MonadReader env m, HasManager env, HasToken env, MonadIO m) => HistoryReq -> m (Response HistoryRsp)

Retrieve channel history. Consider using historyFetchAll in combination with this function

https://api.slack.com/methods/channels.history

groupsHistory :: (MonadReader env m, HasManager env, HasToken env, MonadIO m) => HistoryReq -> m (Response HistoryRsp)

This method returns a portion of messages/events from the specified private channel. To read the entire history for a private channel, call the method with no latest or oldest arguments, and then continue paging. Consider using historyFetchAll in combination with this function

https://api.slack.com/methods/groups.history

groupsList :: (MonadReader env m, HasManager env, HasToken env, MonadIO m) => m (Response ListRsp)

This method returns a list of private channels in the team that the caller is in and archived groups that the caller was in. The list of (non-deactivated) members in each private channel is also returned.

https://api.slack.com/methods/groups.list

historyFetchAll

Arguments

:: (MonadReader env m, HasManager env, HasToken env, MonadIO m)

=> (HistoryReq -> m (Response HistoryRsp))

The request to make. Can be for instance mpimHistory, channelsHistory...

-> Text

The channel name to query

-> Int

The number of entries to fetch at once.

-> SlackTimestamp

The oldest timestamp to fetch records from

-> SlackTimestamp

The newest timestamp to fetch records to

-> m (Response HistoryRsp)

A list merging all the history records that were fetched through the individual queries.

Fetch all history items between two dates. The basic calls channelsHistory, groupsHistory, imHistory and so on may not return exhaustive results if there were too many records. You need to use historyRspHasMore to find out whether you got all the data.

This function will repeatedly call the underlying history function until all the data is fetched or until a call fails, merging the messages obtained from each call.

imHistory :: (MonadReader env m, HasManager env, HasToken env, MonadIO m) => HistoryReq -> m (Response HistoryRsp)

Retrieve direct message channel history. Consider using historyFetchAll in combination with this function

https://api.slack.com/methods/im.history

imList :: (MonadReader env m, HasManager env, HasToken env, MonadIO m) => m (Response ListRsp)

Returns a list of all direct message channels that the user has

https://api.slack.com/methods/im.list

mpimList :: (MonadReader env m, HasManager env, HasToken env, MonadIO m) => m (Response ListRsp)

Returns a list of all multiparty direct message channels that the user has

https://api.slack.com/methods/mpim.list

mpimHistory :: (MonadReader env m, HasManager env, HasToken env, MonadIO m) => HistoryReq -> m (Response HistoryRsp)

Retrieve multiparty direct message channel history. Consider using historyFetchAll in combination with this function

https://api.slack.com/methods/mpim.history

getUserDesc

Arguments

:: (UserId -> Text)

A function to give a default username in case the username is unknown

-> ListRsp

List of users as known by the slack server. See usersList.

-> UserId -> Text

A function from UserId to username.

Returns a function to get a username from a UserId. Comes in handy to use messageToHtml

usersList :: (MonadReader env m, HasManager env, HasToken env, MonadIO m) => m (Response ListRsp)

This method returns a list of all users in the team. This includes deleted/deactivated users.

https://api.slack.com/methods/users.list

authenticateReq :: Text -> Request -> Request

type Response a = Either SlackClientError a

class HasManager a where

Methods

getManager :: a -> Manager

Instances

HasManager SlackConfig

Defined in Web.Slack

Methods

getManager :: SlackConfig -> Manager

class HasToken a where

Methods

getToken :: a -> Text

Instances

HasToken SlackConfig

Defined in Web.Slack

Methods

getToken :: SlackConfig -> Text