MTPyroger/pyrogram/client/methods/messages/vote_poll.py

68 lines
2.4 KiB
Python
Raw Normal View History

2020-03-21 14:43:32 +00:00
# Pyrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-2020 Dan <https://github.com/delivrance>
2018-12-23 15:19:24 +00:00
#
2020-03-21 14:43:32 +00:00
# This file is part of Pyrogram.
2018-12-23 15:19:24 +00:00
#
2020-03-21 14:43:32 +00:00
# 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.
2018-12-23 15:19:24 +00:00
#
2020-03-21 14:43:32 +00:00
# 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.
2018-12-23 15:19:24 +00:00
#
2020-03-21 14:43:32 +00:00
# You should have received a copy of the GNU Lesser General Public License
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
2018-12-23 15:19:24 +00:00
from typing import Union, List
2018-12-23 15:19:24 +00:00
import pyrogram
2018-12-23 15:19:24 +00:00
from pyrogram.api import functions
from pyrogram.client.ext import BaseClient
class VotePoll(BaseClient):
2019-05-06 15:27:21 +00:00
async def vote_poll(
2019-03-16 18:23:23 +00:00
self,
chat_id: Union[int, str],
message_id: id,
options: Union[int, List[int]]
) -> "pyrogram.Poll":
"""Vote a poll.
2018-12-23 15:45:54 +00:00
Parameters:
2018-12-23 15:45:54 +00:00
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.
2018-12-23 15:45:54 +00:00
options (``Int`` | List of ``int``):
Index or list of indexes (for multiple answers) of the poll option(s) you want to vote for (0 to 9).
2018-12-23 15:45:54 +00:00
Returns:
:obj:`Poll` - On success, the poll with the chosen option is returned.
2018-12-23 15:45:54 +00:00
2019-07-25 09:22:14 +00:00
Example:
.. code-block:: python
app.vote_poll(chat_id, message_id, 6)
2018-12-23 15:45:54 +00:00
"""
2019-05-06 15:27:21 +00:00
poll = (await self.get_messages(chat_id, message_id)).poll
options = [options] if not isinstance(options, list) else options
2019-05-06 15:27:21 +00:00
r = await self.send(
2018-12-23 15:19:24 +00:00
functions.messages.SendVote(
2019-05-06 15:27:21 +00:00
peer=await self.resolve_peer(chat_id),
2018-12-23 15:19:24 +00:00
msg_id=message_id,
options=[poll.options[option].data for option in options]
2018-12-23 15:19:24 +00:00
)
)
return pyrogram.Poll._parse(self, r.updates[0])