Safe Haskell	Safe-Inferred
Language	GHC2021

TD.Data.InputMessageContent

Synopsis

data InputMessageContent
- = InputMessageText {
  - text :: Maybe FormattedText
  - link_preview_options :: Maybe LinkPreviewOptions
  - clear_draft :: Maybe Bool
  }
- | InputMessageAnimation {
  - animation :: Maybe InputFile
  - thumbnail :: Maybe InputThumbnail
  - added_sticker_file_ids :: Maybe [Int]
  - duration :: Maybe Int
  - width :: Maybe Int
  - height :: Maybe Int
  - caption :: Maybe FormattedText
  - show_caption_above_media :: Maybe Bool
  - has_spoiler :: Maybe Bool
  }
- | InputMessageAudio {
  - audio :: Maybe InputFile
  - album_cover_thumbnail :: Maybe InputThumbnail
  - duration :: Maybe Int
  - title :: Maybe Text
  - performer :: Maybe Text
  - caption :: Maybe FormattedText
  }
- | InputMessageDocument {
  - document :: Maybe InputFile
  - thumbnail :: Maybe InputThumbnail
  - disable_content_type_detection :: Maybe Bool
  - caption :: Maybe FormattedText
  }
- | InputMessagePaidMedia {
  - star_count :: Maybe Int
  - paid_media :: Maybe [InputPaidMedia]
  - caption :: Maybe FormattedText
  - show_caption_above_media :: Maybe Bool
  - payload :: Maybe Text
  }
- | InputMessagePhoto {
  - photo :: Maybe InputFile
  - thumbnail :: Maybe InputThumbnail
  - video :: Maybe InputFile
  - added_sticker_file_ids :: Maybe [Int]
  - width :: Maybe Int
  - height :: Maybe Int
  - caption :: Maybe FormattedText
  - show_caption_above_media :: Maybe Bool
  - self_destruct_type :: Maybe MessageSelfDestructType
  - has_spoiler :: Maybe Bool
  }
- | InputMessageSticker {
  - sticker :: Maybe InputFile
  - thumbnail :: Maybe InputThumbnail
  - width :: Maybe Int
  - height :: Maybe Int
  - emoji :: Maybe Text
  }
- | InputMessageVideo {
  - video :: Maybe InputFile
  - thumbnail :: Maybe InputThumbnail
  - cover :: Maybe InputFile
  - start_timestamp :: Maybe Int
  - added_sticker_file_ids :: Maybe [Int]
  - duration :: Maybe Int
  - width :: Maybe Int
  - height :: Maybe Int
  - supports_streaming :: Maybe Bool
  - caption :: Maybe FormattedText
  - show_caption_above_media :: Maybe Bool
  - self_destruct_type :: Maybe MessageSelfDestructType
  - has_spoiler :: Maybe Bool
  }
- | InputMessageVideoNote {
  - video_note :: Maybe InputFile
  - thumbnail :: Maybe InputThumbnail
  - duration :: Maybe Int
  - _length :: Maybe Int
  - self_destruct_type :: Maybe MessageSelfDestructType
  }
- | InputMessageVoiceNote {
  - voice_note :: Maybe InputFile
  - duration :: Maybe Int
  - waveform :: Maybe ByteString
  - caption :: Maybe FormattedText
  - self_destruct_type :: Maybe MessageSelfDestructType
  }
- | InputMessageLocation {
  - location :: Maybe Location
  - live_period :: Maybe Int
  - heading :: Maybe Int
  - proximity_alert_radius :: Maybe Int
  }
- | InputMessageVenue {
  - venue :: Maybe Venue
  }
- | InputMessageContact {
  - contact :: Maybe Contact
  }
- | InputMessageDice {
  - emoji :: Maybe Text
  - clear_draft :: Maybe Bool
  }
- | InputMessageGame {
  - bot_user_id :: Maybe Int
  - game_short_name :: Maybe Text
  }
- | InputMessageInvoice {
  - invoice :: Maybe Invoice
  - title :: Maybe Text
  - description :: Maybe Text
  - photo_url :: Maybe Text
  - photo_size :: Maybe Int
  - photo_width :: Maybe Int
  - photo_height :: Maybe Int
  - _payload :: Maybe ByteString
  - provider_token :: Maybe Text
  - provider_data :: Maybe Text
  - start_parameter :: Maybe Text
  - _paid_media :: Maybe InputPaidMedia
  - paid_media_caption :: Maybe FormattedText
  }
- | InputMessagePoll {
  - question :: Maybe FormattedText
  - options :: Maybe [InputPollOption]
  - _description :: Maybe FormattedText
  - is_anonymous :: Maybe Bool
  - allows_multiple_answers :: Maybe Bool
  - allows_revoting :: Maybe Bool
  - shuffle_options :: Maybe Bool
  - hide_results_until_closes :: Maybe Bool
  - _type :: Maybe InputPollType
  - open_period :: Maybe Int
  - close_date :: Maybe Int
  - is_closed :: Maybe Bool
  }
