Telegram.Bot.API.UpdatingMessages

Documentation

data EditMessageResponse

Constructors

EditedInlineMessage Bool

EditedMessage Message

Instances

FromJSON EditMessageResponse

Defined in Telegram.Bot.API.UpdatingMessages

Methods

parseJSON :: Value -> Parser EditMessageResponse

parseJSONList :: Value -> Parser [EditMessageResponse]

Generic EditMessageResponse

Defined in Telegram.Bot.API.UpdatingMessages

Associated Types

type Rep EditMessageResponse :: Type -> Type

Methods

from :: EditMessageResponse -> Rep EditMessageResponse x

to :: Rep EditMessageResponse x -> EditMessageResponse

Show EditMessageResponse

Defined in Telegram.Bot.API.UpdatingMessages

Methods

showsPrec :: Int -> EditMessageResponse -> ShowS

show :: EditMessageResponse -> String

showList :: [EditMessageResponse] -> ShowS

type Rep EditMessageResponse

Defined in Telegram.Bot.API.UpdatingMessages

type Rep EditMessageResponse = D1 ('MetaData "EditMessageResponse" "Telegram.Bot.API.UpdatingMessages" "telegram-bot-api-6.5-3pY7XQZ5v9zCuyh8HdDMyB" 'False) (C1 ('MetaCons "EditedInlineMessage" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :+: C1 ('MetaCons "EditedMessage" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Message)))

editMessageText

data EditMessageTextRequest

Request parameters for editMessageText.

Constructors

EditMessageTextRequest

Fields

• editMessageTextChatId :: Maybe SomeChatId

  Required if editMessageTextInlineMessageId is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername).

• editMessageTextMessageId :: Maybe MessageId

  Required if editMessageTextInlineMessageId is not specified. Identifier of the sent message.

• editMessageTextInlineMessageId :: Maybe MessageId

  Required if editMessageTextChatId and editMessageTextMessageId are not specified. Identifier of the sent message.

• editMessageTextText :: Text

  Text of the message to be sent.

• editMessageTextParseMode :: Maybe ParseMode

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

• editMessageEntities :: Maybe [MessageEntity]

  A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode.

• editMessageTextDisableWebPagePreview :: Maybe Bool

  Disables link previews for links in this message.

• editMessageTextReplyMarkup :: 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

FromJSON EditMessageTextRequest

Defined in Telegram.Bot.API.UpdatingMessages

Methods

parseJSON :: Value -> Parser EditMessageTextRequest

parseJSONList :: Value -> Parser [EditMessageTextRequest]

ToJSON EditMessageTextRequest

Defined in Telegram.Bot.API.UpdatingMessages

Methods

toJSON :: EditMessageTextRequest -> Value

toEncoding :: EditMessageTextRequest -> Encoding

toJSONList :: [EditMessageTextRequest] -> Value

toEncodingList :: [EditMessageTextRequest] -> Encoding

Generic EditMessageTextRequest

Defined in Telegram.Bot.API.UpdatingMessages

Associated Types

type Rep EditMessageTextRequest :: Type -> Type

Methods

from :: EditMessageTextRequest -> Rep EditMessageTextRequest x

to :: Rep EditMessageTextRequest x -> EditMessageTextRequest

type Rep EditMessageTextRequest

Defined in Telegram.Bot.API.UpdatingMessages

