Add bound method stop() to the Poll object

Signed-off-by: wulan17 <wulan17@nusantararom.org>
This commit is contained in:
Devesh Pal 2021-07-16 21:31:27 -03:00 committed by wulan17
parent c0efd663fd
commit 165ade92d5
No known key found for this signature in database
GPG key ID: 318CD6CD3A6AC0A5

View file

@ -1,20 +1,21 @@
# Pyrogram - Telegram MTProto API Client Library for Python
# Pyrofork - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-present Dan <https://github.com/delivrance>
# Copyright (C) 2022-present Mayuri-Chan <https://github.com/Mayuri-Chan>
#
# This file is part of Pyrogram.
# This file is part of Pyrofork.
#
# Pyrogram is free software: you can redistribute it and/or modify
# Pyrofork 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,
# Pyrofork 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/>.
# along with Pyrofork. If not, see <http://www.gnu.org/licenses/>.
from datetime import datetime
from typing import List, Union, Optional
@ -201,3 +202,40 @@ class Poll(Object, Update):
correct_option_id=correct_option_id,
client=client
)
async def stop(
self,
reply_markup: "types.InlineKeyboardMarkup" = None
) -> "types.Poll":
"""Bound method *stop* of :obj:`~pyrogram.types.Poll`.
Use as a shortcut for:
.. code-block:: python
client.stop_poll(
chat_id=message.chat.id,
message_id=message.id,
)
Parameters:
reply_markup (:obj:`~pyrogram.types.InlineKeyboardMarkup`, *optional*):
An InlineKeyboardMarkup object.
Example:
.. code-block:: python
message.poll.stop()
Returns:
:obj:`~pyrogram.types.Poll`: On success, the stopped poll with the final results is returned.
Raises:
RPCError: In case of a Telegram RPC error.
"""
return await self._client.stop_poll(
chat_id=self.chat.id,
message_id=self.id,
reply_markup=reply_markup
)