Index | Telegram API

A

TelegramTrait::approveChatJoinRequest() — Method in class TelegramTrait: Use this method to approve a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.
TelegramTrait::answerCallbackQuery() — Method in class TelegramTrait: Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert. On success, True is returned.
TelegramTrait::addStickerToSet() — Method in class TelegramTrait: Use this method to add a new sticker to a set created by the bot. You must use exactly one of the fields png_sticker, tgs_sticker, or webm_sticker. Animated stickers can be added to animated sticker sets and only to them. Animated sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns True on success.
TelegramTrait::answerInlineQuery() — Method in class TelegramTrait: Use this method to send answers to an inline query. On success, True is returned.
TelegramTrait::answerWebAppQuery() — Method in class TelegramTrait: Use this method to set the result of an interaction with a Web App and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a SentWebAppMessage object is returned.
TelegramTrait::answerShippingQuery() — Method in class TelegramTrait: If you sent an invoice requesting a shipping address and the parameter is_flexible was specified, the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply to shipping queries. On success, True is returned.
TelegramTrait::answerPreCheckoutQuery() — Method in class TelegramTrait: Once the user has confirmed their payment and shipping details, the Bot API sends the final confirmation in the form of an Update with the field pre_checkout_query. Use this method to respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must receive an answer within 10 seconds after the pre-checkout query was sent.
Animation — Class in namespace GingTeam\Telegram\Type: This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).
Audio — Class in namespace GingTeam\Telegram\Type: This object represents an audio file to be treated as music by the Telegram clients.

B

TelegramTrait::banChatMember() — Method in class TelegramTrait: Use this method to ban a user in a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the chat on their own using invite links, etc., unless unbanned first. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
TelegramTrait::banChatSenderChat() — Method in class TelegramTrait: Use this method to ban a channel chat in a supergroup or a channel. Until the chat is unbanned, the owner of the banned chat won't be able to send messages on behalf of any of their channels. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights. Returns True on success.
BotCommand — Class in namespace GingTeam\Telegram\Type: This object represents a bot command.
BotCommandScopeAllChatAdministrators — Class in namespace GingTeam\Telegram\Type: Represents the scope of bot commands, covering all group and supergroup chat administrators.
BotCommandScopeAllGroupChats — Class in namespace GingTeam\Telegram\Type: Represents the scope of bot commands, covering all group and supergroup chats.
BotCommandScopeAllPrivateChats — Class in namespace GingTeam\Telegram\Type: Represents the scope of bot commands, covering all private chats.
BotCommandScopeChat — Class in namespace GingTeam\Telegram\Type: Represents the scope of bot commands, covering a specific chat.
BotCommandScopeChatAdministrators — Class in namespace GingTeam\Telegram\Type: Represents the scope of bot commands, covering all administrators of a specific group or supergroup chat.
BotCommandScopeChatMember — Class in namespace GingTeam\Telegram\Type: Represents the scope of bot commands, covering a specific member of a group or supergroup chat.
BotCommandScopeDefault — Class in namespace GingTeam\Telegram\Type: Represents the default scope of bot commands. Default commands are used if no commands with a narrower scope are specified for the user.
BotCommandScopeInterface — Class in namespace GingTeam\Telegram\Type: This object represents the scope to which bot commands are applied. Currently, the following 7 scopes are supported:.

C

TelegramTrait::close() — Method in class TelegramTrait: Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns True on success. Requires no parameters.
TelegramTrait::copyMessage() — Method in class TelegramTrait: Use this method to copy messages of any kind. Service messages and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.
TelegramTrait::createChatInviteLink() — Method in class TelegramTrait: Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink. Returns the new invite link as ChatInviteLink object.
TelegramTrait::createForumTopic() — Method in class TelegramTrait: Use this method to create a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns information about the created topic as a ForumTopic object.
TelegramTrait::closeForumTopic() — Method in class TelegramTrait: Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
TelegramTrait::closeGeneralForumTopic() — Method in class TelegramTrait: Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
TelegramTrait::createNewStickerSet() — Method in class TelegramTrait: Use this method to create a new sticker set owned by a user. The bot will be able to edit the sticker set thus created. You must use exactly one of the fields png_sticker, tgs_sticker, or webm_sticker. Returns True on success.
TelegramTrait::createInvoiceLink() — Method in class TelegramTrait: Use this method to create a link for an invoice. Returns the created invoice link as String on success.
CallbackGameInterface — Class in namespace GingTeam\Telegram\Type: A placeholder, currently holds no information. Use BotFather to set up your game.
CallbackQuery — Class in namespace GingTeam\Telegram\Type: 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.
Chat — Class in namespace GingTeam\Telegram\Type: This object represents a chat.
ChatAdministratorRights — Class in namespace GingTeam\Telegram\Type: Represents the rights of an administrator in a chat.
ChatInviteLink — Class in namespace GingTeam\Telegram\Type: Represents an invite link for a chat.
ChatJoinRequest — Class in namespace GingTeam\Telegram\Type: Represents a join request sent to a chat.
ChatLocation — Class in namespace GingTeam\Telegram\Type: Represents a location to which a chat is connected.
ChatMemberAdministrator — Class in namespace GingTeam\Telegram\Type: Represents a chat member that has some additional privileges.
ChatMemberBanned — Class in namespace GingTeam\Telegram\Type: Represents a chat member that was banned in the chat and can't return to the chat or view chat messages.
ChatMemberInterface — Class in namespace GingTeam\Telegram\Type: This object contains information about one member of a chat. Currently, the following 6 types of chat members are supported:.
ChatMemberLeft — Class in namespace GingTeam\Telegram\Type: Represents a chat member that isn't currently a member of the chat, but may join it themselves.
ChatMemberMember — Class in namespace GingTeam\Telegram\Type: Represents a chat member that has no additional privileges or restrictions.
ChatMemberOwner — Class in namespace GingTeam\Telegram\Type: Represents a chat member that owns the chat and has all administrator privileges.
ChatMemberRestricted — Class in namespace GingTeam\Telegram\Type: Represents a chat member that is under certain restrictions in the chat. Supergroups only.
ChatMemberUpdated — Class in namespace GingTeam\Telegram\Type: This object represents changes in the status of a chat member.
ChatPermissions — Class in namespace GingTeam\Telegram\Type: Describes actions that a non-administrator user is allowed to take in a chat.
ChatPhoto — Class in namespace GingTeam\Telegram\Type: This object represents a chat photo.
ChosenInlineResult — Class in namespace GingTeam\Telegram\Type: Represents a result of an inline query that was chosen by the user and sent to their chat partner.
Contact — Class in namespace GingTeam\Telegram\Type: This object represents a phone contact.

D

TelegramTrait::deleteWebhook() — Method in class TelegramTrait

Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success.

TelegramTrait::declineChatJoinRequest() — Method in class TelegramTrait

Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the can_invite_users administrator right. Returns True on success.

TelegramTrait::deleteChatPhoto() — Method in class TelegramTrait

Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.

TelegramTrait::deleteChatStickerSet() — Method in class TelegramTrait

Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.

TelegramTrait::deleteForumTopic() — Method in class TelegramTrait

Use this method to delete a forum topic along with all its messages in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_delete_messages administrator rights. Returns True on success.

TelegramTrait::deleteMyCommands() — Method in class TelegramTrait

Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, higher level commands will be shown to affected users. Returns True on success.

TelegramTrait::deleteMessage() — Method in class TelegramTrait

Use this method to delete a message, including service messages, with the following limitations:

A message can only be deleted if it was sent less than 48 hours ago.

TelegramTrait::deleteStickerFromSet() — Method in class TelegramTrait

Use this method to delete a sticker from a set created by the bot. Returns True on success.

Dice — Class in namespace GingTeam\Telegram\Type

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

Document — Class in namespace GingTeam\Telegram\Type

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

E

TelegramTrait::editMessageLiveLocation() — Method in class TelegramTrait: Use this method to edit live location messages. A location can be edited until its live_period expires or editing is explicitly disabled by a call to stopMessageLiveLocation. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.
TelegramTrait::exportChatInviteLink() — Method in class TelegramTrait: Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as String on success.
TelegramTrait::editChatInviteLink() — Method in class TelegramTrait: Use this method to edit a non-primary invite link created by the bot. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the edited invite link as a ChatInviteLink object.
TelegramTrait::editForumTopic() — Method in class TelegramTrait: Use this method to edit name and icon of a topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
TelegramTrait::editGeneralForumTopic() — Method in class TelegramTrait: Use this method to edit the name of the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have can_manage_topics administrator rights. Returns True on success.
TelegramTrait::editMessageText() — Method in class TelegramTrait: Use this method to edit text and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.
TelegramTrait::editMessageCaption() — Method in class TelegramTrait: Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.
TelegramTrait::editMessageMedia() — Method in class TelegramTrait: Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.
TelegramTrait::editMessageReplyMarkup() — Method in class TelegramTrait: Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.
EncryptedCredentials — Class in namespace GingTeam\Telegram\Type: Describes data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport Documentation for a complete description of the data decryption and authentication processes.
EncryptedPassportElement — Class in namespace GingTeam\Telegram\Type: Describes documents or other Telegram Passport elements shared with the bot by the user.

F

TelegramTrait::forwardMessage() — Method in class TelegramTrait: Use this method to forward messages of any kind. Service messages can't be forwarded. On success, the sent Message is returned.
File — Class in namespace GingTeam\Telegram\Type: This object represents a file ready to be downloaded. The file can be downloaded via the link https://api.telegram.org/file/bot/. 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 getFile.
ForceReply — Class in namespace GingTeam\Telegram\Type: 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.
ForumTopic — Class in namespace GingTeam\Telegram\Type: This object represents a forum topic.
ForumTopicClosedInterface — Class in namespace GingTeam\Telegram\Type: This object represents a service message about a forum topic closed in the chat. Currently holds no information.
ForumTopicCreated — Class in namespace GingTeam\Telegram\Type: This object represents a service message about a new forum topic created in the chat.
ForumTopicReopenedInterface — Class in namespace GingTeam\Telegram\Type: This object represents a service message about a forum topic reopened in the chat. Currently holds no information.

G

