Skip to content

Commit

Permalink
Add get_channel_recommendations to high-lvl
Browse files Browse the repository at this point in the history
  • Loading branch information
KurimuzonAkuma committed Dec 2, 2023
1 parent e73f32f commit 3b98efa
Show file tree
Hide file tree
Showing 3 changed files with 62 additions and 0 deletions.
1 change: 1 addition & 0 deletions compiler/docs/compiler.py
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,7 @@ def get_title_list(s: str) -> list:
export_folder_link
get_folders
update_folder
get_channel_recommendations
""",
users="""
Users
Expand Down
2 changes: 2 additions & 0 deletions pyrogram/methods/chats/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@
from .get_chat_members import GetChatMembers
from .get_chat_members_count import GetChatMembersCount
from .get_chat_online_count import GetChatOnlineCount
from .get_channel_recommendations import GetChannelRecommendations
from .get_dialogs import GetDialogs
from .get_dialogs_count import GetDialogsCount
from .get_folders import GetFolders
Expand Down Expand Up @@ -120,6 +121,7 @@ class Chats(
MarkChatUnread,
GetChatEventLog,
GetChatOnlineCount,
GetChannelRecommendations,
GetSendAsChats,
SetSendAsChat,
SetChatProtectedContent
Expand Down
59 changes: 59 additions & 0 deletions pyrogram/methods/chats/get_channel_recommendations.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# 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 typing import Union

import pyrogram
from pyrogram import raw
from pyrogram import types


class GetChannelRecommendations:
async def get_channel_recommendations(
self: "pyrogram.Client",
chat_id: Union[int, str]
) -> "types.Chat":
"""Get channel recommendations.
.. include:: /_includes/usable-by/users.rst
Parameters:
chat_id (``int`` | ``str``):
Unique identifier (int) or username (str) of the target chat.
Returns:
List of :obj:`~pyrogram.types.Chat`: On success, the list of channels is returned.
Example:
.. code-block:: python
channels = await app.get_channel_recommendations(chat_id)
print(channels)
"""
chat = await self.resolve_peer(chat_id)

if isinstance(chat, raw.types.InputPeerChannel):
r = await self.invoke(
raw.functions.channels.GetChannelRecommendations(
channel=chat
)
)

return types.List([types.Chat._parse_channel_chat(self, chat) for chat in r.chats]) or None
else:
raise ValueError(f'The chat_id "{chat_id}" belongs to a user or chat')

0 comments on commit 3b98efa

Please sign in to comment.