Network.IRC.Fun.Bot.State

This module provides access functions for working with the state stored within a bot session.

Documentation

askConfig :: Session e s Config

Fetch the bot configuration.

askConfigS :: (Config -> a) -> Session e s a

Retrieve a function of the bot configuration.

askBehavior :: Session e s (Behavior e s)

Fetch the bot behavior definition.

askBehaviorS :: (Behavior e s -> a) -> Session e s a

Retrieve a function of the bot behavior definition.

askTimeGetter :: Session e s (IO (UTCTime, String))

Fetch the time getter. The actual time data is cached and updated at most once per second depending on need. You can safely use it at any frequency withou overloading IO and time formatting.

The second item is a formatted time string in the form 2015-09-01 18:10:00, and is always expressed in UTC.

askEnv :: Session e s e

Fetch the bot environment, i.e. read-only state.

askEnvS :: (e -> a) -> Session e s a

Retrieve a function of the bot environment.

getState :: Session e s s

Fetch the current value of the state within the session.

getStateS :: (s -> a) -> Session e s a

Get a specific component of the state, using a projection function supplied.

putState :: s -> Session e s ()

Set the state within the session.

modifyState :: (s -> s) -> Session e s ()

Update the state to the result of applying a function to the current state.

getChannelState :: Session e s (HashMap String (Bool, Bool))

Get channel state information, in the form of a mapping from channel names to their data.

Channel data is a pair of two booleans. The first says whether channel tracking is enabled. The second says whether channel logging info a file is enabled.

selectChannel :: String -> Session e s ()

Add a channel to the persistent list of channels to be joined. Next time the bot launches (or, say, joinConfig is called), it will join this channel. If the channel is already listed, nothing happens.

unselectChannel :: String -> Session e s ()

Remove a channel from the persistent list of channels to be joined. Next time the bot launches, it won't join this channel (unless listed in the config or otherwise requested). If the channel isn't listed, nothing happens.

channelSelected :: String -> Session e s Bool

Check whether a channel is listed in persistent state to be joined.

botMemberOf :: String -> Session e s Bool

Check whether, as far as the bot knows, if it currently a member of the given channel. Currently kicks, bans, etc. are fully tracked, therefore this information isn't 100% accurate, but if you aren't planning to ban your bot you can probably rely on it.

addChannelState :: String -> Session e s ()

Add default channel state for the given channel. It will be stored into the state file. If the channel already has state, nothing will happen.

saveBotState :: Session e s ()