Web.Bot.Platform

Bot platform type class.

Documentation

data Bot a b

Message bot monad

Instances

MonadBaseControl IO (Bot a)

Associated Types

type StM (Bot a :: * -> *) a :: *

Methods

liftBaseWith :: (RunInBase (Bot a) IO -> IO a) -> Bot a a

restoreM :: StM (Bot a) a -> Bot a a

MonadBase IO (Bot a)

Methods

liftBase :: IO α -> Bot a α

Monad (Bot a)

Methods

(>>=) :: Bot a a -> (a -> Bot a b) -> Bot a b

(>>) :: Bot a a -> Bot a b -> Bot a b

return :: a -> Bot a a

fail :: String -> Bot a a

Functor (Bot a)

Methods

fmap :: (a -> b) -> Bot a a -> Bot a b

(<$) :: a -> Bot a b -> Bot a a

Applicative (Bot a)

Methods

pure :: a -> Bot a a

(<*>) :: Bot a (a -> b) -> Bot a a -> Bot a b

(*>) :: Bot a a -> Bot a b -> Bot a b

(<*) :: Bot a a -> Bot a b -> Bot a a

MonadIO (Bot a)

Methods

liftIO :: IO a -> Bot a a

MonadLogger (Bot a)

Methods

monadLoggerLog :: ToLogStr msg => Loc -> LogSource -> LogLevel -> msg -> Bot a ()

type StM (Bot a) b

type StM (Bot a) b = b

class Platform a where

Message bot platform. Different platforms provide message bot API, e.g. Telegram, Viber, Facebook Messenger etc. This is generalized interface to it.

Minimal complete definition

trySelf, sendMessage, messageHandler, platformName

Methods

trySelf :: APIToken a => Bot a ()

Try connection to platform API

sendMessage :: (ToMessage msg, APIToken a) => User -> msg -> Bot a ()

Send message to user by platform API

messageHandler :: APIToken a => (User -> Message -> Bot a b) -> Bot a c

Get user updates by platform API

platformName :: a -> Text

Short description of platform

Instances

Platform Telegram

Methods

trySelf :: Bot Telegram ()

sendMessage :: (ToMessage msg, APIToken Telegram) => User -> msg -> Bot Telegram ()

messageHandler :: APIToken Telegram => (User -> Message -> Bot Telegram b) -> Bot Telegram c

platformName :: Telegram -> Text

class Platform a => APIToken a where

Bot authentification in platform Instance of it should be writen by user

Minimal complete definition

apiToken

Methods

apiToken :: Bot a Text

Platform API token

getManager :: Bot a Manager

TCP-connection manager getter

forkFinallyBot :: APIToken a => Bot a b -> (Either SomeException b -> IO ()) -> Bot a ThreadId

Fork bot thread with finalizer

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

Fork bot thread

runBot :: (APIToken a, MonadIO m) => Bot a b -> m b

Run bot monad