Module telexide::api::types

This modules provides all the objects describing the payloads to be send to the different telegram API endpoints

Structs

• AddStickerToSet
  struct for holding data needed to call add_sticker_to_set
• AnswerCallbackQuery
  struct for holding data needed to call answer_callback_query
• AnswerInlineQuery
  struct for holding data needed to call answer_inline_query
• AnswerPreCheckoutQuery
  struct for holding data needed to call answer_pre_checkout_query
• AnswerShippingQuery
  struct for holding data needed to call answer_shipping_query
• AnswerWebAppQuery
  Represents the content of an answer to a web app query
• ApproveChatJoinRequest
  struct for holding data needed to call approve_chat_join_request
• BanChatMember
  struct for holding data needed to call ban_chat_member
• BanChatSenderChat
  struct for holding data needed to call ban_chat_sender_chat
• CloseForumTopic
  struct for holding data needed to call close_forum_topic
• CloseGeneralForumTopic
  struct for holding data needed to call close_general_forum_topic
• CopyMessage
  struct for holding data needed to call copy_message
• CreateChatInviteLink
  struct for holding data needed to call create_chat_invite_link
• CreateForumTopic
  struct for holding data needed to call create_forum_topic
• CreateInvoiceLink
  struct for holding data needed to call create_invoice_link
• CreateNewStickerSet
  struct for holding data needed to call create_new_sticker_set
• DeclineChatJoinRequest
  struct for holding data needed to call decline_chat_join_request
• DeleteChatPhoto
  struct for holding data needed to call delete_chat_photo
• DeleteChatStickerSet
  struct for holding data needed to call delete_chat_sticker_set
• DeleteForumTopic
  struct for holding data needed to call delete_forum_topic
• DeleteMessage
  struct for holding data needed to call delete_message
• DeleteMyCommands
  struct for holding data needed to call delete_my_commands
• DeleteStickerFromSet
  struct for holding data needed to call delete_sticker_from_set
• DeleteStickerSet
  struct for holding data needed to call delete_sticker_set
• DeleteWebhook
  Struct for holding data needed to call delete_webhook
• EditChatInviteLink
  struct for holding data needed to call edit_chat_invite_link
• EditForumTopic
  struct for holding data needed to call edit_forum_topic
• EditGeneralForumTopic
  struct for holding data needed to call edit_general_forum_topic
• EditMessageCaption
  struct for holding data needed to call edit_message_caption
• EditMessageLiveLocation
  struct for holding data needed to call edit_message_live_location
• EditMessageMedia
  struct for holding data needed to call edit_message_media
• EditMessageReplyMarkup
  struct for holding data needed to call edit_message_reply_markup
• EditMessageText
  struct for holding data needed to call edit_message_text
• ExportChatInviteLink
  struct for holding data needed to call export_chat_invite_link
• ForwardMessage
  struct for holding data needed to call forward_message
• GetChat
  struct for holding data needed to call get_chat
• GetChatAdministrators
  struct for holding data needed to call get_chat_administrator
• GetChatMember
  struct for holding data needed to call get_chat_member
• GetChatMemberCount
  struct for holding data needed to call get_chat_member_count
• GetChatMenuButton
  struct for holding data needed to call get_chat_menu_button
• GetCustomEmojiStickers
  struct for holding data needed to call get_custom_emoji_stickers
• GetFile
  struct for holding data needed to call get_file
• GetGameHighScores
  struct for holding data needed to call get_game_high_scores
• GetMyCommands
  struct for holding data needed to call get_my_commands
• GetMyDefaultAdministratorRights
  struct for holding data needed to call set_my_default_administrator_rights
• GetMyDescription
  struct for holding data needed to call get_my_description
• GetMyName
  struct for holding data needed to call get_my_name
• GetMyShortDescription
  struct for holding data needed to call get_my_short_description
• GetStickerSet
  struct for holding data needed to call get_sticker_set