TelegramTrait::getUpdates() — Method in class TelegramTrait: Use this method to receive incoming updates using long polling (wiki). Returns an Array of Update objects.
TelegramTrait::getWebhookInfo() — Method in class TelegramTrait: Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty.
TelegramTrait::getMe() — Method in class TelegramTrait: A simple method for testing your bot's authentication token. Requires no parameters. Returns basic information about the bot in form of a User object.
TelegramTrait::getUserProfilePhotos() — Method in class TelegramTrait: Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.
TelegramTrait::getFile() — Method in class TelegramTrait: Use this method to get basic information about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot/, where is taken from the response. 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 getFile again.
TelegramTrait::getChat() — Method in class TelegramTrait: Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.). Returns a Chat object on success.
TelegramTrait::getChatAdministrators() — Method in class TelegramTrait: Use this method to get a list of administrators in a chat, which aren't bots. Returns an Array of ChatMember objects.
TelegramTrait::getChatMemberCount() — Method in class TelegramTrait: Use this method to get the number of members in a chat. Returns Int on success.
TelegramTrait::getChatMember() — Method in class TelegramTrait: Use this method to get information about a member of a chat. The method is guaranteed to work for other users, only if the bot is an administrator in the chat. Returns a ChatMember object on success.
TelegramTrait::getForumTopicIconStickers() — Method in class TelegramTrait: Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an Array of Sticker objects.
TelegramTrait::getMyCommands() — Method in class TelegramTrait: Use this method to get the current list of the bot's commands for the given scope and user language. Returns an Array of BotCommand objects. If commands aren't set, an empty list is returned.
TelegramTrait::getChatMenuButton() — Method in class TelegramTrait: Use this method to get the current value of the bot's menu button in a private chat, or the default menu button. Returns MenuButton on success.
TelegramTrait::getMyDefaultAdministratorRights() — Method in class TelegramTrait: Use this method to get the current default administrator rights of the bot. Returns ChatAdministratorRights on success.
TelegramTrait::getStickerSet() — Method in class TelegramTrait: Use this method to get a sticker set. On success, a StickerSet object is returned.
TelegramTrait::getCustomEmojiStickers() — Method in class TelegramTrait: Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects.
TelegramTrait::getGameHighScores() — Method in class TelegramTrait: Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. Returns an Array of GameHighScore objects.
Animation::getFileId() — Method in class Animation: Identifier for this file, which can be used to download or reuse the file.
Animation::getFileUniqueId() — Method in class Animation: Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
Animation::getWidth() — Method in class Animation: Video width as defined by sender.
Animation::getHeight() — Method in class Animation: Video height as defined by sender.
Animation::getDuration() — Method in class Animation: Duration of the video in seconds as defined by sender.
Animation::getThumb() — Method in class Animation: Optional. Animation thumbnail as defined by sender.
Animation::getFileName() — Method in class Animation: Optional. Original animation filename as defined by sender.
Animation::getMimeType() — Method in class Animation: Optional. MIME type of the file as defined by sender.
Animation::getFileSize() — Method in class Animation: Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.
Audio::getFileId() — Method in class Audio: Identifier for this file, which can be used to download or reuse the file.
Audio::getFileUniqueId() — Method in class Audio: Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
Audio::getDuration() — Method in class Audio: Duration of the audio in seconds as defined by sender.
Audio::getPerformer() — Method in class Audio: Optional. Performer of the audio as defined by sender or by audio tags.
Audio::getTitle() — Method in class Audio: Optional. Title of the audio as defined by sender or by audio tags.
Audio::getFileName() — Method in class Audio: Optional. Original filename as defined by sender.
Audio::getMimeType() — Method in class Audio: Optional. MIME type of the file as defined by sender.
Audio::getFileSize() — Method in class Audio: Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.
Audio::getThumb() — Method in class Audio: Optional. Thumbnail of the album cover to which the music file belongs.
BotCommand::getCommand() — Method in class BotCommand: Text of the command; 1-32 characters. Can contain only lowercase English letters, digits and underscores.
BotCommand::getDescription() — Method in class BotCommand: Description of the command; 1-256 characters.
BotCommandScopeAllChatAdministrators::getType() — Method in class BotCommandScopeAllChatAdministrators: Scope type, must be all_chat_administrators.
BotCommandScopeAllGroupChats::getType() — Method in class BotCommandScopeAllGroupChats: Scope type, must be all_group_chats.
BotCommandScopeAllPrivateChats::getType() — Method in class BotCommandScopeAllPrivateChats: Scope type, must be all_private_chats.
BotCommandScopeChat::getType() — Method in class BotCommandScopeChat: Scope type, must be chat.
BotCommandScopeChat::getChatId() — Method in class BotCommandScopeChat: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername).
BotCommandScopeChatAdministrators::getType() — Method in class BotCommandScopeChatAdministrators: Scope type, must be chat_administrators.
BotCommandScopeChatAdministrators::getChatId() — Method in class BotCommandScopeChatAdministrators: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername).
BotCommandScopeChatMember::getType() — Method in class BotCommandScopeChatMember: Scope type, must be chat_member.
BotCommandScopeChatMember::getChatId() — Method in class BotCommandScopeChatMember: Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername).
BotCommandScopeChatMember::getUserId() — Method in class BotCommandScopeChatMember: Unique identifier of the target user.
BotCommandScopeDefault::getType() — Method in class BotCommandScopeDefault: Scope type, must be default.
CallbackQuery::getId() — Method in class CallbackQuery: Unique identifier for this query.
CallbackQuery::getFrom() — Method in class CallbackQuery: Sender.
CallbackQuery::getChatInstance() — Method in class CallbackQuery: Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games.
CallbackQuery::getMessage() — Method in class CallbackQuery: Optional. Message with the callback button that originated the query. Note that message content and message date will not be available if the message is too old.
CallbackQuery::getInlineMessageId() — Method in class CallbackQuery: Optional. Identifier of the message sent via the bot in inline mode, that originated the query.
CallbackQuery::getData() — Method in class CallbackQuery: Optional. Data associated with the callback button. Be aware that the message originated the query can contain no callback buttons with this data.
CallbackQuery::getGameShortName() — Method in class CallbackQuery: Optional. Short name of a Game to be returned, serves as the unique identifier for the game.
Chat::getId() — Method in class Chat: Unique identifier for this chat. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.
Chat::getType() — Method in class Chat: Type of chat, can be either “private”, “group”, “supergroup” or “channel”.
Chat::getTitle() — Method in class Chat: Optional. Title, for supergroups, channels and group chats.
Chat::getUsername() — Method in class Chat: Optional. Username, for private chats, supergroups and channels if available.
Chat::getFirstName() — Method in class Chat: Optional. First name of the other party in a private chat.
Chat::getLastName() — Method in class Chat: Optional. Last name of the other party in a private chat.
Chat::getIsForum() — Method in class Chat: Optional. True, if the supergroup chat is a forum (has topics enabled).
Chat::getPhoto() — Method in class Chat: Optional. Chat photo. Returned only in getChat.
Chat::getActiveUsernames() — Method in class Chat: Optional. If non-empty, the list of all active chat usernames; for private chats, supergroups and channels. Returned only in getChat.
Chat::getEmojiStatusCustomEmojiId() — Method in class Chat: Optional. Custom emoji identifier of emoji status of the other party in a private chat. Returned only in getChat.
Chat::getBio() — Method in class Chat: Optional. Bio of the other party in a private chat. Returned only in getChat.
Chat::getHasPrivateForwards() — Method in class Chat: Optional. True, if privacy settings of the other party in the private chat allows to use tg://user?id= links only in chats with the user. Returned only in getChat.
Chat::getHasRestrictedVoiceAndVideoMessages() — Method in class Chat: Optional. True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat. Returned only in getChat.
Chat::getJoinToSendMessages() — Method in class Chat: Optional. True, if users need to join the supergroup before they can send messages. Returned only in getChat.
Chat::getJoinByRequest() — Method in class Chat: Optional. True, if all users directly joining the supergroup need to be approved by supergroup administrators. Returned only in getChat.
Chat::getDescription() — Method in class Chat: Optional. Description, for groups, supergroups and channel chats. Returned only in getChat.
Chat::getInviteLink() — Method in class Chat: Optional. Primary invite link, for groups, supergroups and channel chats. Returned only in getChat.
Chat::getPinnedMessage() — Method in class Chat: Optional. The most recent pinned message (by sending date). Returned only in getChat.
Chat::getPermissions() — Method in class Chat: Optional. Default chat member permissions, for groups and supergroups. Returned only in getChat.
Chat::getSlowModeDelay() — Method in class Chat: Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unpriviledged user; in seconds. Returned only in getChat.
Chat::getMessageAutoDeleteTime() — Method in class Chat: Optional. The time after which all messages sent to the chat will be automatically deleted; in seconds. Returned only in getChat.
Chat::getHasProtectedContent() — Method in class Chat: Optional. True, if messages from the chat can't be forwarded to other chats. Returned only in getChat.
Chat::getStickerSetName() — Method in class Chat: Optional. For supergroups, name of group sticker set. Returned only in getChat.
Chat::getCanSetStickerSet() — Method in class Chat: Optional. True, if the bot can change the group sticker set. Returned only in getChat.
Chat::getLinkedChatId() — Method in class Chat: Optional. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. Returned only in getChat.
Chat::getLocation() — Method in class Chat: Optional. For supergroups, the location to which the supergroup is connected. Returned only in getChat.
ChatAdministratorRights::getIsAnonymous() — Method in class ChatAdministratorRights: True, if the user's presence in the chat is hidden.
ChatAdministratorRights::getCanManageChat() — Method in class ChatAdministratorRights: True, if the administrator can access the chat event log, chat statistics, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege.
ChatAdministratorRights::getCanDeleteMessages() — Method in class ChatAdministratorRights: True, if the administrator can delete messages of other users.
ChatAdministratorRights::getCanManageVideoChats() — Method in class ChatAdministratorRights: True, if the administrator can manage video chats.
ChatAdministratorRights::getCanRestrictMembers() — Method in class ChatAdministratorRights: True, if the administrator can restrict, ban or unban chat members.
ChatAdministratorRights::getCanPromoteMembers() — Method in class ChatAdministratorRights: True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by the user).
ChatAdministratorRights::getCanChangeInfo() — Method in class ChatAdministratorRights: True, if the user is allowed to change the chat title, photo and other settings.
ChatAdministratorRights::getCanInviteUsers() — Method in class ChatAdministratorRights: True, if the user is allowed to invite new users to the chat.
ChatAdministratorRights::getCanPostMessages() — Method in class ChatAdministratorRights: Optional. True, if the administrator can post in the channel; channels only.
ChatAdministratorRights::getCanEditMessages() — Method in class ChatAdministratorRights: Optional. True, if the administrator can edit messages of other users and can pin messages; channels only.
ChatAdministratorRights::getCanPinMessages() — Method in class ChatAdministratorRights: Optional. True, if the user is allowed to pin messages; groups and supergroups only.
ChatAdministratorRights::getCanManageTopics() — Method in class ChatAdministratorRights: Optional. True, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only.
ChatInviteLink::getInviteLink() — Method in class ChatInviteLink: The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with “…”.
ChatInviteLink::getCreator() — Method in class ChatInviteLink: Creator of the link.
ChatInviteLink::getCreatesJoinRequest() — Method in class ChatInviteLink: True, if users joining the chat via the link need to be approved by chat administrators.
ChatInviteLink::getIsPrimary() — Method in class ChatInviteLink: True, if the link is primary.
ChatInviteLink::getIsRevoked() — Method in class ChatInviteLink: True, if the link is revoked.
ChatInviteLink::getName() — Method in class ChatInviteLink: Optional. Invite link name.
ChatInviteLink::getExpireDate() — Method in class ChatInviteLink: Optional. Point in time (Unix timestamp) when the link will expire or has been expired.
ChatInviteLink::getMemberLimit() — Method in class ChatInviteLink: Optional. The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999.
ChatInviteLink::getPendingJoinRequestCount() — Method in class ChatInviteLink: Optional. Number of pending join requests created using this link.
ChatJoinRequest::getChat() — Method in class ChatJoinRequest: Chat to which the request was sent.
ChatJoinRequest::getFrom() — Method in class ChatJoinRequest: User that sent the join request.
ChatJoinRequest::getDate() — Method in class ChatJoinRequest: Date the request was sent in Unix time.
ChatJoinRequest::getBio() — Method in class ChatJoinRequest: Optional. Bio of the user.
ChatJoinRequest::getInviteLink() — Method in class ChatJoinRequest: Optional. Chat invite link that was used by the user to send the join request.
ChatLocation::getLocation() — Method in class ChatLocation: The location to which the supergroup is connected. Can't be a live location.
ChatLocation::getAddress() — Method in class ChatLocation: Location address; 1-64 characters, as defined by the chat owner.
ChatMemberAdministrator::getStatus() — Method in class ChatMemberAdministrator: The member's status in the chat, always “administrator”.
ChatMemberAdministrator::getUser() — Method in class ChatMemberAdministrator: Information about the user.
ChatMemberAdministrator::getCanBeEdited() — Method in class ChatMemberAdministrator: True, if the bot is allowed to edit administrator privileges of that user.
ChatMemberAdministrator::getIsAnonymous() — Method in class ChatMemberAdministrator: True, if the user's presence in the chat is hidden.
ChatMemberAdministrator::getCanManageChat() — Method in class ChatMemberAdministrator: True, if the administrator can access the chat event log, chat statistics, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege.
ChatMemberAdministrator::getCanDeleteMessages() — Method in class ChatMemberAdministrator: True, if the administrator can delete messages of other users.
ChatMemberAdministrator::getCanManageVideoChats() — Method in class ChatMemberAdministrator: True, if the administrator can manage video chats.
ChatMemberAdministrator::getCanRestrictMembers() — Method in class ChatMemberAdministrator: True, if the administrator can restrict, ban or unban chat members.
ChatMemberAdministrator::getCanPromoteMembers() — Method in class ChatMemberAdministrator: True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by the user).
ChatMemberAdministrator::getCanChangeInfo() — Method in class ChatMemberAdministrator: True, if the user is allowed to change the chat title, photo and other settings.
ChatMemberAdministrator::getCanInviteUsers() — Method in class ChatMemberAdministrator: True, if the user is allowed to invite new users to the chat.
ChatMemberAdministrator::getCanPostMessages() — Method in class ChatMemberAdministrator: Optional. True, if the administrator can post in the channel; channels only.
ChatMemberAdministrator::getCanEditMessages() — Method in class ChatMemberAdministrator: Optional. True, if the administrator can edit messages of other users and can pin messages; channels only.
ChatMemberAdministrator::getCanPinMessages() — Method in class ChatMemberAdministrator: Optional. True, if the user is allowed to pin messages; groups and supergroups only.
ChatMemberAdministrator::getCanManageTopics() — Method in class ChatMemberAdministrator: Optional. True, if the user is allowed to create, rename, close, and reopen forum topics; supergroups only.
ChatMemberAdministrator::getCustomTitle() — Method in class ChatMemberAdministrator: Optional. Custom title for this user.
ChatMemberBanned::getStatus() — Method in class ChatMemberBanned: The member's status in the chat, always “kicked”.
ChatMemberBanned::getUser() — Method in class ChatMemberBanned: Information about the user.
ChatMemberBanned::getUntilDate() — Method in class ChatMemberBanned: Date when restrictions will be lifted for this user; unix time. If 0, then the user is banned forever.
ChatMemberLeft::getStatus() — Method in class ChatMemberLeft: The member's status in the chat, always “left”.
ChatMemberLeft::getUser() — Method in class ChatMemberLeft: Information about the user.
ChatMemberMember::getStatus() — Method in class ChatMemberMember: The member's status in the chat, always “member”.
ChatMemberMember::getUser() — Method in class ChatMemberMember: Information about the user.
ChatMemberOwner::getStatus() — Method in class ChatMemberOwner: The member's status in the chat, always “creator”.
ChatMemberOwner::getUser() — Method in class ChatMemberOwner: Information about the user.
ChatMemberOwner::getIsAnonymous() — Method in class ChatMemberOwner: True, if the user's presence in the chat is hidden.
ChatMemberOwner::getCustomTitle() — Method in class ChatMemberOwner: Optional. Custom title for this user.
ChatMemberRestricted::getStatus() — Method in class ChatMemberRestricted: The member's status in the chat, always “restricted”.
ChatMemberRestricted::getUser() — Method in class ChatMemberRestricted: Information about the user.
ChatMemberRestricted::getIsMember() — Method in class ChatMemberRestricted: True, if the user is a member of the chat at the moment of the request.
ChatMemberRestricted::getCanChangeInfo() — Method in class ChatMemberRestricted: True, if the user is allowed to change the chat title, photo and other settings.
ChatMemberRestricted::getCanInviteUsers() — Method in class ChatMemberRestricted: True, if the user is allowed to invite new users to the chat.
ChatMemberRestricted::getCanPinMessages() — Method in class ChatMemberRestricted: True, if the user is allowed to pin messages.
ChatMemberRestricted::getCanManageTopics() — Method in class ChatMemberRestricted: True, if the user is allowed to create forum topics.
ChatMemberRestricted::getCanSendMessages() — Method in class ChatMemberRestricted: True, if the user is allowed to send text messages, contacts, locations and venues.
ChatMemberRestricted::getCanSendMediaMessages() — Method in class ChatMemberRestricted: True, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes.
ChatMemberRestricted::getCanSendPolls() — Method in class ChatMemberRestricted: True, if the user is allowed to send polls.
ChatMemberRestricted::getCanSendOtherMessages() — Method in class ChatMemberRestricted: True, if the user is allowed to send animations, games, stickers and use inline bots.
ChatMemberRestricted::getCanAddWebPagePreviews() — Method in class ChatMemberRestricted: True, if the user is allowed to add web page previews to their messages.
ChatMemberRestricted::getUntilDate() — Method in class ChatMemberRestricted: Date when restrictions will be lifted for this user; unix time. If 0, then the user is restricted forever.
ChatMemberUpdated::getChat() — Method in class ChatMemberUpdated: Chat the user belongs to.
ChatMemberUpdated::getFrom() — Method in class ChatMemberUpdated: Performer of the action, which resulted in the change.
ChatMemberUpdated::getDate() — Method in class ChatMemberUpdated: Date the change was done in Unix time.
ChatMemberUpdated::getOldChatMember() — Method in class ChatMemberUpdated: Previous information about the chat member.
ChatMemberUpdated::getNewChatMember() — Method in class ChatMemberUpdated: New information about the chat member.
ChatMemberUpdated::getInviteLink() — Method in class ChatMemberUpdated: Optional. Chat invite link, which was used by the user to join the chat; for joining by invite link events only.
ChatPermissions::getCanSendMessages() — Method in class ChatPermissions: Optional. True, if the user is allowed to send text messages, contacts, locations and venues.
ChatPermissions::getCanSendMediaMessages() — Method in class ChatPermissions: Optional. True, if the user is allowed to send audios, documents, photos, videos, video notes and voice notes, implies can_send_messages.
ChatPermissions::getCanSendPolls() — Method in class ChatPermissions: Optional. True, if the user is allowed to send polls, implies can_send_messages.
ChatPermissions::getCanSendOtherMessages() — Method in class ChatPermissions: Optional. True, if the user is allowed to send animations, games, stickers and use inline bots, implies can_send_media_messages.
ChatPermissions::getCanAddWebPagePreviews() — Method in class ChatPermissions: Optional. True, if the user is allowed to add web page previews to their messages, implies can_send_media_messages.
ChatPermissions::getCanChangeInfo() — Method in class ChatPermissions: Optional. True, if the user is allowed to change the chat title, photo and other settings. Ignored in public supergroups.
ChatPermissions::getCanInviteUsers() — Method in class ChatPermissions: Optional. True, if the user is allowed to invite new users to the chat.
ChatPermissions::getCanPinMessages() — Method in class ChatPermissions: Optional. True, if the user is allowed to pin messages. Ignored in public supergroups.
ChatPermissions::getCanManageTopics() — Method in class ChatPermissions: Optional. True, if the user is allowed to create forum topics. If omitted defaults to the value of can_pin_messages.
ChatPhoto::getSmallFileId() — Method in class ChatPhoto: File identifier of small (160x160) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed.
ChatPhoto::getSmallFileUniqueId() — Method in class ChatPhoto: Unique file identifier of small (160x160) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
ChatPhoto::getBigFileId() — Method in class ChatPhoto: File identifier of big (640x640) chat photo. This file_id can be used only for photo download and only for as long as the photo is not changed.
ChatPhoto::getBigFileUniqueId() — Method in class ChatPhoto: Unique file identifier of big (640x640) chat photo, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
ChosenInlineResult::getResultId() — Method in class ChosenInlineResult: The unique identifier for the result that was chosen.
ChosenInlineResult::getFrom() — Method in class ChosenInlineResult: The user that chose the result.
ChosenInlineResult::getQuery() — Method in class ChosenInlineResult: The query that was used to obtain the result.
ChosenInlineResult::getLocation() — Method in class ChosenInlineResult: Optional. Sender location, only for bots that require user location.
ChosenInlineResult::getInlineMessageId() — Method in class ChosenInlineResult: Optional. Identifier of the sent inline message. Available only if there is an inline keyboard attached to the message. Will be also received in callback queries and can be used to edit the message.
Contact::getPhoneNumber() — Method in class Contact: Contact's phone number.
Contact::getFirstName() — Method in class Contact: Contact's first name.
Contact::getLastName() — Method in class Contact: Optional. Contact's last name.
Contact::getUserId() — Method in class Contact: Optional. Contact's user identifier in Telegram. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.
Contact::getVcard() — Method in class Contact: Optional. Additional data about the contact in the form of a vCard.
Dice::getEmoji() — Method in class Dice: Emoji on which the dice throw animation is based.
Dice::getValue() — Method in class Dice: __simple_html_domvoku__html_wrapper____>Value of the dice, 1-6 for “🎲”, “🎯” and “🎳” base emoji, 1-5 for “🏀” and “⚽” base emoji, 1-64 for “🎰” base emoji.
Document::getFileId() — Method in class Document: Identifier for this file, which can be used to download or reuse the file.
Document::getFileUniqueId() — Method in class Document: Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
Document::getThumb() — Method in class Document: Optional. Document thumbnail as defined by sender.
Document::getFileName() — Method in class Document: Optional. Original filename as defined by sender.
Document::getMimeType() — Method in class Document: Optional. MIME type of the file as defined by sender.
Document::getFileSize() — Method in class Document: Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.
EncryptedCredentials::getData() — Method in class EncryptedCredentials: Base64-encoded encrypted JSON-serialized data with unique user's payload, data hashes and secrets required for EncryptedPassportElement decryption and authentication.
EncryptedCredentials::getHash() — Method in class EncryptedCredentials: Base64-encoded data hash for data authentication.
EncryptedCredentials::getSecret() — Method in class EncryptedCredentials: Base64-encoded secret, encrypted with the bot's public RSA key, required for data decryption.
EncryptedPassportElement::getType() — Method in class EncryptedPassportElement: Element type. One of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”, “phone_number”, “email”.
EncryptedPassportElement::getHash() — Method in class EncryptedPassportElement: Base64-encoded element hash for using in PassportElementErrorUnspecified.
EncryptedPassportElement::getData() — Method in class EncryptedPassportElement: Optional. Base64-encoded encrypted Telegram Passport element data provided by the user, available for “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport” and “address” types. Can be decrypted and verified using the accompanying EncryptedCredentials.
EncryptedPassportElement::getPhoneNumber() — Method in class EncryptedPassportElement: Optional. User's verified phone number, available only for “phone_number” type.
EncryptedPassportElement::getEmail() — Method in class EncryptedPassportElement: Optional. User's verified email address, available only for “email” type.
EncryptedPassportElement::getFiles() — Method in class EncryptedPassportElement: Optional. Array of encrypted files with documents provided by the user, available for “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials.
EncryptedPassportElement::getFrontSide() — Method in class EncryptedPassportElement: Optional. Encrypted file with the front side of the document, provided by the user. Available for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials.
EncryptedPassportElement::getReverseSide() — Method in class EncryptedPassportElement: Optional. Encrypted file with the reverse side of the document, provided by the user. Available for “driver_license” and “identity_card”. The file can be decrypted and verified using the accompanying EncryptedCredentials.
EncryptedPassportElement::getSelfie() — Method in class EncryptedPassportElement: Optional. Encrypted file with the selfie of the user holding a document, provided by the user; available for “passport”, “driver_license”, “identity_card” and “internal_passport”. The file can be decrypted and verified using the accompanying EncryptedCredentials.
EncryptedPassportElement::getTranslation() — Method in class EncryptedPassportElement: Optional. Array of encrypted files with translated versions of documents provided by the user. Available if requested for “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration” and “temporary_registration” types. Files can be decrypted and verified using the accompanying EncryptedCredentials.
File::getFileId() — Method in class File: Identifier for this file, which can be used to download or reuse the file.
File::getFileUniqueId() — Method in class File: Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
File::getFileSize() — Method in class File: Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.
File::getFilePath() — Method in class File: Optional. File path. Use https://api.telegram.org/file/bot/ to get the file.
ForceReply::getForceReply() — Method in class ForceReply: Shows reply interface to the user, as if they manually selected the bot's message and tapped 'Reply'.
ForceReply::getInputFieldPlaceholder() — Method in class ForceReply: Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters.
ForceReply::getSelective() — Method in class ForceReply: Optional. Use this parameter if you want to force reply from specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.
ForumTopic::getMessageThreadId() — Method in class ForumTopic: Unique identifier of the forum topic.
ForumTopic::getName() — Method in class ForumTopic: Name of the topic.
ForumTopic::getIconColor() — Method in class ForumTopic: Color of the topic icon in RGB format.
ForumTopic::getIconCustomEmojiId() — Method in class ForumTopic: Optional. Unique identifier of the custom emoji shown as the topic icon.
ForumTopicCreated::getName() — Method in class ForumTopicCreated: Name of the topic.
ForumTopicCreated::getIconColor() — Method in class ForumTopicCreated: Color of the topic icon in RGB format.
ForumTopicCreated::getIconCustomEmojiId() — Method in class ForumTopicCreated: Optional. Unique identifier of the custom emoji shown as the topic icon.
Game — Class in namespace GingTeam\Telegram\Type: This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.
Game::getTitle() — Method in class Game: Title of the game.
Game::getDescription() — Method in class Game: Description of the game.
Game::getPhoto() — Method in class Game: Photo that will be displayed in the game message in chats.
Game::getText() — Method in class Game: Optional. Brief description of the game or high scores included in the game message. Can be automatically edited to include current high scores for the game when the bot calls setGameScore, or manually edited using editMessageText. 0-4096 characters.
Game::getTextEntities() — Method in class Game: Optional. Special entities that appear in text, such as usernames, URLs, bot commands, etc.
Game::getAnimation() — Method in class Game: Optional. Animation that will be displayed in the game message in chats. Upload via BotFather.
GameHighScore — Class in namespace GingTeam\Telegram\Type: This object represents one row of the high scores table for a game.
GameHighScore::getPosition() — Method in class GameHighScore: Position in high score table for the game.
GameHighScore::getUser() — Method in class GameHighScore: User.
GameHighScore::getScore() — Method in class GameHighScore: Score.
InlineKeyboardButton::getText() — Method in class InlineKeyboardButton: Label text on the button.
InlineKeyboardButton::getUrl() — Method in class InlineKeyboardButton: Optional. HTTP or tg:// URL to be opened when the button is pressed. Links tg://user?id= can be used to mention a user by their ID without using a username, if this is allowed by their privacy settings.
InlineKeyboardButton::getCallbackData() — Method in class InlineKeyboardButton: Optional. Data to be sent in a callback query to the bot when button is pressed, 1-64 bytes.
InlineKeyboardButton::getWebApp() — Method in class InlineKeyboardButton: Optional. Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery. Available only in private chats between a user and the bot.
InlineKeyboardButton::getLoginUrl() — Method in class InlineKeyboardButton: Optional. An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget.
InlineKeyboardButton::getSwitchInlineQuery() — Method in class InlineKeyboardButton: Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted.Note: This offers an easy way for users to start using your bot in inline mode when they are currently in a private chat with it. Especially useful when combined with switch_pm… actions - in this case the user will be automatically returned to the chat they switched from, skipping the chat selection screen.
InlineKeyboardButton::getSwitchInlineQueryCurrentChat() — Method in class InlineKeyboardButton: Optional. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted.This offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options.
InlineKeyboardButton::getCallbackGame() — Method in class InlineKeyboardButton: Optional. Description of the game that will be launched when the user presses the button.NOTE: This type of button must always be the first button in the first row.
InlineKeyboardButton::getPay() — Method in class InlineKeyboardButton: Optional. Specify True, to send a Pay button.NOTE: This type of button must always be the first button in the first row and can only be used in invoice messages.
InlineKeyboardMarkup::getInlineKeyboard() — Method in class InlineKeyboardMarkup: Array of button rows, each represented by an Array of InlineKeyboardButton objects.
InlineQuery::getId() — Method in class InlineQuery: Unique identifier for this query.
InlineQuery::getFrom() — Method in class InlineQuery: Sender.
InlineQuery::getQuery() — Method in class InlineQuery: Text of the query (up to 256 characters).
InlineQuery::getOffset() — Method in class InlineQuery: Offset of the results to be returned, can be controlled by the bot.
InlineQuery::getChatType() — Method in class InlineQuery: Optional. Type of the chat from which the inline query was sent. Can be either “sender” for a private chat with the inline query sender, “private”, “group”, “supergroup”, or “channel”. The chat type should be always known for requests sent from official clients and most third-party clients, unless the request was sent from a secret chat.
InlineQuery::getLocation() — Method in class InlineQuery: Optional. Sender location, only for bots that request user location.
InlineQueryResultArticle::getType() — Method in class InlineQueryResultArticle: Type of the result, must be article.
InlineQueryResultArticle::getId() — Method in class InlineQueryResultArticle: Unique identifier for this result, 1-64 Bytes.
InlineQueryResultArticle::getTitle() — Method in class InlineQueryResultArticle: Title of the result.
InlineQueryResultArticle::getInputMessageContent() — Method in class InlineQueryResultArticle: Content of the message to be sent.
InlineQueryResultArticle::getReplyMarkup() — Method in class InlineQueryResultArticle: Optional. Inline keyboard attached to the message.
InlineQueryResultArticle::getUrl() — Method in class InlineQueryResultArticle: Optional. URL of the result.
InlineQueryResultArticle::getHideUrl() — Method in class InlineQueryResultArticle: Optional. Pass True if you don't want the URL to be shown in the message.
InlineQueryResultArticle::getDescription() — Method in class InlineQueryResultArticle: Optional. Short description of the result.
InlineQueryResultArticle::getThumbUrl() — Method in class InlineQueryResultArticle: Optional. Url of the thumbnail for the result.
InlineQueryResultArticle::getThumbWidth() — Method in class InlineQueryResultArticle: Optional. Thumbnail width.
InlineQueryResultArticle::getThumbHeight() — Method in class InlineQueryResultArticle: Optional. Thumbnail height.
InlineQueryResultAudio::getType() — Method in class InlineQueryResultAudio: Type of the result, must be audio.
InlineQueryResultAudio::getId() — Method in class InlineQueryResultAudio: Unique identifier for this result, 1-64 bytes.
InlineQueryResultAudio::getAudioUrl() — Method in class InlineQueryResultAudio: A valid URL for the audio file.
InlineQueryResultAudio::getTitle() — Method in class InlineQueryResultAudio: Title.
InlineQueryResultAudio::getCaption() — Method in class InlineQueryResultAudio: Optional. Caption, 0-1024 characters after entities parsing.
InlineQueryResultAudio::getParseMode() — Method in class InlineQueryResultAudio: Optional. Mode for parsing entities in the audio caption. See formatting options for more details.
InlineQueryResultAudio::getCaptionEntities() — Method in class InlineQueryResultAudio: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode.
InlineQueryResultAudio::getPerformer() — Method in class InlineQueryResultAudio: Optional. Performer.
InlineQueryResultAudio::getAudioDuration() — Method in class InlineQueryResultAudio: Optional. Audio duration in seconds.
InlineQueryResultAudio::getReplyMarkup() — Method in class InlineQueryResultAudio: Optional. Inline keyboard attached to the message.
InlineQueryResultAudio::getInputMessageContent() — Method in class InlineQueryResultAudio: Optional. Content of the message to be sent instead of the audio.
InlineQueryResultCachedAudio::getType() — Method in class InlineQueryResultCachedAudio: Type of the result, must be audio.
InlineQueryResultCachedAudio::getId() — Method in class InlineQueryResultCachedAudio: Unique identifier for this result, 1-64 bytes.
InlineQueryResultCachedAudio::getAudioFileId() — Method in class InlineQueryResultCachedAudio: A valid file identifier for the audio file.
InlineQueryResultCachedAudio::getCaption() — Method in class InlineQueryResultCachedAudio: Optional. Caption, 0-1024 characters after entities parsing.
InlineQueryResultCachedAudio::getParseMode() — Method in class InlineQueryResultCachedAudio: Optional. Mode for parsing entities in the audio caption. See formatting options for more details.
InlineQueryResultCachedAudio::getCaptionEntities() — Method in class InlineQueryResultCachedAudio: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode.
InlineQueryResultCachedAudio::getReplyMarkup() — Method in class InlineQueryResultCachedAudio: Optional. Inline keyboard attached to the message.
InlineQueryResultCachedAudio::getInputMessageContent() — Method in class InlineQueryResultCachedAudio: Optional. Content of the message to be sent instead of the audio.
InlineQueryResultCachedDocument::getType() — Method in class InlineQueryResultCachedDocument: Type of the result, must be document.
InlineQueryResultCachedDocument::getId() — Method in class InlineQueryResultCachedDocument: Unique identifier for this result, 1-64 bytes.
InlineQueryResultCachedDocument::getTitle() — Method in class InlineQueryResultCachedDocument: Title for the result.
InlineQueryResultCachedDocument::getDocumentFileId() — Method in class InlineQueryResultCachedDocument: A valid file identifier for the file.
InlineQueryResultCachedDocument::getDescription() — Method in class InlineQueryResultCachedDocument: Optional. Short description of the result.
InlineQueryResultCachedDocument::getCaption() — Method in class InlineQueryResultCachedDocument: Optional. Caption of the document to be sent, 0-1024 characters after entities parsing.
InlineQueryResultCachedDocument::getParseMode() — Method in class InlineQueryResultCachedDocument: Optional. Mode for parsing entities in the document caption. See formatting options for more details.
InlineQueryResultCachedDocument::getCaptionEntities() — Method in class InlineQueryResultCachedDocument: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode.
InlineQueryResultCachedDocument::getReplyMarkup() — Method in class InlineQueryResultCachedDocument: Optional. Inline keyboard attached to the message.
InlineQueryResultCachedDocument::getInputMessageContent() — Method in class InlineQueryResultCachedDocument: Optional. Content of the message to be sent instead of the file.
InlineQueryResultCachedGif::getType() — Method in class InlineQueryResultCachedGif: Type of the result, must be gif.
InlineQueryResultCachedGif::getId() — Method in class InlineQueryResultCachedGif: Unique identifier for this result, 1-64 bytes.
InlineQueryResultCachedGif::getGifFileId() — Method in class InlineQueryResultCachedGif: A valid file identifier for the GIF file.
InlineQueryResultCachedGif::getTitle() — Method in class InlineQueryResultCachedGif: Optional. Title for the result.
InlineQueryResultCachedGif::getCaption() — Method in class InlineQueryResultCachedGif: Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing.
InlineQueryResultCachedGif::getParseMode() — Method in class InlineQueryResultCachedGif: Optional. Mode for parsing entities in the caption. See formatting options for more details.
InlineQueryResultCachedGif::getCaptionEntities() — Method in class InlineQueryResultCachedGif: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode.
InlineQueryResultCachedGif::getReplyMarkup() — Method in class InlineQueryResultCachedGif: Optional. Inline keyboard attached to the message.
InlineQueryResultCachedGif::getInputMessageContent() — Method in class InlineQueryResultCachedGif: Optional. Content of the message to be sent instead of the GIF animation.
InlineQueryResultCachedMpeg4Gif::getType() — Method in class InlineQueryResultCachedMpeg4Gif: Type of the result, must be mpeg4_gif.
InlineQueryResultCachedMpeg4Gif::getId() — Method in class InlineQueryResultCachedMpeg4Gif: Unique identifier for this result, 1-64 bytes.
InlineQueryResultCachedMpeg4Gif::getMpeg4FileId() — Method in class InlineQueryResultCachedMpeg4Gif: A valid file identifier for the MPEG4 file.
InlineQueryResultCachedMpeg4Gif::getTitle() — Method in class InlineQueryResultCachedMpeg4Gif: Optional. Title for the result.
InlineQueryResultCachedMpeg4Gif::getCaption() — Method in class InlineQueryResultCachedMpeg4Gif: Optional. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing.
InlineQueryResultCachedMpeg4Gif::getParseMode() — Method in class InlineQueryResultCachedMpeg4Gif: Optional. Mode for parsing entities in the caption. See formatting options for more details.
InlineQueryResultCachedMpeg4Gif::getCaptionEntities() — Method in class InlineQueryResultCachedMpeg4Gif: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode.
InlineQueryResultCachedMpeg4Gif::getReplyMarkup() — Method in class InlineQueryResultCachedMpeg4Gif: Optional. Inline keyboard attached to the message.
InlineQueryResultCachedMpeg4Gif::getInputMessageContent() — Method in class InlineQueryResultCachedMpeg4Gif: Optional. Content of the message to be sent instead of the video animation.
InlineQueryResultCachedPhoto::getType() — Method in class InlineQueryResultCachedPhoto: Type of the result, must be photo.
InlineQueryResultCachedPhoto::getId() — Method in class InlineQueryResultCachedPhoto: Unique identifier for this result, 1-64 bytes.
InlineQueryResultCachedPhoto::getPhotoFileId() — Method in class InlineQueryResultCachedPhoto: A valid file identifier of the photo.
InlineQueryResultCachedPhoto::getTitle() — Method in class InlineQueryResultCachedPhoto: Optional. Title for the result.
InlineQueryResultCachedPhoto::getDescription() — Method in class InlineQueryResultCachedPhoto: Optional. Short description of the result.
InlineQueryResultCachedPhoto::getCaption() — Method in class InlineQueryResultCachedPhoto: Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing.
InlineQueryResultCachedPhoto::getParseMode() — Method in class InlineQueryResultCachedPhoto: Optional. Mode for parsing entities in the photo caption. See formatting options for more details.
InlineQueryResultCachedPhoto::getCaptionEntities() — Method in class InlineQueryResultCachedPhoto: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode.
InlineQueryResultCachedPhoto::getReplyMarkup() — Method in class InlineQueryResultCachedPhoto: Optional. Inline keyboard attached to the message.
InlineQueryResultCachedPhoto::getInputMessageContent() — Method in class InlineQueryResultCachedPhoto: Optional. Content of the message to be sent instead of the photo.
InlineQueryResultCachedSticker::getType() — Method in class InlineQueryResultCachedSticker: Type of the result, must be sticker.
InlineQueryResultCachedSticker::getId() — Method in class InlineQueryResultCachedSticker: Unique identifier for this result, 1-64 bytes.
InlineQueryResultCachedSticker::getStickerFileId() — Method in class InlineQueryResultCachedSticker: A valid file identifier of the sticker.
InlineQueryResultCachedSticker::getReplyMarkup() — Method in class InlineQueryResultCachedSticker: Optional. Inline keyboard attached to the message.
InlineQueryResultCachedSticker::getInputMessageContent() — Method in class InlineQueryResultCachedSticker: Optional. Content of the message to be sent instead of the sticker.
InlineQueryResultCachedVideo::getType() — Method in class InlineQueryResultCachedVideo: Type of the result, must be video.
InlineQueryResultCachedVideo::getId() — Method in class InlineQueryResultCachedVideo: Unique identifier for this result, 1-64 bytes.
InlineQueryResultCachedVideo::getVideoFileId() — Method in class InlineQueryResultCachedVideo: A valid file identifier for the video file.
InlineQueryResultCachedVideo::getTitle() — Method in class InlineQueryResultCachedVideo: Title for the result.
InlineQueryResultCachedVideo::getDescription() — Method in class InlineQueryResultCachedVideo: Optional. Short description of the result.
InlineQueryResultCachedVideo::getCaption() — Method in class InlineQueryResultCachedVideo: Optional. Caption of the video to be sent, 0-1024 characters after entities parsing.
InlineQueryResultCachedVideo::getParseMode() — Method in class InlineQueryResultCachedVideo: Optional. Mode for parsing entities in the video caption. See formatting options for more details.
InlineQueryResultCachedVideo::getCaptionEntities() — Method in class InlineQueryResultCachedVideo: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode.
InlineQueryResultCachedVideo::getReplyMarkup() — Method in class InlineQueryResultCachedVideo: Optional. Inline keyboard attached to the message.
InlineQueryResultCachedVideo::getInputMessageContent() — Method in class InlineQueryResultCachedVideo: Optional. Content of the message to be sent instead of the video.
InlineQueryResultCachedVoice::getType() — Method in class InlineQueryResultCachedVoice: Type of the result, must be voice.
InlineQueryResultCachedVoice::getId() — Method in class InlineQueryResultCachedVoice: Unique identifier for this result, 1-64 bytes.
InlineQueryResultCachedVoice::getVoiceFileId() — Method in class InlineQueryResultCachedVoice: A valid file identifier for the voice message.
InlineQueryResultCachedVoice::getTitle() — Method in class InlineQueryResultCachedVoice: Voice message title.
InlineQueryResultCachedVoice::getCaption() — Method in class InlineQueryResultCachedVoice: Optional. Caption, 0-1024 characters after entities parsing.
InlineQueryResultCachedVoice::getParseMode() — Method in class InlineQueryResultCachedVoice: Optional. Mode for parsing entities in the voice message caption. See formatting options for more details.
InlineQueryResultCachedVoice::getCaptionEntities() — Method in class InlineQueryResultCachedVoice: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode.
InlineQueryResultCachedVoice::getReplyMarkup() — Method in class InlineQueryResultCachedVoice: Optional. Inline keyboard attached to the message.
InlineQueryResultCachedVoice::getInputMessageContent() — Method in class InlineQueryResultCachedVoice: Optional. Content of the message to be sent instead of the voice message.
InlineQueryResultContact::getType() — Method in class InlineQueryResultContact: Type of the result, must be contact.
InlineQueryResultContact::getId() — Method in class InlineQueryResultContact: Unique identifier for this result, 1-64 Bytes.
InlineQueryResultContact::getPhoneNumber() — Method in class InlineQueryResultContact: Contact's phone number.
InlineQueryResultContact::getFirstName() — Method in class InlineQueryResultContact: Contact's first name.
InlineQueryResultContact::getLastName() — Method in class InlineQueryResultContact: Optional. Contact's last name.
InlineQueryResultContact::getVcard() — Method in class InlineQueryResultContact: Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes.
InlineQueryResultContact::getReplyMarkup() — Method in class InlineQueryResultContact: Optional. Inline keyboard attached to the message.
InlineQueryResultContact::getInputMessageContent() — Method in class InlineQueryResultContact: Optional. Content of the message to be sent instead of the contact.
InlineQueryResultContact::getThumbUrl() — Method in class InlineQueryResultContact: Optional. Url of the thumbnail for the result.
InlineQueryResultContact::getThumbWidth() — Method in class InlineQueryResultContact: Optional. Thumbnail width.
InlineQueryResultContact::getThumbHeight() — Method in class InlineQueryResultContact: Optional. Thumbnail height.
InlineQueryResultDocument::getType() — Method in class InlineQueryResultDocument: Type of the result, must be document.
InlineQueryResultDocument::getId() — Method in class InlineQueryResultDocument: Unique identifier for this result, 1-64 bytes.
InlineQueryResultDocument::getTitle() — Method in class InlineQueryResultDocument: Title for the result.
InlineQueryResultDocument::getDocumentUrl() — Method in class InlineQueryResultDocument: A valid URL for the file.
InlineQueryResultDocument::getMimeType() — Method in class InlineQueryResultDocument: MIME type of the content of the file, either “application/pdf” or “application/zip”.
InlineQueryResultDocument::getCaption() — Method in class InlineQueryResultDocument: Optional. Caption of the document to be sent, 0-1024 characters after entities parsing.
InlineQueryResultDocument::getParseMode() — Method in class InlineQueryResultDocument: Optional. Mode for parsing entities in the document caption. See formatting options for more details.
InlineQueryResultDocument::getCaptionEntities() — Method in class InlineQueryResultDocument: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode.
InlineQueryResultDocument::getDescription() — Method in class InlineQueryResultDocument: Optional. Short description of the result.
InlineQueryResultDocument::getReplyMarkup() — Method in class InlineQueryResultDocument: Optional. Inline keyboard attached to the message.
InlineQueryResultDocument::getInputMessageContent() — Method in class InlineQueryResultDocument: Optional. Content of the message to be sent instead of the file.
InlineQueryResultDocument::getThumbUrl() — Method in class InlineQueryResultDocument: Optional. URL of the thumbnail (JPEG only) for the file.
InlineQueryResultDocument::getThumbWidth() — Method in class InlineQueryResultDocument: Optional. Thumbnail width.
InlineQueryResultDocument::getThumbHeight() — Method in class InlineQueryResultDocument: Optional. Thumbnail height.
InlineQueryResultGame::getType() — Method in class InlineQueryResultGame: Type of the result, must be game.
InlineQueryResultGame::getId() — Method in class InlineQueryResultGame: Unique identifier for this result, 1-64 bytes.
InlineQueryResultGame::getGameShortName() — Method in class InlineQueryResultGame: Short name of the game.
InlineQueryResultGame::getReplyMarkup() — Method in class InlineQueryResultGame: Optional. Inline keyboard attached to the message.
InlineQueryResultGif::getType() — Method in class InlineQueryResultGif: Type of the result, must be gif.
InlineQueryResultGif::getId() — Method in class InlineQueryResultGif: Unique identifier for this result, 1-64 bytes.
InlineQueryResultGif::getGifUrl() — Method in class InlineQueryResultGif: A valid URL for the GIF file. File size must not exceed 1MB.
InlineQueryResultGif::getThumbUrl() — Method in class InlineQueryResultGif: URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result.
InlineQueryResultGif::getGifWidth() — Method in class InlineQueryResultGif: Optional. Width of the GIF.
InlineQueryResultGif::getGifHeight() — Method in class InlineQueryResultGif: Optional. Height of the GIF.
InlineQueryResultGif::getGifDuration() — Method in class InlineQueryResultGif: Optional. Duration of the GIF in seconds.
InlineQueryResultGif::getThumbMimeType() — Method in class InlineQueryResultGif: Optional. MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg”.
InlineQueryResultGif::getTitle() — Method in class InlineQueryResultGif: Optional. Title for the result.
InlineQueryResultGif::getCaption() — Method in class InlineQueryResultGif: Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing.
InlineQueryResultGif::getParseMode() — Method in class InlineQueryResultGif: Optional. Mode for parsing entities in the caption. See formatting options for more details.
InlineQueryResultGif::getCaptionEntities() — Method in class InlineQueryResultGif: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode.
InlineQueryResultGif::getReplyMarkup() — Method in class InlineQueryResultGif: Optional. Inline keyboard attached to the message.
InlineQueryResultGif::getInputMessageContent() — Method in class InlineQueryResultGif: Optional. Content of the message to be sent instead of the GIF animation.
InlineQueryResultLocation::getType() — Method in class InlineQueryResultLocation: Type of the result, must be location.
InlineQueryResultLocation::getId() — Method in class InlineQueryResultLocation: Unique identifier for this result, 1-64 Bytes.
InlineQueryResultLocation::getLatitude() — Method in class InlineQueryResultLocation: Location latitude in degrees.
InlineQueryResultLocation::getLongitude() — Method in class InlineQueryResultLocation: Location longitude in degrees.
InlineQueryResultLocation::getTitle() — Method in class InlineQueryResultLocation: Location title.
InlineQueryResultLocation::getHorizontalAccuracy() — Method in class InlineQueryResultLocation: Optional. The radius of uncertainty for the location, measured in meters; 0-1500.
InlineQueryResultLocation::getLivePeriod() — Method in class InlineQueryResultLocation: Optional. Period in seconds for which the location can be updated, should be between 60 and 86400.
InlineQueryResultLocation::getHeading() — Method in class InlineQueryResultLocation: Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.
InlineQueryResultLocation::getProximityAlertRadius() — Method in class InlineQueryResultLocation: Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.
InlineQueryResultLocation::getReplyMarkup() — Method in class InlineQueryResultLocation: Optional. Inline keyboard attached to the message.
InlineQueryResultLocation::getInputMessageContent() — Method in class InlineQueryResultLocation: Optional. Content of the message to be sent instead of the location.
InlineQueryResultLocation::getThumbUrl() — Method in class InlineQueryResultLocation: Optional. Url of the thumbnail for the result.
InlineQueryResultLocation::getThumbWidth() — Method in class InlineQueryResultLocation: Optional. Thumbnail width.
InlineQueryResultLocation::getThumbHeight() — Method in class InlineQueryResultLocation: Optional. Thumbnail height.
InlineQueryResultMpeg4Gif::getType() — Method in class InlineQueryResultMpeg4Gif: Type of the result, must be mpeg4_gif.
InlineQueryResultMpeg4Gif::getId() — Method in class InlineQueryResultMpeg4Gif: Unique identifier for this result, 1-64 bytes.
InlineQueryResultMpeg4Gif::getMpeg4Url() — Method in class InlineQueryResultMpeg4Gif: A valid URL for the MPEG4 file. File size must not exceed 1MB.
InlineQueryResultMpeg4Gif::getThumbUrl() — Method in class InlineQueryResultMpeg4Gif: URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result.
InlineQueryResultMpeg4Gif::getMpeg4Width() — Method in class InlineQueryResultMpeg4Gif: Optional. Video width.
InlineQueryResultMpeg4Gif::getMpeg4Height() — Method in class InlineQueryResultMpeg4Gif: Optional. Video height.
InlineQueryResultMpeg4Gif::getMpeg4Duration() — Method in class InlineQueryResultMpeg4Gif: Optional. Video duration in seconds.
InlineQueryResultMpeg4Gif::getThumbMimeType() — Method in class InlineQueryResultMpeg4Gif: Optional. MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to “image/jpeg”.
InlineQueryResultMpeg4Gif::getTitle() — Method in class InlineQueryResultMpeg4Gif: Optional. Title for the result.
InlineQueryResultMpeg4Gif::getCaption() — Method in class InlineQueryResultMpeg4Gif: Optional. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing.
InlineQueryResultMpeg4Gif::getParseMode() — Method in class InlineQueryResultMpeg4Gif: Optional. Mode for parsing entities in the caption. See formatting options for more details.
InlineQueryResultMpeg4Gif::getCaptionEntities() — Method in class InlineQueryResultMpeg4Gif: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode.
InlineQueryResultMpeg4Gif::getReplyMarkup() — Method in class InlineQueryResultMpeg4Gif: Optional. Inline keyboard attached to the message.
InlineQueryResultMpeg4Gif::getInputMessageContent() — Method in class InlineQueryResultMpeg4Gif: Optional. Content of the message to be sent instead of the video animation.
InlineQueryResultPhoto::getType() — Method in class InlineQueryResultPhoto: Type of the result, must be photo.
InlineQueryResultPhoto::getId() — Method in class InlineQueryResultPhoto: Unique identifier for this result, 1-64 bytes.
InlineQueryResultPhoto::getPhotoUrl() — Method in class InlineQueryResultPhoto: A valid URL of the photo. Photo must be in JPEG format. Photo size must not exceed 5MB.
InlineQueryResultPhoto::getThumbUrl() — Method in class InlineQueryResultPhoto: URL of the thumbnail for the photo.
InlineQueryResultPhoto::getPhotoWidth() — Method in class InlineQueryResultPhoto: Optional. Width of the photo.
InlineQueryResultPhoto::getPhotoHeight() — Method in class InlineQueryResultPhoto: Optional. Height of the photo.
InlineQueryResultPhoto::getTitle() — Method in class InlineQueryResultPhoto: Optional. Title for the result.
InlineQueryResultPhoto::getDescription() — Method in class InlineQueryResultPhoto: Optional. Short description of the result.
InlineQueryResultPhoto::getCaption() — Method in class InlineQueryResultPhoto: Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing.
InlineQueryResultPhoto::getParseMode() — Method in class InlineQueryResultPhoto: Optional. Mode for parsing entities in the photo caption. See formatting options for more details.
InlineQueryResultPhoto::getCaptionEntities() — Method in class InlineQueryResultPhoto: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode.
InlineQueryResultPhoto::getReplyMarkup() — Method in class InlineQueryResultPhoto: Optional. Inline keyboard attached to the message.
InlineQueryResultPhoto::getInputMessageContent() — Method in class InlineQueryResultPhoto: Optional. Content of the message to be sent instead of the photo.
InlineQueryResultVenue::getType() — Method in class InlineQueryResultVenue: Type of the result, must be venue.
InlineQueryResultVenue::getId() — Method in class InlineQueryResultVenue: Unique identifier for this result, 1-64 Bytes.
InlineQueryResultVenue::getLatitude() — Method in class InlineQueryResultVenue: Latitude of the venue location in degrees.
InlineQueryResultVenue::getLongitude() — Method in class InlineQueryResultVenue: Longitude of the venue location in degrees.
InlineQueryResultVenue::getTitle() — Method in class InlineQueryResultVenue: Title of the venue.
InlineQueryResultVenue::getAddress() — Method in class InlineQueryResultVenue: Address of the venue.
InlineQueryResultVenue::getFoursquareId() — Method in class InlineQueryResultVenue: Optional. Foursquare identifier of the venue if known.
InlineQueryResultVenue::getFoursquareType() — Method in class InlineQueryResultVenue: Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.).
InlineQueryResultVenue::getGooglePlaceId() — Method in class InlineQueryResultVenue: Optional. Google Places identifier of the venue.
InlineQueryResultVenue::getGooglePlaceType() — Method in class InlineQueryResultVenue: Optional. Google Places type of the venue. (See supported types.).
InlineQueryResultVenue::getReplyMarkup() — Method in class InlineQueryResultVenue: Optional. Inline keyboard attached to the message.
InlineQueryResultVenue::getInputMessageContent() — Method in class InlineQueryResultVenue: Optional. Content of the message to be sent instead of the venue.
InlineQueryResultVenue::getThumbUrl() — Method in class InlineQueryResultVenue: Optional. Url of the thumbnail for the result.
InlineQueryResultVenue::getThumbWidth() — Method in class InlineQueryResultVenue: Optional. Thumbnail width.
InlineQueryResultVenue::getThumbHeight() — Method in class InlineQueryResultVenue: Optional. Thumbnail height.
InlineQueryResultVideo::getType() — Method in class InlineQueryResultVideo: Type of the result, must be video.
InlineQueryResultVideo::getId() — Method in class InlineQueryResultVideo: Unique identifier for this result, 1-64 bytes.
InlineQueryResultVideo::getVideoUrl() — Method in class InlineQueryResultVideo: A valid URL for the embedded video player or video file.
InlineQueryResultVideo::getMimeType() — Method in class InlineQueryResultVideo: MIME type of the content of the video URL, “text/html” or “video/mp4”.
InlineQueryResultVideo::getThumbUrl() — Method in class InlineQueryResultVideo: URL of the thumbnail (JPEG only) for the video.
InlineQueryResultVideo::getTitle() — Method in class InlineQueryResultVideo: Title for the result.
InlineQueryResultVideo::getCaption() — Method in class InlineQueryResultVideo: Optional. Caption of the video to be sent, 0-1024 characters after entities parsing.
InlineQueryResultVideo::getParseMode() — Method in class InlineQueryResultVideo: Optional. Mode for parsing entities in the video caption. See formatting options for more details.
InlineQueryResultVideo::getCaptionEntities() — Method in class InlineQueryResultVideo: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode.
InlineQueryResultVideo::getVideoWidth() — Method in class InlineQueryResultVideo: Optional. Video width.
InlineQueryResultVideo::getVideoHeight() — Method in class InlineQueryResultVideo: Optional. Video height.
InlineQueryResultVideo::getVideoDuration() — Method in class InlineQueryResultVideo: Optional. Video duration in seconds.
InlineQueryResultVideo::getDescription() — Method in class InlineQueryResultVideo: Optional. Short description of the result.
InlineQueryResultVideo::getReplyMarkup() — Method in class InlineQueryResultVideo: Optional. Inline keyboard attached to the message.
InlineQueryResultVideo::getInputMessageContent() — Method in class InlineQueryResultVideo: Optional. Content of the message to be sent instead of the video. This field is required if InlineQueryResultVideo is used to send an HTML-page as a result (e.g., a YouTube video).
InlineQueryResultVoice::getType() — Method in class InlineQueryResultVoice: Type of the result, must be voice.
InlineQueryResultVoice::getId() — Method in class InlineQueryResultVoice: Unique identifier for this result, 1-64 bytes.
InlineQueryResultVoice::getVoiceUrl() — Method in class InlineQueryResultVoice: A valid URL for the voice recording.
InlineQueryResultVoice::getTitle() — Method in class InlineQueryResultVoice: Recording title.
InlineQueryResultVoice::getCaption() — Method in class InlineQueryResultVoice: Optional. Caption, 0-1024 characters after entities parsing.
InlineQueryResultVoice::getParseMode() — Method in class InlineQueryResultVoice: Optional. Mode for parsing entities in the voice message caption. See formatting options for more details.
InlineQueryResultVoice::getCaptionEntities() — Method in class InlineQueryResultVoice: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode.
InlineQueryResultVoice::getVoiceDuration() — Method in class InlineQueryResultVoice: Optional. Recording duration in seconds.
InlineQueryResultVoice::getReplyMarkup() — Method in class InlineQueryResultVoice: Optional. Inline keyboard attached to the message.
InlineQueryResultVoice::getInputMessageContent() — Method in class InlineQueryResultVoice: Optional. Content of the message to be sent instead of the voice recording.
InputContactMessageContent::getPhoneNumber() — Method in class InputContactMessageContent: Contact's phone number.
InputContactMessageContent::getFirstName() — Method in class InputContactMessageContent: Contact's first name.
InputContactMessageContent::getLastName() — Method in class InputContactMessageContent: Optional. Contact's last name.
InputContactMessageContent::getVcard() — Method in class InputContactMessageContent: Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes.
InputInvoiceMessageContent::getTitle() — Method in class InputInvoiceMessageContent: Product name, 1-32 characters.
InputInvoiceMessageContent::getDescription() — Method in class InputInvoiceMessageContent: Product description, 1-255 characters.
InputInvoiceMessageContent::getPayload() — Method in class InputInvoiceMessageContent: Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.
InputInvoiceMessageContent::getProviderToken() — Method in class InputInvoiceMessageContent: Payment provider token, obtained via @BotFather.
InputInvoiceMessageContent::getCurrency() — Method in class InputInvoiceMessageContent: Three-letter ISO 4217 currency code, see more on currencies.
InputInvoiceMessageContent::getPrices() — Method in class InputInvoiceMessageContent: Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.).
InputInvoiceMessageContent::getMaxTipAmount() — Method in class InputInvoiceMessageContent: Optional. The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0.
InputInvoiceMessageContent::getSuggestedTipAmounts() — Method in class InputInvoiceMessageContent: Optional. A JSON-serialized array of suggested amounts of tip in the smallest units of the currency (integer, not float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed in a strictly increased order and must not exceed max_tip_amount.
InputInvoiceMessageContent::getProviderData() — Method in class InputInvoiceMessageContent: Optional. A JSON-serialized object for data about the invoice, which will be shared with the payment provider. A detailed description of the required fields should be provided by the payment provider.
InputInvoiceMessageContent::getPhotoUrl() — Method in class InputInvoiceMessageContent: Optional. URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.
InputInvoiceMessageContent::getPhotoSize() — Method in class InputInvoiceMessageContent: Optional. Photo size in bytes.
InputInvoiceMessageContent::getPhotoWidth() — Method in class InputInvoiceMessageContent: Optional. Photo width.
InputInvoiceMessageContent::getPhotoHeight() — Method in class InputInvoiceMessageContent: Optional. Photo height.
InputInvoiceMessageContent::getNeedName() — Method in class InputInvoiceMessageContent: Optional. Pass True if you require the user's full name to complete the order.
InputInvoiceMessageContent::getNeedPhoneNumber() — Method in class InputInvoiceMessageContent: Optional. Pass True if you require the user's phone number to complete the order.
InputInvoiceMessageContent::getNeedEmail() — Method in class InputInvoiceMessageContent: Optional. Pass True if you require the user's email address to complete the order.
InputInvoiceMessageContent::getNeedShippingAddress() — Method in class InputInvoiceMessageContent: Optional. Pass True if you require the user's shipping address to complete the order.
InputInvoiceMessageContent::getSendPhoneNumberToProvider() — Method in class InputInvoiceMessageContent: Optional. Pass True if the user's phone number should be sent to provider.
InputInvoiceMessageContent::getSendEmailToProvider() — Method in class InputInvoiceMessageContent: Optional. Pass True if the user's email address should be sent to provider.
InputInvoiceMessageContent::getIsFlexible() — Method in class InputInvoiceMessageContent: Optional. Pass True if the final price depends on the shipping method.
InputLocationMessageContent::getLatitude() — Method in class InputLocationMessageContent: Latitude of the location in degrees.
InputLocationMessageContent::getLongitude() — Method in class InputLocationMessageContent: Longitude of the location in degrees.
InputLocationMessageContent::getHorizontalAccuracy() — Method in class InputLocationMessageContent: Optional. The radius of uncertainty for the location, measured in meters; 0-1500.
InputLocationMessageContent::getLivePeriod() — Method in class InputLocationMessageContent: Optional. Period in seconds for which the location can be updated, should be between 60 and 86400.
InputLocationMessageContent::getHeading() — Method in class InputLocationMessageContent: Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.
InputLocationMessageContent::getProximityAlertRadius() — Method in class InputLocationMessageContent: Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.
InputMediaAnimation::getType() — Method in class InputMediaAnimation: Type of the result, must be animation.
InputMediaAnimation::getMedia() — Method in class InputMediaAnimation: File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://” to upload a new one using multipart/form-data under name. More information on Sending Files ».
InputMediaAnimation::getThumb() — Method in class InputMediaAnimation: Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://” if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files ».
InputMediaAnimation::getCaption() — Method in class InputMediaAnimation: Optional. Caption of the animation to be sent, 0-1024 characters after entities parsing.
InputMediaAnimation::getParseMode() — Method in class InputMediaAnimation: Optional. Mode for parsing entities in the animation caption. See formatting options for more details.
InputMediaAnimation::getCaptionEntities() — Method in class InputMediaAnimation: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode.
InputMediaAnimation::getWidth() — Method in class InputMediaAnimation: Optional. Animation width.
InputMediaAnimation::getHeight() — Method in class InputMediaAnimation: Optional. Animation height.
InputMediaAnimation::getDuration() — Method in class InputMediaAnimation: Optional. Animation duration in seconds.
InputMediaAudio::getType() — Method in class InputMediaAudio: Type of the result, must be audio.
InputMediaAudio::getMedia() — Method in class InputMediaAudio: File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://” to upload a new one using multipart/form-data under name. More information on Sending Files ».
InputMediaAudio::getThumb() — Method in class InputMediaAudio: Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://” if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files ».
InputMediaAudio::getCaption() — Method in class InputMediaAudio: Optional. Caption of the audio to be sent, 0-1024 characters after entities parsing.
InputMediaAudio::getParseMode() — Method in class InputMediaAudio: Optional. Mode for parsing entities in the audio caption. See formatting options for more details.
InputMediaAudio::getCaptionEntities() — Method in class InputMediaAudio: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode.
InputMediaAudio::getDuration() — Method in class InputMediaAudio: Optional. Duration of the audio in seconds.
InputMediaAudio::getPerformer() — Method in class InputMediaAudio: Optional. Performer of the audio.
InputMediaAudio::getTitle() — Method in class InputMediaAudio: Optional. Title of the audio.
InputMediaDocument::getType() — Method in class InputMediaDocument: Type of the result, must be document.
InputMediaDocument::getMedia() — Method in class InputMediaDocument: File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://” to upload a new one using multipart/form-data under name. More information on Sending Files ».
InputMediaDocument::getThumb() — Method in class InputMediaDocument: Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://” if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files ».
InputMediaDocument::getCaption() — Method in class InputMediaDocument: Optional. Caption of the document to be sent, 0-1024 characters after entities parsing.
InputMediaDocument::getParseMode() — Method in class InputMediaDocument: Optional. Mode for parsing entities in the document caption. See formatting options for more details.
InputMediaDocument::getCaptionEntities() — Method in class InputMediaDocument: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode.
InputMediaDocument::getDisableContentTypeDetection() — Method in class InputMediaDocument: Optional. Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always True, if the document is sent as part of an album.
InputMediaPhoto::getType() — Method in class InputMediaPhoto: Type of the result, must be photo.
InputMediaPhoto::getMedia() — Method in class InputMediaPhoto: File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://” to upload a new one using multipart/form-data under name. More information on Sending Files ».
InputMediaPhoto::getCaption() — Method in class InputMediaPhoto: Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing.
InputMediaPhoto::getParseMode() — Method in class InputMediaPhoto: Optional. Mode for parsing entities in the photo caption. See formatting options for more details.
InputMediaPhoto::getCaptionEntities() — Method in class InputMediaPhoto: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode.
InputMediaVideo::getType() — Method in class InputMediaVideo: Type of the result, must be video.
InputMediaVideo::getMedia() — Method in class InputMediaVideo: File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://” to upload a new one using multipart/form-data under name. More information on Sending Files ».
InputMediaVideo::getThumb() — Method in class InputMediaVideo: Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://” if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files ».
InputMediaVideo::getCaption() — Method in class InputMediaVideo: Optional. Caption of the video to be sent, 0-1024 characters after entities parsing.
InputMediaVideo::getParseMode() — Method in class InputMediaVideo: Optional. Mode for parsing entities in the video caption. See formatting options for more details.
InputMediaVideo::getCaptionEntities() — Method in class InputMediaVideo: Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode.
InputMediaVideo::getWidth() — Method in class InputMediaVideo: Optional. Video width.
InputMediaVideo::getHeight() — Method in class InputMediaVideo: Optional. Video height.
InputMediaVideo::getDuration() — Method in class InputMediaVideo: Optional. Video duration in seconds.
InputMediaVideo::getSupportsStreaming() — Method in class InputMediaVideo: Optional. Pass True if the uploaded video is suitable for streaming.
InputTextMessageContent::getMessageText() — Method in class InputTextMessageContent: Text of the message to be sent, 1-4096 characters.
InputTextMessageContent::getParseMode() — Method in class InputTextMessageContent: Optional. Mode for parsing entities in the message text. See formatting options for more details.
InputTextMessageContent::getEntities() — Method in class InputTextMessageContent: Optional. List of special entities that appear in message text, which can be specified instead of parse_mode.
InputTextMessageContent::getDisableWebPagePreview() — Method in class InputTextMessageContent: Optional. Disables link previews for links in the sent message.
InputVenueMessageContent::getLatitude() — Method in class InputVenueMessageContent: Latitude of the venue in degrees.
InputVenueMessageContent::getLongitude() — Method in class InputVenueMessageContent: Longitude of the venue in degrees.
InputVenueMessageContent::getTitle() — Method in class InputVenueMessageContent: Name of the venue.
InputVenueMessageContent::getAddress() — Method in class InputVenueMessageContent: Address of the venue.
InputVenueMessageContent::getFoursquareId() — Method in class InputVenueMessageContent: Optional. Foursquare identifier of the venue, if known.
InputVenueMessageContent::getFoursquareType() — Method in class InputVenueMessageContent: Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.).
InputVenueMessageContent::getGooglePlaceId() — Method in class InputVenueMessageContent: Optional. Google Places identifier of the venue.
InputVenueMessageContent::getGooglePlaceType() — Method in class InputVenueMessageContent: Optional. Google Places type of the venue. (See supported types.).
Invoice::getTitle() — Method in class Invoice: Product name.
Invoice::getDescription() — Method in class Invoice: Product description.
Invoice::getStartParameter() — Method in class Invoice: Unique bot deep-linking parameter that can be used to generate this invoice.
Invoice::getCurrency() — Method in class Invoice: Three-letter ISO 4217 currency code.
Invoice::getTotalAmount() — Method in class Invoice: Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
KeyboardButton::getText() — Method in class KeyboardButton: Text of the button. If none of the optional fields are used, it will be sent as a message when the button is pressed.
KeyboardButton::getRequestContact() — Method in class KeyboardButton: Optional. If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only.
KeyboardButton::getRequestLocation() — Method in class KeyboardButton: Optional. If True, the user's current location will be sent when the button is pressed. Available in private chats only.
KeyboardButton::getRequestPoll() — Method in class KeyboardButton: Optional. If specified, the user will be asked to create a poll and send it to the bot when the button is pressed. Available in private chats only.
KeyboardButton::getWebApp() — Method in class KeyboardButton: Optional. If specified, the described Web App will be launched when the button is pressed. The Web App will be able to send a “web_app_data” service message. Available in private chats only.
KeyboardButtonPollType::getType() — Method in class KeyboardButtonPollType: Optional. If quiz is passed, the user will be allowed to create only polls in the quiz mode. If regular is passed, only regular polls will be allowed. Otherwise, the user will be allowed to create a poll of any type.
LabeledPrice::getLabel() — Method in class LabeledPrice: Portion label.
LabeledPrice::getAmount() — Method in class LabeledPrice: Price of the product in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
Location::getLongitude() — Method in class Location: Longitude as defined by sender.
Location::getLatitude() — Method in class Location: Latitude as defined by sender.
Location::getHorizontalAccuracy() — Method in class Location: Optional. The radius of uncertainty for the location, measured in meters; 0-1500.
Location::getLivePeriod() — Method in class Location: Optional. Time relative to the message sending date, during which the location can be updated; in seconds. For active live locations only.
Location::getHeading() — Method in class Location: Optional. The direction in which user is moving, in degrees; 1-360. For active live locations only.
Location::getProximityAlertRadius() — Method in class Location: Optional. The maximum distance for proximity alerts about approaching another chat member, in meters. For sent live locations only.
LoginUrl::getUrl() — Method in class LoginUrl: An HTTPS URL to be opened with user authorization data added to the query string when the button is pressed. If the user refuses to provide authorization data, the original URL without information about the user will be opened. The data added is the same as described in Receiving authorization data.NOTE: You must always check the hash of the received data to verify the authentication and the integrity of the data as described in Checking authorization.
LoginUrl::getForwardText() — Method in class LoginUrl: Optional. New text of the button in forwarded messages.
LoginUrl::getBotUsername() — Method in class LoginUrl: Optional. Username of a bot, which will be used for user authorization. See Setting up a bot for more details. If not specified, the current bot's username will be assumed. The url's domain must be the same as the domain linked with the bot. See Linking your domain to the bot for more details.
LoginUrl::getRequestWriteAccess() — Method in class LoginUrl: Optional. Pass True to request the permission for your bot to send messages to the user.
MaskPosition::getPoint() — Method in class MaskPosition: The part of the face relative to which the mask should be placed. One of “forehead”, “eyes”, “mouth”, or “chin”.
MaskPosition::getXShift() — Method in class MaskPosition: Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. For example, choosing -1.0 will place mask just to the left of the default mask position.
MaskPosition::getYShift() — Method in class MaskPosition: Shift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom. For example, 1.0 will place the mask just below the default mask position.
MaskPosition::getScale() — Method in class MaskPosition: Mask scaling coefficient. For example, 2.0 means double size.
MenuButtonCommands::getType() — Method in class MenuButtonCommands: Type of the button, must be commands.
MenuButtonDefault::getType() — Method in class MenuButtonDefault: Type of the button, must be default.
MenuButtonWebApp::getType() — Method in class MenuButtonWebApp: Type of the button, must be web_app.
MenuButtonWebApp::getText() — Method in class MenuButtonWebApp: Text on the button.
MenuButtonWebApp::getWebApp() — Method in class MenuButtonWebApp: Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery.
Message::getMessageId() — Method in class Message: Unique message identifier inside this chat.
Message::getDate() — Method in class Message: Date the message was sent in Unix time.
Message::getChat() — Method in class Message: Conversation the message belongs to.
Message::getMessageThreadId() — Method in class Message: Optional. Unique identifier of a message thread to which the message belongs; for supergroups only.
Message::getFrom() — Method in class Message: Optional. Sender of the message; empty for messages sent to channels. For backward compatibility, the field contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat.
Message::getSenderChat() — Method in class Message: Optional. Sender of the message, sent on behalf of a chat. For example, the channel itself for channel posts, the supergroup itself for messages from anonymous group administrators, the linked channel for messages automatically forwarded to the discussion group. For backward compatibility, the field from contains a fake sender user in non-channel chats, if the message was sent on behalf of a chat.
Message::getForwardFrom() — Method in class Message: Optional. For forwarded messages, sender of the original message.
Message::getForwardFromChat() — Method in class Message: Optional. For messages forwarded from channels or from anonymous administrators, information about the original sender chat.
Message::getForwardFromMessageId() — Method in class Message: Optional. For messages forwarded from channels, identifier of the original message in the channel.
Message::getForwardSignature() — Method in class Message: Optional. For forwarded messages that were originally sent in channels or by an anonymous chat administrator, signature of the message sender if present.
Message::getForwardSenderName() — Method in class Message: Optional. Sender's name for messages forwarded from users who disallow adding a link to their account in forwarded messages.
Message::getForwardDate() — Method in class Message: Optional. For forwarded messages, date the original message was sent in Unix time.
Message::getIsTopicMessage() — Method in class Message: Optional. True, if the message is sent to a forum topic.
Message::getIsAutomaticForward() — Method in class Message: Optional. True, if the message is a channel post that was automatically forwarded to the connected discussion group.
Message::getReplyToMessage() — Method in class Message: Optional. For replies, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.
Message::getViaBot() — Method in class Message: Optional. Bot through which the message was sent.
Message::getEditDate() — Method in class Message: Optional. Date the message was last edited in Unix time.
Message::getHasProtectedContent() — Method in class Message: Optional. True, if the message can't be forwarded.
Message::getMediaGroupId() — Method in class Message: Optional. The unique identifier of a media message group this message belongs to.
Message::getAuthorSignature() — Method in class Message: Optional. Signature of the post author for messages in channels, or the custom title of an anonymous group administrator.
Message::getText() — Method in class Message: Optional. For text messages, the actual UTF-8 text of the message.
Message::getEntities() — Method in class Message: Optional. For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text.
Message::getAnimation() — Method in class Message: Optional. Message is an animation, information about the animation. For backward compatibility, when this field is set, the document field will also be set.
Message::getAudio() — Method in class Message: Optional. Message is an audio file, information about the file.
Message::getDocument() — Method in class Message: Optional. Message is a general file, information about the file.
Message::getPhoto() — Method in class Message: Optional. Message is a photo, available sizes of the photo.
Message::getSticker() — Method in class Message: Optional. Message is a sticker, information about the sticker.
Message::getVideo() — Method in class Message: Optional. Message is a video, information about the video.
Message::getVideoNote() — Method in class Message: Optional. Message is a video note, information about the video message.
Message::getVoice() — Method in class Message: Optional. Message is a voice message, information about the file.
Message::getCaption() — Method in class Message: Optional. Caption for the animation, audio, document, photo, video or voice.
Message::getCaptionEntities() — Method in class Message: Optional. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption.
Message::getContact() — Method in class Message: Optional. Message is a shared contact, information about the contact.
Message::getDice() — Method in class Message: Optional. Message is a dice with random value.
Message::getGame() — Method in class Message: Optional. Message is a game, information about the game. More about games ».
Message::getPoll() — Method in class Message: Optional. Message is a native poll, information about the poll.
Message::getVenue() — Method in class Message: Optional. Message is a venue, information about the venue. For backward compatibility, when this field is set, the location field will also be set.
Message::getLocation() — Method in class Message: Optional. Message is a shared location, information about the location.
Message::getNewChatMembers() — Method in class Message: Optional. New members that were added to the group or supergroup and information about them (the bot itself may be one of these members).
Message::getLeftChatMember() — Method in class Message: Optional. A member was removed from the group, information about them (this member may be the bot itself).
Message::getNewChatTitle() — Method in class Message: Optional. A chat title was changed to this value.
Message::getNewChatPhoto() — Method in class Message: Optional. A chat photo was change to this value.
Message::getDeleteChatPhoto() — Method in class Message: Optional. Service message: the chat photo was deleted.
Message::getGroupChatCreated() — Method in class Message: Optional. Service message: the group has been created.
Message::getSupergroupChatCreated() — Method in class Message: Optional. Service message: the supergroup has been created. This field can't be received in a message coming through updates, because bot can't be a member of a supergroup when it is created. It can only be found in reply_to_message if someone replies to a very first message in a directly created supergroup.
Message::getChannelChatCreated() — Method in class Message: Optional. Service message: the channel has been created. This field can't be received in a message coming through updates, because bot can't be a member of a channel when it is created. It can only be found in reply_to_message if someone replies to a very first message in a channel.
Message::getMessageAutoDeleteTimerChanged() — Method in class Message: Optional. Service message: auto-delete timer settings changed in the chat.
Message::getMigrateToChatId() — Method in class Message: Optional. The group has been migrated to a supergroup with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.
Message::getMigrateFromChatId() — Method in class Message: Optional. The supergroup has been migrated from a group with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.
Message::getPinnedMessage() — Method in class Message: Optional. Specified message was pinned. Note that the Message object in this field will not contain further reply_to_message fields even if it is itself a reply.
Message::getInvoice() — Method in class Message: Optional. Message is an invoice for a payment, information about the invoice. More about payments ».
Message::getSuccessfulPayment() — Method in class Message: Optional. Message is a service message about a successful payment, information about the payment. More about payments ».
Message::getConnectedWebsite() — Method in class Message: Optional. The domain name of the website on which the user has logged in. More about Telegram Login ».
Message::getPassportData() — Method in class Message: Optional. Telegram Passport data.
Message::getProximityAlertTriggered() — Method in class Message: Optional. Service message. A user in the chat triggered another user's proximity alert while sharing Live Location.
Message::getForumTopicCreated() — Method in class Message: Optional. Service message: forum topic created.
Message::getForumTopicClosed() — Method in class Message: Optional. Service message: forum topic closed.
Message::getForumTopicReopened() — Method in class Message: Optional. Service message: forum topic reopened.
Message::getVideoChatScheduled() — Method in class Message: Optional. Service message: video chat scheduled.
Message::getVideoChatStarted() — Method in class Message: Optional. Service message: video chat started.
Message::getVideoChatEnded() — Method in class Message: Optional. Service message: video chat ended.
Message::getVideoChatParticipantsInvited() — Method in class Message: Optional. Service message: new participants invited to a video chat.
Message::getWebAppData() — Method in class Message: Optional. Service message: data sent by a Web App.
Message::getReplyMarkup() — Method in class Message: Optional. Inline keyboard attached to the message. login_url buttons are represented as ordinary url buttons.
MessageAutoDeleteTimerChanged::getMessageAutoDeleteTime() — Method in class MessageAutoDeleteTimerChanged: New auto-delete time for messages in the chat; in seconds.
MessageEntity::getType() — Method in class MessageEntity: Type of the entity. Currently, can be “mention” (@username), “hashtag” (#hashtag), “cashtag” ($USD), “bot_command” (/start@jobs_bot), “url” (https://telegram.org), “email” (do-not-reply@telegram.org), “phone_number” (+1-212-555-0123), “bold” (bold text), “italic” (italic text), “underline” (underlined text), “strikethrough” (strikethrough text), “spoiler” (spoiler message), “code” (monowidth string), “pre” (monowidth block), “text_link” (for clickable text URLs), “text_mention” (for users without usernames), “custom_emoji” (for inline custom emoji stickers).
MessageEntity::getOffset() — Method in class MessageEntity: Offset in UTF-16 code units to the start of the entity.
MessageEntity::getLength() — Method in class MessageEntity: Length of the entity in UTF-16 code units.
MessageEntity::getUrl() — Method in class MessageEntity: Optional. For “text_link” only, URL that will be opened after user taps on the text.
MessageEntity::getUser() — Method in class MessageEntity: Optional. For “text_mention” only, the mentioned user.
MessageEntity::getLanguage() — Method in class MessageEntity: Optional. For “pre” only, the programming language of the entity text.
MessageEntity::getCustomEmojiId() — Method in class MessageEntity: Optional. For “custom_emoji” only, unique identifier of the custom emoji. Use getCustomEmojiStickers to get full information about the sticker.
MessageId::getMessageId() — Method in class MessageId: Unique message identifier.
OrderInfo::getName() — Method in class OrderInfo: Optional. User name.
OrderInfo::getPhoneNumber() — Method in class OrderInfo: Optional. User's phone number.
OrderInfo::getEmail() — Method in class OrderInfo: Optional. User email.
OrderInfo::getShippingAddress() — Method in class OrderInfo: Optional. User shipping address.
PassportData::getData() — Method in class PassportData: Array with information about documents and other Telegram Passport elements that was shared with the bot.
PassportData::getCredentials() — Method in class PassportData: Encrypted credentials required to decrypt the data.
PassportElementErrorDataField::getSource() — Method in class PassportElementErrorDataField: Error source, must be data.
PassportElementErrorDataField::getType() — Method in class PassportElementErrorDataField: The section of the user's Telegram Passport which has the error, one of “personal_details”, “passport”, “driver_license”, “identity_card”, “internal_passport”, “address”.
PassportElementErrorDataField::getFieldName() — Method in class PassportElementErrorDataField: Name of the data field which has the error.
PassportElementErrorDataField::getDataHash() — Method in class PassportElementErrorDataField: Base64-encoded data hash.
PassportElementErrorDataField::getMessage() — Method in class PassportElementErrorDataField: Error message.
PassportElementErrorFile::getSource() — Method in class PassportElementErrorFile: Error source, must be file.
PassportElementErrorFile::getType() — Method in class PassportElementErrorFile: The section of the user's Telegram Passport which has the issue, one of “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”.
PassportElementErrorFile::getFileHash() — Method in class PassportElementErrorFile: Base64-encoded file hash.
PassportElementErrorFile::getMessage() — Method in class PassportElementErrorFile: Error message.
PassportElementErrorFiles::getSource() — Method in class PassportElementErrorFiles: Error source, must be files.
PassportElementErrorFiles::getType() — Method in class PassportElementErrorFiles: The section of the user's Telegram Passport which has the issue, one of “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”.
PassportElementErrorFiles::getFileHashes() — Method in class PassportElementErrorFiles: List of base64-encoded file hashes.
PassportElementErrorFiles::getMessage() — Method in class PassportElementErrorFiles: Error message.
PassportElementErrorFrontSide::getSource() — Method in class PassportElementErrorFrontSide: Error source, must be front_side.
PassportElementErrorFrontSide::getType() — Method in class PassportElementErrorFrontSide: The section of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”.
PassportElementErrorFrontSide::getFileHash() — Method in class PassportElementErrorFrontSide: Base64-encoded hash of the file with the front side of the document.
PassportElementErrorFrontSide::getMessage() — Method in class PassportElementErrorFrontSide: Error message.
PassportElementErrorReverseSide::getSource() — Method in class PassportElementErrorReverseSide: Error source, must be reverse_side.
PassportElementErrorReverseSide::getType() — Method in class PassportElementErrorReverseSide: The section of the user's Telegram Passport which has the issue, one of “driver_license”, “identity_card”.
PassportElementErrorReverseSide::getFileHash() — Method in class PassportElementErrorReverseSide: Base64-encoded hash of the file with the reverse side of the document.
PassportElementErrorReverseSide::getMessage() — Method in class PassportElementErrorReverseSide: Error message.
PassportElementErrorSelfie::getSource() — Method in class PassportElementErrorSelfie: Error source, must be selfie.
PassportElementErrorSelfie::getType() — Method in class PassportElementErrorSelfie: The section of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”.
PassportElementErrorSelfie::getFileHash() — Method in class PassportElementErrorSelfie: Base64-encoded hash of the file with the selfie.
PassportElementErrorSelfie::getMessage() — Method in class PassportElementErrorSelfie: Error message.
PassportElementErrorTranslationFile::getSource() — Method in class PassportElementErrorTranslationFile: Error source, must be translation_file.
PassportElementErrorTranslationFile::getType() — Method in class PassportElementErrorTranslationFile: Type of element of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”.
PassportElementErrorTranslationFile::getFileHash() — Method in class PassportElementErrorTranslationFile: Base64-encoded file hash.
PassportElementErrorTranslationFile::getMessage() — Method in class PassportElementErrorTranslationFile: Error message.
PassportElementErrorTranslationFiles::getSource() — Method in class PassportElementErrorTranslationFiles: Error source, must be translation_files.
PassportElementErrorTranslationFiles::getType() — Method in class PassportElementErrorTranslationFiles: Type of element of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”, “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”, “passport_registration”, “temporary_registration”.
PassportElementErrorTranslationFiles::getFileHashes() — Method in class PassportElementErrorTranslationFiles: List of base64-encoded file hashes.
PassportElementErrorTranslationFiles::getMessage() — Method in class PassportElementErrorTranslationFiles: Error message.
PassportElementErrorUnspecified::getSource() — Method in class PassportElementErrorUnspecified: Error source, must be unspecified.
PassportElementErrorUnspecified::getType() — Method in class PassportElementErrorUnspecified: Type of element of the user's Telegram Passport which has the issue.
PassportElementErrorUnspecified::getElementHash() — Method in class PassportElementErrorUnspecified: Base64-encoded element hash.
PassportElementErrorUnspecified::getMessage() — Method in class PassportElementErrorUnspecified: Error message.
PassportFile::getFileId() — Method in class PassportFile: Identifier for this file, which can be used to download or reuse the file.
PassportFile::getFileUniqueId() — Method in class PassportFile: Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
PassportFile::getFileSize() — Method in class PassportFile: File size in bytes.
PassportFile::getFileDate() — Method in class PassportFile: Unix time when the file was uploaded.
PhotoSize::getFileId() — Method in class PhotoSize: Identifier for this file, which can be used to download or reuse the file.
PhotoSize::getFileUniqueId() — Method in class PhotoSize: Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
PhotoSize::getWidth() — Method in class PhotoSize: Photo width.
PhotoSize::getHeight() — Method in class PhotoSize: Photo height.
PhotoSize::getFileSize() — Method in class PhotoSize: Optional. File size in bytes.
Poll::getId() — Method in class Poll: Unique poll identifier.
Poll::getQuestion() — Method in class Poll: Poll question, 1-300 characters.
Poll::getOptions() — Method in class Poll: List of poll options.
Poll::getTotalVoterCount() — Method in class Poll: Total number of users that voted in the poll.
Poll::getIsClosed() — Method in class Poll: True, if the poll is closed.
Poll::getIsAnonymous() — Method in class Poll: True, if the poll is anonymous.
Poll::getType() — Method in class Poll: Poll type, currently can be “regular” or “quiz”.
Poll::getAllowsMultipleAnswers() — Method in class Poll: True, if the poll allows multiple answers.
Poll::getCorrectOptionId() — Method in class Poll: Optional. 0-based identifier of the correct answer option. Available only for polls in the quiz mode, which are closed, or was sent (not forwarded) by the bot or to the private chat with the bot.
Poll::getExplanation() — Method in class Poll: Optional. Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll, 0-200 characters.
Poll::getExplanationEntities() — Method in class Poll: Optional. Special entities like usernames, URLs, bot commands, etc. that appear in the explanation.
Poll::getOpenPeriod() — Method in class Poll: Optional. Amount of time in seconds the poll will be active after creation.
Poll::getCloseDate() — Method in class Poll: Optional. Point in time (Unix timestamp) when the poll will be automatically closed.
PollAnswer::getPollId() — Method in class PollAnswer: Unique poll identifier.
PollAnswer::getUser() — Method in class PollAnswer: The user, who changed the answer to the poll.
PollAnswer::getOptionIds() — Method in class PollAnswer: 0-based identifiers of answer options, chosen by the user. May be empty if the user retracted their vote.
PollOption::getText() — Method in class PollOption: Option text, 1-100 characters.
PollOption::getVoterCount() — Method in class PollOption: Number of users that voted for this option.
PreCheckoutQuery::getId() — Method in class PreCheckoutQuery: Unique query identifier.
PreCheckoutQuery::getFrom() — Method in class PreCheckoutQuery: User who sent the query.
PreCheckoutQuery::getCurrency() — Method in class PreCheckoutQuery: Three-letter ISO 4217 currency code.
PreCheckoutQuery::getTotalAmount() — Method in class PreCheckoutQuery: Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
PreCheckoutQuery::getInvoicePayload() — Method in class PreCheckoutQuery: Bot specified invoice payload.
PreCheckoutQuery::getShippingOptionId() — Method in class PreCheckoutQuery: Optional. Identifier of the shipping option chosen by the user.
PreCheckoutQuery::getOrderInfo() — Method in class PreCheckoutQuery: Optional. Order information provided by the user.
ProximityAlertTriggered::getTraveler() — Method in class ProximityAlertTriggered: User that triggered the alert.
ProximityAlertTriggered::getWatcher() — Method in class ProximityAlertTriggered: User that set the alert.
ProximityAlertTriggered::getDistance() — Method in class ProximityAlertTriggered: The distance between the users.
ReplyKeyboardMarkup::getKeyboard() — Method in class ReplyKeyboardMarkup: Array of button rows, each represented by an Array of KeyboardButton objects.
ReplyKeyboardMarkup::getResizeKeyboard() — Method in class ReplyKeyboardMarkup: Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard.
ReplyKeyboardMarkup::getOneTimeKeyboard() — Method in class ReplyKeyboardMarkup: Optional. Requests clients to hide the keyboard as soon as it's been used. The keyboard will still be available, but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button in the input field to see the custom keyboard again. Defaults to false.
ReplyKeyboardMarkup::getInputFieldPlaceholder() — Method in class ReplyKeyboardMarkup: Optional. The placeholder to be shown in the input field when the keyboard is active; 1-64 characters.
ReplyKeyboardMarkup::getSelective() — Method in class ReplyKeyboardMarkup: Optional. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.Example: A user requests to change the bot's language, bot replies to the request with a keyboard to select the new language. Other users in the group don't see the keyboard.
ReplyKeyboardRemove::getRemoveKeyboard() — Method in class ReplyKeyboardRemove: Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup).
ReplyKeyboardRemove::getSelective() — Method in class ReplyKeyboardRemove: Optional. Use this parameter if you want to remove the keyboard for specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.Example: A user votes in a poll, bot returns confirmation message in reply to the vote and removes the keyboard for that user, while still showing the keyboard with poll options to users who haven't voted yet.
Response::getResult() — Method in class Response
Response::getErrorCode() — Method in class Response
Response::getDescription() — Method in class Response
ResponseParameters::getMigrateToChatId() — Method in class ResponseParameters: Optional. The group has been migrated to a supergroup with the specified identifier. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this identifier.
ResponseParameters::getRetryAfter() — Method in class ResponseParameters: Optional. In case of exceeding flood control, the number of seconds left to wait before the request can be repeated.
SentWebAppMessage::getInlineMessageId() — Method in class SentWebAppMessage: Optional. Identifier of the sent inline message. Available only if there is an inline keyboard attached to the message.
ShippingAddress::getCountryCode() — Method in class ShippingAddress: Two-letter ISO 3166-1 alpha-2 country code.
ShippingAddress::getState() — Method in class ShippingAddress: State, if applicable.
ShippingAddress::getCity() — Method in class ShippingAddress: City.
ShippingAddress::getStreetLine1() — Method in class ShippingAddress: First line for the address.
ShippingAddress::getStreetLine2() — Method in class ShippingAddress: Second line for the address.
ShippingAddress::getPostCode() — Method in class ShippingAddress: Address post code.
ShippingOption::getId() — Method in class ShippingOption: Shipping option identifier.
ShippingOption::getTitle() — Method in class ShippingOption: Option title.
ShippingOption::getPrices() — Method in class ShippingOption: List of price portions.
ShippingQuery::getId() — Method in class ShippingQuery: Unique query identifier.
ShippingQuery::getFrom() — Method in class ShippingQuery: User who sent the query.
ShippingQuery::getInvoicePayload() — Method in class ShippingQuery: Bot specified invoice payload.
ShippingQuery::getShippingAddress() — Method in class ShippingQuery: User specified shipping address.
Sticker::getFileId() — Method in class Sticker: Identifier for this file, which can be used to download or reuse the file.
Sticker::getFileUniqueId() — Method in class Sticker: Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
Sticker::getType() — Method in class Sticker: Type of the sticker, currently one of “regular”, “mask”, “custom_emoji”. The type of the sticker is independent from its format, which is determined by the fields is_animated and is_video.
Sticker::getWidth() — Method in class Sticker: Sticker width.
Sticker::getHeight() — Method in class Sticker: Sticker height.
Sticker::getIsAnimated() — Method in class Sticker: True, if the sticker is animated.
Sticker::getIsVideo() — Method in class Sticker: True, if the sticker is a video sticker.
Sticker::getThumb() — Method in class Sticker: Optional. Sticker thumbnail in the .WEBP or .JPG format.
Sticker::getEmoji() — Method in class Sticker: Optional. Emoji associated with the sticker.
Sticker::getSetName() — Method in class Sticker: Optional. Name of the sticker set to which the sticker belongs.
Sticker::getPremiumAnimation() — Method in class Sticker: Optional. For premium regular stickers, premium animation for the sticker.
Sticker::getMaskPosition() — Method in class Sticker: Optional. For mask stickers, the position where the mask should be placed.
Sticker::getCustomEmojiId() — Method in class Sticker: Optional. For custom emoji stickers, unique identifier of the custom emoji.
Sticker::getFileSize() — Method in class Sticker: Optional. File size in bytes.
StickerSet::getName() — Method in class StickerSet: Sticker set name.
StickerSet::getTitle() — Method in class StickerSet: Sticker set title.
StickerSet::getStickerType() — Method in class StickerSet: Type of stickers in the set, currently one of “regular”, “mask”, “custom_emoji”.
StickerSet::getIsAnimated() — Method in class StickerSet: True, if the sticker set contains animated stickers.
StickerSet::getIsVideo() — Method in class StickerSet: True, if the sticker set contains video stickers.
StickerSet::getStickers() — Method in class StickerSet: List of all set stickers.
StickerSet::getThumb() — Method in class StickerSet: Optional. Sticker set thumbnail in the .WEBP, .TGS, or .WEBM format.
SuccessfulPayment::getCurrency() — Method in class SuccessfulPayment: Three-letter ISO 4217 currency code.
SuccessfulPayment::getTotalAmount() — Method in class SuccessfulPayment: Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
SuccessfulPayment::getInvoicePayload() — Method in class SuccessfulPayment: Bot specified invoice payload.
SuccessfulPayment::getTelegramPaymentChargeId() — Method in class SuccessfulPayment: Telegram payment identifier.
SuccessfulPayment::getProviderPaymentChargeId() — Method in class SuccessfulPayment: Provider payment identifier.
SuccessfulPayment::getShippingOptionId() — Method in class SuccessfulPayment: Optional. Identifier of the shipping option chosen by the user.
SuccessfulPayment::getOrderInfo() — Method in class SuccessfulPayment: Optional. Order information provided by the user.
Update::getUpdateId() — Method in class Update: The update's unique identifier. Update identifiers start from a certain positive number and increase sequentially. This ID becomes especially handy if you're using webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order. If there are no new updates for at least a week, then identifier of the next update will be chosen randomly instead of sequentially.
Update::getMessage() — Method in class Update: Optional. New incoming message of any kind - text, photo, sticker, etc.
Update::getEditedMessage() — Method in class Update: Optional. New version of a message that is known to the bot and was edited.
Update::getChannelPost() — Method in class Update: Optional. New incoming channel post of any kind - text, photo, sticker, etc.
Update::getEditedChannelPost() — Method in class Update: Optional. New version of a channel post that is known to the bot and was edited.
Update::getInlineQuery() — Method in class Update: Optional. New incoming inline query.
Update::getChosenInlineResult() — Method in class Update: Optional. The result of an inline query that was chosen by a user and sent to their chat partner. Please see our documentation on the feedback collecting for details on how to enable these updates for your bot.
Update::getCallbackQuery() — Method in class Update: Optional. New incoming callback query.
Update::getShippingQuery() — Method in class Update: Optional. New incoming shipping query. Only for invoices with flexible price.
Update::getPreCheckoutQuery() — Method in class Update: Optional. New incoming pre-checkout query. Contains full information about checkout.
Update::getPoll() — Method in class Update: Optional. New poll state. Bots receive only updates about stopped polls and polls, which are sent by the bot.
Update::getPollAnswer() — Method in class Update: Optional. A user changed their answer in a non-anonymous poll. Bots receive new votes only in polls that were sent by the bot itself.
Update::getMyChatMember() — Method in class Update: Optional. The bot's chat member status was updated in a chat. For private chats, this update is received only when the bot is blocked or unblocked by the user.
Update::getChatMember() — Method in class Update: Optional. A chat member's status was updated in a chat. The bot must be an administrator in the chat and must explicitly specify “chat_member” in the list of allowed_updates to receive these updates.
Update::getChatJoinRequest() — Method in class Update: Optional. A request to join the chat has been sent. The bot must have the can_invite_users administrator right in the chat to receive these updates.
User::getId() — Method in class User: Unique identifier for this user or bot. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.
User::getIsBot() — Method in class User: True, if this user is a bot.
User::getFirstName() — Method in class User: User's or bot's first name.
User::getLastName() — Method in class User: Optional. User's or bot's last name.
User::getUsername() — Method in class User: Optional. User's or bot's username.
User::getLanguageCode() — Method in class User: Optional. IETF language tag of the user's language.
User::getIsPremium() — Method in class User: Optional. True, if this user is a Telegram Premium user.
User::getAddedToAttachmentMenu() — Method in class User: Optional. True, if this user added the bot to the attachment menu.
User::getCanJoinGroups() — Method in class User: Optional. True, if the bot can be invited to groups. Returned only in getMe.
User::getCanReadAllGroupMessages() — Method in class User: Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.
User::getSupportsInlineQueries() — Method in class User: Optional. True, if the bot supports inline queries. Returned only in getMe.
UserProfilePhotos::getTotalCount() — Method in class UserProfilePhotos: Total number of profile pictures the target user has.
UserProfilePhotos::getPhotos() — Method in class UserProfilePhotos: Requested profile pictures (in up to 4 sizes each).
Venue::getLocation() — Method in class Venue: Venue location. Can't be a live location.
Venue::getTitle() — Method in class Venue: Name of the venue.
Venue::getAddress() — Method in class Venue: Address of the venue.
Venue::getFoursquareId() — Method in class Venue: Optional. Foursquare identifier of the venue.
Venue::getFoursquareType() — Method in class Venue: Optional. Foursquare type of the venue. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.).
Venue::getGooglePlaceId() — Method in class Venue: Optional. Google Places identifier of the venue.
Venue::getGooglePlaceType() — Method in class Venue: Optional. Google Places type of the venue. (See supported types.).
Video::getFileId() — Method in class Video: Identifier for this file, which can be used to download or reuse the file.
Video::getFileUniqueId() — Method in class Video: Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
Video::getWidth() — Method in class Video: Video width as defined by sender.
Video::getHeight() — Method in class Video: Video height as defined by sender.
Video::getDuration() — Method in class Video: Duration of the video in seconds as defined by sender.
Video::getThumb() — Method in class Video: Optional. Video thumbnail.
Video::getFileName() — Method in class Video: Optional. Original filename as defined by sender.
Video::getMimeType() — Method in class Video: Optional. MIME type of the file as defined by sender.
Video::getFileSize() — Method in class Video: Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.
VideoChatEnded::getDuration() — Method in class VideoChatEnded: Video chat duration in seconds.
VideoChatParticipantsInvited::getUsers() — Method in class VideoChatParticipantsInvited: New members that were invited to the video chat.
VideoChatScheduled::getStartDate() — Method in class VideoChatScheduled: Point in time (Unix timestamp) when the video chat is supposed to be started by a chat administrator.
VideoNote::getFileId() — Method in class VideoNote: Identifier for this file, which can be used to download or reuse the file.
VideoNote::getFileUniqueId() — Method in class VideoNote: Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
VideoNote::getLength() — Method in class VideoNote: Video width and height (diameter of the video message) as defined by sender.
VideoNote::getDuration() — Method in class VideoNote: Duration of the video in seconds as defined by sender.
VideoNote::getThumb() — Method in class VideoNote: Optional. Video thumbnail.
VideoNote::getFileSize() — Method in class VideoNote: Optional. File size in bytes.
Voice::getFileId() — Method in class Voice: Identifier for this file, which can be used to download or reuse the file.
Voice::getFileUniqueId() — Method in class Voice: Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.
Voice::getDuration() — Method in class Voice: Duration of the audio in seconds as defined by sender.
Voice::getMimeType() — Method in class Voice: Optional. MIME type of the file as defined by sender.
Voice::getFileSize() — Method in class Voice: Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.
WebAppData::getData() — Method in class WebAppData: The data. Be aware that a bad client can send arbitrary data in this field.
WebAppData::getButtonText() — Method in class WebAppData: Text of the web_app keyboard button from which the Web App was opened. Be aware that a bad client can send arbitrary data in this field.
WebAppInfo::getUrl() — Method in class WebAppInfo: An HTTPS URL of a Web App to be opened with additional data as specified in Initializing Web Apps.
WebhookInfo::getUrl() — Method in class WebhookInfo: Webhook URL, may be empty if webhook is not set up.
WebhookInfo::getHasCustomCertificate() — Method in class WebhookInfo: True, if a custom certificate was provided for webhook certificate checks.
WebhookInfo::getPendingUpdateCount() — Method in class WebhookInfo: Number of updates awaiting delivery.
WebhookInfo::getIpAddress() — Method in class WebhookInfo: Optional. Currently used webhook IP address.
WebhookInfo::getLastErrorDate() — Method in class WebhookInfo: Optional. Unix time for the most recent error that happened when trying to deliver an update via webhook.
WebhookInfo::getLastErrorMessage() — Method in class WebhookInfo: Optional. Error message in human-readable format for the most recent error that happened when trying to deliver an update via webhook.
WebhookInfo::getLastSynchronizationErrorDate() — Method in class WebhookInfo: Optional. Unix time of the most recent error that happened when trying to synchronize available updates with Telegram datacenters.
WebhookInfo::getMaxConnections() — Method in class WebhookInfo: Optional. The maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery.
WebhookInfo::getAllowedUpdates() — Method in class WebhookInfo: Optional. A list of update types the bot is subscribed to. Defaults to all update types except chat_member.

