Marvin.Adapter

Documentation

data Event a

Representation for the types of events which can occur

Constructors

MessageEvent (Message a)

ChannelJoinEvent (User a) (Channel a)

ChannelLeaveEvent (User a) (Channel a)

TopicChangeEvent Text (Channel a)

Instances

HasCustoms (Handlers a0) (Vector (Event a0 -> Maybe (RunnerM ())))

Methods

customs :: Lens' (Handlers a0) (Vector (Event a0 -> Maybe (RunnerM ())))

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

type EventHandler a = Event a -> 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

Associated Types

type User a

type Channel a

Methods

adapterId :: AdapterId a

Used for scoping config and logging

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

Post a message to a channel given the internal channel identifier

runWithAdapter :: RunWithAdapter a

Initialize and run the bot

getUsername :: a -> User a -> RunnerM Text

Resolve a username given the internal user identifier

getChannelName :: a -> Channel a -> RunnerM Text

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

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

Resolve to the internal channel identifier given a human readable name

Instances

MkSlack a => IsAdapter (SlackAdapter a)

Associated Types

type User (SlackAdapter a) :: *

type Channel (SlackAdapter a) :: *

Methods

adapterId :: AdapterId (SlackAdapter a)

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

runWithAdapter :: RunWithAdapter (SlackAdapter a)

getUsername :: SlackAdapter a -> User (SlackAdapter a) -> RunnerM Text

getChannelName :: SlackAdapter a -> Channel (SlackAdapter a) -> RunnerM Text

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

MkTelegram a => IsAdapter (TelegramAdapter a)

Associated Types

type User (TelegramAdapter a) :: *

type Channel (TelegramAdapter a) :: *

Methods

adapterId :: AdapterId (TelegramAdapter a)

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

runWithAdapter :: RunWithAdapter (TelegramAdapter a)

getUsername :: TelegramAdapter a -> User (TelegramAdapter a) -> RunnerM Text

getChannelName :: TelegramAdapter a -> Channel (TelegramAdapter a) -> RunnerM Text

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

data AdapterId a

A type, basically a String, which identifies an adapter to the config and the logging facilities.

Instances

Eq (AdapterId a)

Methods

(==) :: AdapterId a -> AdapterId a -> Bool

(/=) :: AdapterId a -> AdapterId a -> Bool

Show (AdapterId a)

Methods

showsPrec :: Int -> AdapterId a -> ShowS

show :: AdapterId a -> String

showList :: [AdapterId a] -> ShowS

IsString (AdapterId a)

Methods

fromString :: String -> AdapterId a

ShowT (AdapterId a)

Methods

showT :: AdapterId a -> Text

showListT :: [AdapterId a] -> Text

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