Source code for pyrogram.methods.messages.add_poll_option
# Pyrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-present <https://github.com/TelegramPlayGround>
#
# 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 __future__ import annotations
import pyrogram
from pyrogram import raw, types, utils
class AddPollOption:
async def add_poll_option(
self: pyrogram.Client,
chat_id: int | str,
message_id: int,
option: str | types.InputPollOption,
) -> types.Message | bool:
"""Adds an option to 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".
message_id (``int``):
Identifier of the message containing the poll.
option (``str`` | :obj:`~pyrogram.types.InputPollOption`):
The new option.
Returns:
:obj:`~pyrogram.types.Message` | ``bool``: On success, an edited message or a service message will be returned (when applicable),
otherwise, in case a message object couldn't be returned, True is returned.
Example:
.. code-block:: python
await app.add_poll_option(
chat_id,
message_id,
option="new option"
)
"""
if isinstance(option, str):
option = types.InputPollOption(text=types.FormattedText(text=option))
r = await self.invoke(
raw.functions.messages.AddPollAnswer(
peer=await self.resolve_peer(chat_id),
msg_id=message_id,
answer=await option.write(self),
)
)
return next(iter(await utils.parse_messages(client=self, messages=r)), True)