# 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 io import BytesIO
from pyrogram.raw.core.primitives import Int, Long, Int128, Int256, Bool, Bytes, String, Double, Vector
from pyrogram.raw.core import TLObject
from pyrogram import raw
from typing import List, Optional, Any
# # # # # # # # # # # # # # # # # # # # # # # #
# !!! WARNING !!! #
# This is a generated file! #
# All changes made in this file will be lost! #
# # # # # # # # # # # # # # # # # # # # # # # #
[docs]
class Poll(TLObject): # type: ignore
"""Poll
Constructor of :obj:`~pyrogram.raw.base.Poll`.
Details:
- Layer: ``229``
- ID: ``966E2DBF``
Parameters:
id (``int`` ``64-bit``):
ID of the poll
question (:obj:`TextWithEntities <pyrogram.raw.base.TextWithEntities>`):
The question of the poll (only `Premium <https://core.telegram.org/api/premium>`_ users can use `custom emoji entities <https://core.telegram.org/api/custom-emoji>`_ here).
answers (List of :obj:`PollAnswer <pyrogram.raw.base.PollAnswer>`):
The possible answers (2- `poll_answers_max <https://core.telegram.org/api/config#poll-answers-max>`_ ), vote using `messages.sendVote <https://core.telegram.org/method/messages.sendVote>`_.
hash (``int`` ``64-bit``):
Hash for use with `messages.getPollResults <https://core.telegram.org/method/messages.getPollResults>`_
closed (``bool``, *optional*):
Whether the poll is closed and doesn't accept any more answers
public_voters (``bool``, *optional*):
Whether cast votes are publicly visible to all users (non-anonymous poll)
multiple_choice (``bool``, *optional*):
Whether multiple options can be chosen as answer
quiz (``bool``, *optional*):
Whether this is a quiz (with wrong and correct answers, results shown in the return type). When creating a poll, the correct answers are specified in `inputMediaPoll <https://core.telegram.org/constructor/inputMediaPoll>`_. ``correct_answers``.
open_answers (``bool``, *optional*):
Whether users can add new answer options after the poll is created, see `open-answer polls » <https://core.telegram.org/api/poll#open-answer-polls>`_
revoting_disabled (``bool``, *optional*):
If set, users cannot change their vote after casting it
shuffle_answers (``bool``, *optional*):
Whether answer options are displayed in a randomized order to each user
hide_results_until_close (``bool``, *optional*):
Whether vote results are hidden from all participants until the poll is closed
creator (``bool``, *optional*):
Whether the current user created this poll
subscribers_only (``bool``, *optional*):
Whether only subscribers can vote: a user may vote only if they are currently a member of the channel/supergroup and joined it at least 24 hours before the poll was posted, see `subscriber-only polls » <https://core.telegram.org/api/poll#subscriber-only-polls>`_.
close_period (``int`` ``32-bit``, *optional*):
Amount of time in seconds the poll will be active after creation, up to `poll_close_period_max » <https://core.telegram.org/api/config#poll-close-period-max>`_ seconds. Can't be used together with close_date.
close_date (``int`` ``32-bit``, *optional*):
Point in time (Unix timestamp) when the poll will be automatically closed. Up to `poll_close_period_max » <https://core.telegram.org/api/config#poll-close-period-max>`_ seconds in the future; can't be used together with close_period.
countries_iso2 (List of ``str``, *optional*):
If set, only users from the specified ISO 3166-1 alpha-2 country codes may vote, see `country-restricted polls » <https://core.telegram.org/api/poll#country-restricted-polls>`_; a user may vote only if the `phone_country_iso2 » <https://core.telegram.org/api/config#phone-country-iso2>`_ configuration parameter is contained in this list.
"""
__slots__: List[str] = ["id", "question", "answers", "hash", "closed", "public_voters", "multiple_choice", "quiz", "open_answers", "revoting_disabled", "shuffle_answers", "hide_results_until_close", "creator", "subscribers_only", "close_period", "close_date", "countries_iso2"]
ID = 0x966e2dbf
QUALNAME = "types.Poll"
def __init__(self, *, id: int, question: "raw.base.TextWithEntities", answers: List["raw.base.PollAnswer"], hash: int, closed: Optional[bool] = None, public_voters: Optional[bool] = None, multiple_choice: Optional[bool] = None, quiz: Optional[bool] = None, open_answers: Optional[bool] = None, revoting_disabled: Optional[bool] = None, shuffle_answers: Optional[bool] = None, hide_results_until_close: Optional[bool] = None, creator: Optional[bool] = None, subscribers_only: Optional[bool] = None, close_period: Optional[int] = None, close_date: Optional[int] = None, countries_iso2: Optional[List[str]] = None) -> None:
self.id = id # long
self.question = question # TextWithEntities
self.answers = answers # Vector<PollAnswer>
self.hash = hash # long
self.closed = closed # flags.0?true
self.public_voters = public_voters # flags.1?true
self.multiple_choice = multiple_choice # flags.2?true
self.quiz = quiz # flags.3?true
self.open_answers = open_answers # flags.6?true
self.revoting_disabled = revoting_disabled # flags.7?true
self.shuffle_answers = shuffle_answers # flags.8?true
self.hide_results_until_close = hide_results_until_close # flags.9?true
self.creator = creator # flags.10?true
self.subscribers_only = subscribers_only # flags.11?true
self.close_period = close_period # flags.4?int
self.close_date = close_date # flags.5?int
self.countries_iso2 = countries_iso2 # flags.12?Vector<string>
@staticmethod
def read(b: BytesIO, *args: Any) -> "Poll":
id = Long.read(b)
flags = Int.read(b)
closed = True if flags & (1 << 0) else False
public_voters = True if flags & (1 << 1) else False
multiple_choice = True if flags & (1 << 2) else False
quiz = True if flags & (1 << 3) else False
open_answers = True if flags & (1 << 6) else False
revoting_disabled = True if flags & (1 << 7) else False
shuffle_answers = True if flags & (1 << 8) else False
hide_results_until_close = True if flags & (1 << 9) else False
creator = True if flags & (1 << 10) else False
subscribers_only = True if flags & (1 << 11) else False
question = TLObject.read(b)
answers = TLObject.read(b)
close_period = Int.read(b) if flags & (1 << 4) else None
close_date = Int.read(b) if flags & (1 << 5) else None
countries_iso2 = TLObject.read(b, String) if flags & (1 << 12) else []
hash = Long.read(b)
return Poll(id=id, question=question, answers=answers, hash=hash, closed=closed, public_voters=public_voters, multiple_choice=multiple_choice, quiz=quiz, open_answers=open_answers, revoting_disabled=revoting_disabled, shuffle_answers=shuffle_answers, hide_results_until_close=hide_results_until_close, creator=creator, subscribers_only=subscribers_only, close_period=close_period, close_date=close_date, countries_iso2=countries_iso2)
def write(self, *args) -> bytes:
b = BytesIO()
b.write(Int(self.ID, False))
b.write(Long(self.id))
flags = 0
flags |= (1 << 0) if self.closed else 0
flags |= (1 << 1) if self.public_voters else 0
flags |= (1 << 2) if self.multiple_choice else 0
flags |= (1 << 3) if self.quiz else 0
flags |= (1 << 6) if self.open_answers else 0
flags |= (1 << 7) if self.revoting_disabled else 0
flags |= (1 << 8) if self.shuffle_answers else 0
flags |= (1 << 9) if self.hide_results_until_close else 0
flags |= (1 << 10) if self.creator else 0
flags |= (1 << 11) if self.subscribers_only else 0
flags |= (1 << 4) if self.close_period is not None else 0
flags |= (1 << 5) if self.close_date is not None else 0
flags |= (1 << 12) if self.countries_iso2 else 0
b.write(Int(flags))
b.write(self.question.write())
b.write(Vector(self.answers))
if self.close_period is not None:
b.write(Int(self.close_period))
if self.close_date is not None:
b.write(Int(self.close_date))
if self.countries_iso2:
b.write(Vector(self.countries_iso2, String))
b.write(Long(self.hash))
return b.getvalue()