mirror of
https://github.com/LonamiWebs/Telethon.git
synced 2024-11-22 17:36:34 +03:00
31 lines
5.1 KiB
HTML
31 lines
5.1 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
|
|
<title>GetDialogsRequest</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">Messages</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_dialogs.html">GetDialogsRequest</a></li></ul><h1>GetDialogsRequest</h1><p><strong>Only users</strong> can use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
||
|
|
messages.getDialogs#a0f4cb4f flags:# exclude_pinned:flags.0?<a href="../../index.html#true">true</a> folder_id:flags.1?<a href="../../index.html#int">int</a> offset_date:<a href="../../index.html#date">date</a> offset_id:<a href="../../index.html#int">int</a> offset_peer:<a href="../../types/input_peer.html">InputPeer</a> limit:<a href="../../index.html#int">int</a> hash:<a href="../../index.html#long">long</a> = <a href="../../types/messages/dialogs.html">messages.Dialogs</a></pre><button onclick="cp('from telethon.tl.functions.messages import GetDialogsRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/messages/dialogs.html">messages.Dialogs</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/messages/dialogs.html">Dialogs</a></td><td><a href="../../constructors/messages/dialogs_not_modified.html">DialogsNotModified</a></td></tr><tr><td><a href="../../constructors/messages/dialogs_slice.html">DialogsSlice</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>offset_date</b></td><td style="text-align:center"><a href="../../index.html#date">date</a></td><td></td></tr><tr><td><b>offset_id</b></td><td style="text-align:center"><a href="../../index.html#int">int</a></td><td></td></tr><tr><td><b>offset_peer</b></td><td style="text-align:center"><a href="../../types/input_peer.html">InputPeer</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.).</td></tr><tr><td><b>limit</b></td><td style="text-align:center"><a href="../../index.html#int">int</a></td><td></td></tr><tr><td><b>hash</b></td><td style="text-align:center"><a href="../../index.html#long">long</a></td><td></td></tr><tr><td><b>exclude_pinned</b></td><td style="text-align:center"><a href="../../index.html#true">flag</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>folder_id</b></td><td style="text-align:center"><a href="../../index.html#int">int</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr></table><h1>Known RPC errors</h1><p>This request can cause 4 known errors:</p><table><tr><td><code>InputConstructorInvalidError</code></td><td>The provided constructor is invalid.</td></tr><tr><td><code>OffsetPeerIdInvalidError</code></td><td>The provided offset peer is invalid.</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.dialogs.DialogMethods.iter_dialogs"><code>client.iter_dialogs()</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.messages.GetDialogsRequest(
|
||
|
|
offset_date=datetime.datetime(2018, 6, 25),
|
||
|
|
offset_id=42,
|
||
|
|
offset_peer=<em>'username'</em>,
|
||
|
|
limit=100,
|
||
|
|
hash=-12398745604826,
|
||
|
|
exclude_pinned=<strong>True</strong>,
|
||
|
|
folder_id=42
|
||
|
|
))
|
||
|
|
print(result.stringify())</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>
|