diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst index 80ae1ecc..de9d354d 100644 --- a/docs/source/glossary.rst +++ b/docs/source/glossary.rst @@ -56,6 +56,7 @@ Terms Userbot Also known as *user bot* or *ubot* for short, is a user logged in by third-party Telegram libraries --- such as Pyrogram --- to automate some behaviours, like sending messages or reacting to text commands or any other event. + Not to be confused with *bot*, that is, a normal Telegram bot created by `@BotFather `_. Session Also known as *login session*, is a strictly personal piece of data created and held by both parties diff --git a/pyrogram/client/methods/chats/delete_user_history.py b/pyrogram/client/methods/chats/delete_user_history.py new file mode 100644 index 00000000..c374d911 --- /dev/null +++ b/pyrogram/client/methods/chats/delete_user_history.py @@ -0,0 +1,53 @@ +# Pyrogram - Telegram MTProto API Client Library for Python +# Copyright (C) 2017-2019 Dan Tès +# +# This file is part of Pyrogram. +# +# Pyrogram is free software: you can redistribute it and/or modify +# it under the terms of the GNU Lesser General Public License as published +# by the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Pyrogram is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public License +# along with Pyrogram. If not, see . + +from typing import Union + +from pyrogram.api import functions, types +from pyrogram.client.ext import BaseClient + + +class DeleteUserHistory(BaseClient): + def delete_user_history( + self, + chat_id: Union[int, str], + user_id: Union[int, str], + ) -> bool: + """Delete all messages sent by a certain user in a supergroup. + + Parameters: + chat_id (``int`` | ``str``): + Unique identifier (int) or username (str) of the target chat. + + user_id (``int`` | ``str``): + Unique identifier (int) or username (str) of the user whose messages will be deleted. + + Returns: + ``bool``: True on success, False otherwise. + """ + + r = self.send( + functions.channels.DeleteUserHistory( + channel=self.resolve_peer(chat_id), + user_id=self.resolve_peer(user_id) + ) + ) + + # Deleting messages you don't have right onto won't raise any error. + # Check for pts_count, which is 0 in case deletes fail. + return bool(r.pts_count) diff --git a/pyrogram/client/methods/users/update_profile.py b/pyrogram/client/methods/users/update_profile.py new file mode 100644 index 00000000..c543156d --- /dev/null +++ b/pyrogram/client/methods/users/update_profile.py @@ -0,0 +1,70 @@ +# Pyrogram - Telegram MTProto API Client Library for Python +# Copyright (C) 2017-2019 Dan Tès +# +# This file is part of Pyrogram. +# +# Pyrogram is free software: you can redistribute it and/or modify +# it under the terms of the GNU Lesser General Public License as published +# by the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Pyrogram is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public License +# along with Pyrogram. If not, see . + +from pyrogram.api import functions +from ...ext import BaseClient + + +class UpdateProfile(BaseClient): + def update_profile( + self, + first_name: str = None, + last_name: str = None, + bio: str = None + ) -> bool: + """Update your profile details such as first name, last name and bio. + + You can omit the parameters you don't want to change. + + Parameters: + first_name (``str``, *optional*): + The new first name. + + last_name (``str``, *optional*): + The new last name. + Pass "" (empty string) to remove it. + + bio (``str``, *optional*): + The new bio, also known as "about". Max 70 characters. + Pass "" (empty string) to remove it. + + Returns: + ``bool``: True on success. + + Example: + .. code-block:: python + + # Update your first name only + app.update_bio(first_name="Pyrogram") + + # Update first name and bio + app.update_bio(first_name="Pyrogram", bio="https://docs.pyrogram.org/") + + # Remove the last name + app.update_bio(last_name="") + """ + + return bool( + self.send( + functions.account.UpdateProfile( + first_name=first_name, + last_name=last_name, + about=bio + ) + ) + )