• GetUpdates
  struct for holding data needed to call get_updates
• GetUserProfilePhotos
  struct for holding data needed to call get_user_profile_photos
• HideGeneralForumTopic
  struct for holding data needed to call hide_general_forum_topic
• InlineQueryResultArticle
  Represents a link to an article or web page.
• InlineQueryResultAudio
  Represents a link to an MP3 audio file. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.
• InlineQueryResultContact
  Represents a contact with a phone number. By default, this contact will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the contact.
• InlineQueryResultDocument
  Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file. Currently, only .PDF and .ZIP files can be sent using this method.
• InlineQueryResultGame
  Represents a Game.
• InlineQueryResultGif
  Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.
• InlineQueryResultLocation
  Represents a location on a map. By default, the location will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the location.
• InlineQueryResultMpeg4Gif
  Represents a link to a video animation (H.264/MPEG-4 AVC video without sound). By default, this animated MPEG-4 file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.
• InlineQueryResultPhoto
  Represents a link to a photo. By default, this photo will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.
• InlineQueryResultVenue
  Represents a venue. By default, the venue will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the venue.
• InlineQueryResultVideo
  Represents a link to a page containing an embedded video player or a video file. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.
• InlineQueryResultVoice
  Represents a link to a voice recording in an .OGG container encoded with OPUS. By default, this voice recording will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the the voice message.
• InlineQueryResultsButton
• InputContactMessageContent
  Represents the content of a contact message to be sent as the result of an inline query.
• InputInvoiceMessageContent
  Represents the content of an invoice message to be sent as the result of an inline query.
• InputLocationMessageContent
  Represents the content of a location message to be sent as the result of an inline query.
• InputMediaAnimation
  Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.
• InputMediaAudio
  Represents an audio file to be treated as music to be sent.
• InputMediaDocument
  Represents a general file to be sent.
• InputMediaPhoto
  Represents a photo to be sent.
• InputMediaVideo
• InputTextMessageContent
  Represents the content of a text message to be sent as the result of an inline query.
• InputVenueMessageContent
  Represents the content of a venue message to be sent as the result of an inline query.
• LeaveChat
  struct for holding data needed to call leave_chat
• PassportElementErrorDataField
  Represents an issue in one of the data fields that was provided by the user. The error is considered resolved when the field’s value changes.
• PassportElementErrorFile
  Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes.
• PassportElementErrorFiles
  Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes.
• PassportElementErrorFrontSide
  Represents an issue with the front side of a document. The error is considered resolved when the file with the front side of the document changes.
• PassportElementErrorReverseSide
  Represents an issue with the reverse side of a document. The error is considered resolved when the file with reverse side of the document changes.
• PassportElementErrorSelfie
  Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes.
• PassportElementErrorTranslationFile
  Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes.
• PassportElementErrorTranslationFiles
  Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation change.
• PassportElementErrorUnspecified
  Represents an issue in an unspecified place. The error is considered resolved when new data is added.
• PinChatMessage
  struct for holding data needed to call pin_chat_message
• PromoteChatMember
  struct for holding data needed to call promote_chat_member
• ReopenForumTopic
  struct for holding data needed to call reopen_forum_topic
• ReopenGeneralForumTopic
  struct for holding data needed to call reopen_general_forum_topic
• RestrictChatMember
  struct for holding data needed to call restrict_chat_member
• RevokeChatInviteLink
  struct for holding data needed to call revoke_chat_invite_link
• SendAnimation
  struct for holding data needed to call send_animation
• SendAudio
  struct for holding data needed to call send_audio
• SendChatAction
  struct for holding data needed to call send_chat_action
• SendContact
  struct for holding data needed to call send_contact
• SendDice
  struct for holding data needed to call send_dice
• SendDocument
  struct for holding data needed to call send_document
• SendGame
  struct for holding data needed to call send_game
