1dc4df8cb1
* Change type1 or type2 to Union[type1, type2] * Address @KunoiSayami suggestions * Change Union[type1, None] to Optional[type1] * Update PR with latest commit changes * Address Dan suggestions
62 lines
2.0 KiB
Python
62 lines
2.0 KiB
Python
# Pyrogram - Telegram MTProto API Client Library for Python
|
|
# Copyright (C) 2017-2020 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 Union, Optional
|
|
|
|
from pyrogram import raw
|
|
from pyrogram.scaffold import Scaffold
|
|
|
|
|
|
class SetSlowMode(Scaffold):
|
|
async def set_slow_mode(
|
|
self,
|
|
chat_id: Union[int, str],
|
|
seconds: Optional[int]
|
|
) -> bool:
|
|
"""Set the slow mode interval for a chat.
|
|
|
|
Parameters:
|
|
chat_id (``int`` | ``str``):
|
|
Unique identifier (int) or username (str) of the target chat.
|
|
|
|
seconds (``int`` | ``None``):
|
|
Seconds in which members will be able to send only one message per this interval.
|
|
Valid values are: 0 or None (off), 10, 30, 60 (1m), 300 (5m), 900 (15m) or 3600 (1h).
|
|
|
|
Returns:
|
|
``bool``: True on success.
|
|
|
|
Example:
|
|
.. code-block:: python
|
|
|
|
# Set slow mode to 60 seconds
|
|
app.set_slow_mode("pyrogramchat", 60)
|
|
|
|
# Disable slow mode
|
|
app.set_slow_mode("pyrogramchat", None)
|
|
"""
|
|
|
|
await self.send(
|
|
raw.functions.channels.ToggleSlowMode(
|
|
channel=await self.resolve_peer(chat_id),
|
|
seconds=0 if seconds is None else seconds
|
|
)
|
|
)
|
|
|
|
return True
|