Module types

Module types 

Source
Expand description

This module contains types representing Telegram API objects.

Structs§

Animation
This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).
Audio
BotCommand
This object represents a bot command.
CallbackGame
A placeholder, currently holds no information. Use BotFather to set up your game.
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.
Caption
Caption for the animation, audio, document, photo, video or voice
Chat
This object represents a chat.
ChatJoinRequest
ChatLocation
Represents a location to which a chat is connected.
ChatMemberUpdated
ChatPermissions
ChatPhoto
This object represents a chat photo.
ChatUser
This object respresents an information about user from private chat
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
False
Game
InlineKeyboardMarkup
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
KeyboardButtonPollType
This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.
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. Optional fields web_app, request_contact, request_location, and request_poll are mutually exclusive.
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:
Message
This object represents a message.
MessageAutoDeleteTimerChanged
This object represents a service message about a change in auto-delete timer settings.
MessageEntity
This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.
MessageId
This object represents a unique message identifier.
PassportData
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.
PreCheckoutQuery
ProximityAlertTriggered
ShippingQuery
Sticker
SuccessfulPayment
True
Update
This object represents an incoming update. At most one of the optional parameters can be present in any given update.
User
This object represents a Telegram user or bot.
Venue
Video
VideoChatEnded
This object represents a service message about a video chat ended in the chat.
VideoChatParticipantsInvited
This object represents a service message about new members invited to a video chat.
VideoChatScheduled
This object represents a service message about a video chat scheduled in the chat.
VideoChatStarted
This object represents a service message about a video chat started in the chat. Currently holds no information.
VideoNote
Voice
WebAppData
Describes data sent from a Web App to the bot.
WebAppInfo
Describes a Web App.
WebhookInfo
Describes the current status of a webhook.

Enums§

BotCommandScope
This object represents the scope to which bot commands are applied.
ChatId
The chat id either an integer or a string
ChatKind
The kind of chat
KeyboardButtonPollTypeKind
This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.
KeyboardbuttonAction
The action to be performed when a keyboard button is pressed.
MessageContent
The object representing message content
MessageEntityKind
This object represents the kind of message entity, and its metadata.
PollKind
The kind of poll
UpdateEvent
The update event can be taken from an Update.
UpdateKind
The kind of event can be taken from an Update.