APIMethod enum

Represents the methods available in the Telegram Bot API.

Each enum value corresponds to a specific Telegram Bot API endpoint.

Inheritance
Available extensions

Values

getUpdates → const APIMethod

Returns the updates for the bot.

setWebhook → const APIMethod

Sets a webhook for the bot.

deleteWebhook → const APIMethod

Deletes the webhook for the bot.

getMe → const APIMethod

Returns the bot's information.

logOut → const APIMethod

Logs the bot out.

close → const APIMethod

Closes the bot.

sendMessage → const APIMethod

Sends a message.

forwardMessage → const APIMethod

Forwards a message.

copyMessage → const APIMethod

Copies a message.

sendPhoto → const APIMethod

Sends a photo.

sendAudio → const APIMethod

Sends an audio file.

sendDocument → const APIMethod

Sends a document.

sendVideo → const APIMethod

Sends a video.

sendAnimation → const APIMethod

Sends an animation.

sendVoice → const APIMethod

Sends a voice message.

sendVideoNote → const APIMethod

Sends a video note.

sendMediaGroup → const APIMethod

Sends a group of media files.

sendLocation → const APIMethod

Sends a location.

sendVenue → const APIMethod

Sends a venue.

sendContact → const APIMethod

Sends a contact.

sendPoll → const APIMethod

Sends a poll.

sendDice → const APIMethod

Sends a dice.

sendChatAction → const APIMethod

Sends a chat action.

getUserProfilePhotos → const APIMethod

Gets a user's profile photos.

getFile → const APIMethod

Gets a file.

banChatMember → const APIMethod

Bans a chat member.

unbanChatMember → const APIMethod

Unbans a chat member.

restrictChatMember → const APIMethod

Restricts a chat member.

promoteChatMember → const APIMethod

Promotes a chat member.

setChatAdministratorCustomTitle → const APIMethod

Sets a chat administrator's custom title.

banChatSenderChat → const APIMethod

Bans a chat sender chat.

unbanChatSenderChat → const APIMethod

Unbans a chat sender chat.

setChatPermissions → const APIMethod

Sets a chat's permissions.

Exports a chat's invite link.

Creates a chat's invite link.

Edits a chat's invite link.

Revokes a chat's invite link.

approveChatJoinRequest → const APIMethod

Approves a chat's join request.

declineChatJoinRequest → const APIMethod

Declines a chat's join request.

setChatPhoto → const APIMethod

Sets a chat's photo.

deleteChatPhoto → const APIMethod

Deletes a chat's photo.

setChatTitle → const APIMethod

Sets a chat's title.

setChatDescription → const APIMethod

Sets a chat's description.

pinChatMessage → const APIMethod

Pins a chat message.

unpinChatMessage → const APIMethod

Unpins a chat message.

unpinAllChatMessages → const APIMethod

Unpins all chat messages.

leaveChat → const APIMethod

Leaves a chat.

getChat → const APIMethod

Gets a chat.

getChatAdministrators → const APIMethod

Gets a chat's administrators.

getChatMemberCount → const APIMethod

Gets a chat's member count.

getChatMember → const APIMethod

Gets a chat member.

setChatStickerSet → const APIMethod

Sets a chat's sticker set.

deleteChatStickerSet → const APIMethod

Deletes a chat's sticker set.

getForumTopicIconStickers → const APIMethod

Gets a forum topic's icon stickers.

createForumTopic → const APIMethod

Creates a forum topic.

editForumTopic → const APIMethod

Edits a forum topic.

closeForumTopic → const APIMethod

Closes a forum topic.

reopenForumTopic → const APIMethod

Reopens a forum topic.

deleteForumTopic → const APIMethod

Deletes a forum topic.

unpinAllForumTopicMessages → const APIMethod

Unpins all forum topic messages.

editGeneralForumTopic → const APIMethod

Edits a general forum topic.

closeGeneralForumTopic → const APIMethod

Closes a general forum topic.

reopenGeneralForumTopic → const APIMethod

Reopens a general forum topic.

hideGeneralForumTopic → const APIMethod

Hides a general forum topic.

unhideGeneralForumTopic → const APIMethod

Unhides a general forum topic.

answerCallbackQuery → const APIMethod

Answers a callback query.

setMyCommands → const APIMethod

Sets a bot's commands.

deleteMyCommands → const APIMethod

Deletes a bot's commands.

getMyCommands → const APIMethod

Gets a bot's commands.

setMyName → const APIMethod

Sets a bot's name.

getMyName → const APIMethod

Gets a bot's name.

setMyDescription → const APIMethod

Sets a bot's description.

getMyDescription → const APIMethod

Gets a bot's description.

setMyShortDescription → const APIMethod

Sets a bot's short description.

getMyShortDescription → const APIMethod

Gets a bot's short description.

setChatMenuButton → const APIMethod

Sets a chat's menu button.

getChatMenuButton → const APIMethod

Gets a chat's menu button.

setMyDefaultAdministratorRights → const APIMethod

Sets a bot's default administrator rights.

getMyDefaultAdministratorRights → const APIMethod

Gets a bot's default administrator rights.

editMessageText → const APIMethod

Edits a message's text.

editMessageCaption → const APIMethod

Edits a message's caption.

editMessageMedia → const APIMethod

Edits a message's media.

editMessageLiveLocation → const APIMethod

Edits a message's live location.

stopMessageLiveLocation → const APIMethod

Stops a message's live location.

editMessageReplyMarkup → const APIMethod

Edits a message's reply markup.

stopPoll → const APIMethod

Stops a poll.

deleteMessage → const APIMethod

Deletes a message.

sendSticker → const APIMethod

Sends a sticker.

getStickerSet → const APIMethod

Gets a sticker set.

getCustomEmojiStickers → const APIMethod

