Telegram.Bot.Simple.BotApp.Internal

Documentation

data BotApp model action

A bot application.

Constructors

BotApp

Fields

• botInitialModel :: model

  Initial bot state.

• botAction :: Update -> model -> Maybe action

  How to convert incoming Updates into actions. See Telegram.Bot.Simple.UpdateParser for some helpers.

• botHandler :: action -> model -> Eff action model

  How to handle actions.

• botJobs :: [BotJob model action]

  Background bot jobs.

data BotJob model action

A background bot job.

Constructors

BotJob

Fields

• botJobSchedule :: Text

  Cron schedule for the job.

• botJobTask :: model -> Eff action model

  Job function.

Instances

Functor (BotJob model)

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

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 actions to process (with associated Updates).

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

Run bot job task once.

scheduleBotJob :: BotEnv model action -> BotJob model action -> IO [ThreadId]

Schedule a cron-like bot job.

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

Schedule all bot jobs.

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

Construct a default BotEnv model action for a bot.

issueAction :: BotEnv model action -> Maybe Update -> Maybe action -> IO ()

Issue a new action for the bot to process.

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

Process one action.

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

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

processActionsIndefinitely :: BotApp model action -> BotEnv model action -> IO ThreadId

Process incoming actions indefinitely.

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

Start Update polling for a bot.

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

Start Update polling with a given update handler.

Helpers

asyncLink :: IO a -> IO (Async a)

Instead of forkIO which hides exceptions, allow users to handle those exceptions separately.

See https://github.com/fizruk/telegram-bot-simple/issues/159.