mir/pyrogram
2
0
Fork 0
mirror of https://github.com/pyrogram/pyrogram synced 2025-08-29 05:18:10 +00:00
Code Issues Releases Wiki Activity

Add resolve_peer docstrings

Browse Source
This commit is contained in:
Dan 2018-02-13 16:24:04 +01:00
parent 78f2c9549c
commit 89200f4697
1 changed files with 21 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
pyrogram/client/client.py
View File

@ -383,7 +383,7 @@ class Client:
client (:obj:`pyrogram.Client`): client (:obj:`pyrogram.Client`):
The Client itself, useful when you want to call other API methods inside the update handler. The Client itself, useful when you want to call other API methods inside the update handler.
update (:obj:`types.Update <pyrogram.api.types.Update>`): update (:obj:`Update`):
The received update, which can be one of the many single Updates listed in the *updates* The received update, which can be one of the many single Updates listed in the *updates*
field you see in the :obj:`types.Update <pyrogram.api.types.Update>` type. field you see in the :obj:`types.Update <pyrogram.api.types.Update>` type.
@ -703,7 +703,26 @@ class Client:
return input_peer return input_peer
def resolve_peer(self, peer_id: int or str or types.PeerUser or types.PeerChat or types.PeerChannel): def resolve_peer(self, peer_id: int or str):
"""Use this method to get the *InputPeer* of a known *peer_id*.
It is intended to be used when working with Raw Functions (i.e: a Telegram API method you wish to use which is
not available yet in the Client class as an easy-to-use method).
Args:
peer_id (:obj:`int` | :obj:`str` | :obj:`Peer`):
The Peer ID you want to extract the InputPeer from. Can be one of these types: :obj:`int` (direct ID),
:obj:`str` (@username), :obj:`PeerUser <pyrogram.api.types.PeerUser>`,
:obj:`PeerChat <pyrogram.api.types.PeerChat>`, :obj:`PeerChannel <pyrogram.api.types.PeerChannel>`
Returns:
:obj:`InputPeerUser <pyrogram.api.types.InputPeerUser>` or
:obj:`InputPeerChat <pyrogram.api.types.InputPeerChat>` or
:obj:`InputPeerChannel <pyrogram.api.types.InputPeerChannel>` depending on the *peer_id*.
Raises:
:class:`pyrogram.Error`
"""
if type(peer_id) is str: if type(peer_id) is str:
if peer_id in ("self", "me"): if peer_id in ("self", "me"):
return InputPeerSelf() return InputPeerSelf()