mirror of
https://github.com/TeamPGM/pyrogram.git
synced 2024-11-16 04:35:24 +00:00
Update description of some methods
This commit is contained in:
parent
b784ae8800
commit
eecf23b2c6
@ -29,6 +29,10 @@ class DeleteFolder:
|
|||||||
|
|
||||||
.. include:: /_includes/usable-by/users.rst
|
.. include:: /_includes/usable-by/users.rst
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
folder_id (``int``):
|
||||||
|
Unique identifier (int) of the target folder.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
``bool``: True, on success.
|
``bool``: True, on success.
|
||||||
|
|
||||||
@ -36,7 +40,7 @@ class DeleteFolder:
|
|||||||
.. code-block:: python
|
.. code-block:: python
|
||||||
|
|
||||||
# Delete folder
|
# Delete folder
|
||||||
app.delete_folder(123456789)
|
app.delete_folder(folder_id)
|
||||||
"""
|
"""
|
||||||
r = await self.invoke(
|
r = await self.invoke(
|
||||||
raw.functions.messages.UpdateDialogFilter(
|
raw.functions.messages.UpdateDialogFilter(
|
||||||
|
@ -29,6 +29,10 @@ class ExportFolderLink:
|
|||||||
|
|
||||||
.. include:: /_includes/usable-by/users.rst
|
.. include:: /_includes/usable-by/users.rst
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
folder_id (``int``):
|
||||||
|
Unique identifier (int) of the target folder.
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
``str``: On success, a link to the folder as string is returned.
|
``str``: On success, a link to the folder as string is returned.
|
||||||
|
|
||||||
@ -36,7 +40,7 @@ class ExportFolderLink:
|
|||||||
.. code-block:: python
|
.. code-block:: python
|
||||||
|
|
||||||
# Export folder link
|
# Export folder link
|
||||||
app.export_folder_link(123456789)
|
app.export_folder_link(folder_id)
|
||||||
"""
|
"""
|
||||||
folder = await self.get_folders(folder_id)
|
folder = await self.get_folders(folder_id)
|
||||||
|
|
||||||
|
@ -97,8 +97,8 @@ class UpdateFolder:
|
|||||||
Example:
|
Example:
|
||||||
.. code-block:: python
|
.. code-block:: python
|
||||||
|
|
||||||
# Delete folder
|
# Create or update folder
|
||||||
app.update_folder(folder_id, title="New folder", included_chats=["me"])
|
app.update_folder(folder_id, title="New folder", included_chats="me")
|
||||||
"""
|
"""
|
||||||
if not isinstance(included_chats, list):
|
if not isinstance(included_chats, list):
|
||||||
included_chats = [included_chats]
|
included_chats = [included_chats]
|
||||||
|
@ -57,7 +57,7 @@ class EditStoryPrivacy:
|
|||||||
Note: Works with :obj:`~pyrogram.enums.StoriesPrivacyRules.PUBLIC`
|
Note: Works with :obj:`~pyrogram.enums.StoriesPrivacyRules.PUBLIC`
|
||||||
and :obj:`~pyrogram.enums.StoriesPrivacyRules.CONTACTS` only
|
and :obj:`~pyrogram.enums.StoriesPrivacyRules.CONTACTS` only
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
:obj:`~pyrogram.types.Story`: On success, the edited story is returned.
|
:obj:`~pyrogram.types.Story`: On success, the edited story is returned.
|
||||||
|
|
||||||
Example:
|
Example:
|
||||||
|
Loading…
Reference in New Issue
Block a user