mirror of
https://github.com/LonamiWebs/Telethon.git
synced 2024-11-22 09:26:37 +03:00
34 lines
5.3 KiB
HTML
34 lines
5.3 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<title>ExportChatInviteRequest</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="export_chat_invite.html">ExportChatInviteRequest</a></li></ul><h1>ExportChatInviteRequest</h1><p><strong>Both users and bots</strong> can use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
|
|
messages.exportChatInvite#a455de90 flags:# legacy_revoke_permanent:flags.2?<a href="../../index.html#true">true</a> request_needed:flags.3?<a href="../../index.html#true">true</a> peer:<a href="../../types/input_peer.html">InputPeer</a> expire_date:flags.0?<a href="../../index.html#date">date</a> usage_limit:flags.1?<a href="../../index.html#int">int</a> title:flags.4?<a href="../../index.html#string">string</a> subscription_pricing:flags.5?<a href="../../types/stars_subscription_pricing.html">StarsSubscriptionPricing</a> = <a href="../../types/exported_chat_invite.html">ExportedChatInvite</a></pre><button onclick="cp('from telethon.tl.functions.messages import ExportChatInviteRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/exported_chat_invite.html">ExportedChatInvite</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/chat_invite_exported.html">ChatInviteExported</a></td><td><a href="../../constructors/chat_invite_public_join_requests.html">ChatInvitePublicJoinRequests</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>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>legacy_revoke_permanent</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>request_needed</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>expire_date</b></td><td style="text-align:center"><a href="../../index.html#date">date</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>usage_limit</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><tr><td><b>title</b></td><td style="text-align:center"><a href="../../index.html#string">string</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>subscription_pricing</b></td><td style="text-align:center"><a href="../../types/stars_subscription_pricing.html">StarsSubscriptionPricing</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 2 known errors:</p><table><tr><td><code>ChatIdInvalidError</code></td><td>Invalid object ID for a chat. Make sure to pass the right types, for instance making sure that the request is designed for chats (not channels/megagroups) or otherwise look for a different one more suited\nAn example working with a megagroup and AddChatUserRequest, it will fail because megagroups are channels. Use InviteToChannelRequest instead.</td></tr><tr><td><code>ExpireDateInvalidError</code></td><td>The specified expiration date is invalid.</td></tr></table><p>You can import these from <code>telethon.errors</code>.</p><h1 id="examples">Example</h1><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.ExportChatInviteRequest(
|
|
peer=<em>'username'</em>,
|
|
legacy_revoke_permanent=<strong>True</strong>,
|
|
request_needed=<strong>True</strong>,
|
|
expire_date=datetime.datetime(2018, 6, 25),
|
|
usage_limit=42,
|
|
title=<em>'My awesome title'</em>,
|
|
subscription_pricing=types.StarsSubscriptionPricing(
|
|
period=42,
|
|
amount=-12398745604826
|
|
)
|
|
))
|
|
print(result.stringify())</pre><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> |