Safe Haskell	None
Language	Haskell2010

Telegram.Bot.Simple.BotApp.Internal

Synopsis

data BotApp model action = BotApp {
- botInitialModel :: model
- botAction :: Update -> model -> Maybe action
- botHandler :: action -> model -> Eff action model
- botJobs :: [BotJob model action]
}
data BotJob model action = BotJob {
- botJobSchedule :: Text
- botJobTask :: model -> Eff action model
}
data BotEnv model action = BotEnv {
- botModelVar :: TVar model
- botActionsQueue :: TQueue (Maybe Update, action)
- botClientEnv :: ClientEnv
- botUser :: User
}
runJobTask :: BotEnv model action -> (model -> Eff action model) -> IO ()
scheduleBotJob :: BotEnv model action -> BotJob model action -> IO [ThreadId]
scheduleBotJobs :: BotEnv model action -> [BotJob model action] -> IO [ThreadId]
defaultBotEnv :: BotApp model action -> ClientEnv -> IO (BotEnv model action)
issueAction :: BotEnv model action -> Maybe Update -> Maybe action -> IO ()
processAction :: BotApp model action -> BotEnv model action -> Maybe Update -> action -> ClientM ()
processActionJob :: BotApp model action -> BotEnv model action -> ClientM ()
processActionsIndefinitely :: BotApp model action -> BotEnv model action -> IO ThreadId
startBotPolling :: BotApp model action -> BotEnv model action -> ClientM ()
startPolling :: (Update -> ClientM a) -> ClientM a

Documentation

data BotApp model action Source #

A bot application.

Constructors

BotApp
Fields botInitialModel :: model Initial bot state. botAction :: Update -> model -> Maybe action How to convert incoming `Update`s into `action`s. See Telegram.Bot.Simple.UpdateParser for some helpers. botHandler :: action -> model -> Eff action model How to handle `action`s. botJobs :: [BotJob model action] Background bot jobs.

data BotJob model action Source #

A background bot job.

Constructors

BotJob
Fields botJobSchedule :: Text Cron schedule for the job. botJobTask :: model -> Eff action model Job function.

Instances details

Functor (BotJob model) Source #
Instance details Defined in Telegram.Bot.Simple.BotApp.Internal Methods fmap :: (a -> b) -> BotJob model a -> BotJob model b # (<$) :: a -> BotJob model b -> BotJob model a #

data BotEnv model action Source #

An environment actual bot runs in.

Constructors

BotEnv
Fields botModelVar :: TVar model A transactional variable with bot's current state. botActionsQueue :: TQueue (Maybe Update, action) A queue of `action`s to process (with associated `Update`s). botClientEnv :: ClientEnv HTTP client environment (where and how exactly to make requests to Telegram Bot API). This includes `Token`. botUser :: User Information about the bot in the form of `User`.

runJobTask :: BotEnv model action -> (model -> Eff action model) -> IO () Source #

Run bot job task once.

Schedule a cron-like bot job.

scheduleBotJobs :: BotEnv model action -> [BotJob model action] -> IO [ThreadId] Source #

Schedule all bot jobs.

defaultBotEnv :: BotApp model action -> ClientEnv -> IO (BotEnv model action) Source #

Construct a default BotEnv model action for a bot.

Issue a new action for the bot to process.

processAction :: BotApp model action -> BotEnv model action -> Maybe Update -> action -> ClientM () Source #

Process one action.

processActionJob :: BotApp model action -> BotEnv model action -> ClientM () Source #

A job to wait for the next action and process it.

Process incoming actions indefinitely.

startBotPolling :: BotApp model action -> BotEnv model action -> ClientM () Source #

Start Update polling for a bot.

startPolling :: (Update -> ClientM a) -> ClientM a Source #

Start Update polling with a given update handler.