Update missing links in the documentation summary

This commit is contained in:
Lonami Exo 2019-09-24 16:19:35 +02:00
parent 40aa46e72a
commit d1ddfd09b6
4 changed files with 21 additions and 0 deletions

View File

@ -121,6 +121,7 @@ Methods
delete delete
get_reply_message get_reply_message
click click
mark_read
pin pin
download_media download_media
get_entities_text get_entities_text
@ -142,6 +143,8 @@ its name, bot-API style file ID, etc.
id id
name name
ext
mime_type
width width
height height
size size
@ -176,6 +179,7 @@ It bases `ChatGetter <telethon.tl.custom.chatgetter.ChatGetter>`.
wait_read wait_read
wait_event wait_event
cancel cancel
cancel_all
AdminLogEvent AdminLogEvent
@ -236,6 +240,7 @@ These are the static methods you can use to create instances of the markup:
inline inline
switch_inline switch_inline
url url
auth
text text
request_location request_location
request_phone request_phone

View File

@ -1122,6 +1122,8 @@ class MessageMethods:
If neither message nor maximum ID are provided, all messages will be If neither message nor maximum ID are provided, all messages will be
marked as read by assuming that ``max_id = 0``. marked as read by assuming that ``max_id = 0``.
See also `Message.mark_read() <telethon.tl.custom.message.Message.mark_read>`.
Arguments Arguments
entity (`entity`): entity (`entity`):
The chat where these messages are located. The chat where these messages are located.

View File

@ -250,6 +250,12 @@ class Conversation(ChatGetter):
""" """
Waits for a custom event to occur. Timeouts still apply. Waits for a custom event to occur. Timeouts still apply.
.. note::
Only use this if there isn't another method available!
For example, don't use `wait_event` for new messages,
since `get_response` already exists, etc.
Unless you're certain that your code will run fast enough, Unless you're certain that your code will run fast enough,
generally you should get a "handle" of this special coroutine generally you should get a "handle" of this special coroutine
before acting. Generally, you should do this: before acting. Generally, you should do this:

View File

@ -22,6 +22,14 @@ class File:
def id(self): def id(self):
""" """
The bot-API style ``file_id`` representing this file. The bot-API style ``file_id`` representing this file.
.. note::
This file ID may not work under user accounts,
but should still be usable by bot accounts.
You can, however, still use it to identify
a file in for example a database.
""" """
return utils.pack_bot_file_id(self.media) return utils.pack_bot_file_id(self.media)