H

TelegramTrait::hideGeneralForumTopic() — Method in class TelegramTrait: Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically closed if it was open. Returns True on success.

I

InlineKeyboardButton — Class in namespace GingTeam\Telegram\Type: This object represents one button of an inline keyboard. You must use exactly one of the optional fields.
InlineKeyboardMarkup — Class in namespace GingTeam\Telegram\Type: This object represents an inline keyboard that appears right next to the message it belongs to.
InlineQuery — Class in namespace GingTeam\Telegram\Type: This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.
InlineQueryResultArticle — Class in namespace GingTeam\Telegram\Type: Represents a link to an article or web page.
InlineQueryResultAudio — Class in namespace GingTeam\Telegram\Type: 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.
InlineQueryResultCachedAudio — Class in namespace GingTeam\Telegram\Type: Represents a link to an MP3 audio file stored on the Telegram servers. 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.
InlineQueryResultCachedDocument — Class in namespace GingTeam\Telegram\Type: Represents a link to a file stored on the Telegram servers. 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.
InlineQueryResultCachedGif — Class in namespace GingTeam\Telegram\Type: Represents a link to an animated GIF file stored on the Telegram servers. By default, this animated GIF file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with specified content instead of the animation.
InlineQueryResultCachedMpeg4Gif — Class in namespace GingTeam\Telegram\Type: Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers. By default, this animated MPEG-4 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 animation.
InlineQueryResultCachedPhoto — Class in namespace GingTeam\Telegram\Type: Represents a link to a photo stored on the Telegram servers. By default, this photo 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 photo.
InlineQueryResultCachedSticker — Class in namespace GingTeam\Telegram\Type: Represents a link to a sticker stored on the Telegram servers. By default, this sticker will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the sticker.
InlineQueryResultCachedVideo — Class in namespace GingTeam\Telegram\Type: Represents a link to a video file stored on the Telegram servers. 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.
InlineQueryResultCachedVoice — Class in namespace GingTeam\Telegram\Type: Represents a link to a voice message stored on the Telegram servers. By default, this voice message will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the voice message.
InlineQueryResultContact — Class in namespace GingTeam\Telegram\Type: 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 — Class in namespace GingTeam\Telegram\Type: 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 — Class in namespace GingTeam\Telegram\Type: Represents a Game.
InlineQueryResultGif — Class in namespace GingTeam\Telegram\Type: 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.
InlineQueryResultInterface — Class in namespace GingTeam\Telegram\Type: This object represents one result of an inline query. Telegram clients currently support results of the following 20 types:.
InlineQueryResultLocation — Class in namespace GingTeam\Telegram\Type: 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 — Class in namespace GingTeam\Telegram\Type: 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 — Class in namespace GingTeam\Telegram\Type: 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 — Class in namespace GingTeam\Telegram\Type: 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 — Class in namespace GingTeam\Telegram\Type: 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 — Class in namespace GingTeam\Telegram\Type: 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.
InputContactMessageContent — Class in namespace GingTeam\Telegram\Type: Represents the content of a contact message to be sent as the result of an inline query.
InputFileInterface — Class in namespace GingTeam\Telegram\Type: This object represents the contents of a file to be uploaded. Must be posted using multipart/form-data in the usual way that files are uploaded via the browser.
InputInvoiceMessageContent — Class in namespace GingTeam\Telegram\Type: Represents the content of an invoice message to be sent as the result of an inline query.
InputLocationMessageContent — Class in namespace GingTeam\Telegram\Type: Represents the content of a location message to be sent as the result of an inline query.
InputMediaAnimation — Class in namespace GingTeam\Telegram\Type: Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.
InputMediaAudio — Class in namespace GingTeam\Telegram\Type: Represents an audio file to be treated as music to be sent.
InputMediaDocument — Class in namespace GingTeam\Telegram\Type: Represents a general file to be sent.
InputMediaInterface — Class in namespace GingTeam\Telegram\Type: This object represents the content of a media message to be sent. It should be one of.
InputMediaPhoto — Class in namespace GingTeam\Telegram\Type: Represents a photo to be sent.
InputMediaVideo — Class in namespace GingTeam\Telegram\Type: Represents a video to be sent.
InputMessageContentInterface — Class in namespace GingTeam\Telegram\Type: This object represents the content of a message to be sent as a result of an inline query. Telegram clients currently support the following 5 types:.
InputTextMessageContent — Class in namespace GingTeam\Telegram\Type: Represents the content of a text message to be sent as the result of an inline query.
InputVenueMessageContent — Class in namespace GingTeam\Telegram\Type: Represents the content of a venue message to be sent as the result of an inline query.
Invoice — Class in namespace GingTeam\Telegram\Type: This object contains basic information about an invoice.

