forked from pyrogram/pyrogram
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathset_bot_commands.py
More file actions
59 lines (47 loc) · 2.04 KB
/
set_bot_commands.py
File metadata and controls
59 lines (47 loc) · 2.04 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# Pyrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-2021 Dan <https://github.com/delivrance>
#
# 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 <http://www.gnu.org/licenses/>.
from typing import Optional, List
from pyrogram import raw
from pyrogram import types
from pyrogram.scaffold import Scaffold
class SetBotCommands(Scaffold):
async def set_bot_commands(self, commands: Optional[List[types.BotCommand]]):
"""Set the bot commands list.
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.
Pass None to remove all commands.
Returns:
``bool``: True on success, False otherwise.
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")])
# Remove commands
app.set_bot_commands(None)
"""
return await self.send(
raw.functions.bots.SetBotCommands(
commands=[c.write() for c in commands or []]
)
)