Web.Telegram.Bot

Telegram Bot API microframework for creating story like command handlers:

     helloStory :: Story
     helloStory _ = hello $ question "How your name?"
                          * question "How your surname?"
                          * question "How old are you?"

Exported types

API types

module Web.Telegram.API.Bot.Data

Story types

class ToBotMessage a where

Bot message typeclass for conversion.

Minimal complete definition

toMessage

Methods

toMessage :: a -> BotMessage

Instances

ToBotMessage Text

Simple text question send text message from bot

Methods

toMessage :: Text -> BotMessage

ToBotMessage BotMessage

Idenity instance

Methods

toMessage :: BotMessage -> BotMessage

data BotMessage

Bot message data.

Constructors

BotTyping

BotText Text

BotKeyboard Text [[Text]]

Instances

Show BotMessage

Methods

showsPrec :: Int -> BotMessage -> ShowS

show :: BotMessage -> String

showList :: [BotMessage] -> ShowS

ToBotMessage BotMessage

Idenity instance

Methods

toMessage :: BotMessage -> BotMessage

class BotConfig a where

Telegram bot config

Minimal complete definition

authToken

Methods

pollTimeout :: a -> Timeout

authToken :: a -> Token

BotFather authentification token

class Answer a where

The value can be passed to story handler function.

Minimal complete definition

parse

Methods

parse :: MonadIO m => Message -> ExceptT Text m a

Instances

Answer Double

Methods

parse :: MonadIO m => Message -> ExceptT Text m Double

Answer Int

Methods

parse :: MonadIO m => Message -> ExceptT Text m Int

Answer Integer

Methods

parse :: MonadIO m => Message -> ExceptT Text m Integer

Answer Word

Methods

parse :: MonadIO m => Message -> ExceptT Text m Word

Answer Text

Simple text answer, pass any text message

Methods

parse :: MonadIO m => Message -> ExceptT Text m Text

newtype Token :: *

Telegram Bot's Token

Constructors

Token Text

Instances

Eq Token

Methods

(==) :: Token -> Token -> Bool

(/=) :: Token -> Token -> Bool

Ord Token

Methods

compare :: Token -> Token -> Ordering

(<) :: Token -> Token -> Bool

(<=) :: Token -> Token -> Bool

(>) :: Token -> Token -> Bool

(>=) :: Token -> Token -> Bool

max :: Token -> Token -> Token

min :: Token -> Token -> Token

Show Token

Methods

showsPrec :: Int -> Token -> ShowS

show :: Token -> String

showList :: [Token] -> ShowS

ToHttpApiData Token

Methods

toUrlPiece :: Token -> Text

toHeader :: Token -> ByteString

toQueryParam :: Token -> Text

FromHttpApiData Token

Methods

parseUrlPiece :: Text -> Either Text Token

parseHeader :: ByteString -> Either Text Token

parseQueryParam :: Text -> Either Text Token

type StoryT = Pipe Message BotMessage

type Story a = (User, Chat) -> StoryT (Bot a) BotMessage

Story is a pipe from user message to bot message and result is a final message bot.

Story makers

select :: (MonadIO m, Answer a) => Text -> [[Text]] -> StoryT m a

Reply keyboard selection

replica :: (ToBotMessage a, MonadIO m, Answer b) => a -> StoryT m b

Generalized story maker. The replica send to user, when answer isn't parsed the error send to user and waiting for correct answer.

question :: (MonadIO m, Answer a) => Text -> StoryT m a

Bot text question.

Bot runners

sendMessageBot :: BotConfig a => Chat -> BotMessage -> Bot a ()

storyBot :: (BotConfig a, ToBotMessage help) => help -> Map Text (Story a) -> Bot a ()

User story handler

forkBot :: BotConfig a => Bot a () -> Bot a ThreadId

runBot :: BotConfig a => a -> Bot a b -> IO b

Run bot monad

Re-exports

lift :: MonadTrans t => forall m a. Monad m => m a -> t m a

Lift a computation from the argument monad to the constructed monad.