K

KeyboardButton — Class in namespace GingTeam\Telegram\Type: 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.
KeyboardButtonPollType — Class in namespace GingTeam\Telegram\Type: This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.

L

TelegramTrait::logOut() — Method in class TelegramTrait: Use this method to log out from the cloud Bot API server before launching the bot locally. You must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters.
TelegramTrait::leaveChat() — Method in class TelegramTrait: Use this method for your bot to leave a group, supergroup or channel. Returns True on success.
LabeledPrice — Class in namespace GingTeam\Telegram\Type: This object represents a portion of the price for goods or services.
Location — Class in namespace GingTeam\Telegram\Type: This object represents a point on the map.
LoginUrl — Class in namespace GingTeam\Telegram\Type: 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: Telegram apps support these buttons as of version 5.7.

M

MaskPosition — Class in namespace GingTeam\Telegram\Type: This object describes the position on faces where a mask should be placed by default.
MenuButtonCommands — Class in namespace GingTeam\Telegram\Type: Represents a menu button, which opens the bot's list of commands.
MenuButtonDefault — Class in namespace GingTeam\Telegram\Type: Describes that no specific value for the menu button was set.
MenuButtonInterface — Class in namespace GingTeam\Telegram\Type: This object describes the bot's menu button in a private chat. It should be one of.
MenuButtonWebApp — Class in namespace GingTeam\Telegram\Type: Represents a menu button, which launches a Web App.
Message — Class in namespace GingTeam\Telegram\Type: This object represents a message.
MessageAutoDeleteTimerChanged — Class in namespace GingTeam\Telegram\Type: This object represents a service message about a change in auto-delete timer settings.
MessageEntity — Class in namespace GingTeam\Telegram\Type: This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.
MessageId — Class in namespace GingTeam\Telegram\Type: This object represents a unique message identifier.