• SendInvoice
  struct for holding data needed to call send_invoice
• SendLocation
  struct for holding data needed to call send_location
• SendMediaGroup
  struct for sending photos, videos, documents or audios as an album send_media_group
• SendMessage
  struct for holding data needed to call send_message
• SendPhoto
  struct for holding data needed to call send_photo
• SendPoll
  struct for holding data needed to call send_poll
• SendSticker
  struct for holding data needed to call send_sticker
• SendVenue
  struct for holding data needed to call send_venue
• SendVideo
  struct for holding data needed to call send_video
• SendVideoNote
  struct for holding data needed to call send_video_note
• SendVoice
  struct for holding data needed to call send_voice
• SetChatAdministratorCustomTitle
  struct for holding data needed to call set_chat_administrator_custom_title
• SetChatDescription
  struct for holding data needed to call set_chat_description
• SetChatMenuButton
  struct for holding data needed to call set_chat_menu_button
• SetChatPermissions
  struct for holding data needed to call set_chat_permissions
• SetChatPhoto
  struct for holding data needed to call set_chat_photo
• SetChatStickerSet
  struct for holding data needed to call set_chat_sticker_set
• SetChatTitle
  struct for holding data needed to call set_chat_title
• SetCustomEmojiStickerSetThumbnail
  struct for holding data needed to call set_custom_emoji_sticker_set_thumbnail
• SetGameScore
  struct for holding data needed to call set_game_score
• SetMyCommands
  struct for holding data needed to call set_my_commands
• SetMyDefaultAdministratorRights
  struct for holding data needed to call set_my_default_administrator_rights
• SetMyDescription
  struct for holding data needed to call set_my_description
• SetMyName
  struct for holding data needed to call set_my_name
• SetMyShortDescription
  struct for holding data needed to call set_my_short_description
• SetPassportDataErrors
  struct for holding data needed to call set_passport_data_errors
• SetStickerEmojiList
  struct for holding data needed to call set_sticker_emoji_list
• SetStickerKeywords
  struct for holding data needed to call set_sticker_keywords
• SetStickerMaskPosition
  struct for holding data needed to call set_sticker_mask_position
• SetStickerPositionInSet
  struct for holding data needed to call set_sticker_position_in_set
• SetStickerSetThumbnail
  struct for holding data needed to call set_sticker_set_thumbnail
• SetStickerSetTitle
  struct for holding data needed to call set_sticker_set_title
• SetWebhook
  struct for holding data needed to call set_webhook
• StopMessageLiveLocation
  struct for holding data needed to call stop_message_live_location
• StopPoll
  struct for holding data needed to call stop_poll
• UnbanChatMember
  struct for holding data needed to call unban_chat_member
• UnbanChatSenderChat
  struct for holding data needed to call unban_chat_sender_chat
• UnhideGeneralForumTopic
  struct for holding data needed to call unhide_general_forum_topic
• UnpinAllChatMessages
  struct for holding data needed to call unpin_all_chat_messages
• UnpinAllForumTopicMessages
  struct for holding data needed to call unpin_all_forum_topic_messages
• UnpinAllGeneralForumTopicMessages
  struct for holding data needed to call [unpin_all_general_forum_topic_messages]
• UnpinChatMessage
  struct for holding data needed to call unpin_chat_message
• UploadStickerFile
  struct for holding data needed to call upload_sticker_file

Enums

• InlineQueryResult
  This object represents one result of an inline query.
• InputFile
  This object represents either the file_id, http url or the contents of a file to be uploaded.
• InputMedia
  This object represents the content of a media message to be sent
• InputMessageContent
  This object represents the content of a message to be sent as a result of an inline query.
• PassportElementError
  This object represents an error in the Telegram Passport element which was submitted that should be resolved by the user
• TrueOrObject
  Is either true (the bool), or is object T
• UpdateType
  The type of an update, can be used for specifying which update types you want to receive