Marvin.Adapter.Telegram.Push

Documentation

data TelegramAdapter updateType

The telegram adapter type for a particular update type. Either Push or Poll

Instances

MkTelegram a => IsAdapter (TelegramAdapter a)

Associated Types

type User (TelegramAdapter a) :: *

type Channel (TelegramAdapter a) :: *

Methods

adapterId :: AdapterId (TelegramAdapter a)

messageChannel :: Channel (TelegramAdapter a) -> Text -> AdapterM (TelegramAdapter a) ()

initAdapter :: RunnerM (TelegramAdapter a)

runWithAdapter :: RunWithAdapter (TelegramAdapter a)

getUsername :: User (TelegramAdapter a) -> AdapterM (TelegramAdapter a) Text

getChannelName :: Channel (TelegramAdapter a) -> AdapterM (TelegramAdapter a) Text

resolveChannel :: Text -> AdapterM (TelegramAdapter a) (Maybe (Channel (TelegramAdapter a)))

resolveUser :: Text -> AdapterM (TelegramAdapter a) (Maybe (User (TelegramAdapter a)))

type User (TelegramAdapter a)

type User (TelegramAdapter a) = TelegramUser

type Channel (TelegramAdapter a)

type Channel (TelegramAdapter a) = TelegramChat

data Push

Use the telegram API by recieving updates as a server via webhook

Note: The initialization for this adapter _includes_ registering or clearing its own webhook.

Instances

MkTelegram Push

Methods

mkEventGetter :: Chan (TelegramUpdate Push) -> AdapterM (TelegramAdapter Push) ()

mkAdapterId :: AdapterId (TelegramAdapter Push)

data TelegramChat

A telegram chat object as contained in telegram updates

Constructors

TelegramChat Integer ChatType (Maybe Text) (Maybe Text) (Maybe Text)

Instances

FromJSON TelegramChat

Methods

parseJSON :: Value -> Parser TelegramChat

parseJSONList :: Value -> Parser [TelegramChat]

data ChatType

Chat type as defined by the telegram api

Constructors

PrivateChat

GroupChat

SupergroupChat

ChannelChat

Instances

FromJSON ChatType

Methods

parseJSON :: Value -> Parser ChatType

parseJSONList :: Value -> Parser [ChatType]

data TelegramUser

A user object as contained in the telegram update objects

Constructors

TelegramUser Integer Text (Maybe Text) (Maybe Text)

Instances

FromJSON TelegramUser

Methods

parseJSON :: Value -> Parser TelegramUser

parseJSONList :: Value -> Parser [TelegramUser]

class MkTelegram a

Class to enable polymorphism over update mechanics for TelegramAdapter

Minimal complete definition

mkEventGetter, mkAdapterId

Instances

MkTelegram Poll

Methods

mkEventGetter :: Chan (TelegramUpdate Poll) -> AdapterM (TelegramAdapter Poll) ()

mkAdapterId :: AdapterId (TelegramAdapter Poll)

MkTelegram Push

Methods

mkEventGetter :: Chan (TelegramUpdate Push) -> AdapterM (TelegramAdapter Push) ()

mkAdapterId :: AdapterId (TelegramAdapter Push)