Marvin.Run

Documentation

runMarvin :: forall a. IsAdapter a => [ScriptInit a] -> IO ()

Runs the marvin bot using whatever method the adapter uses.

data ScriptInit a

Initializer for a script. This gets run by the server during startup and creates a Script

class IsAdapter a

Basic functionality required of any adapter

Minimal complete definition

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

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

resolveUser :: Text -> AdapterM ShellAdapter (Maybe (User 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)))

resolveUser :: Text -> AdapterM (TelegramAdapter a) (Maybe (User (TelegramAdapter a)))

requireFromAppConfig :: Configured a => Config -> Name -> IO a

Retrieve a value from the application config, given the whole config structure. Fails if value not parseable as a or not present.

lookupFromAppConfig :: Configured a => Config -> Name -> IO (Maybe a)

Retrieve a value from the application config, given the whole config structure. Returns Nothing if value not parseable as a or not present.

defaultConfigName :: FilePath

Default name for the config file