[][src]Module teloxide::types

API types.

Structs

Animation

This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).

Audio

This object represents an audio file to be treated as music by the Telegram clients.

BotCommand

This object represents a bot command.

CallbackGame

A placeholder, currently holds no information.

CallbackQuery

This object represents an incoming callback query from a callback button in an inline keyboard.

Chat

This object represents a chat.

ChatMember

This object contains information about one member of the chat.

ChatPermissions

Describes actions that a non-administrator user is allowed to take in a chat.

ChatPhoto

This object represents a chat photo.

ChatPrivate
ChatPublic
ChosenInlineResult

Represents a result of an inline query that was chosen by the user and sent to their chat partner.

Contact

This object represents a phone contact.

Dice

This object represents an animated emoji that displays a random value.

Document

This object represents a general file (as opposed to photos, voice messages and audio files).

EncryptedCredentials

Contains data required for decrypting and authenticating EncryptedPassportElement.

EncryptedPassportElement

Contains information about documents or other Telegram Passport elements shared with the bot by the user.

EncryptedPassportElementAddress
EncryptedPassportElementBankStatement
EncryptedPassportElementDriverLicense
EncryptedPassportElementEmail
EncryptedPassportElementIdentityCard
EncryptedPassportElementInternalPassport
EncryptedPassportElementPassport
EncryptedPassportElementPassportRegistration
EncryptedPassportElementPersonalDetails
EncryptedPassportElementPhoneNumber
EncryptedPassportElementRentalAgreement
EncryptedPassportElementTemporaryRegistration
EncryptedPassportElementUtilityBill
False

A type that is always false.

File

This object represents a file ready to be downloaded.

ForceReply

Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot‘s message and tapped ’Reply').

ForwardChannel
ForwardNonChannel
ForwardOrigin
Game

This object represents a game.

GameHighScore

This object represents one row of the high scores table for a game.

InlineKeyboardButton

This object represents one button of an inline keyboard.

InlineKeyboardMarkup

This object represents an inline keyboard that appears right next to the message it belongs to.

InlineQuery

This object represents an incoming inline query.

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.

InlineQueryResultCachedAudio

Represents a link to an MP3 audio file stored on the Telegram servers.

InlineQueryResultCachedDocument

Represents a link to a file stored on the Telegram servers.

InlineQueryResultCachedGif

Represents a link to an animated GIF file stored on the Telegram servers.

InlineQueryResultCachedMpeg4Gif

Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers.

InlineQueryResultCachedPhoto

Represents a link to a photo stored on the Telegram servers.

InlineQueryResultCachedSticker

Represents a link to a sticker stored on the Telegram servers.

InlineQueryResultCachedVideo

Represents a link to a video file stored on the Telegram servers.

InlineQueryResultCachedVoice

Represents a link to a voice message stored on the Telegram servers.

InlineQueryResultContact

Represents a contact with a phone number.

InlineQueryResultDocument

Represents a link to a file.

InlineQueryResultGame

Represents a game.

InlineQueryResultGif

Represents a link to an animated GIF file.

InlineQueryResultLocation

Represents a location on a map.

InlineQueryResultMpeg4Gif

Represents a link to a video animation (H.264/MPEG-4 AVC video without sound).

InlineQueryResultPhoto

Represents a link to a photo.

InlineQueryResultVenue

Represents a venue.

InlineQueryResultVideo

Represents a link to a page containing an embedded video player or a video file.

InlineQueryResultVoice

Represents a link to a voice recording in an .ogg container encoded with OPUS.

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

Represents a video to be sent.

InputMessageContentContact

Represents the content of a contact message to be sent as the result of an inline query.

InputMessageContentLocation

Represents the content of a location message to be sent as the result of an inline query.

InputMessageContentText

Represents the content of a text message to be sent as the result of an inline query.

InputMessageContentVenue

Represents the content of a venue message to be sent as the result of an inline query.

Invoice

This object contains basic information about an invoice.

KeyboardButton

This object represents one button of the reply keyboard.

KeyboardButtonPollType
LabeledPrice

