-
-
Notifications
You must be signed in to change notification settings - Fork 48
Expand file tree
/
Copy pathset_bot_commands.py
More file actions
73 lines (60 loc) · 2.69 KB
/
set_bot_commands.py
File metadata and controls
73 lines (60 loc) · 2.69 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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
# Hydrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-2023 Dan <https://github.com/delivrance>
# Copyright (C) 2023-present Hydrogram <https://hydrogram.org>
#
# This file is part of Hydrogram.
#
# Hydrogram 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.
#
# Hydrogram 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 Hydrogram. If not, see <http://www.gnu.org/licenses/>.
import hydrogram
from hydrogram import raw, types
class SetBotCommands:
async def set_bot_commands(
self: "hydrogram.Client",
commands: list["types.BotCommand"],
scope: "types.BotCommandScope" = types.BotCommandScopeDefault(),
language_code: str = "",
) -> bool:
"""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.
.. include:: /_includes/usable-by/bots.rst
Parameters:
commands (List of :obj:`~hydrogram.types.BotCommand`):
A list of bot commands.
At most 100 commands can be specified.
scope (:obj:`~hydrogram.types.BotCommandScope`, *optional*):
An object describing the scope of users for which the commands are relevant.
Defaults to :obj:`~hydrogram.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 hydrogram.types import BotCommand
# Set new commands
await app.set_bot_commands([
BotCommand("start", "Start the bot"),
BotCommand("settings", "Bot settings"),
])
"""
return await self.invoke(
raw.functions.bots.SetBotCommands(
commands=[c.write() for c in commands],
scope=await scope.write(self),
lang_code=language_code,
)
)