O

OrderInfo — Class in namespace GingTeam\Telegram\Type: This object represents information about an order.

P

TelegramTrait::promoteChatMember() — Method in class TelegramTrait: Use this method to promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Pass False for all boolean parameters to demote a user. Returns True on success.
TelegramTrait::pinChatMessage() — Method in class TelegramTrait: Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.
PassportData — Class in namespace GingTeam\Telegram\Type: Describes Telegram Passport data shared with the bot by the user.
PassportElementErrorDataField — Class in namespace GingTeam\Telegram\Type: 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 — Class in namespace GingTeam\Telegram\Type: Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes.
PassportElementErrorFiles — Class in namespace GingTeam\Telegram\Type: Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes.
PassportElementErrorFrontSide — Class in namespace GingTeam\Telegram\Type: 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.
PassportElementErrorInterface — Class in namespace GingTeam\Telegram\Type: This object represents an error in the Telegram Passport element which was submitted that should be resolved by the user. It should be one of:.
PassportElementErrorReverseSide — Class in namespace GingTeam\Telegram\Type: 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 — Class in namespace GingTeam\Telegram\Type: Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes.
PassportElementErrorTranslationFile — Class in namespace GingTeam\Telegram\Type: 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 — Class in namespace GingTeam\Telegram\Type: Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation change.
PassportElementErrorUnspecified — Class in namespace GingTeam\Telegram\Type: Represents an issue in an unspecified place. The error is considered resolved when new data is added.
PassportFile — Class in namespace GingTeam\Telegram\Type: 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 — Class in namespace GingTeam\Telegram\Type: This object represents one size of a photo or a file / sticker thumbnail.
Poll — Class in namespace GingTeam\Telegram\Type: This object contains information about a poll.
PollAnswer — Class in namespace GingTeam\Telegram\Type: This object represents an answer of a user in a non-anonymous poll.
PollOption — Class in namespace GingTeam\Telegram\Type: This object contains information about one answer option in a poll.
PreCheckoutQuery — Class in namespace GingTeam\Telegram\Type: This object contains information about an incoming pre-checkout query.
ProximityAlertTriggered — Class in namespace GingTeam\Telegram\Type: This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user.

