Safe Haskell	None
Language	Haskell2010

Telegram.Bot.API.Methods

Contents

Available methods
- getMe
- sendMessage

Synopsis

type GetMe = "getMe" :> Get '[JSON] (Response User)
getMe :: ClientM (Response User)
type SendMessage = "sendMessage" :> (ReqBody '[JSON] SendMessageRequest :> Post '[JSON] (Response Message))
sendMessage :: SendMessageRequest -> ClientM (Response Message)
data SomeChatId
- = SomeChatId ChatId
- | SomeChatUsername Text
data SomeReplyMarkup
data ParseMode
- = Markdown
- | HTML
data SendMessageRequest = SendMessageRequest {
- sendMessageChatId :: SomeChatId
- sendMessageText :: Text
- sendMessageParseMode :: Maybe ParseMode
- sendMessageDisableWebPagePreview :: Maybe Bool
- sendMessageDisableNotification :: Maybe Bool
- sendMessageReplyToMessageId :: Maybe MessageId
- sendMessageReplyMarkup :: Maybe SomeReplyMarkup
}

Available methods

`getMe`

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

getMe :: ClientM (Response User) Source #

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.

`sendMessage`

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

sendMessage :: SendMessageRequest -> ClientM (Response Message) Source #

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

data SomeChatId Source #

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 Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep SomeChatId :: Type -> Type # Methods from :: SomeChatId -> Rep SomeChatId x # to :: Rep SomeChatId x -> SomeChatId #
ToJSON SomeChatId Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: SomeChatId -> Value # toEncoding :: SomeChatId -> Encoding # toJSONList :: [SomeChatId] -> Value # toEncodingList :: [SomeChatId] -> Encoding #
FromJSON SomeChatId Source #
Instance details Defined in Telegram.Bot.API.Methods Methods parseJSON :: Value -> Parser SomeChatId # parseJSONList :: Value -> Parser [SomeChatId] #
type Rep SomeChatId Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep SomeChatId = D1 (MetaData "SomeChatId" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.2.0-1M8rmfx2QZj8E0BosnPvnR" 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 Source #

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 Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep SomeReplyMarkup :: Type -> Type # Methods from :: SomeReplyMarkup -> Rep SomeReplyMarkup x # to :: Rep SomeReplyMarkup x -> SomeReplyMarkup #
ToJSON SomeReplyMarkup Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: SomeReplyMarkup -> Value # toEncoding :: SomeReplyMarkup -> Encoding # toJSONList :: [SomeReplyMarkup] -> Value # toEncodingList :: [SomeReplyMarkup] -> Encoding #
FromJSON SomeReplyMarkup Source #
Instance details Defined in Telegram.Bot.API.Methods Methods parseJSON :: Value -> Parser SomeReplyMarkup # parseJSONList :: Value -> Parser [SomeReplyMarkup] #
type Rep SomeReplyMarkup Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep SomeReplyMarkup = D1 (MetaData "SomeReplyMarkup" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.2.0-1M8rmfx2QZj8E0BosnPvnR" 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 Source #

Constructors

Markdown
HTML

Instances

Generic ParseMode Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep ParseMode :: Type -> Type # Methods from :: ParseMode -> Rep ParseMode x # to :: Rep ParseMode x -> ParseMode #
ToJSON ParseMode Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: ParseMode -> Value # toEncoding :: ParseMode -> Encoding # toJSONList :: [ParseMode] -> Value # toEncodingList :: [ParseMode] -> Encoding #
FromJSON ParseMode Source #
Instance details Defined in Telegram.Bot.API.Methods Methods parseJSON :: Value -> Parser ParseMode # parseJSONList :: Value -> Parser [ParseMode] #
type Rep ParseMode Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep ParseMode = D1 (MetaData "ParseMode" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.2.0-1M8rmfx2QZj8E0BosnPvnR" False) (C1 (MetaCons "Markdown" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "HTML" PrefixI False) (U1 :: Type -> Type))

data SendMessageRequest Source #

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 Source #
Instance details Defined in Telegram.Bot.API.Methods Associated Types type Rep SendMessageRequest :: Type -> Type # Methods from :: SendMessageRequest -> Rep SendMessageRequest x # to :: Rep SendMessageRequest x -> SendMessageRequest #
ToJSON SendMessageRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods toJSON :: SendMessageRequest -> Value # toEncoding :: SendMessageRequest -> Encoding # toJSONList :: [SendMessageRequest] -> Value # toEncodingList :: [SendMessageRequest] -> Encoding #
FromJSON SendMessageRequest Source #
Instance details Defined in Telegram.Bot.API.Methods Methods parseJSON :: Value -> Parser SendMessageRequest # parseJSONList :: Value -> Parser [SendMessageRequest] #
type Rep SendMessageRequest Source #
Instance details Defined in Telegram.Bot.API.Methods type Rep SendMessageRequest = D1 (MetaData "SendMessageRequest" "Telegram.Bot.API.Methods" "telegram-bot-simple-0.2.0-1M8rmfx2QZj8E0BosnPvnR" 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))))))