.. _ref-summary: ================= Reference Summary ================= This page contains a summary of all the important methods and properties that you may need when using Telethon. They are sorted by relevance and are not in alphabetical order. The way you should use this page is by looking up the type you need in the table of contents (method index below) and searching for the method or property that you are interested in. .. contents:: Method Index TelegramClient ============== This is a summary of the methods and properties you will find at :ref:`telethon-client`. Auth ---- .. currentmodule:: telethon.client.auth.AuthMethods .. autosummary:: :nosignatures: start send_code_request sign_in sign_up log_out edit_2fa Base ---- .. py:currentmodule:: telethon.client.telegrambaseclient.TelegramBaseClient .. autosummary:: :nosignatures: connect disconnect is_connected disconnected loop Messages -------- .. py:currentmodule:: telethon.client.messages.MessageMethods .. autosummary:: :nosignatures: send_message edit_message delete_messages forward_messages iter_messages get_messages send_read_acknowledge Uploads ------- .. py:currentmodule:: telethon.client.uploads.UploadMethods .. autosummary:: :nosignatures: send_file upload_file Downloads --------- .. currentmodule:: telethon.client.downloads.DownloadMethods .. autosummary:: :nosignatures: download_media download_profile_photo download_file Dialogs ------- .. py:currentmodule:: telethon.client.dialogs.DialogMethods .. autosummary:: :nosignatures: iter_dialogs get_dialogs iter_drafts get_drafts conversation Users ----- .. py:currentmodule:: telethon.client.users.UserMethods .. autosummary:: :nosignatures: get_me is_bot is_user_authorized get_entity get_input_entity get_peer_id Chats ----- .. currentmodule:: telethon.client.chats.ChatMethods .. autosummary:: :nosignatures: iter_participants get_participants iter_admin_log get_admin_log action Parse Mode ---------- .. py:currentmodule:: telethon.client.messageparse.MessageParseMethods .. autosummary:: :nosignatures: parse_mode Updates ------- .. py:currentmodule:: telethon.client.updates.UpdateMethods .. autosummary:: :nosignatures: on run_until_disconnected add_event_handler remove_event_handler list_event_handlers catch_up Bots ---- .. currentmodule:: telethon.client.bots.BotMethods .. autosummary:: :nosignatures: inline_query Buttons ------- .. currentmodule:: telethon.client.buttons.ButtonMethods .. autosummary:: :nosignatures: build_reply_markup Account ------- .. currentmodule:: telethon.client.account.AccountMethods .. autosummary:: :nosignatures: takeout end_takeout Message ======= .. currentmodule:: telethon.tl.custom.message The `Message` type is very important, mostly because we are working with a library for a *messaging* platform, so messages are widely used: in events, when fetching history, replies, etc. Properties ---------- .. note:: We document *custom properties* here, not all the attributes of the `Message` (which is the information Telegram actually returns). .. currentmodule:: telethon.tl.custom.message.Message .. autosummary:: :nosignatures: text raw_text is_reply forward buttons button_count photo document web_preview audio voice video video_note gif sticker contact game geo invoice poll venue action_entities via_bot via_input_bot client Methods ------- .. autosummary:: :nosignatures: respond reply forward_to edit delete get_reply_message click download_media get_entities_text get_buttons Conversation ============ The `Conversation ` object is returned by the `client.conversation() ` method to easily send and receive responses like a normal conversation. .. currentmodule:: telethon.tl.custom.conversation.Conversation .. autosummary:: :nosignatures: send_message send_file mark_read get_response get_reply get_edit wait_read wait_event cancel AdminLogEvent ============= The `AdminLogEvent ` object is returned by the `client.iter_admin_log() ` method to easily iterate over past "events" (deleted messages, edits, title changes, leaving members…) These are all the properties you can find in it: .. currentmodule:: telethon.tl.custom.adminlogevent.AdminLogEvent .. autosummary:: :nosignatures: id date user_id action old new changed_about changed_title changed_username changed_photo changed_sticker_set changed_message deleted_message changed_admin changed_restrictions changed_invites joined joined_invite left changed_hide_history changed_signatures changed_pin changed_default_banned_rights stopped_poll Button ====== The `Button ` class is used when you login as a bot account to send messages with reply markup, such as inline buttons or custom keyboards. These are the static methods you can use to create instances of the markup: .. currentmodule:: telethon.tl.custom.button.Button .. autosummary:: :nosignatures: inline switch_inline url text request_location request_phone clear force_reply InlineResult ============ The `InlineResult ` object is returned inside a list by the `client.inline_query() ` method to make an inline query to a bot that supports being used in inline mode, such as ``@like``. Note that the list returned is in fact a *subclass* of a list called `InlineResults `, which, in addition of being a list (iterator, indexed access, etc.), has extra attributes and methods. These are the constants for the types, properties and methods you can find the individual results: .. currentmodule:: telethon.tl.custom.inlineresult.InlineResult .. autosummary:: :nosignatures: ARTICLE PHOTO GIF VIDEO VIDEO_GIF AUDIO DOCUMENT LOCATION VENUE CONTACT GAME type message title description url photo document click download_media Utils ===== The `telethon.utils` module has plenty of methods that make using the library a lot easier. Only the interesting ones will be listed here. .. currentmodule:: telethon.utils .. autosummary:: :nosignatures: get_display_name get_extension get_inner_text get_peer_id resolve_id pack_bot_file_id resolve_bot_file_id resolve_invite_link