R

TelegramTrait::restrictChatMember() — Method in class TelegramTrait: Use this method to restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work and must have the appropriate administrator rights. Pass True for all permissions to lift restrictions from a user. Returns True on success.
TelegramTrait::revokeChatInviteLink() — Method in class TelegramTrait: Use this method to revoke an invite link created by the bot. If the primary link is revoked, a new link is automatically generated. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the revoked invite link as ChatInviteLink object.
TelegramTrait::reopenForumTopic() — Method in class TelegramTrait: Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights, unless it is the creator of the topic. Returns True on success.
TelegramTrait::reopenGeneralForumTopic() — Method in class TelegramTrait: Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. The topic will be automatically unhidden if it was hidden. Returns True on success.
ReplyKeyboardMarkup — Class in namespace GingTeam\Telegram\Type: This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).
ReplyKeyboardRemove — Class in namespace GingTeam\Telegram\Type: 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).
Response — Class in namespace GingTeam\Telegram\Type
ResponseParameters — Class in namespace GingTeam\Telegram\Type: Describes why a request was unsuccessful.

S

SerializerTrait — Class in namespace GingTeam\Telegram
TelegramTrait::sendRequest() — Method in class TelegramTrait
TelegramTrait::setWebhook() — Method in class TelegramTrait: Use this method to specify a URL and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success.
TelegramTrait::sendMessage() — Method in class TelegramTrait: Use this method to send text messages. On success, the sent Message is returned.
TelegramTrait::sendPhoto() — Method in class TelegramTrait: Use this method to send photos. On success, the sent Message is returned.
TelegramTrait::sendAudio() — Method in class TelegramTrait: Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent Message is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.
TelegramTrait::sendDocument() — Method in class TelegramTrait: Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.
TelegramTrait::sendVideo() — Method in class TelegramTrait: Use this method to send video files, Telegram clients support MPEG4 videos (other formats may be sent as Document). On success, the sent Message is returned. Bots can currently send video files of up to 50 MB in size, this limit may be changed in the future.
TelegramTrait::sendAnimation() — Method in class TelegramTrait: Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent Message is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.
TelegramTrait::sendVoice() — Method in class TelegramTrait: Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS (other formats may be sent as Audio or Document). On success, the sent Message is returned. Bots can currently send voice messages of up to 50 MB in size, this limit may be changed in the future.
TelegramTrait::sendVideoNote() — Method in class TelegramTrait: As of v.4.0, Telegram clients support rounded square MPEG4 videos of up to 1 minute long. Use this method to send video messages. On success, the sent Message is returned.
TelegramTrait::sendMediaGroup() — Method in class TelegramTrait: Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Messages that were sent is returned.
TelegramTrait::sendLocation() — Method in class TelegramTrait: Use this method to send point on the map. On success, the sent Message is returned.
TelegramTrait::stopMessageLiveLocation() — Method in class TelegramTrait: Use this method to stop updating a live location message before live_period expires. On success, if the message is not an inline message, the edited Message is returned, otherwise True is returned.
TelegramTrait::sendVenue() — Method in class TelegramTrait: Use this method to send information about a venue. On success, the sent Message is returned.
TelegramTrait::sendContact() — Method in class TelegramTrait: Use this method to send phone contacts. On success, the sent Message is returned.
TelegramTrait::sendPoll() — Method in class TelegramTrait: Use this method to send a native poll. On success, the sent Message is returned.
TelegramTrait::sendDice() — Method in class TelegramTrait: Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.
TelegramTrait::sendChatAction() — Method in class TelegramTrait: Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success.
TelegramTrait::setChatAdministratorCustomTitle() — Method in class TelegramTrait: Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns True on success.
TelegramTrait::setChatPermissions() — Method in class TelegramTrait: Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the can_restrict_members administrator rights. Returns True on success.
TelegramTrait::setChatPhoto() — Method in class TelegramTrait: Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
TelegramTrait::setChatTitle() — Method in class TelegramTrait: Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
TelegramTrait::setChatDescription() — Method in class TelegramTrait: Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns True on success.
TelegramTrait::setChatStickerSet() — Method in class TelegramTrait: Use this method to set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field can_set_sticker_set optionally returned in getChat requests to check if the bot can use this method. Returns True on success.
TelegramTrait::setMyCommands() — Method in class TelegramTrait: Use this method to change the list of the bot's commands. See this manual for more details about bot commands. Returns True on success.
TelegramTrait::setChatMenuButton() — Method in class TelegramTrait: Use this method to change the bot's menu button in a private chat, or the default menu button. Returns True on success.
TelegramTrait::setMyDefaultAdministratorRights() — Method in class TelegramTrait: Use this method to change the default administrator rights requested by the bot when it's added as an administrator to groups or channels. These rights will be suggested to users, but they are are free to modify the list before adding the bot. Returns True on success.
TelegramTrait::stopPoll() — Method in class TelegramTrait: Use this method to stop a poll which was sent by the bot. On success, the stopped Poll is returned.
TelegramTrait::sendSticker() — Method in class TelegramTrait: Use this method to send static .WEBP, animated .TGS, or video .WEBM stickers. On success, the sent Message is returned.
TelegramTrait::setStickerPositionInSet() — Method in class TelegramTrait: Use this method to move a sticker in a set created by the bot to a specific position. Returns True on success.
TelegramTrait::setStickerSetThumb() — Method in class TelegramTrait: Use this method to set the thumbnail of a sticker set. Animated thumbnails can be set for animated sticker sets only. Video thumbnails can be set only for video sticker sets only. Returns True on success.
TelegramTrait::sendInvoice() — Method in class TelegramTrait: Use this method to send invoices. On success, the sent Message is returned.
TelegramTrait::setPassportDataErrors() — Method in class TelegramTrait: Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns True on success.
TelegramTrait::sendGame() — Method in class TelegramTrait: Use this method to send a game. On success, the sent Message is returned.
TelegramTrait::setGameScore() — Method in class TelegramTrait: Use this method to set the score of the specified user in a game message. On success, if the message is not an inline message, the Message is returned, otherwise True is returned. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.
Response::success() — Method in class Response
SentWebAppMessage — Class in namespace GingTeam\Telegram\Type: Describes an inline message sent by a Web App on behalf of a user.
ShippingAddress — Class in namespace GingTeam\Telegram\Type: This object represents a shipping address.
ShippingOption — Class in namespace GingTeam\Telegram\Type: This object represents one shipping option.
ShippingQuery — Class in namespace GingTeam\Telegram\Type: This object contains information about an incoming shipping query.
Sticker — Class in namespace GingTeam\Telegram\Type: This object represents a sticker.
StickerSet — Class in namespace GingTeam\Telegram\Type: This object represents a sticker set.
SuccessfulPayment — Class in namespace GingTeam\Telegram\Type: This object contains basic information about a successful payment.

