Telethon/methods/channels/get_admin_log.html

48 lines
6.3 KiB
HTML
Raw Normal View History

2016-08-26 13:58:53 +03:00
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GetAdminLogRequest</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">Channels</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_admin_log.html">GetAdminLogRequest</a></li></ul><h1>GetAdminLogRequest</h1><p><strong>Only users</strong> can use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
channels.getAdminLog#33ddf480 flags:# channel:<a href="../../types/input_channel.html">InputChannel</a> q:<a href="../../index.html#string">string</a> events_filter:flags.0?<a href="../../types/channel_admin_log_events_filter.html">ChannelAdminLogEventsFilter</a> admins:flags.1?<a href="../../index.html#vector">Vector</a>&lt;<a href="../../types/input_user.html">InputUser</a>&gt; max_id:<a href="../../index.html#long">long</a> min_id:<a href="../../index.html#long">long</a> limit:<a href="../../index.html#int">int</a> = <a href="../../types/channels/admin_log_results.html">channels.AdminLogResults</a></pre><button onclick="cp('from telethon.tl.functions.channels import GetAdminLogRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/channels/admin_log_results.html">channels.AdminLogResults</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/channels/admin_log_results.html">AdminLogResults</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>channel</b></td><td style="text-align:center"><a href="../../types/input_channel.html">InputChannel</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>q</b></td><td style="text-align:center"><a href="../../index.html#string">string</a></td><td></td></tr><tr><td><b>max_id</b></td><td style="text-align:center"><a href="../../index.html#long">long</a></td><td></td></tr><tr><td><b>min_id</b></td><td style="text-align:center"><a href="../../index.html#long">long</a></td><td></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>events_filter</b></td><td style="text-align:center"><a href="../../types/channel_admin_log_events_filter.html">ChannelAdminLogEventsFilter</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>admins</b></td><td style="text-align:center"><a href="../../types/input_user.html">InputUser</a></td><td>This argument defaults to <code>None</code> and can be omitted. Otherwise, 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 3 known errors:</p><table><tr><td><code>ChannelInvalidError</code></td><td>Invalid channel object. Make sure to pass the right types, for instance making sure that the request is designed for channels or otherwise look for a different one more suited.</td></tr><tr><td><code>ChannelPrivateError</code></td><td>The channel specified is private and you lack permission to access it. Another reason may be that you were banned from it.</td></tr><tr><td><code>ChatAdminRequiredError</code></td><td>Chat admin privileges are required to do that in the specified chat (for example, to send a message in a channel which is not yours), or invalid permissions used for the channel or group.</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.chats.ChatMethods.iter_admin_log"><code>client.iter_admin_log()</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.channels.GetAdminLogRequest(
channel=<em>'username'</em>,
q=<em>'some string here'</em>,
max_id=0,
min_id=0,
limit=100,
events_filter=types.ChannelAdminLogEventsFilter(
join=<strong>True</strong>,
leave=<strong>True</strong>,
invite=<strong>True</strong>,
ban=<strong>True</strong>,
unban=<strong>True</strong>,
kick=<strong>True</strong>,
unkick=<strong>True</strong>,
promote=<strong>True</strong>,
demote=<strong>True</strong>,
info=<strong>True</strong>,
settings=<strong>True</strong>,
pinned=<strong>True</strong>,
group_call=<strong>True</strong>,
invites=<strong>True</strong>,
send=<strong>True</strong>,
forums=<strong>True</strong>,
sub_extend=<strong>True</strong>
)
))
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>