This object represents a portion of the price for goods or services.

Location

This object represents a point on the map.

LoginUrl

This object represents a parameter of the inline keyboard button used to automatically authorize a user.

MaskPosition

This object describes the position on faces where a mask should be placed by default.

Me

Returned only in Bot::get_me.

MediaAnimation
MediaAudio
MediaContact
MediaDocument
MediaGame
MediaLocation
MediaPhoto
MediaPoll
MediaSticker
MediaText
MediaVenue
MediaVideo
MediaVideoNote
MediaVoice
Message

This object represents a message.

MessageChannelChatCreated
MessageCommon
MessageConnectedWebsite
MessageDeleteChatPhoto
MessageDice
MessageEntity

This object represents one special entity in a text message.

MessageGroupChatCreated
MessageInvoice
MessageLeftChatMember
MessageMigrate
MessageNewChatMembers
MessageNewChatPhoto
MessageNewChatTitle
MessagePassportData
MessagePinned
MessageSuccessfulPayment
MessageSupergroupChatCreated
MimeWrapper

Serializable & deserializable MIME wrapper.

OrderInfo

This object represents information about an order.

PassportData

Contains information about Telegram Passport data shared with the bot by the user.

PassportElementError

This object represents an error in the Telegram Passport element which was submitted that should be resolved by the user.

PassportElementErrorDataField

Represents an issue in one of the data fields that was provided by the user.

PassportElementErrorFile

Represents an issue with a document scan.

PassportElementErrorFiles

Represents an issue with a list of scans.

PassportElementErrorFrontSide

Represents an issue with the front side of a document.

PassportElementErrorReverseSide

Represents an issue with the reverse side of a document.

PassportElementErrorSelfie

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.

PassportElementErrorTranslationFiles

Represents an issue with the translated version of a document.

PassportElementErrorUnspecified

Represents an issue in an unspecified place.

PassportFile

This object represents a file uploaded to Telegram Passport.

PhotoSize

This object represents one size of a photo or a file/sticker thumbnail.

Poll

This object contains information about a poll.

PollAnswer
PollOption

This object contains information about one answer option in a poll.

PreCheckoutQuery

This object contains information about an incoming pre-checkout query.

PublicChatChannel
PublicChatGroup
PublicChatSupergroup
ReplyKeyboardMarkup

This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).

ReplyKeyboardRemove

Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard.

SendInvoice
ShippingAddress

This object represents a shipping address.

ShippingOption

This object represents one shipping option.

ShippingQuery

This object contains information about an incoming shipping query.

Sticker

This object represents a sticker.

StickerSet

This object represents a sticker set.

SuccessfulPayment

This object contains basic information about a successful payment.

True

A type that is always true.

Update

This object represents an incoming update.

User

This object represents a Telegram user or bot.

UserProfilePhotos

This object represent a user's profile pictures.

Venue

This object represents a venue.

Video

This object represents a video file.

VideoNote

This object represents a video message (available in Telegram apps as of [v.4.0]).

Voice

This object represents a voice note.

WebhookInfo

Contains information about the current status of a webhook.

Enums

AllowedUpdate
ButtonRequest
ChatAction
ChatId

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

ChatKind
ChatMemberStatus
ChatOrInlineMessage

A chat message or inline message.

CountryCode
Currency
DiceEmoji
EncryptedPassportElementKind
ForwardKind
ForwardedFrom
InlineKeyboardButtonKind
InlineQueryResult

This object represents one result of an inline query.

InputFile

This object represents 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.

MediaKind
MessageEntityKind
MessageKind
ParseMode

Formatting options.

PassportElementErrorDataFieldType
PassportElementErrorFileType
PassportElementErrorFilesType
PassportElementErrorFrontSideType
PassportElementErrorKind
PassportElementErrorReverseSideType
PassportElementErrorSelfieType
PassportElementErrorTranslationFileType
PassportElementErrorTranslationFilesType
PassportElementErrorUnspecifiedType
PollType
PublicChatKind
ReplyMarkup
ResponseParameters

Contains information about why a request was unsuccessful.

StickerType
UpdateKind