T

TelegramTrait — Class in namespace GingTeam\Telegram

U

TelegramTrait::unbanChatMember() — Method in class TelegramTrait: Use this method to unban a previously banned user in a supergroup or channel. The user will not return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be removed from the chat. If you don't want this, use the parameter only_if_banned. Returns True on success.
TelegramTrait::unbanChatSenderChat() — Method in class TelegramTrait: Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns True on success.
TelegramTrait::unpinChatMessage() — Method in class TelegramTrait: Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.
TelegramTrait::unpinAllChatMessages() — Method in class TelegramTrait: Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.
TelegramTrait::unpinAllForumTopicMessages() — Method in class TelegramTrait: Use this method to clear the list of pinned messages in a forum topic. The bot must be an administrator in the chat for this to work and must have the can_pin_messages administrator right in the supergroup. Returns True on success.
TelegramTrait::unhideGeneralForumTopic() — Method in class TelegramTrait: Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator rights. Returns True on success.
TelegramTrait::uploadStickerFile() — Method in class TelegramTrait: Use this method to upload a .PNG file with a sticker for later use in createNewStickerSet and addStickerToSet methods (can be used multiple times). Returns the uploaded File on success.
Update — Class in namespace GingTeam\Telegram\Type: This object represents an incoming update.At most one of the optional parameters can be present in any given update.
User — Class in namespace GingTeam\Telegram\Type: This object represents a Telegram user or bot.
UserProfilePhotos — Class in namespace GingTeam\Telegram\Type: This object represent a user's profile pictures.

