Helpers¶
C¶
ChatActions.sendActionChatActions.setActionChatActions.stopClient.createStarsInvoice— Create an invoice link for Telegram StarsClient.editRichMessage— Edit rich messageClient.editTextMessage— Edit text messageClient.forwardMessage— Forward message to chatClient.getSupergroupId— Get supergroup id from chat idClient.parseText— Parses Bold, Italic, Underline, Strikethrough, Spoiler, Code, Pre, PreCode, TextUrl and MentionName entities containe...Client.sendAlbum— Sends 2-10 messages grouped together into an album. Currently, only audio, document, photo and video messages can be ...Client.sendAnimation— Send animation to chatClient.sendAudio— Send audio to chatClient.sendCopy— Copy message to chatClient.sendDocument— Send document to chatClient.sendInvoice— Send invoice to chatClient.sendMessageWithContentClient.sendPhoto— Send photo to chatClient.sendRichMessage— Send rich message to chat; either markdown or html must be providedClient.sendSticker— Send sticker to chatClient.sendTextMessage— Send text message to chatClient.sendVideo— Send video to chatClient.sendVideoNote— Send video note to chatClient.sendVoice— Send voice to chat
F¶
File.delete— Deletes a file from the TDLib file cache. Shortcut for deleteFileFile.download— Downloads a file. Shortcut for downloadFile
M¶
Message.action— Sends a chat action to a specific chat. Supporting context manager (withstatement)Message.ban— Ban the message senderMessage.caption— Caption of the received mediaMessage.caption_entities— Caption entities of the received mediaMessage.copy— Copy message to chat. Shortcut for sendCopy.Message.delete— Delete the received messageMessage.download— Download the media file and returnsLocalFileobject. Shortcut for downloadFile.Message.edit_rich_message— Edit rich message. Shortcut for editRichMessage.Message.edit_text— Edit text message. Shortcut for editTextMessage.Message.entities— Entities of the messageMessage.forward— Forward message to chat. Shortcut for forwardMessage.Message.from_id— Message Sender IDMessage.getChat— Get chat infoMessage.getChatMember— Get member info in the current chatMessage.getMessageLink— Get message linkMessage.getMessageProperties— Get the message propertiesMessage.getRepliedMessage— Get the replied messageMessage.getUser— Get user infoMessage.kick— Kick the message senderMessage.leaveChat— Leave the current chatMessage.mention— Get the text_mention of the message senderMessage.pin— Pin the messageMessage.react— React to the current messageMessage.remote_duration— Remote media file duration in seconds as defined by the sender; 0 if unknownMessage.remote_file_id— Remote file idMessage.remote_file_size— Remote file size in bytes; 0 if unknownMessage.remote_unique_file_id— Remote unique file idMessage.reply_album— Reply to the message with media album. Shortcut for sendAlbum.Message.reply_animation— Reply to the message with animation. Shortcut for sendAnimation.Message.reply_audio— Reply to the message with audio. Shortcut for sendAudio.Message.reply_document— Reply to the message with a document. Shortcut for sendDocument.Message.reply_invoice— Reply to the message with a Telegram Stars invoice. Shortcut for sendInvoice.Message.reply_photo— Reply to the message with a photo. Shortcut for sendPhoto.Message.reply_rich_message— Reply to the message with Rich message. Shortcut for sendRichMessage.Message.reply_sticker— Reply to the message with a sticker. Shortcut for sendSticker.Message.reply_text— Reply to the message with text. Shortcut for sendTextMessage.Message.reply_to_message_id— Replied message IDMessage.reply_video— Reply to the message with a video. Shortcut for sendVideo.Message.reply_video_note— Reply to the message with a video note. Shortcut for sendVideoNote.Message.reply_voice— Reply to the message with a voice note. Shortcut for sendVoice.Message.restrict— Restrict the message senderMessage.rich_media— Returns all media attachments available in the Rich messageMessage.setChatMemberStatus— Set chat member statusMessage.text— Text of the messageMessage.unpin— Unpin the messageMessageSender.from_id— Returns the message sender's ID.Noneif not foundMessageSender.is_chat— ReturnsTrueif the message sender is a chatMessageSender.is_user— ReturnsTrueif the message sender is a user
U¶
UpdateNewCallbackQuery.answer— Answer to callback query. Shortcut for answerCallbackQueryUpdateNewCallbackQuery.callback_data— Callback data that was set by callback_dataUpdateNewCallbackQuery.edit_message_caption— Edit message captionUpdateNewCallbackQuery.edit_message_reply_markup— Edit message reply markup. Shortcut for editMessageReplyMarkupUpdateNewCallbackQuery.edit_message_text— Edit callback query message text. Shortcut for editTextMessageUpdateNewCallbackQuery.getMessage— Get callback query messageUpdateNewCallbackQuery.text— Callback data decoded as strutils.anchor— Create an empty anchor that can be linked to with in_doc_linkutils.aside— Create a pull quoteutils.audio— Create an audio blockutils.blockquote— Create a block quotationutils.bold— Convert the given text to bold formatutils.callback_data— Create callback data for inline buttonsutils.code— Convert the given text to code formatutils.create_webapp_secret_key— Create a secret key for Web App data validationutils.custom_emoji— Convert the given emoji to custom emoji formatutils.details— Create a collapsible details blockutils.email_link— Create an inline e-mail linkutils.escape_html— Escape HTML characters in the given textutils.escape_markdown— Escape Markdown characters in the given textutils.figcaption— Create a figure captionutils.figure— Create a figure blockutils.footer— Create a footer blockutils.get_bot_id_from_tokenutils.get_formatted_text— Convert a FormattedText object to its text representation stringutils.get_message_sender_id— Get the ID from MessageSenderUser or [MessageSenderChat][pytdbot.types.MessageSend...utils.get_retry_after_time— Get the retry after time from flood wait error messageutils.heading— Create a heading with an optional anchorutils.horizontal_rule— Create a horizontal ruleutils.hyperlink— Convert the given text to hyperlink formatutils.image— Create an image blockutils.in_doc_link— Create an in-document link to an anchor created with anchorutils.italic— Convert the given text to italic formatutils.list_item— Create a list itemutils.load_callback_data— loads already created callback data by callback_data. Returns empty CallbackData on errorutils.ltr— Add LTR (Left-to-Right) mark to the given textutils.marked— Wrap text in marked (highlighted) formatutils.mention— Convert the given text to inline mention formatutils.newline— Create one or more HTML line breaks.utils.ordered_list— Create an ordered listutils.paragraph— Create a paragraph blockutils.parse_webapp_data— Parse and validate init data received from Web Apputils.phone— Create an inline phone number linkutils.pre— Convert the given text to pre formatutils.pre_code— Convert the given text to pre-formatted fixed-width code blockutils.quote— Convert the given text to quote blockutils.rich_message_to_html— Convert a TDLib rich message object to HTMLutils.rtl— Add RTL (Right-to-Left) mark to the given textutils.spoiler— Convert the given text to spoiler formatutils.strikethrough— Convert the given text to strikethrough formatutils.subscript— Wrap text in subscript formatutils.superscript— Wrap text in superscript formatutils.table— Create a tableutils.table_cell— Create a table data cellutils.table_header— Create a table header row with<th>cellsutils.table_header_cell— Create a table header cellutils.table_row— Create a table rowutils.tag— Build an HTML tag stringutils.tg_button— Create an inline or row buttonutils.tg_button_row— Create a row of buttonsutils.tg_collage— Create a media collageutils.tg_document— Create a document blockutils.tg_map— Create a map blockutils.tg_math— Wrap text in inline math formulautils.tg_math_block— Wrap text in a block math formulautils.tg_reference— Define referenced text that can be linked to with in_doc_linkutils.tg_slideshow— Create a media slideshowutils.tg_time— Create a date-time entityutils.thinking— Create a Telegram thinkingutils.underline— Convert the given text to underline formatutils.unordered_list— Create an unordered listutils.video— Create a video block