Marvin.Adapter

Documentation

data Event a

Representation for the types of events which can occur

Constructors

MessageEvent (User a) (Channel a) Message TimeStamp

CommandEvent (User a) (Channel a) Message TimeStamp

ChannelJoinEvent (User a) (Channel a) TimeStamp

ChannelLeaveEvent (User a) (Channel a) TimeStamp

TopicChangeEvent (User a) (Channel a) Topic TimeStamp

Instances

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

Methods

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

type RunWithAdapter a = EventHandler a -> AdapterM a ()

type EventHandler a = Event a -> IO ()

type RunnerM = LoggingT IO

class IsAdapter a where

Basic functionality required of any adapter

Minimal complete definition

adapterId, messageChannel, initAdapter, runWithAdapter, getUsername, getChannelName, resolveChannel

Associated Types

type User a

type Channel a

Methods

adapterId :: AdapterId a

Used for scoping config and logging

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

Post a message to a channel given the internal channel identifier

initAdapter :: RunnerM a

Initialize the adapter state

runWithAdapter :: RunWithAdapter a

Initialize and run the bot

getUsername :: User a -> AdapterM a Text

Resolve a username given the internal user identifier

getChannelName :: Channel a -> AdapterM a Text

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

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

Resolve to the internal channel identifier given a human readable name

Instances

IsAdapter ShellAdapter

Associated Types

type User ShellAdapter :: *

type Channel ShellAdapter :: *

Methods

adapterId :: AdapterId ShellAdapter

messageChannel :: Channel ShellAdapter -> Text -> AdapterM ShellAdapter ()

initAdapter :: RunnerM ShellAdapter

runWithAdapter :: RunWithAdapter ShellAdapter

getUsername :: User ShellAdapter -> AdapterM ShellAdapter Text

getChannelName :: Channel ShellAdapter -> AdapterM ShellAdapter Text

resolveChannel :: Text -> AdapterM ShellAdapter (Maybe (Channel ShellAdapter))

MkTelegram a => IsAdapter (TelegramAdapter a)

Associated Types

type User (TelegramAdapter a) :: *

type Channel (TelegramAdapter a) :: *

Methods

adapterId :: AdapterId (TelegramAdapter a)

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

initAdapter :: RunnerM (TelegramAdapter a)

runWithAdapter :: RunWithAdapter (TelegramAdapter a)

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

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

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

MkSlack a => IsAdapter (SlackAdapter a)

Associated Types

type User (SlackAdapter a) :: *

type Channel (SlackAdapter a) :: *

Methods

adapterId :: AdapterId (SlackAdapter a)

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

initAdapter :: RunnerM (SlackAdapter a)

runWithAdapter :: RunWithAdapter (SlackAdapter a)

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

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

resolveChannel :: Text -> AdapterM (SlackAdapter a) (Maybe (Channel (SlackAdapter 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

lookupFromAdapterConfig :: (IsAdapter a, Configured v) => Name -> AdapterM a (Maybe v)

requireFromAdapterConfig :: (IsAdapter a, Configured v) => Name -> AdapterM a v

lookupFromAppConfig :: Configured v => Name -> AdapterM a (Maybe v)

requireFromAppConfig :: Configured v => Name -> AdapterM a v

getAdapterConfig :: forall a. IsAdapter a => AdapterM a Config

getAppConfig :: AdapterM a Config

liftAdapterAction :: (MonadIO m, HasConfigAccess m, AccessAdapter m, IsAdapter a, a ~ AdapterT m) => AdapterM a r -> m r