Safe Haskell	Safe-Inferred
Language	Haskell2010

Telegram.Bot.Simple.BotApp

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 WebhookConfig = WebhookConfig {
}
startBot :: BotApp model action -> ClientEnv -> IO (Either ClientError ())
startBot_ :: BotApp model action -> ClientEnv -> IO ()
startBotAsync :: BotApp model action -> ClientEnv -> IO (action -> IO ())
startBotAsync_ :: BotApp model action -> ClientEnv -> IO ()
startBotWebhook :: BotApp model action -> WebhookConfig -> ClientEnv -> IO (Either ClientError ())
startBotWebhook_ :: BotApp model action -> WebhookConfig -> ClientEnv -> IO ()
getEnvToken :: String -> IO Token

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

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 WebhookConfig Source #

Constructors

WebhookConfig
Fields webhookConfigTlsSettings :: TLSSettings webhookConfigTlsWarpSettings :: Settings webhookConfigSetWebhookRequest :: SetWebhookRequest

startBot :: BotApp model action -> ClientEnv -> IO (Either ClientError ()) Source #

Start bot with update polling in the main thread.

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

Like startBot, but ignores result.

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

Start bot with asynchronous polling. The result is a function that allows you to send actions directly to the bot.

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

Like startBotAsync, but ignores result.

startBotWebhook :: BotApp model action -> WebhookConfig -> ClientEnv -> IO (Either ClientError ()) Source #

Start bot with webhook on update in the main thread. Port must be one of 443, 80, 88, 8443 certPath must be provided if using self signed certificate.

startBotWebhook_ :: BotApp model action -> WebhookConfig -> ClientEnv -> IO () Source #

Like startBotWebhook, but ignores result.

getEnvToken :: String -> IO Token Source #

Get a Token from environment variable.

Common use:

getEnvToken TELEGRAM_BOT_TOKEN