Source code for pyrogram.raw.types.sponsored_peer
# 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 SponsoredPeer(TLObject): # type: ignore
"""A sponsored peer.
Constructor of :obj:`~pyrogram.raw.base.SponsoredPeer`.
Details:
- Layer: ``229``
- ID: ``C69708D3``
Parameters:
random_id (``bytes``):
ID of the sponsored peer, to be passed to `messages.viewSponsoredMessage <https://core.telegram.org/method/messages.viewSponsoredMessage>`_, `messages.clickSponsoredMessage <https://core.telegram.org/method/messages.clickSponsoredMessage>`_ or `messages.reportSponsoredMessage <https://core.telegram.org/method/messages.reportSponsoredMessage>`_ (the same methods used for `sponsored messages » <https://core.telegram.org/api/sponsored-messages>`_ ). See `here ยป <https://core.telegram.org/api/updates#updatemessageid-updates>`_ for more info on random ID deduplication and updateMessageID mapping.
peer (:obj:`Peer <pyrogram.raw.base.Peer>`):
The sponsored peer.
sponsor_info (``str``, *optional*):
If set, contains additional information about the sponsor to be shown along with the peer.
additional_info (``str``, *optional*):
If set, contains additional information about the sponsored message to be shown along with the peer.
"""
__slots__: List[str] = ["random_id", "peer", "sponsor_info", "additional_info"]
ID = 0xc69708d3
QUALNAME = "types.SponsoredPeer"
def __init__(self, *, random_id: bytes, peer: "raw.base.Peer", sponsor_info: Optional[str] = None, additional_info: Optional[str] = None) -> None:
self.random_id = random_id # bytes
self.peer = peer # Peer
self.sponsor_info = sponsor_info # flags.0?string
self.additional_info = additional_info # flags.1?string
@staticmethod
def read(b: BytesIO, *args: Any) -> "SponsoredPeer":
flags = Int.read(b)
random_id = Bytes.read(b)
peer = TLObject.read(b)
sponsor_info = String.read(b) if flags & (1 << 0) else None
additional_info = String.read(b) if flags & (1 << 1) else None
return SponsoredPeer(random_id=random_id, peer=peer, sponsor_info=sponsor_info, additional_info=additional_info)
def write(self, *args) -> bytes:
b = BytesIO()
b.write(Int(self.ID, False))
flags = 0
flags |= (1 << 0) if self.sponsor_info is not None else 0
flags |= (1 << 1) if self.additional_info is not None else 0
b.write(Int(flags))
b.write(Bytes(self.random_id))
b.write(self.peer.write())
if self.sponsor_info is not None:
b.write(String(self.sponsor_info))
if self.additional_info is not None:
b.write(String(self.additional_info))
return b.getvalue()