Marvin.Adapter

Documentation

data Event

Representation for the types of events which can occur

Constructors

MessageEvent Message

ChannelJoinEvent User Channel

ChannelLeaveEvent User Channel

TopicChangeEvent Text Channel

type RunWithAdapter a = Config -> InitEventHandler a -> RunnerM ()

type EventHandler a = Event -> IO ()

type InitEventHandler a = a -> IO (EventHandler a)

type RunnerM = LoggingT IO

class IsAdapter a where

Basic functionality required of any adapter

Minimal complete definition

adapterId, messageChannel, runWithAdapter, getUsername, getChannelName, resolveChannel

Methods

adapterId :: AdapterId a

Used for scoping config and logging

messageChannel :: a -> Channel -> Text -> RunnerM ()

Post a message to a channel given the internal channel identifier

runWithAdapter :: RunWithAdapter a

Initialize and run the bot

getUsername :: a -> User -> RunnerM Text

Resolve a username given the internal user identifier

getChannelName :: a -> Channel -> RunnerM Text

Resolve the human readable name for a channel given the internal channel identifier

resolveChannel :: a -> Text -> RunnerM (Maybe Channel)

Resolve to the internal channel identifier given a human readable name

Instances

IsAdapter SlackRTMAdapter

Methods

adapterId :: AdapterId SlackRTMAdapter

messageChannel :: SlackRTMAdapter -> Channel -> Text -> RunnerM ()

runWithAdapter :: RunWithAdapter SlackRTMAdapter

getUsername :: SlackRTMAdapter -> User -> RunnerM Text

getChannelName :: SlackRTMAdapter -> Channel -> RunnerM Text

resolveChannel :: SlackRTMAdapter -> Text -> RunnerM (Maybe Channel)

liftAdapterAction :: MonadIO m => RunnerM a -> m a