- | InputMessageStakeDice {
  - state_hash :: Maybe Text
  - stake_toncoin_amount :: Maybe Int
  - clear_draft :: Maybe Bool
  }
- | InputMessageStory {
  - story_poster_chat_id :: Maybe Int
  - story_id :: Maybe Int
  }
- | InputMessageChecklist {
  - checklist :: Maybe InputChecklist
  }
- | InputMessageForwarded {
  - from_chat_id :: Maybe Int
  - message_id :: Maybe Int
  - in_game_share :: Maybe Bool
  - replace_video_start_timestamp :: Maybe Bool
  - new_video_start_timestamp :: Maybe Int
  - copy_options :: Maybe MessageCopyOptions
  }

Documentation

data InputMessageContent Source #

The content of a message to send

Constructors

InputMessageText	A text message
Fields text :: Maybe FormattedText Formatted text to be sent; 0-getOption("message_text_length_max") characters. Only Bold, Italic, Underline, Strikethrough, Spoiler, CustomEmoji, BlockQuote, ExpandableBlockQuote, Code, Pre, PreCode, TextUrl, MentionName, and DateTime entities are allowed to be specified manually link_preview_options :: Maybe LinkPreviewOptions Options to be used for generation of a link preview; may be null if none; pass null to use default link preview options clear_draft :: Maybe Bool True, if the chat message draft must be deleted
InputMessageAnimation	An animation message (GIF-style).
Fields animation :: Maybe InputFile Animation file to be sent thumbnail :: Maybe InputThumbnail Animation thumbnail; pass null to skip thumbnail uploading added_sticker_file_ids :: Maybe [Int] File identifiers of the stickers added to the animation, if applicable duration :: Maybe Int Duration of the animation, in seconds width :: Maybe Int Width of the animation; may be replaced by the server height :: Maybe Int Height of the animation; may be replaced by the server caption :: Maybe FormattedText Animation caption; pass null to use an empty caption; 0-getOption("message_caption_length_max") characters show_caption_above_media :: Maybe Bool True, if the caption must be shown above the animation; otherwise, the caption must be shown below the animation; not supported in secret chats has_spoiler :: Maybe Bool True, if the animation preview must be covered by a spoiler animation; not supported in secret chats
InputMessageAudio	An audio message
Fields audio :: Maybe InputFile Audio file to be sent album_cover_thumbnail :: Maybe InputThumbnail Thumbnail of the cover for the album; pass null to skip thumbnail uploading duration :: Maybe Int Duration of the animation, in seconds title :: Maybe Text Title of the audio; 0-64 characters; may be replaced by the server performer :: Maybe Text Performer of the audio; 0-64 characters, may be replaced by the server caption :: Maybe FormattedText Animation caption; pass null to use an empty caption; 0-getOption("message_caption_length_max") characters
InputMessageDocument	A document message (general file)
Fields document :: Maybe InputFile Document to be sent thumbnail :: Maybe InputThumbnail Animation thumbnail; pass null to skip thumbnail uploading disable_content_type_detection :: Maybe Bool Pass true to disable automatic file type detection and send the document as a file. Always true for files sent to secret chats caption :: Maybe FormattedText Animation caption; pass null to use an empty caption; 0-getOption("message_caption_length_max") characters
InputMessagePaidMedia	A message with paid media; can be used only in channel chats with supergroupFullInfo.has_paid_media_allowed
Fields star_count :: Maybe Int The number of Telegram Stars that must be paid to see the media; 1-getOption("paid_media_message_star_count_max") paid_media :: Maybe [InputPaidMedia] The content of the paid media caption :: Maybe FormattedText Animation caption; pass null to use an empty caption; 0-getOption("message_caption_length_max") characters show_caption_above_media :: Maybe Bool True, if the caption must be shown above the animation; otherwise, the caption must be shown below the animation; not supported in secret chats payload :: Maybe Text Bot-provided data for the paid media; bots only
InputMessagePhoto	A photo message
Fields photo :: Maybe InputFile Photo to send. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20 thumbnail :: Maybe InputThumbnail Animation thumbnail; pass null to skip thumbnail uploading video :: Maybe InputFile Video of the live photo; not supported in secret chats; pass null if the photo isn't a live photo added_sticker_file_ids :: Maybe [Int] File identifiers of the stickers added to the animation, if applicable width :: Maybe Int Width of the animation; may be replaced by the server height :: Maybe Int Height of the animation; may be replaced by the server caption :: Maybe FormattedText Animation caption; pass null to use an empty caption; 0-getOption("message_caption_length_max") characters show_caption_above_media :: Maybe Bool True, if the caption must be shown above the animation; otherwise, the caption must be shown below the animation; not supported in secret chats self_destruct_type :: Maybe MessageSelfDestructType Photo self-destruct type; pass null if none; private chats only has_spoiler :: Maybe Bool True, if the animation preview must be covered by a spoiler animation; not supported in secret chats
InputMessageSticker	A sticker message
Fields sticker :: Maybe InputFile Sticker to be sent thumbnail :: Maybe InputThumbnail Animation thumbnail; pass null to skip thumbnail uploading width :: Maybe Int Width of the animation; may be replaced by the server height :: Maybe Int Height of the animation; may be replaced by the server emoji :: Maybe Text Emoji used to choose the sticker
InputMessageVideo	A video message
Fields video :: Maybe InputFile Video of the live photo; not supported in secret chats; pass null if the photo isn't a live photo thumbnail :: Maybe InputThumbnail Animation thumbnail; pass null to skip thumbnail uploading cover :: Maybe InputFile Cover of the video; pass null to skip cover uploading; not supported in secret chats and for self-destructing messages start_timestamp :: Maybe Int Timestamp from which the video playing must start, in seconds added_sticker_file_ids :: Maybe [Int] File identifiers of the stickers added to the animation, if applicable duration :: Maybe Int Duration of the animation, in seconds width :: Maybe Int Width of the animation; may be replaced by the server height :: Maybe Int Height of the animation; may be replaced by the server supports_streaming :: Maybe Bool True, if the video is expected to be streamed caption :: Maybe FormattedText Animation caption; pass null to use an empty caption; 0-getOption("message_caption_length_max") characters show_caption_above_media :: Maybe Bool True, if the caption must be shown above the animation; otherwise, the caption must be shown below the animation; not supported in secret chats self_destruct_type :: Maybe MessageSelfDestructType Photo self-destruct type; pass null if none; private chats only has_spoiler :: Maybe Bool True, if the animation preview must be covered by a spoiler animation; not supported in secret chats
InputMessageVideoNote	A video note message
Fields video_note :: Maybe InputFile Video note to be sent. The video is expected to be encoded to MPEG4 format with H.264 codec and have no data outside of the visible circle thumbnail :: Maybe InputThumbnail Animation thumbnail; pass null to skip thumbnail uploading duration :: Maybe Int Duration of the animation, in seconds _length :: Maybe Int Video width and height; must be positive and not greater than 640 self_destruct_type :: Maybe MessageSelfDestructType Photo self-destruct type; pass null if none; private chats only
InputMessageVoiceNote	A voice note message
Fields voice_note :: Maybe InputFile Voice note to be sent. The voice note must be encoded with the Opus codec and stored inside an OGG container with a single audio channel, or be in MP3 or M4A format as regular audio duration :: Maybe Int Duration of the animation, in seconds waveform :: Maybe ByteString Waveform representation of the voice note in 5-bit format caption :: Maybe FormattedText Animation caption; pass null to use an empty caption; 0-getOption("message_caption_length_max") characters self_destruct_type :: Maybe MessageSelfDestructType Photo self-destruct type; pass null if none; private chats only
InputMessageLocation	A message with a location
Fields location :: Maybe Location Location to be sent live_period :: Maybe Int Period for which the location can be updated, in seconds; must be between 60 and 86400 for a temporary live location, 0x7FFFFFFF for permanent live location, and 0 otherwise heading :: Maybe Int For live locations, a direction in which the location moves, in degrees; 1-360. Pass 0 if unknown proximity_alert_radius :: Maybe Int For live locations, a maximum distance to another chat member for proximity alerts, in meters (0-100000). Pass 0 if the notification is disabled. Can't be enabled in channels and Saved Messages
InputMessageVenue	A message with information about a venue
Fields venue :: Maybe Venue Venue to send
InputMessageContact	A message containing a user contact
Fields contact :: Maybe Contact Contact to send
InputMessageDice	A dice message
Fields emoji :: Maybe Text Emoji used to choose the sticker clear_draft :: Maybe Bool True, if the chat message draft must be deleted
InputMessageGame	A message with a game; not supported for channels or secret chats
Fields bot_user_id :: Maybe Int User identifier of the bot that owns the game game_short_name :: Maybe Text Short name of the game
InputMessageInvoice	A message with an invoice; can be used only by bots
Fields invoice :: Maybe Invoice Invoice title :: Maybe Text Title of the audio; 0-64 characters; may be replaced by the server description :: Maybe Text Product description; 0-255 characters photo_url :: Maybe Text Product photo URL; optional photo_size :: Maybe Int Product photo size photo_width :: Maybe Int Product photo width photo_height :: Maybe Int Product photo height _payload :: Maybe ByteString The invoice payload provider_token :: Maybe Text Payment provider token; may be empty for payments in Telegram Stars provider_data :: Maybe Text JSON-encoded data about the invoice, which will be shared with the payment provider start_parameter :: Maybe Text Unique invoice bot deep link parameter for the generation of this invoice. If empty, it would be possible to pay directly from forwards of the invoice message _paid_media :: Maybe InputPaidMedia The content of paid media attached to the invoice; pass null if none paid_media_caption :: Maybe FormattedText Paid media caption; pass null to use an empty caption; 0-getOption("message_caption_length_max") characters
InputMessagePoll	A message with a poll. Polls can't be sent to secret chats and channel direct messages chats. Polls can be sent to a private chat only if the chat is a chat with a bot or the Saved Messages chat
Fields question :: Maybe FormattedText Poll question; 1-255 characters (up to 300 characters for bots). Only custom emoji entities are allowed to be added and only by Premium users options :: Maybe [InputPollOption] List of poll answer options; 2-getOption("poll_answer_count_max") options _description :: Maybe FormattedText Poll description; pass null to use an empty description; 0-getOption("message_caption_length_max") characters is_anonymous :: Maybe Bool True, if the poll voters are anonymous. Non-anonymous polls can't be sent or forwarded to channels allows_multiple_answers :: Maybe Bool True, if multiple answer options can be chosen simultaneously allows_revoting :: Maybe Bool True, if the poll can be answered multiple times shuffle_options :: Maybe Bool True, if poll options must be shown in a fixed random order hide_results_until_closes :: Maybe Bool True, if the poll results will appear only after the poll closes _type :: Maybe InputPollType Type of the poll open_period :: Maybe Int Amount of time the poll will be active after creation, in seconds; 0-getOption("poll_open_period_max"); pass 0 if not specified close_date :: Maybe Int Point in time (Unix timestamp) when the poll will automatically be closed; must be 0-getOption("poll_open_period_max") seconds in the future; pass 0 if not specified is_closed :: Maybe Bool True, if the poll needs to be sent already closed; for bots only
InputMessageStakeDice	A stake dice message
Fields state_hash :: Maybe Text Hash of the stake dice state. The state hash can be used only if it was received recently enough. Otherwise, a new state must be requested using getStakeDiceState stake_toncoin_amount :: Maybe Int The Toncoin amount that will be staked; in the smallest units of the currency. Must be in the range getOption("stake_dice_stake_amount_min")-getOption("stake_dice_stake_amount_max") clear_draft :: Maybe Bool True, if the chat message draft must be deleted
InputMessageStory	A message with a forwarded story. Stories can't be forwarded to secret chats. A story can be forwarded only if story.can_be_forwarded
Fields story_poster_chat_id :: Maybe Int Identifier of the chat that posted the story story_id :: Maybe Int Story identifier
InputMessageChecklist	A message with a checklist. Checklists can't be sent to secret chats, channel chats and channel direct messages chats; for Telegram Premium users only
Fields checklist :: Maybe InputChecklist The checklist to send
InputMessageForwarded	A forwarded message
Fields from_chat_id :: Maybe Int Identifier for the chat this forwarded message came from message_id :: Maybe Int Identifier of the message to forward. A message can be forwarded only if messageProperties.can_be_forwarded in_game_share :: Maybe Bool Pass true if a game message is being shared from a launched game; applies only to game messages replace_video_start_timestamp :: Maybe Bool Pass true to replace video start timestamp in the forwarded message new_video_start_timestamp :: Maybe Int The new video start timestamp; ignored if replace_video_start_timestamp == false copy_options :: Maybe MessageCopyOptions Options to be used to copy content of the message without reference to the original sender; pass null to forward the message as usual

Instances

Instances details

FromJSON InputMessageContent Source #
Instance details Defined in TD.Data.InputMessageContent Methods parseJSON :: Value -> Parser InputMessageContent # parseJSONList :: Value -> Parser [InputMessageContent] #
ToJSON InputMessageContent Source #
Instance details Defined in TD.Data.InputMessageContent Methods toJSON :: InputMessageContent -> Value # toEncoding :: InputMessageContent -> Encoding # toJSONList :: [InputMessageContent] -> Value # toEncodingList :: [InputMessageContent] -> Encoding #
Show InputMessageContent Source #
Instance details Defined in TD.Data.InputMessageContent Methods showsPrec :: Int -> InputMessageContent -> ShowS # show :: InputMessageContent -> String # showList :: [InputMessageContent] -> ShowS #
Eq InputMessageContent Source #
Instance details Defined in TD.Data.InputMessageContent Methods (==) :: InputMessageContent -> InputMessageContent -> Bool # (/=) :: InputMessageContent -> InputMessageContent -> Bool #
ShortShow InputMessageContent Source #
Instance details Defined in TD.Data.InputMessageContent Methods shortShow :: InputMessageContent -> String Source #