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 c35e60de94
commit 9bb83e9319
No known key found for this signature in database
GPG key ID: 318CD6CD3A6AC0A5

View file

@ -201,3 +201,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
)