Source code for pyrogram.methods.payments.get_chat_gifts_count
# 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 __future__ import annotations
import logging
import pyrogram
from pyrogram import raw
log = logging.getLogger(__name__)
class GetChatGiftsCount:
async def get_chat_gifts_count(self: pyrogram.Client, chat_id: int | str) -> int:
"""Get the total count of owned gifts of specified chat.
.. 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".
For a contact that exists in your Telegram address book you can use his phone number (str).
Returns:
``int``: On success, the star gifts count is returned.
Example:
.. code-block:: python
await app.get_chat_gifts_count(chat_id)
"""
peer = await self.resolve_peer(chat_id)
r = await self.invoke(
raw.functions.payments.GetSavedStarGifts(peer=peer, offset="", limit=1)
)
return r.count
get_received_gifts_count = get_chat_gifts_count