MTPyroger/pyrogram/methods/chats/mark_chat_unread.py
2021-01-01 22:58:48 +01:00

46 lines
1.5 KiB
Python

# 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 Union
from pyrogram.raw import functions
from pyrogram.scaffold import Scaffold
class MarkChatUnread(Scaffold):
async def mark_chat_unread(
self,
chat_id: Union[int, str],
) -> bool:
"""Mark a chat as unread.
Parameters:
chat_id (``int`` | ``str``):
Unique identifier (int) or username (str) of the target chat.
Returns:
``bool``: On success, True is returned.
"""
return await self.send(
functions.messages.MarkDialogUnread(
peer=await self.resolve_peer(chat_id),
unread=True
)
)