mirror of
https://github.com/Mayuri-Chan/pyrofork.git
synced 2025-12-29 20:14:51 +00:00
63 lines
2.4 KiB
Python
63 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, types
|
|
|
|
|
|
class DeleteBotCommands:
|
|
async def delete_bot_commands(
|
|
self: "pyrogram.Client",
|
|
scope: "types.BotCommandScope" = types.BotCommandScopeDefault(),
|
|
language_code: str = "",
|
|
) -> bool:
|
|
"""Delete the list of the bot's commands for the given scope and user language.
|
|
After deletion, higher level commands will be shown to affected users.
|
|
|
|
The commands passed will overwrite any command set previously.
|
|
This method can be used by the own bot only.
|
|
|
|
.. include:: /_includes/usable-by/bots.rst
|
|
|
|
Parameters:
|
|
scope (:obj:`~pyrogram.types.BotCommandScope`, *optional*):
|
|
An object describing the scope of users for which the commands are relevant.
|
|
Defaults to :obj:`~pyrogram.types.BotCommandScopeDefault`.
|
|
|
|
language_code (``str``, *optional*):
|
|
A two-letter ISO 639-1 language code.
|
|
If empty, commands will be applied to all users from the given scope, for whose language there are no
|
|
dedicated commands.
|
|
|
|
Returns:
|
|
``bool``: On success, True is returned.
|
|
|
|
Example:
|
|
.. code-block:: python
|
|
|
|
# Delete commands
|
|
await app.delete_bot_commands()
|
|
"""
|
|
|
|
return await self.invoke(
|
|
raw.functions.bots.ResetBotCommands(
|
|
scope=await scope.write(self),
|
|
lang_code=language_code,
|
|
)
|
|
)
|