V

Venue — Class in namespace GingTeam\Telegram\Type: This object represents a venue.
Video — Class in namespace GingTeam\Telegram\Type: This object represents a video file.
VideoChatEnded — Class in namespace GingTeam\Telegram\Type: This object represents a service message about a video chat ended in the chat.
VideoChatParticipantsInvited — Class in namespace GingTeam\Telegram\Type: This object represents a service message about new members invited to a video chat.
VideoChatScheduled — Class in namespace GingTeam\Telegram\Type: This object represents a service message about a video chat scheduled in the chat.
VideoChatStartedInterface — Class in namespace GingTeam\Telegram\Type: This object represents a service message about a video chat started in the chat. Currently holds no information.
VideoNote — Class in namespace GingTeam\Telegram\Type: This object represents a video message (available in Telegram apps as of v.4.0).
Voice — Class in namespace GingTeam\Telegram\Type: This object represents a voice note.

W

WebAppData — Class in namespace GingTeam\Telegram\Type: Describes data sent from a Web App to the bot.
WebAppInfo — Class in namespace GingTeam\Telegram\Type: Describes a Web App.
WebhookInfo — Class in namespace GingTeam\Telegram\Type: Describes the current status of a webhook.

_

Animation::__construct() — Method in class Animation
Audio::__construct() — Method in class Audio
BotCommand::__construct() — Method in class BotCommand
BotCommandScopeAllChatAdministrators::__construct() — Method in class BotCommandScopeAllChatAdministrators
BotCommandScopeAllGroupChats::__construct() — Method in class BotCommandScopeAllGroupChats
BotCommandScopeAllPrivateChats::__construct() — Method in class BotCommandScopeAllPrivateChats
BotCommandScopeChat::__construct() — Method in class BotCommandScopeChat
BotCommandScopeChatAdministrators::__construct() — Method in class BotCommandScopeChatAdministrators
BotCommandScopeChatMember::__construct() — Method in class BotCommandScopeChatMember
BotCommandScopeDefault::__construct() — Method in class BotCommandScopeDefault
CallbackQuery::__construct() — Method in class CallbackQuery
Chat::__construct() — Method in class Chat
ChatAdministratorRights::__construct() — Method in class ChatAdministratorRights
ChatInviteLink::__construct() — Method in class ChatInviteLink
ChatJoinRequest::__construct() — Method in class ChatJoinRequest
ChatLocation::__construct() — Method in class ChatLocation
ChatMemberAdministrator::__construct() — Method in class ChatMemberAdministrator
ChatMemberBanned::__construct() — Method in class ChatMemberBanned
ChatMemberLeft::__construct() — Method in class ChatMemberLeft
ChatMemberMember::__construct() — Method in class ChatMemberMember
ChatMemberOwner::__construct() — Method in class ChatMemberOwner
ChatMemberRestricted::__construct() — Method in class ChatMemberRestricted
ChatMemberUpdated::__construct() — Method in class ChatMemberUpdated
ChatPermissions::__construct() — Method in class ChatPermissions
ChatPhoto::__construct() — Method in class ChatPhoto
ChosenInlineResult::__construct() — Method in class ChosenInlineResult
Contact::__construct() — Method in class Contact
Dice::__construct() — Method in class Dice
Document::__construct() — Method in class Document
EncryptedCredentials::__construct() — Method in class EncryptedCredentials
EncryptedPassportElement::__construct() — Method in class EncryptedPassportElement
File::__construct() — Method in class File
ForceReply::__construct() — Method in class ForceReply
ForumTopic::__construct() — Method in class ForumTopic
ForumTopicCreated::__construct() — Method in class ForumTopicCreated
Game::__construct() — Method in class Game
GameHighScore::__construct() — Method in class GameHighScore
InlineKeyboardButton::__construct() — Method in class InlineKeyboardButton
InlineKeyboardMarkup::__construct() — Method in class InlineKeyboardMarkup
InlineQuery::__construct() — Method in class InlineQuery
InlineQueryResultArticle::__construct() — Method in class InlineQueryResultArticle
InlineQueryResultAudio::__construct() — Method in class InlineQueryResultAudio
InlineQueryResultCachedAudio::__construct() — Method in class InlineQueryResultCachedAudio
InlineQueryResultCachedDocument::__construct() — Method in class InlineQueryResultCachedDocument
InlineQueryResultCachedGif::__construct() — Method in class InlineQueryResultCachedGif
InlineQueryResultCachedMpeg4Gif::__construct() — Method in class InlineQueryResultCachedMpeg4Gif
InlineQueryResultCachedPhoto::__construct() — Method in class InlineQueryResultCachedPhoto
InlineQueryResultCachedSticker::__construct() — Method in class InlineQueryResultCachedSticker
InlineQueryResultCachedVideo::__construct() — Method in class InlineQueryResultCachedVideo
InlineQueryResultCachedVoice::__construct() — Method in class InlineQueryResultCachedVoice
InlineQueryResultContact::__construct() — Method in class InlineQueryResultContact
InlineQueryResultDocument::__construct() — Method in class InlineQueryResultDocument
InlineQueryResultGame::__construct() — Method in class InlineQueryResultGame
InlineQueryResultGif::__construct() — Method in class InlineQueryResultGif
InlineQueryResultLocation::__construct() — Method in class InlineQueryResultLocation
InlineQueryResultMpeg4Gif::__construct() — Method in class InlineQueryResultMpeg4Gif
InlineQueryResultPhoto::__construct() — Method in class InlineQueryResultPhoto
InlineQueryResultVenue::__construct() — Method in class InlineQueryResultVenue
InlineQueryResultVideo::__construct() — Method in class InlineQueryResultVideo
InlineQueryResultVoice::__construct() — Method in class InlineQueryResultVoice
InputContactMessageContent::__construct() — Method in class InputContactMessageContent
InputInvoiceMessageContent::__construct() — Method in class InputInvoiceMessageContent
InputLocationMessageContent::__construct() — Method in class InputLocationMessageContent
InputMediaAnimation::__construct() — Method in class InputMediaAnimation
InputMediaAudio::__construct() — Method in class InputMediaAudio
InputMediaDocument::__construct() — Method in class InputMediaDocument
InputMediaPhoto::__construct() — Method in class InputMediaPhoto
InputMediaVideo::__construct() — Method in class InputMediaVideo
InputTextMessageContent::__construct() — Method in class InputTextMessageContent
InputVenueMessageContent::__construct() — Method in class InputVenueMessageContent
Invoice::__construct() — Method in class Invoice
KeyboardButton::__construct() — Method in class KeyboardButton
KeyboardButtonPollType::__construct() — Method in class KeyboardButtonPollType
LabeledPrice::__construct() — Method in class LabeledPrice
Location::__construct() — Method in class Location
LoginUrl::__construct() — Method in class LoginUrl
MaskPosition::__construct() — Method in class MaskPosition
MenuButtonCommands::__construct() — Method in class MenuButtonCommands
MenuButtonDefault::__construct() — Method in class MenuButtonDefault
MenuButtonWebApp::__construct() — Method in class MenuButtonWebApp
Message::__construct() — Method in class Message
MessageAutoDeleteTimerChanged::__construct() — Method in class MessageAutoDeleteTimerChanged
MessageEntity::__construct() — Method in class MessageEntity
MessageId::__construct() — Method in class MessageId
OrderInfo::__construct() — Method in class OrderInfo
PassportData::__construct() — Method in class PassportData
PassportElementErrorDataField::__construct() — Method in class PassportElementErrorDataField
PassportElementErrorFile::__construct() — Method in class PassportElementErrorFile
PassportElementErrorFiles::__construct() — Method in class PassportElementErrorFiles
PassportElementErrorFrontSide::__construct() — Method in class PassportElementErrorFrontSide
PassportElementErrorReverseSide::__construct() — Method in class PassportElementErrorReverseSide
PassportElementErrorSelfie::__construct() — Method in class PassportElementErrorSelfie
PassportElementErrorTranslationFile::__construct() — Method in class PassportElementErrorTranslationFile
PassportElementErrorTranslationFiles::__construct() — Method in class PassportElementErrorTranslationFiles
PassportElementErrorUnspecified::__construct() — Method in class PassportElementErrorUnspecified
PassportFile::__construct() — Method in class PassportFile
PhotoSize::__construct() — Method in class PhotoSize
Poll::__construct() — Method in class Poll
PollAnswer::__construct() — Method in class PollAnswer
PollOption::__construct() — Method in class PollOption
PreCheckoutQuery::__construct() — Method in class PreCheckoutQuery
ProximityAlertTriggered::__construct() — Method in class ProximityAlertTriggered
ReplyKeyboardMarkup::__construct() — Method in class ReplyKeyboardMarkup
ReplyKeyboardRemove::__construct() — Method in class ReplyKeyboardRemove
Response::__construct() — Method in class Response
ResponseParameters::__construct() — Method in class ResponseParameters
SentWebAppMessage::__construct() — Method in class SentWebAppMessage
ShippingAddress::__construct() — Method in class ShippingAddress
ShippingOption::__construct() — Method in class ShippingOption
ShippingQuery::__construct() — Method in class ShippingQuery
Sticker::__construct() — Method in class Sticker
StickerSet::__construct() — Method in class StickerSet
SuccessfulPayment::__construct() — Method in class SuccessfulPayment
Update::__construct() — Method in class Update
User::__construct() — Method in class User
UserProfilePhotos::__construct() — Method in class UserProfilePhotos
Venue::__construct() — Method in class Venue
Video::__construct() — Method in class Video
VideoChatEnded::__construct() — Method in class VideoChatEnded
VideoChatParticipantsInvited::__construct() — Method in class VideoChatParticipantsInvited
VideoChatScheduled::__construct() — Method in class VideoChatScheduled
VideoNote::__construct() — Method in class VideoNote
Voice::__construct() — Method in class Voice
WebAppData::__construct() — Method in class WebAppData
WebAppInfo::__construct() — Method in class WebAppInfo
WebhookInfo::__construct() — Method in class WebhookInfo