Telethon/methods/users/get_users.html
2024-09-23 18:48:46 +02:00

26 lines
4.1 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GetUsersRequest</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link id="style" href="../../css/docs.dark.css" rel="stylesheet">
<script>
document.getElementById("style").href = "../../css/docs."
+ (localStorage.getItem("theme") || "light")
+ ".css";
</script>
<link href="https://fonts.googleapis.com/css?family=Nunito|Source+Code+Pro"
rel="stylesheet">
</head>
<body>
<div id="main_div"><ul class="horizontal"><li><a href="../../index.html">API</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="../index.html">Methods</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="index.html">Users</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_users.html">GetUsersRequest</a></li></ul><h1>GetUsersRequest</h1><p><strong>Both users and bots</strong> can use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
users.getUsers#0d91a548 id:<a href="../../index.html#vector">Vector</a>&lt;<a href="../../types/input_user.html">InputUser</a>&gt; = <a href="../../index.html#vector">Vector</a>&lt;<a href="../../types/user.html">User</a>&gt;</pre><button onclick="cp('from telethon.tl.functions.users import GetUsersRequest');">Copy import to the clipboard</button><h3>Returns</h3><p>A list of the following type is returned.</p><table><tr><td><a href="../../types/user.html">User</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/user.html">User</a></td><td><a href="../../constructors/user_empty.html">UserEmpty</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>id</b></td><td style="text-align:center"><a href="../../types/input_user.html">InputUser</a></td><td>Anything entity-like will work if the library can find its <code>Input</code> version (e.g., usernames, <code>Peer</code>, <code>User</code> or <code>Channel</code> objects, etc.). A <span class="tooltip" title="Any iterable that supports len() will work too">list</span> must be supplied.</td></tr></table><h1>Known RPC errors</h1><p>This request can cause 5 known errors:</p><table><tr><td><code>AuthKeyPermEmptyError</code></td><td>The method is unavailable for temporary authorization key, not bound to permanent.</td></tr><tr><td><code>MemberNoLocationError</code></td><td>An internal failure occurred while fetching user info (couldn't find location).</td></tr><tr><td><code>NeedMemberInvalidError</code></td><td>The provided member is invalid or does not exist (for example a thumb size).</td></tr><tr><td><code>SessionPasswordNeededError</code></td><td>Two-steps verification is enabled and a password is required.</td></tr><tr><td><code>TimeoutError</code></td><td>A timeout occurred while fetching data from the worker.</td></tr></table><p>You can import these from <code>telethon.errors</code>.</p><h1 id="examples">Example</h1><p>Please refer to the documentation of <a href="https://docs.telethon.dev/en/stable/modules/client.html#telethon.client.users.UserMethods.get_entity"><code>client.get_entity()</code></a> to learn about the parameters and see several code examples on how to use it.</p><p>The method above is the recommended way to do it. If you need more control over the parameters or want to learn how it is implemented, open the details by clicking on the "Details" text.</p><details><pre><strong>from</strong> telethon.sync <strong>import</strong> TelegramClient
<strong>from</strong> telethon <strong>import</strong> functions, types
<strong>with</strong> TelegramClient(name, api_id, api_hash) <strong>as</strong> client:
result = client(functions.users.GetUsersRequest(
id=[<em>'username'</em>]
))
<strong>for</strong> x <strong>in</strong> result:
print(x)</pre></details><textarea id="c" class="invisible"></textarea><script>function cp(t){var c=document.getElementById("c");c.value=t;c.select();try{document.execCommand("copy")}catch(e){}}</script></div><script>prependPath = "../../";</script><script src="../../js/search.js"></script></body></html>