async def set_bot_commands(
self: "pyrogram.Client",
commands: List["types.BotCommand"],
scope: "types.BotCommandScope" = types.BotCommandScopeDefault(),
language_code: str = "",
):
"""Set the list of the bot's commands.
The commands passed will overwrite any command set previously.
This method can be used by the own bot only.
Parameters:
commands (List of :obj:`~pyrogram.types.BotCommand`):
A list of bot commands.
At most 100 commands can be specified.
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
from pyrogram.types import BotCommand
# Set new commands
app.set_bot_commands([
BotCommand("start", "Start the bot"),
BotCommand("settings", "Bot settings")])
"""
return await self.send(
raw.functions.bots.SetBotCommands(
commands=[c.write() for c in commands],
scope=await scope.write(self),
lang_code=language_code,
))
async def get_bot_commands(
self: "pyrogram.Client",
scope: "types.BotCommandScope" = types.BotCommandScopeDefault(),
language_code: str = "",
) -> List["types.BotCommand"]:
"""Get the current list of the bot's commands for the given scope and user language.
Returns Array of BotCommand on success. If commands aren't set, an empty list is returned.
The commands passed will overwrite any command set previously.
This method can be used by the own bot only.
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:
List of :obj:`~pyrogram.types.BotCommand`: On success, the list of bot commands is returned.
Example:
.. code-block:: python
# Get commands
commands = await app.get_bot_commands()
print(commands)
"""
r = await self.invoke(
raw.functions.bots.GetBotCommands(
scope=await scope.write(self),
lang_code=language_code,
))
return types.List(types.BotCommand.read(c) for c in r)
async def delete_bot_commands(
self: "pyrogram.Client",
scope: "types.BotCommandScope" = types.BotCommandScopeDefault(),
language_code: str = "",
):
"""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.
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
app.delete_bot_commands()
"""
return await self.send(
raw.functions.bots.ResetBotCommands(
scope=await scope.write(self),
lang_code=language_code,
)
)