Module telexide::model[][src]

Mappings of objects received from the API

Modules

raw

Structs

AdministratorMemberStatus

Represents a ChatMember who is an Admin of the Chat.

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

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. If the button that originated the query was attached to a message sent by the bot, the field message will be present. If the button was attached to a message sent via the bot (in inline mode), the field inline_message_id will be present. Exactly one of the fields data or game_short_name will be present.

ChannelChat

A Channel object

ChatInviteLink

Represents an invite link for a chat.

ChatLocation

Represents a location to which a chat is connected.

ChatMemberUpdated

Represents changes in the status of a chat member.

ChatPermissions

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

ChatPhoto

This object represents a chat photo.

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.

CreatorMemberStatus

Represents a ChatMember who is the creator of the Chat.

Dice

This object represents a dice with a random value from 1 to 6 for currently supported base emoji.

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. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes.

EncryptedPassportElement

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

File

This object represents a file ready to be downloaded. The file can be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>. It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested by calling get_file.

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’). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode.

ForwardData

Holds information about the forwarded message

Game

This object represents a game. Use @BotFather to create and edit games, their short names will act as unique identifiers.

GameHighScore

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

GroupChat

A Group chat object

InlineKeyboardButton

This object represents one button of an inline keyboard. You must use exactly one of the optional fields.

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. When the user sends an empty query, your bot could return some default or trending results.

Invoice

This object contains basic information about an invoice.

KeyboardButton

This object represents one button of the reply keyboard. For simple text buttons String can be used instead of this object to specify text of the button.

KeyboardButtonPollType

This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.

KickedMemberStatus

Represents a ChatMember who has been kicked from the Chat.

LabeledPrice

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

LeftMemberStatus

Represents a ChatMember who left the Chat.

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. Serves as a great replacement for the Telegram Login Widget when the user is coming from Telegram. All the user needs to do is tap/click a button and confirm that they want to log in

MaskPosition

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

MemberMemberStatus

Represents a ChatMember who is a normal member of the Chat without any special powers.

Message

This object represents a message.

MessageAutoDeleteTimerChanged

This object represents a service message about a change in auto-delete timer settings.

MessageId

This object represents a unique message identifier.

OrderInfo

This object represents information about an order.

PassportData

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

PassportFile

This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format when decrypted and don’t exceed 10MB.

PhotoSize

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

Poll

This object contains information about a poll.

PollAnswer

This object represents an answer of a user in a non-anonymous poll.

PollOption

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

Pre

A monowidth code block

PreCheckoutQuery

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

PrivateChat

A private chat object, also known as a DM, between the bot and an user

ProximityAlertTriggered

This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user.

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. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup).

RestrictedMemberStatus

Represents a restricted ChatMember of a Chat.

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.

SuperGroupChat

A supergroup object (a group with more than 200 members)

TextBlock

An object describing a part of a text

TextLink

A clickable text URL

TextMention

For users without usernames

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

Voice

This object represents a voice note

VoiceChatEnded

This object represents a service message about a voice chat ended in the chat.

VoiceChatParticipantsInvited

This object represents a service message about new members invited to a voice chat.

VoiceChatScheduled

This object represents a service message about a voice chat scheduled in the chat.

VoiceChatStarted

This object represents a service message about a voice chat started in the chat. Currently holds no information.

WebhookInfo

Contains information about the current status of a webhook.

Enums

Chat

This object represents a chat. It can be a private, group, supergroup or channel chat

ChatAction

An action indicating to a user what they are about to receive

ChatMember

This object contains information about one member of a chat.

ChatType

The type of chat

MaskPoint

The part of the face relative to which a mask should be placed

MessageContent

The content of a Message

MessageEntity

This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.

ParseMode

The Bot API supports basic formatting for messages. You can use bold, italic, underlined and strikethrough text, as well as inline links and pre-formatted code in your bots’ messages. Telegram clients will render them accordingly. You can use either markdown-style or HTML-style formatting.

PollType

The type of the Poll

ReplyMarkup

Enum object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

TelegramPassportElement

The type of a telegram passport element

UpdateContent

The content of an Update