Telegram class

A class for communicating with Telegram API

You probably want to use its methods through TeleDart, rather than accessing them directly.

Implementers

Constructors

Telegram(String _token)

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

addStickerToSet(int userId, String name, InputSticker sticker) → Future<bool>
Use this method to add a new sticker to a set created by the bot
answerCallbackQuery(String callbackQueryId, {String? text, bool? showAlert, String? url, int? cacheTime}) → Future<bool>
Use this method to send answers to callback queries sent from inline keyboards
answerInlineQuery(String inlineQueryId, List<InlineQueryResult> results, {int? cacheTime, bool? isPersonal, String? nextOffset, InlineQueryResultsButton? button}) → Future<bool>
Use this method to send answers to an inline query
answerPreCheckoutQuery(String preCheckoutQueryId, bool ok, {String? errorMessage}) → Future<bool>
Use this method to respond to such pre-checkout queries
answerShippingQuery(String shippingQueryId, bool ok, {List<ShippingOption>? shippingOptions, String? errorMessage}) → Future<bool>
Use this method to reply to shipping queries.
answerWebAppQuery(String webAppQueryId, InlineQueryResult result) → Future<SentWebAppMessage>
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.
approveChatJoinRequest(dynamic chatId, int userId) → Future<bool>
Use this method to approve a chat join request
banChatMember(dynamic chatId, int userId, {int? untilDate, bool? revokeMessages}) → Future<bool>
Use this method to ban a user in a group, a supergroup or a channel
banChatSenderChat(dynamic chatId, int senderChatId) → Future<bool>
Use this method to ban a channel chat in a supergroup or a channel
close() → Future<bool>
Use this method to close the bot instance before moving it from one local server to another
closeForumTopic(dynamic chatId, String messageThreadId) → Future<bool>
Use this method to close an open topic in a forum supergroup chat.
closeGeneralForumTopic(dynamic chatId) → Future<bool>
Use this method to close an open 'General' topic in a forum supergroup chat.
copyMessage(dynamic chatId, int fromChatId, int messageId, {int? messageThreadId, String? caption, String? parseMode, List<MessageEntity>? captionEntities, bool? disableNotification, bool? protectContent, int? replyToMessageId, bool? allowSendingWithoutReply, ReplyMarkup? replyMarkup}) → Future<MessageId>
Use this method to copy messages of any kind
Use this method to create an additional invite link for a chat
createForumTopic(dynamic chatId, String name, {int? iconColor, String? iconCustomEmojiId}) → Future<ForumTopic>
Use this method to create a topic in a forum supergroup chat.
Use this method to create a link for an invoice.
createNewStickerSet(int userId, String name, String title, List<InputSticker> stickers, String stickerFormat, {String? stickerType, bool? needsRepainting}) → Future<bool>
Use this method to create sticker set owned by a user
declineChatJoinRequest(dynamic chatId, int userId) → Future<bool>
Use this method to decline a chat join request
deleteChatPhoto(dynamic chatId) → Future<bool>
Use this method to delete a chat photo
deleteChatStickerSet(dynamic chatId) → Future<bool>
Use this method to delete a group sticker set from a supergroup
deleteForumTopic(dynamic chatId, String messageThreadId) → Future<bool>
Use this method to delete a forum topic along with all its messages in a forum supergroup chat.
deleteMessage(dynamic chatId, int messageId) → Future<bool>
Use this method to delete a message, including service messages
deleteMyCommands({BotCommandScope? scope, String? languageCode}) → Future<bool>
Use this method to delete the list of the bot's commands for the given scope and user language
deleteStickerFromSet(String sticker) → Future<bool>
Use this method to delete a sticker from a set created by the bot
deleteStickerSet(String name) → Future<bool>
Use this method to delete a sticker set that was created by the bot.
deleteWebhook({bool? dropPendingUpdates}) → Future<bool>
Use this method to remove webhook integration if you decide to switch back to getUpdates
Use this method to edit a non-primary invite link created by the bot
editForumTopic(dynamic chatId, String messageThreadId, String name, String iconCustomEmojiId) → Future<bool>
Use this method to edit name and icon of a topic in a forum supergroup chat.
editGeneralForumTopic(dynamic chatId, String name) → Future<bool>
Use this method to edit the name of the 'General' topic in a forum supergroup chat.
editMessageCaption({dynamic chatId, int? messageId, String? inlineMessageId, String? caption, String? parseMode, InlineKeyboardMarkup? replyMarkup}) → Future<Message>
Use this method to edit captions of messages sent by the bot or via the bot (for inline bots).
editMessageLiveLocation(double latitude, double longitude, {dynamic chatId, int? messageId, String? inlineMessageId, double? horizontalAccuracy, int? heading, int? proximityAlertRadius, ReplyMarkup? replyMarkup}) → Future<Message>
Use this method to edit live location messages sent by the bot or via the bot (for inline bots).
editMessageMedia({dynamic chatId, int? messageId, String? inlineMessageId, InputMedia? media, String? parseMode, InlineKeyboardMarkup? replyMarkup}) → Future<Message>
Use this method to edit audio, document, photo, or video messages
editMessageReplyMarkup({dynamic chatId, int? messageId, String? inlineMessageId, InlineKeyboardMarkup? replyMarkup}) → Future<Message>
Use this method to edit only the reply markup of messages sent by the bot or via the bot (for inline bots).
editMessageText(String text, {dynamic chatId, int? messageId, String? inlineMessageId, String? parseMode, bool? disableWebPagePreview, InlineKeyboardMarkup? replyMarkup}) → Future<Message>
Use this method to edit text and Game messages sent by the bot or via the bot (for inline bots).
Use this method to generate a invite link for a chat
forwardMessage(dynamic chatId, int fromChatId, int messageId, {int? messageThreadId, bool? disableNotification, bool? protectContent}) → Future<Message>
Use this method to forward messages of any kind. On success, the sent Message is returned.
getChat(dynamic chatId) → Future<Chat>
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.).
getChatAdministrators(dynamic chatId) → Future<List<ChatMember>>
Use this method to get a list of administrators in a chat
getChatMember(dynamic chatId, int userId) → Future<ChatMember>
Use this method to get information about a member of a chat
getChatMemberCount(dynamic chatId) → Future<int>
Use this method to get the number of members in a chat
getChatMenuButton(int? chatId) → Future<MenuButton>
Use this method to get the current value of the bot's menu button in a private chat, or the default menu button.
getCustomEmojiStickers(List<String> customEmojiIds) → Future<List<Sticker>>
Use this method to get information about custom emoji stickers by their identifiers.
getFile(String fileId) → Future<File>
Use this method to get basic info about a file and prepare it for downloading
getForumTopicIconStickers() → Future<List<Sticker>>
Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user.
getGameHighScores(int userId, {dynamic chatId, int? messageId, String? inlineMessageId}) → Future<List<GameHighScore>>
Use this method to get data for high score tables
getMe() → Future<User>
A simple method for testing your bot's auth token. Requires no parameters. Returns basic information about the bot in form of a User object.
getMyCommands({BotCommandScope? scope, String? languageCode}) → Future<List<BotCommand>>
Use this method to get the current list of the bot's commands for the given scope and user language
getMyDefaultAdministratorRights(bool? forChannels) → Future<ChatAdministratorRights>
Use this method to get the current default administrator rights of the bot.
getMyDescription(String languageCode) → Future<BotDescription>
Use this method to get the current bot description for the given user language.
getMyName(String languageCode) → Future<BotName>
Use this method to get the current bot name for the given user language.
getMyShortDescription(String languageCode) → Future<BotShortDescription>
Use this method to get the current bot short description for the given user language.
getStickerSet(String name) → Future<StickerSet>
Use this method to get a sticker set
getUpdates({int? offset, int? limit, int? timeout, List<String>? allowedUpdates}) → Future<List<Update>>
Use this method to receive incoming updates using long polling (wiki)
getUserProfilePhotos(int userId, {int? offset, int? limit}) → Future<UserProfilePhotos>
Use this method to get a list of profile pictures for a user
getWebhookInfo() → Future<WebhookInfo>
Use this method to get current webhook status. Requires no parameters.
hideGeneralForumTopic(dynamic chatId) → Future<bool>
Use this method to hide the 'General' topic in a forum supergroup chat.
leaveChat(dynamic chatId) → Future<bool>
Use this method for your bot to leave a group, supergroup or channel
logOut() → Future<bool>
Use this method to log out from the cloud Bot API server before launching the bot locally
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pinChatMessage(dynamic chatId, int messageId, {bool? disableNotification}) → Future<bool>
Use this method to pin a message in a supergroup or a channel
promoteChatMember(dynamic chatId, int userId, {bool? isAnonymous, bool? canManageChat, bool? canPostMessages, bool? canEditMessages, bool? canDeleteMessages, bool? canManageVideoChats, bool? canRestrictMembers, bool? canPromoteMembers, bool? canChangeInfo, bool? canInviteUsers, bool? canPinMessages, bool? canManageTopics}) → Future<bool>
Use this method to promote or demote a user in a supergroup or a channel
reopenForumTopic(dynamic chatId, String messageThreadId) → Future<bool>
Use this method to reopen a closed topic in a forum supergroup chat.
reopenGeneralForumTopic(dynamic chatId) → Future<bool>
Use this method to reopen a closed 'General' topic in a forum supergroup chat.
restrictChatMember(dynamic chatId, int userId, ChatPermissions permissions, {bool? useIndependentChatPermissions, int? untilDate}) → Future<bool>
Use this method to restrict a user in a supergroup
Use this method to revoke an invite link created by the bot
sendAnimation(dynamic chatId, dynamic animation, {int? messageThreadId, int? duration, int? width, int? height, dynamic thumbnail, String? caption, String? parseMode, List<MessageEntity>? captionEntities, bool? hasSpoiler, bool? disableNotification, bool? protectContent, int? replyToMessageId, bool? allowSendingWithoutReply, ReplyMarkup? replyMarkup}) → Future<Message>
Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound)
sendAudio(dynamic chatId, dynamic audio, {int? messageThreadId, String? caption, String? parseMode, List<MessageEntity>? captionEntities, int? duration, String? performer, String? title, dynamic thumbnail, bool? disableNotification, bool? protectContent, int? replyToMessageId, bool? allowSendingWithoutReply, ReplyMarkup? replyMarkup}) → Future<Message>
Use this method to send audio files
sendChatAction(dynamic chatId, String action, {int? messageThreadId}) → Future<bool>
Use this method when you need to tell the user that something is happening on the bot's side
sendContact(dynamic chatId, String phoneNumber, String firstName, {int? messageThreadId, String? lastName, String? vcard, bool? disableNotification, bool? protectContent, int? replyToMessageId, bool? allowSendingWithoutReply, ReplyMarkup? replyMarkup}) → Future<Message>
Use this method to send phone contacts
sendDice(dynamic chatId, {int? messageThreadId, String emoji = Dice.emojiDice, bool? disableNotification, bool? protectContent, int? replyToMessageId, bool? allowSendingWithoutReply, ReplyMarkup? replyMarkup}) → Future<Message>
Use this method to send an animated emoji that will display a random value
sendDocument(dynamic chatId, dynamic document, {int? messageThreadId, dynamic thumbnail, String? caption, String? parseMode, List<MessageEntity>? captionEntities, bool? disableContentTypeDetection, bool? disableNotification, bool? protectContent, int? replyToMessageId, bool? allowSendingWithoutReply, ReplyMarkup? replyMarkup}) → Future<Message>
Use this method to send general files
sendGame(dynamic chatId, String gameShortName, {int? messageThreadId, bool? disableNotification, bool? protectContent, int? replyToMessageId, bool? allowSendingWithoutReply, InlineKeyboardMarkup? replyMarkup}) → Future<Message>
Use this method to send a game
sendInvoice(dynamic chatId, String title, String description, String payload, String providerToken, String currency, List<LabeledPrice> prices, {int? messageThreadId, int? maxTipAmount, List<int>? suggestedTipAmounts, String? startParameter, String? providerData, String? photoUrl, int? photoSize, int? photoWidth, int? photoHeight, bool? needName, bool? needPhoneNumber, bool? needEmail, bool? needShippingAddress, bool? sendPhoneNumberToProvider, bool? sendEmailToProvider, bool? isFlexible, bool? disableNotification, bool? protectContent, int? replyToMessageId, bool? allowSendingWithoutReply, InlineKeyboardMarkup? replyMarkup}) → Future<Message>
Use this method to send invoices
sendLocation(dynamic chatId, double latitude, double longitude, {int? messageThreadId, double? horizontalAccuracy, int? livePeriod, int? heading, int? proximityAlertRadius, bool? disableNotification, bool? protectContent, int? replyToMessageId, bool? allowSendingWithoutReply, ReplyMarkup? replyMarkup}) → Future<Message>
Use this method to send point on the map
sendMediaGroup(dynamic chatId, List<InputMedia> media, {int? messageThreadId, bool? disableNotification, bool? protectContent, int? replyToMessageId, bool? allowSendingWithoutReply}) → Future<List<Message>>
Use this method to send a group of photos or videos as an album
sendMessage(dynamic chatId, String text, {int? messageThreadId, String? parseMode, List<MessageEntity>? entities, bool? disableWebPagePreview, bool? disableNotification, bool? protectContent, int? replyToMessageId, bool? allowSendingWithoutReply, ReplyMarkup? replyMarkup}) → Future<Message>
Use this method to send text messages. On success, the sent Message is returned.
sendPhoto(dynamic chatId, dynamic photo, {int? messageThreadId, String? caption, String? parseMode, List<MessageEntity>? captionEntities, bool? hasSpoiler, bool? disableNotification, bool? protectContent, int? replyToMessageId, bool? allowSendingWithoutReply, ReplyMarkup? replyMarkup}) → Future<Message>
Use this method to send photos
sendPoll(dynamic chatId, String question, List<String> options, {int? messageThreadId, bool? isAnonymous, String? type, bool? allowsMultipleAnswers, int? correctOptionId, String? explanation, String? explanationParseMode, List<MessageEntity>? explanationEntities, int? openPeriod, int? closeDate, bool? isClosed, bool? disableNotification, bool? protectContent, int? replyToMessageId, bool? allowSendingWithoutReply, ReplyMarkup? replyMarkup}) → Future<Message>
Use this method to send a native poll
sendSticker(dynamic chatId, dynamic sticker, {int? messageThreadId, String? emoji, bool? disableNotification, bool? protectContent, int? replyToMessageId, bool? allowSendingWithoutReply, ReplyMarkup? replyMarkup}) → Future<Message>
Use this method to send .webp stickers
sendVenue(dynamic chatId, double latitude, double longitude, String title, String address, {int? messageThreadId, String? foursquareId, String? foursquareType, String? googlePlaceId, String? googlePlaceType, bool? disableNotification, bool? protectContent, int? replyToMessageId, bool? allowSendingWithoutReply, ReplyMarkup? replyMarkup}) → Future<Message>
Use this method to send information about a venue
sendVideo(dynamic chatId, dynamic video, {int? messageThreadId, int? duration, int? width, int? height, dynamic thumbnail, String? caption, String? parseMode, List<MessageEntity>? captionEntities, bool? hasSpoiler, bool? supportsStreaming, bool? disableNotification, bool? protectContent, int? replyToMessageId, bool? allowSendingWithoutReply, ReplyMarkup? replyMarkup}) → Future<Message>
Use this method to send video files
sendVideoNote(dynamic chatId, dynamic videoNote, {int? messageThreadId, int? duration, int? length, dynamic thumbnail, bool? disableNotification, bool? protectContent, int? replyToMessageId, bool? allowSendingWithoutReply, ReplyMarkup? replyMarkup}) → Future<Message>
Use this method to send video messages
sendVoice(dynamic chatId, dynamic voice, {int? messageThreadId, String? caption, String? parseMode, List<MessageEntity>? captionEntities, int? duration, bool? disableNotification, bool? protectContent, int? replyToMessageId, bool? allowSendingWithoutReply, ReplyMarkup? replyMarkup}) → Future<Message>
Use this method to send audio files
setChatAdministratorCustomTitle(dynamic chatId, int userId, String customTitle) → Future<bool>
Use this method to set a custom title for an administrator in a supergroup promoted by the bot
setChatDescription(dynamic chatId, {String? description}) → Future<bool>
Use this method to change the description of a supergroup or a channel
setChatMenuButton(int? chatId, MenuButton? menuButton) → Future<bool>
Use this method to change the bot's menu button in a private chat, or the default menu button.
setChatPermissions(dynamic chatId, ChatPermissions permissions, {bool? useIndependentChatPermissions}) → Future<bool>
Use this method to set default chat permissions for all members
setChatPhoto(dynamic chatId, File photo) → Future<bool>
Use this method to set a profile photo for the chat
setChatStickerSet(dynamic chatId, String stickerSetName) → Future<bool>
Use this method to set a group sticker set for a supergroup
setChatTitle(dynamic chatId, String title) → Future<bool>
Use this method to change the title of a chat
setCustomEmojiStickerSetThumbnail(String name, {String? customEmojiId}) → Future<bool>
Use this method to set the thumbnail of a custom emoji sticker set.
setGameScore(int userId, int score, {bool? force, bool? disableEditMessage, dynamic chatId, int? messageId, String? inlineMessageId}) → Future<Message>
Use this method to set the score of the specified user in a game
setMyCommands(List<BotCommand> commands, {BotCommandScope? scope, String? languageCode}) → Future<bool>
Use this method to change the list of the bot's commands
setMyDefaultAdministratorRights(ChatAdministratorRights? rights, bool? forChannels) → Future<bool>
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.
setMyDescription(String description, String languageCode) → Future<bool>
Use this method to change the bot's description, which is shown in the chat with the bot if the chat is empty.
setMyName(String name, String languageCode) → Future<bool>
Use this method to change the bot's name.
setMyShortDescription(String shortDescription, String languageCode) → Future<bool>
Use this method to change the bot's short description, which is shown on the bot's profile page and is sent together with the link when users share the bot.
setPassportDataErrors(int userId, List<PassportElementError> errors) → Future<bool>
Informs a user that some of the Telegram Passport elements they provided contains errors.
setStickerEmojiList(String sticker, List<String> emojiList) → Future<bool>
Use this method to change the list of emoji assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot.
setStickerKeywords(String sticker, List<String>? keywords) → Future<bool>
Use this method to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot.
setStickerMaskPosition(String sticker, MaskPosition? maskPosition) → Future<bool>
Use this method to change the MaskPosition of a mask sticker. The sticker must belong to a sticker set that was created by the bot.
setStickerPositionInSet(String sticker, int position) → Future<bool>
Use this method to move a sticker in a set created by the bot to a specific position
setStickerSetThumbnail(String name, int userId, {dynamic thumbnail}) → Future<bool>
Use this method to set the thumbnail of a sticker set
setStickerSetTitle(String name, String title) → Future<bool>
Use this method to set the title of a created sticker set.
setWebhook(String url, {String? ipAddress, File? certificate, int? maxConnections, List<String>? allowedUpdates, bool? dropPendingUpdates, String? secretToken}) → Future<bool>
Use this method to specify a url and receive incoming updates via an outgoing webhook
stopMessageLiveLocation({dynamic chatId, int? messageId, String? inlineMessageId, ReplyMarkup? replyMarkup}) → Future<Message>
Use this method to stop updating a live location message sent by the bot or via the bot (for inline bots) before livePeriod expires.
stopPoll(dynamic chatId, int messageId, InlineKeyboardMarkup replyMarkup) → Future<Poll>
Use this method to stop a poll which was sent by the bot
toString() → String
A string representation of this object.
inherited
unbanChatMember(dynamic chatId, int userId, {bool? onlyIfBanned}) → Future<bool>
Use this method to unban a previously kicked user in a supergroup or channel
unbanChatSenderChat(dynamic chatId, int senderChatId) → Future<bool>
Use this method to unban a previously banned channel chat in a supergroup or channel
unhideGeneralForumTopic(dynamic chatId) → Future<bool>
Use this method to unhide the 'General' topic in a forum supergroup chat.
unpinAllChatMessages(dynamic chatId) → Future<bool>
Use this method to clear the list of pinned messages in a chat
unpinAllForumTopicMessages(dynamic chatId, String messageThreadId) → Future<bool>
Use this method to clear the list of pinned messages in a forum topic.
unpinAllGeneralForumTopicMessages(dynamic chatId) → Future<bool>
Use this method to clear the list of pinned messages in a General 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.
unpinChatMessage(dynamic chatId, {int? messageId}) → Future<bool>
Use this method to remove a message from the list of pinned messages in a chat
uploadStickerFile(int userId, File sticker, String stickerFormat) → Future<File>
Use this method to upload a .png file with a sticker for later use in createNewStickerSet and addStickerToSet methods (can be used multiple times)

Operators

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