Documentation

The contents of a recieved message

An abstract type describing a marvin script.

This is basically a collection of event handlers.

Internal structure is exposed for people wanting to extend this.

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

For conversion please use mkScriptId and unwrapScriptId. They will perform necessary checks.

Attempt to create a script id from Text

Script id sed for the bot itself

Similar to AccessAdapter, this class says there is a ScriptId reachable from the type (usually a monad) m.

Retrieve the script id out of m, ususally a monad.

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.

A timestamp type. Supplied with most Event types

Similar to IsScript, this class says that there is an adapter AdapterT available from this type (usually a monad) m.

The type of adapter depends on the monad itself. This class can be thought of as MonadReader specified to AdapterT.

Wrapping type for users. Only used to enable Get typeclass instances.

Wrapping type for channels. Only used to enable Get typeclass instances.

Class which says that there is a way to get to b from this type a.

This typeclass is used to allow handlers with different types of payload to share common accessor functions such as getUser and getMessage.

The instances specify for each type of payload which pieces of data can be extracted and how.

Representation for the types of events which can occur

Basic monad which most internal actions run in