pyrofork/pyrogram/methods/users/update_profile.py
wulan17 f990b1e7f9
pyrofork: Update documentation url
Signed-off-by: wulan17 <wulan17@nusantararom.org>
2024-10-13 01:54:55 +07:00

73 lines
2.4 KiB
Python

# Pyrofork - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-present Dan <https://github.com/delivrance>
# Copyright (C) 2022-present Mayuri-Chan <https://github.com/Mayuri-Chan>
#
# This file is part of Pyrofork.
#
# Pyrofork 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.
#
# Pyrofork 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 Pyrofork. If not, see <http://www.gnu.org/licenses/>.
import pyrogram
from pyrogram import raw
class UpdateProfile:
async def update_profile(
self: "pyrogram.Client",
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.
.. include:: /_includes/usable-by/users.rst
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
await app.update_profile(first_name="Pyrofork")
# Update first name and bio
await app.update_profile(first_name="Pyrofork", bio="https://pyrofork.wulan17.top/")
# Remove the last name
await app.update_profile(last_name="")
"""
return bool(
await self.invoke(
raw.functions.account.UpdateProfile(
first_name=first_name,
last_name=last_name,
about=bio
)
)
)