Marvin.Internal.Types

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 EventHandler a = Event a -> IO ()

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

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

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)))

newtype User' a

Constructors

User'

Fields

• unwrapUser' :: User a

Instances

HasLeaves (Handlers a0) (Vector ((User' a0, Channel' a0) -> RunnerM ()))

Methods

leaves :: Lens' (Handlers a0) (Vector ((User' a0, Channel' a0) -> RunnerM ()))

HasJoins (Handlers a0) (Vector ((User' a0, Channel' a0) -> RunnerM ()))

Methods

joins :: Lens' (Handlers a0) (Vector ((User' a0, Channel' a0) -> RunnerM ()))

HasLeavesFrom (Handlers a0) (HashMap Text (Vector ((User' a0, Channel' a0) -> RunnerM ())))

Methods

leavesFrom :: Lens' (Handlers a0) (HashMap Text (Vector ((User' a0, Channel' a0) -> RunnerM ())))

HasJoinsIn (Handlers a0) (HashMap Text (Vector ((User' a0, Channel' a0) -> RunnerM ())))

Methods

joinsIn :: Lens' (Handlers a0) (HashMap Text (Vector ((User' a0, Channel' a0) -> RunnerM ())))

Get (b, Message a) (User' a)

Methods

getLens :: Lens' (b, Message a) (User' a)

Get (User' a, b) (User' a)

Methods

getLens :: Lens' (User' a, b) (User' a)

newtype Channel' a

Constructors

Channel'

Fields

• unwrapChannel' :: Channel a

Instances

HasTopicChange (Handlers a0) (Vector ((Topic, Channel' a0) -> RunnerM ()))

Methods

topicChange :: Lens' (Handlers a0) (Vector ((Topic, Channel' a0) -> RunnerM ()))

HasLeaves (Handlers a0) (Vector ((User' a0, Channel' a0) -> RunnerM ()))

Methods

leaves :: Lens' (Handlers a0) (Vector ((User' a0, Channel' a0) -> RunnerM ()))

HasJoins (Handlers a0) (Vector ((User' a0, Channel' a0) -> RunnerM ()))

Methods

joins :: Lens' (Handlers a0) (Vector ((User' a0, Channel' a0) -> RunnerM ()))

HasTopicChangeIn (Handlers a0) (HashMap Text (Vector ((Topic, Channel' a0) -> RunnerM ())))

Methods

topicChangeIn :: Lens' (Handlers a0) (HashMap Text (Vector ((Topic, Channel' a0) -> RunnerM ())))

HasLeavesFrom (Handlers a0) (HashMap Text (Vector ((User' a0, Channel' a0) -> RunnerM ())))

Methods

leavesFrom :: Lens' (Handlers a0) (HashMap Text (Vector ((User' a0, Channel' a0) -> RunnerM ())))

HasJoinsIn (Handlers a0) (HashMap Text (Vector ((User' a0, Channel' a0) -> RunnerM ())))

Methods

joinsIn :: Lens' (Handlers a0) (HashMap Text (Vector ((User' a0, Channel' a0) -> RunnerM ())))

Get (b, Message a) (Channel' a)

Methods

getLens :: Lens' (b, Message a) (Channel' a)

Get (b, Channel' a) (Channel' a)

Methods

getLens :: Lens' (b, Channel' a) (Channel' a)

newtype TimeStamp

Constructors

TimeStamp

Fields

• unwrapTimeStamp :: Double

Instances

Show TimeStamp

Methods

showsPrec :: Int -> TimeStamp -> ShowS

show :: TimeStamp -> String

showList :: [TimeStamp] -> ShowS

ToJSON TimeStamp

Methods

toJSON :: TimeStamp -> Value

toEncoding :: TimeStamp -> Encoding

FromJSON TimeStamp

Methods

parseJSON :: Value -> Parser TimeStamp

data Message a

contents and meta information of a recieved message

Constructors

Message

Fields

• sender :: User a
• channel :: Channel a
• content :: Text
• timestamp :: TimeStamp

Instances

HasResponds (Handlers a0) (Vector (Regex, Match -> Message a0 -> RunnerM ()))

Methods

responds :: Lens' (Handlers a0) (Vector (Regex, Match -> Message a0 -> RunnerM ()))

HasHears (Handlers a0) (Vector (Regex, Match -> Message a0 -> RunnerM ()))

Methods

hears :: Lens' (Handlers a0) (Vector (Regex, Match -> Message a0 -> RunnerM ()))

Get (b, Message a) (User' a)

Methods

getLens :: Lens' (b, Message a) (User' a)

Get (b, Message a) (Channel' a)

Methods

getLens :: Lens' (b, Message a) (Channel' a)

Get (b, Message a) (Message a)

Methods

getLens :: Lens' (b, Message a) (Message a)

newtype ScriptId

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

Constructors

ScriptId

Fields

• unwrapScriptId :: Text

Instances

Eq ScriptId

Methods

(==) :: ScriptId -> ScriptId -> Bool

(/=) :: ScriptId -> ScriptId -> Bool

Show ScriptId

Methods

showsPrec :: Int -> ScriptId -> ShowS

show :: ScriptId -> String

showList :: [ScriptId] -> ShowS

IsString ScriptId

Methods

fromString :: String -> ScriptId

ShowT ScriptId

Methods

showT :: ScriptId -> Text

showListT :: [ScriptId] -> Text

HasScriptId (Script a0) ScriptId

Methods

scriptId :: Lens' (Script a0) ScriptId

HasScriptId (BotActionState a0 d0) ScriptId

Methods

scriptId :: Lens' (BotActionState a0 d0) ScriptId

newtype AdapterId a

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

Constructors

AdapterId

Fields

• unwrapAdapterId :: Text

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

applicationScriptId :: ScriptId

type RunnerM = LoggingT IO

verifyIdString :: String -> (String -> a) -> String -> a

class HasScriptId s a | s -> a where

Minimal complete definition

scriptId

Methods

scriptId :: Lens' s a

Instances

HasScriptId (Script a0) ScriptId

Methods

scriptId :: Lens' (Script a0) ScriptId

HasScriptId (BotActionState a0 d0) ScriptId

Methods

scriptId :: Lens' (BotActionState a0 d0) ScriptId

class (IsScript m, MonadIO m) => HasConfigAccess m where

Denotes a place from which we may access the configuration.

During script definition or when handling a request we can obtain the config with getConfigVal or requireConfigVal.

Minimal complete definition

getConfigInternal

Methods

getConfigInternal :: m Config

INTERNAL USE WITH CARE

Obtain the entire config structure

Instances

HasConfigAccess (ScriptDefinition a)

Methods

getConfigInternal :: ScriptDefinition a Config

HasConfigAccess (BotReacting a b)

Methods

getConfigInternal :: BotReacting a b Config

class IsScript m where

Minimal complete definition

getScriptId

Methods

getScriptId :: m ScriptId

Instances

IsScript (ScriptDefinition a)

Methods

getScriptId :: ScriptDefinition a ScriptId

IsScript (BotReacting a b)

Methods

getScriptId :: BotReacting a b ScriptId

Orphan instances

Configured LogLevel

Methods

convert :: Value -> Maybe LogLevel

convertList :: Value -> Maybe [LogLevel]