pyrofork/pyrogram/methods/messages/retract_vote.py
wulan17 1b3f0933c7
Pyrofork: Update Copyright headers
Signed-off-by: wulan17 <wulan17@nusantararom.org>
2024-02-07 20:25:08 +07:00

63 lines
2.2 KiB
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 Pyrofork.
#
# 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.
#
# 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 Pyrofork. If not, see <http://www.gnu.org/licenses/>.
from typing import Union
import pyrogram
from pyrogram import raw
from pyrogram import types
class RetractVote:
async def retract_vote(
self: "pyrogram.Client",
chat_id: Union[int, str],
message_id: int
) -> "types.Poll":
"""Retract your vote in a poll.
.. include:: /_includes/usable-by/users.rst
Parameters:
chat_id (``int`` | ``str``):
Unique identifier (int) or username (str) of the target chat.
For your personal cloud (Saved Messages) you can simply use "me" or "self".
For a contact that exists in your Telegram address book you can use his phone number (str).
You can also use chat public link in form of *t.me/<username>* (str).
message_id (``int``):
Identifier of the original message with the poll.
Returns:
:obj:`~pyrogram.types.Poll`: On success, the poll with the retracted vote is returned.
Example:
.. code-block:: python
await app.retract_vote(chat_id, message_id)
"""
r = await self.invoke(
raw.functions.messages.SendVote(
peer=await self.resolve_peer(chat_id),
msg_id=message_id,
options=[]
)
)
return types.Poll._parse(self, r.updates[0])