Gets custom emoji stickers.

uploadStickerFile → const APIMethod

Uploads a sticker file.

createNewStickerSet → const APIMethod

Creates a new sticker set.

addStickerToSet → const APIMethod

Adds a sticker to a set.

setStickerPositionInSet → const APIMethod

Sets a sticker's position in a set.

deleteStickerFromSet → const APIMethod

Deletes a sticker from a set.

setStickerEmojiList → const APIMethod

Sets a sticker's emoji list.

setStickerKeywords → const APIMethod

Sets a sticker's keywords.

setStickerMaskPosition → const APIMethod

Sets a sticker's mask position.

setStickerSetTitle → const APIMethod

Sets a sticker set's title.

setStickerSetThumbnail → const APIMethod

Sets a sticker set's thumbnail.

setCustomEmojiStickerSetThumbnail → const APIMethod

Sets a custom emoji sticker set's thumbnail.

deleteStickerSet → const APIMethod

Deletes a sticker set.

answerInlineQuery → const APIMethod

Answers an inline query.

answerWebAppQuery → const APIMethod

Answers a web app query.

sendInvoice → const APIMethod

Sends an invoice.

Creates an invoice link.

answerShippingQuery → const APIMethod

Answers a shipping query.

answerPreCheckoutQuery → const APIMethod

Answers a pre checkout query.

setPassportDataErrors → const APIMethod

Sets passport data errors.

sendGame → const APIMethod

Sends a game.

setGameScore → const APIMethod

Sets a game's score.

getGameHighScores → const APIMethod

Gets a game's high scores.

setMessageReaction → const APIMethod

Sets a message reaction.

deleteMessages → const APIMethod

Deletes multiple messages.

forwardMessages → const APIMethod

Forwards multiple messages.

copyMessages → const APIMethod

Copies multiple messages.

getUserChatBoosts → const APIMethod

Gets a user's active chat boosts.

getWebhookInfo → const APIMethod

Returns the webhook info.

setInlineGameScore → const APIMethod

Sets an inline game's score.

unpinAllGeneralForumTopicMessages → const APIMethod

Unpins all general forum topic messages.

getChatMembersCount → const APIMethod

Gets a chat's member count (deprecated, use getChatMemberCount instead).

getBusinessConnection → const APIMethod

Gets information about the connection of the bot with a business account.

replaceStickerInSet → const APIMethod

Replaces an existing sticker in a sticker pack.

refundStarPayment → const APIMethod

Refunds a successful payment in Telegram Stars.

getStarTransactions → const APIMethod

Returns the bot's Telegram Star transactions in chronological order.

sendPaidMedia → const APIMethod

Sends paid media.

Creates a subscription invite link for a channel chat.

Edits a subscription invite link created by the bot.

editUserStarSubscription → const APIMethod

Edits user's star subscription.

setUserEmojiStatus → const APIMethod

Changes the emoji status for a given user.

savePreparedInlineMessage → const APIMethod

Stores a message that can be sent by a user of a Mini App.

getAvailableGifts → const APIMethod

Returns the list of gifts that can be sent by the bot to users.

sendGift → const APIMethod

Sends a gift to the given user.

verifyUser → const APIMethod

Verifies a user on behalf of the organization which is represented by the bot.

verifyChat → const APIMethod

Verifies a chat on behalf of the organization which is represented by the bot.

removeUserVerification → const APIMethod

Removes verification from a user who is currently verified.

removeChatVerification → const APIMethod

Removes verification from a chat that is currently verified.

readBusinessMessage → const APIMethod

Marks a message as read on behalf of the business.

deleteBusinessMessages → const APIMethod

Deletes a message on behalf of the business

setBusinessAccountName → const APIMethod

Change the first and last name of a managed business account

setBusinessAccountUsername → const APIMethod

Change username of a managed business account

setBusinessAccountBio → const APIMethod

Change the bio of a managed business account

setBusinessAccountProfilePhoto → const APIMethod

Change the profile picture of a managed account

removeBusinessAccountProfilePhoto → const APIMethod

Removes the profile photo of a managed business account

setBusinessAccountGiftSettings → const APIMethod

Changes the privacy settings pertaining to incoming gifts in a managed business account.

getBusinessAccountStarBalance → const APIMethod

Returns the amount of Telegram Stars owned by a managed business account

transferBusinessAccountStars → const APIMethod

Transfers Telegram Stars from the business account balance to the bot's balance

getBusinessAccountGifts → const APIMethod

Get business account gifts method

convertGiftToStars → const APIMethod

Converts a given regular gift to Telegram Stars.

upgradeGift → const APIMethod

Upgrades a iven gift to unique gift

transferGift → const APIMethod

Transfers an owned unique gift to another user

postStory → const APIMethod

Post a story on behalf of a managed account

editStory → const APIMethod

Edits a story previously posted by the bot on behalf of a managed business account.

deleteStory → const APIMethod

Deletes a story previously posted by the bot on behalf of a managed business account.

giftPremiumSubscription → const APIMethod

Gifts a Telegram Premium subscription to the given user

sendChecklist → const APIMethod

Send a checklist on behalf of a connected business account

editMessageChecklist → const APIMethod

Edit a checklist on behalf of a connected business account

getMyStarBalance → const APIMethod

Get the current Telegram Stars balance of the bot

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
name → String
Returns the name of the API method as a string, matching the Telegram Bot API endpoint.
no setter
name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

sendMethods → List<APIMethod>
List of API methods that are used to send messages of any kind.
no setter

Static Methods

isExistingMethod(String name) → bool
Checks if a given string matches any API method name.
method(String path) → APIMethod
Gets an APIMethod enum value from a string path.

Constants

values → const List<APIMethod>
A constant List of the values in this enum, in order of their declaration.