MTPyroger/pyrogram/methods/messages/retract_vote.py
2022-01-07 10:23:45 +01:00

60 lines
2.0 KiB
Python

# Pyrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-present 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 import raw
from pyrogram import types
from pyrogram.scaffold import Scaffold
class RetractVote(Scaffold):
async def retract_vote(
self,
chat_id: Union[int, str],
message_id: int
) -> "types.Poll":
"""Retract your vote in a poll.
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).
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
app.retract_vote(chat_id, message_id)
"""
r = await self.send(
raw.functions.messages.SendVote(
peer=await self.resolve_peer(chat_id),
msg_id=message_id,
options=[]
)
)
return types.Poll._parse(self, r.updates[0])