Telegram.Bot.API.Methods

Available methods

getMe

type GetMe = "getMe" :> Get '[JSON] (Response User)

getMe :: ClientM (Response User)

A simple method for testing your bot's auth token. Requires no parameters. Returns basic information about the bot in form of a User object.

deleteMessage

type DeleteMessage = "deleteMessage" :> (RequiredQueryParam "chat_id" ChatId :> (RequiredQueryParam "message_id" MessageId :> Get '[JSON] (Response Bool)))

Notice that deleting by POST method was bugged, so we use GET

deleteMessage :: ChatId -> MessageId -> ClientM (Response Bool)

Use this method to delete message in chat. On success, the sent Bool is returned.

sendMessage

type SendMessage = "sendMessage" :> (ReqBody '[JSON] SendMessageRequest :> Post '[JSON] (Response Message))

sendMessage :: SendMessageRequest -> ClientM (Response Message)

Use this method to send text messages. On success, the sent Message is returned.

data SomeChatId

Unique identifier for the target chat or username of the target channel (in the format @channelusername).

Constructors

SomeChatId ChatId

Unique chat ID.

SomeChatUsername Text

Username of the target channel.

Instances

Generic SomeChatId

Defined in Telegram.Bot.API.Methods

Associated Types

type Rep SomeChatId :: Type -> Type

Methods

from :: SomeChatId -> Rep SomeChatId x

to :: Rep SomeChatId x -> SomeChatId

FromJSON SomeChatId

Defined in Telegram.Bot.API.Methods

Methods

parseJSON :: Value -> Parser SomeChatId

parseJSONList :: Value -> Parser [SomeChatId]

ToJSON SomeChatId

Defined in Telegram.Bot.API.Methods

Methods

toJSON :: SomeChatId -> Value

toEncoding :: SomeChatId -> Encoding

toJSONList :: [SomeChatId] -> Value

toEncodingList :: [SomeChatId] -> Encoding

type Rep SomeChatId

Defined in Telegram.Bot.API.Methods

type Rep SomeChatId = D1 (MetaData "SomeChatId" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.3.0-inplace" False) (C1 (MetaCons "SomeChatId" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ChatId)) :+: C1 (MetaCons "SomeChatUsername" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

data SomeReplyMarkup

Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

Constructors

SomeInlineKeyboardMarkup InlineKeyboardMarkup

SomeReplyKeyboardMarkup ReplyKeyboardMarkup

SomeReplyKeyboardRemove ReplyKeyboardRemove

SomeForceReply ForceReply

Instances

Generic SomeReplyMarkup

Defined in Telegram.Bot.API.Methods

Associated Types

type Rep SomeReplyMarkup :: Type -> Type

Methods

from :: SomeReplyMarkup -> Rep SomeReplyMarkup x

to :: Rep SomeReplyMarkup x -> SomeReplyMarkup

FromJSON SomeReplyMarkup

Defined in Telegram.Bot.API.Methods

Methods

parseJSON :: Value -> Parser SomeReplyMarkup

parseJSONList :: Value -> Parser [SomeReplyMarkup]

ToJSON SomeReplyMarkup

Defined in Telegram.Bot.API.Methods

Methods

toJSON :: SomeReplyMarkup -> Value

toEncoding :: SomeReplyMarkup -> Encoding

toJSONList :: [SomeReplyMarkup] -> Value

toEncodingList :: [SomeReplyMarkup] -> Encoding

type Rep SomeReplyMarkup

Defined in Telegram.Bot.API.Methods

type Rep SomeReplyMarkup = D1 (MetaData "SomeReplyMarkup" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.3.0-inplace" False) ((C1 (MetaCons "SomeInlineKeyboardMarkup" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 InlineKeyboardMarkup)) :+: C1 (MetaCons "SomeReplyKeyboardMarkup" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ReplyKeyboardMarkup))) :+: (C1 (MetaCons "SomeReplyKeyboardRemove" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ReplyKeyboardRemove)) :+: C1 (MetaCons "SomeForceReply" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ForceReply))))

data ParseMode

Constructors

Markdown

HTML

Instances

Generic ParseMode

Defined in Telegram.Bot.API.Methods

Associated Types

type Rep ParseMode :: Type -> Type

Methods

from :: ParseMode -> Rep ParseMode x

to :: Rep ParseMode x -> ParseMode

FromJSON ParseMode

Defined in Telegram.Bot.API.Methods

Methods

parseJSON :: Value -> Parser ParseMode

parseJSONList :: Value -> Parser [ParseMode]

ToJSON ParseMode

Defined in Telegram.Bot.API.Methods

Methods

toJSON :: ParseMode -> Value

toEncoding :: ParseMode -> Encoding

toJSONList :: [ParseMode] -> Value

toEncodingList :: [ParseMode] -> Encoding

type Rep ParseMode

Defined in Telegram.Bot.API.Methods

type Rep ParseMode = D1 (MetaData "ParseMode" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.3.0-inplace" False) (C1 (MetaCons "Markdown" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "HTML" PrefixI False) (U1 :: Type -> Type))

data SendMessageRequest

Request parameters for sendMessage.

Constructors

SendMessageRequest

Fields

• sendMessageChatId :: SomeChatId

  Unique identifier for the target chat or username of the target channel (in the format @channelusername).

• sendMessageText :: Text

  Text of the message to be sent.

• sendMessageParseMode :: Maybe ParseMode

  Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message.

• sendMessageDisableWebPagePreview :: Maybe Bool

  Disables link previews for links in this message.

• sendMessageDisableNotification :: Maybe Bool

  Sends the message silently. Users will receive a notification with no sound.

• sendMessageReplyToMessageId :: Maybe MessageId

  If the message is a reply, ID of the original message.

• sendMessageReplyMarkup :: Maybe SomeReplyMarkup

  Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

Instances

Generic SendMessageRequest

Defined in Telegram.Bot.API.Methods

Associated Types

type Rep SendMessageRequest :: Type -> Type

Methods

from :: SendMessageRequest -> Rep SendMessageRequest x

to :: Rep SendMessageRequest x -> SendMessageRequest

FromJSON SendMessageRequest

Defined in Telegram.Bot.API.Methods

Methods

parseJSON :: Value -> Parser SendMessageRequest

parseJSONList :: Value -> Parser [SendMessageRequest]

ToJSON SendMessageRequest

Defined in Telegram.Bot.API.Methods

Methods

toJSON :: SendMessageRequest -> Value

toEncoding :: SendMessageRequest -> Encoding

toJSONList :: [SendMessageRequest] -> Value

toEncodingList :: [SendMessageRequest] -> Encoding

type Rep SendMessageRequest

Defined in Telegram.Bot.API.Methods

type Rep SendMessageRequest = D1 (MetaData "SendMessageRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.3.0-inplace" False) (C1 (MetaCons "SendMessageRequest" PrefixI True) ((S1 (MetaSel (Just "sendMessageChatId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 SomeChatId) :*: (S1 (MetaSel (Just "sendMessageText") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Just "sendMessageParseMode") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe ParseMode)))) :*: ((S1 (MetaSel (Just "sendMessageDisableWebPagePreview") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "sendMessageDisableNotification") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Bool))) :*: (S1 (MetaSel (Just "sendMessageReplyToMessageId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe MessageId)) :*: S1 (MetaSel (Just "sendMessageReplyMarkup") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe SomeReplyMarkup))))))