type Rep EditMessageTextRequest = D1 ('MetaData "EditMessageTextRequest" "Telegram.Bot.API.UpdatingMessages" "telegram-bot-api-6.5-3pY7XQZ5v9zCuyh8HdDMyB" 'False) (C1 ('MetaCons "EditMessageTextRequest" 'PrefixI 'True) (((S1 ('MetaSel ('Just "editMessageTextChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SomeChatId)) :*: S1 ('MetaSel ('Just "editMessageTextMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId))) :*: (S1 ('MetaSel ('Just "editMessageTextInlineMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId)) :*: S1 ('MetaSel ('Just "editMessageTextText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "editMessageTextParseMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ParseMode)) :*: S1 ('MetaSel ('Just "editMessageEntities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [MessageEntity]))) :*: (S1 ('MetaSel ('Just "editMessageTextDisableWebPagePreview") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "editMessageTextReplyMarkup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SomeReplyMarkup))))))

data EditMessageCaptionRequest

Request parameters for editMessageCaption.

Constructors

EditMessageCaptionRequest

Fields

• editMessageCaptionChatId :: Maybe SomeChatId

  Required if editMessageCaptionMessageId is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername).

• editMessageCaptionMessageId :: Maybe MessageId

  Required if editMessageCaptionInlineMessageId is not specified. Identifier of the sent message.

• editMessageCaptionInlineMessageId :: Maybe MessageId

  Required if editMessageCaptionChatId and editMessageCaptionMessageId are not specified. Identifier of the sent message.

• editMessageCaptionCaption :: Maybe Text

  New caption of the message, 0-1024 characters after entities parsing

• editMessageCaptionParseMode :: Maybe ParseMode

  Mode for parsing entities in the message caption. See formatting options for more details.

• editMessageCaptionCaptionEntities :: Maybe [MessageEntity]

  A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode

• editMessageCaptionReplyMarkup :: 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

FromJSON EditMessageCaptionRequest

Defined in Telegram.Bot.API.UpdatingMessages

Methods

parseJSON :: Value -> Parser EditMessageCaptionRequest

parseJSONList :: Value -> Parser [EditMessageCaptionRequest]

ToJSON EditMessageCaptionRequest

Defined in Telegram.Bot.API.UpdatingMessages

Methods

toJSON :: EditMessageCaptionRequest -> Value

toEncoding :: EditMessageCaptionRequest -> Encoding

toJSONList :: [EditMessageCaptionRequest] -> Value

toEncodingList :: [EditMessageCaptionRequest] -> Encoding

Generic EditMessageCaptionRequest

Defined in Telegram.Bot.API.UpdatingMessages

Associated Types

type Rep EditMessageCaptionRequest :: Type -> Type

Methods

from :: EditMessageCaptionRequest -> Rep EditMessageCaptionRequest x

to :: Rep EditMessageCaptionRequest x -> EditMessageCaptionRequest

type Rep EditMessageCaptionRequest

Defined in Telegram.Bot.API.UpdatingMessages

type Rep EditMessageCaptionRequest = D1 ('MetaData "EditMessageCaptionRequest" "Telegram.Bot.API.UpdatingMessages" "telegram-bot-api-6.5-3pY7XQZ5v9zCuyh8HdDMyB" 'False) (C1 ('MetaCons "EditMessageCaptionRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "editMessageCaptionChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SomeChatId)) :*: (S1 ('MetaSel ('Just "editMessageCaptionMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId)) :*: S1 ('MetaSel ('Just "editMessageCaptionInlineMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId)))) :*: ((S1 ('MetaSel ('Just "editMessageCaptionCaption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "editMessageCaptionParseMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ParseMode))) :*: (S1 ('MetaSel ('Just "editMessageCaptionCaptionEntities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [MessageEntity])) :*: S1 ('MetaSel ('Just "editMessageCaptionReplyMarkup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SomeReplyMarkup))))))

data EditMessageMediaRequest

Request parameters for editMessageMedia.

Constructors

EditMessageMediaRequest

Fields

• editMessageMediaChatId :: Maybe SomeChatId

  Required if editMessageMediaMessageId is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername).

• editMessageMediaMessageId :: Maybe MessageId

  Required if editMessageMediaInlineMessageId is not specified. Identifier of the sent message.

• editMessageMediaInlineMessageId :: Maybe MessageId

  Required if editMessageMediaChatId and editMessageMediaMessageId are not specified. Identifier of the sent message.

• editMessageMediaMedia :: InputMedia

  A JSON-serialized object for a new media content of the message

• editMessageMediaReplyMarkup :: 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

ToJSON EditMessageMediaRequest

Defined in Telegram.Bot.API.UpdatingMessages

Methods

toJSON :: EditMessageMediaRequest -> Value

toEncoding :: EditMessageMediaRequest -> Encoding

toJSONList :: [EditMessageMediaRequest] -> Value

toEncodingList :: [EditMessageMediaRequest] -> Encoding

Generic EditMessageMediaRequest

Defined in Telegram.Bot.API.UpdatingMessages

Associated Types

type Rep EditMessageMediaRequest :: Type -> Type

Methods

from :: EditMessageMediaRequest -> Rep EditMessageMediaRequest x

to :: Rep EditMessageMediaRequest x -> EditMessageMediaRequest

type Rep EditMessageMediaRequest

Defined in Telegram.Bot.API.UpdatingMessages

type Rep EditMessageMediaRequest = D1 ('MetaData "EditMessageMediaRequest" "Telegram.Bot.API.UpdatingMessages" "telegram-bot-api-6.5-3pY7XQZ5v9zCuyh8HdDMyB" 'False) (C1 ('MetaCons "EditMessageMediaRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "editMessageMediaChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SomeChatId)) :*: S1 ('MetaSel ('Just "editMessageMediaMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId))) :*: (S1 ('MetaSel ('Just "editMessageMediaInlineMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId)) :*: (S1 ('MetaSel ('Just "editMessageMediaMedia") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 InputMedia) :*: S1 ('MetaSel ('Just "editMessageMediaReplyMarkup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SomeReplyMarkup))))))

data EditMessageReplyMarkupRequest

Request parameters for editMessageReplyMarkup.

Constructors

EditMessageReplyMarkupRequest

Fields

• editMessageReplyMarkupChatId :: Maybe SomeChatId

  Required if editMessageReplyMarkupMessageId is not specified. Unique identifier for the target chat or username of the target channel (in the format @channelusername).

• editMessageReplyMarkupMessageId :: Maybe MessageId

  Required if editMessageReplyMarkupInlineMessageId is not specified. Identifier of the sent message.

• editMessageReplyMarkupInlineMessageId :: Maybe MessageId

  Required if editMessageReplyMarkupChatId and editMessageReplyMarkupMessageId are not specified. Identifier of the sent message.

• editMessageReplyMarkupReplyMarkup :: 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

FromJSON EditMessageReplyMarkupRequest

Defined in Telegram.Bot.API.UpdatingMessages

Methods

parseJSON :: Value -> Parser EditMessageReplyMarkupRequest

parseJSONList :: Value -> Parser [EditMessageReplyMarkupRequest]

ToJSON EditMessageReplyMarkupRequest

Defined in Telegram.Bot.API.UpdatingMessages

Methods

toJSON :: EditMessageReplyMarkupRequest -> Value

toEncoding :: EditMessageReplyMarkupRequest -> Encoding

toJSONList :: [EditMessageReplyMarkupRequest] -> Value

toEncodingList :: [EditMessageReplyMarkupRequest] -> Encoding

Generic EditMessageReplyMarkupRequest

Defined in Telegram.Bot.API.UpdatingMessages

Associated Types

type Rep EditMessageReplyMarkupRequest :: Type -> Type

Methods

from :: EditMessageReplyMarkupRequest -> Rep EditMessageReplyMarkupRequest x

to :: Rep EditMessageReplyMarkupRequest x -> EditMessageReplyMarkupRequest

type Rep EditMessageReplyMarkupRequest

Defined in Telegram.Bot.API.UpdatingMessages

type Rep EditMessageReplyMarkupRequest = D1 ('MetaData "EditMessageReplyMarkupRequest" "Telegram.Bot.API.UpdatingMessages" "telegram-bot-api-6.5-3pY7XQZ5v9zCuyh8HdDMyB" 'False) (C1 ('MetaCons "EditMessageReplyMarkupRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "editMessageReplyMarkupChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SomeChatId)) :*: S1 ('MetaSel ('Just "editMessageReplyMarkupMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId))) :*: (S1 ('MetaSel ('Just "editMessageReplyMarkupInlineMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MessageId)) :*: S1 ('MetaSel ('Just "editMessageReplyMarkupReplyMarkup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SomeReplyMarkup)))))

data StopPollRequest

Request parameters for stopPoll.

Constructors

StopPollRequest

Fields

• stopPollChatId :: SomeChatId

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

• stopPollMessageId :: MessageId

  Identifier of the original message with the poll

• stopPollReplyMarkup :: Maybe SomeReplyMarkup

  A JSON-serialized object for a new message inline keyboard.

Instances

FromJSON StopPollRequest

Defined in Telegram.Bot.API.UpdatingMessages

Methods

parseJSON :: Value -> Parser StopPollRequest

parseJSONList :: Value -> Parser [StopPollRequest]

ToJSON StopPollRequest

Defined in Telegram.Bot.API.UpdatingMessages

Methods

toJSON :: StopPollRequest -> Value

toEncoding :: StopPollRequest -> Encoding

toJSONList :: [StopPollRequest] -> Value

toEncodingList :: [StopPollRequest] -> Encoding

Generic StopPollRequest

Defined in Telegram.Bot.API.UpdatingMessages

Associated Types

type Rep StopPollRequest :: Type -> Type

Methods

from :: StopPollRequest -> Rep StopPollRequest x

to :: Rep StopPollRequest x -> StopPollRequest

type Rep StopPollRequest

Defined in Telegram.Bot.API.UpdatingMessages

type Rep StopPollRequest = D1 ('MetaData "StopPollRequest" "Telegram.Bot.API.UpdatingMessages" "telegram-bot-api-6.5-3pY7XQZ5v9zCuyh8HdDMyB" 'False) (C1 ('MetaCons "StopPollRequest" 'PrefixI 'True) (S1 ('MetaSel ('Just "stopPollChatId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SomeChatId) :*: (S1 ('MetaSel ('Just "stopPollMessageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MessageId) :*: S1 ('MetaSel ('Just "stopPollReplyMarkup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SomeReplyMarkup)))))

type EditMessageText = "editMessageText" :> (ReqBody '[JSON] EditMessageTextRequest :> Post '[JSON] (Response EditMessageResponse))

editMessageText :: EditMessageTextRequest -> ClientM (Response EditMessageResponse)

Use this method to edit text and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

type EditMessageCaption = "editMessageCaption" :> (ReqBody '[JSON] EditMessageCaptionRequest :> Post '[JSON] (Response EditMessageResponse))

editMessageCaption :: EditMessageCaptionRequest -> ClientM (Response EditMessageResponse)

Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

type EditMessageMedia = "editMessageMedia" :> (ReqBody '[JSON] EditMessageMediaRequest :> Post '[JSON] (Response EditMessageResponse))

editMessageMedia :: EditMessageMediaRequest -> ClientM (Response EditMessageResponse)

Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

type EditMessageReplyMarkup = "editMessageReplyMarkup" :> (ReqBody '[JSON] EditMessageReplyMarkupRequest :> Post '[JSON] (Response EditMessageResponse))

editMessageReplyMarkup :: EditMessageReplyMarkupRequest -> ClientM (Response EditMessageResponse)

Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.

type StopPoll = "stopPoll" :> (ReqBody '[JSON] StopPollRequest :> Post '[JSON] (Response Poll))

stopPoll :: StopPollRequest -> ClientM (Response Poll)

Use this method to stop a poll which was sent by the bot. On success, the stopped Poll is returned.