Update documentation

This commit is contained in:
Lonami
2025-11-05 20:14:25 +01:00
committed by Lonami Exo
commit 9a95659d62
2930 changed files with 60617 additions and 0 deletions
+27
View File
@@ -0,0 +1,27 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AcceptTermsOfServiceRequest</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">Help</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="accept_terms_of_service.html">AcceptTermsOfServiceRequest</a></li></ul><h1>AcceptTermsOfServiceRequest</h1><p><strong>Only users</strong> can use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
help.acceptTermsOfService#ee72f79a id:<a href="../../types/data_json.html">DataJSON</a> = <a href="../../index.html#bool">Bool</a></pre><button onclick="cp('from telethon.tl.functions.help import AcceptTermsOfServiceRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../index.html#bool">Bool</a></td></tr></table><p>This type has no instances available.</p><table></table><h3>Parameters</h3><table><tr><td><b>id</b></td><td style="text-align:center"><a href="../../types/data_json.html">DataJSON</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</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.help.AcceptTermsOfServiceRequest(
id=types.DataJSON(
data=<em>'some string here'</em>
)
))
print(result)</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>
+26
View File
@@ -0,0 +1,26 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>DismissSuggestionRequest</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">Help</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="dismiss_suggestion.html">DismissSuggestionRequest</a></li></ul><h1>DismissSuggestionRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
help.dismissSuggestion#f50dbaa1 peer:<a href="../../types/input_peer.html">InputPeer</a> suggestion:<a href="../../index.html#string">string</a> = <a href="../../index.html#bool">Bool</a></pre><button onclick="cp('from telethon.tl.functions.help import DismissSuggestionRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../index.html#bool">Bool</a></td></tr></table><p>This type has no instances available.</p><table></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>suggestion</b></td><td style="text-align:center"><a href="../../index.html#string">string</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</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.help.DismissSuggestionRequest(
peer=<em>'username'</em>,
suggestion=<em>'some string here'</em>
))
print(result)</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>
+30
View File
@@ -0,0 +1,30 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EditUserInfoRequest</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">Help</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="edit_user_info.html">EditUserInfoRequest</a></li></ul><h1>EditUserInfoRequest</h1><p><strong>Only users</strong> can use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
help.editUserInfo#66b91b70 user_id:<a href="../../types/input_user.html">InputUser</a> message:<a href="../../index.html#string">string</a> entities:<a href="../../index.html#vector">Vector</a>&lt;<a href="../../types/message_entity.html">MessageEntity</a>&gt; = <a href="../../types/help/user_info.html">help.UserInfo</a></pre><button onclick="cp('from telethon.tl.functions.help import EditUserInfoRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/help/user_info.html">help.UserInfo</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/help/user_info.html">UserInfo</a></td><td><a href="../../constructors/help/user_info_empty.html">UserInfoEmpty</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>user_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.).</td></tr><tr><td><b>message</b></td><td style="text-align:center"><a href="../../index.html#string">string</a></td><td></td></tr><tr><td><b>entities</b></td><td style="text-align:center"><a href="../../types/message_entity.html">MessageEntity</a></td><td>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 2 known errors:</p><table><tr><td><code>EntityBoundsInvalidError</code></td><td>Some of provided entities have invalid bounds (length is zero or out of the boundaries of the string).</td></tr><tr><td><code>UserInvalidError</code></td><td>The given user was 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.help.EditUserInfoRequest(
user_id=<em>'username'</em>,
message=<em>'Hello there!'</em>,
entities=[types.MessageEntityUnknown(
offset=42,
length=42
)]
))
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>
+25
View File
@@ -0,0 +1,25 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GetAppConfigRequest</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">Help</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_app_config.html">GetAppConfigRequest</a></li></ul><h1>GetAppConfigRequest</h1><p><strong>Only users</strong> can use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
help.getAppConfig#61e3f854 hash:<a href="../../index.html#int">int</a> = <a href="../../types/help/app_config.html">help.AppConfig</a></pre><button onclick="cp('from telethon.tl.functions.help import GetAppConfigRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/help/app_config.html">help.AppConfig</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/help/app_config.html">AppConfig</a></td><td><a href="../../constructors/help/app_config_not_modified.html">AppConfigNotModified</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>hash</b></td><td style="text-align:center"><a href="../../index.html#int">int</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</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.help.GetAppConfigRequest(
hash=0
))
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>
+25
View File
@@ -0,0 +1,25 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GetAppUpdateRequest</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">Help</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_app_update.html">GetAppUpdateRequest</a></li></ul><h1>GetAppUpdateRequest</h1><p><strong>Only users</strong> can use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
help.getAppUpdate#522d5a7d source:<a href="../../index.html#string">string</a> = <a href="../../types/help/app_update.html">help.AppUpdate</a></pre><button onclick="cp('from telethon.tl.functions.help import GetAppUpdateRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/help/app_update.html">help.AppUpdate</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/help/app_update.html">AppUpdate</a></td><td><a href="../../constructors/help/no_app_update.html">NoAppUpdate</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>source</b></td><td style="text-align:center"><a href="../../index.html#string">string</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</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.help.GetAppUpdateRequest(
source=<em>'some string here'</em>
))
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>
+23
View File
@@ -0,0 +1,23 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GetCdnConfigRequest</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">Help</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_cdn_config.html">GetCdnConfigRequest</a></li></ul><h1>GetCdnConfigRequest</h1><p><strong>Both users and bots</strong> can use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
help.getCdnConfig#52029342 = <a href="../../types/cdn_config.html">CdnConfig</a></pre><button onclick="cp('from telethon.tl.functions.help import GetCdnConfigRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/cdn_config.html">CdnConfig</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/cdn_config.html">CdnConfig</a></td></tr></table><h3>Parameters</h3><p>This request takes no input parameters.</p><h1>Known RPC errors</h1><p>This request can cause 2 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>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><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.help.GetCdnConfigRequest())
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>
+23
View File
@@ -0,0 +1,23 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GetConfigRequest</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">Help</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_config.html">GetConfigRequest</a></li></ul><h1>GetConfigRequest</h1><p><strong>Both users and bots</strong> can use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
help.getConfig#c4f9186b = <a href="../../types/config.html">Config</a></pre><button onclick="cp('from telethon.tl.functions.help import GetConfigRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/config.html">Config</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/config.html">Config</a></td></tr></table><h3>Parameters</h3><p>This request takes no input parameters.</p><h1>Known RPC errors</h1><p>This request can cause 2 known errors:</p><table><tr><td><code>AuthKeyDuplicatedError</code></td><td>The authorization key (session file) was used under two different IP addresses simultaneously, and can no longer be used. Use the same session exclusively, or use different sessions.</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><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.help.GetConfigRequest())
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>
+26
View File
@@ -0,0 +1,26 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GetCountriesListRequest</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">Help</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_countries_list.html">GetCountriesListRequest</a></li></ul><h1>GetCountriesListRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
help.getCountriesList#735787a8 lang_code:<a href="../../index.html#string">string</a> hash:<a href="../../index.html#int">int</a> = <a href="../../types/help/countries_list.html">help.CountriesList</a></pre><button onclick="cp('from telethon.tl.functions.help import GetCountriesListRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/help/countries_list.html">help.CountriesList</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/help/countries_list.html">CountriesList</a></td><td><a href="../../constructors/help/countries_list_not_modified.html">CountriesListNotModified</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>lang_code</b></td><td style="text-align:center"><a href="../../index.html#string">string</a></td><td></td></tr><tr><td><b>hash</b></td><td style="text-align:center"><a href="../../index.html#int">int</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</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.help.GetCountriesListRequest(
lang_code=<em>'en'</em>,
hash=0
))
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>
+25
View File
@@ -0,0 +1,25 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GetDeepLinkInfoRequest</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">Help</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_deep_link_info.html">GetDeepLinkInfoRequest</a></li></ul><h1>GetDeepLinkInfoRequest</h1><p><strong>Only users</strong> can use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
help.getDeepLinkInfo#3fedc75f path:<a href="../../index.html#string">string</a> = <a href="../../types/help/deep_link_info.html">help.DeepLinkInfo</a></pre><button onclick="cp('from telethon.tl.functions.help import GetDeepLinkInfoRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/help/deep_link_info.html">help.DeepLinkInfo</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/help/deep_link_info.html">DeepLinkInfo</a></td><td><a href="../../constructors/help/deep_link_info_empty.html">DeepLinkInfoEmpty</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>path</b></td><td style="text-align:center"><a href="../../index.html#string">string</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</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.help.GetDeepLinkInfoRequest(
path=<em>'some string here'</em>
))
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>
+23
View File
@@ -0,0 +1,23 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GetInviteTextRequest</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">Help</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_invite_text.html">GetInviteTextRequest</a></li></ul><h1>GetInviteTextRequest</h1><p><strong>Only users</strong> can use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
help.getInviteText#4d392343 = <a href="../../types/help/invite_text.html">help.InviteText</a></pre><button onclick="cp('from telethon.tl.functions.help import GetInviteTextRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/help/invite_text.html">help.InviteText</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/help/invite_text.html">InviteText</a></td></tr></table><h3>Parameters</h3><p>This request takes no input parameters.</p><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</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.help.GetInviteTextRequest())
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>
+23
View File
@@ -0,0 +1,23 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GetNearestDcRequest</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">Help</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_nearest_dc.html">GetNearestDcRequest</a></li></ul><h1>GetNearestDcRequest</h1><p><strong>Only users</strong> can use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
help.getNearestDc#1fb33026 = <a href="../../types/nearest_dc.html">NearestDc</a></pre><button onclick="cp('from telethon.tl.functions.help import GetNearestDcRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/nearest_dc.html">NearestDc</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/nearest_dc.html">NearestDc</a></td></tr></table><h3>Parameters</h3><p>This request takes no input parameters.</p><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</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.help.GetNearestDcRequest())
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>
+25
View File
@@ -0,0 +1,25 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GetPassportConfigRequest</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">Help</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_passport_config.html">GetPassportConfigRequest</a></li></ul><h1>GetPassportConfigRequest</h1><p><strong>Only users</strong> can use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
help.getPassportConfig#c661ad08 hash:<a href="../../index.html#int">int</a> = <a href="../../types/help/passport_config.html">help.PassportConfig</a></pre><button onclick="cp('from telethon.tl.functions.help import GetPassportConfigRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/help/passport_config.html">help.PassportConfig</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/help/passport_config.html">PassportConfig</a></td><td><a href="../../constructors/help/passport_config_not_modified.html">PassportConfigNotModified</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>hash</b></td><td style="text-align:center"><a href="../../index.html#int">int</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</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.help.GetPassportConfigRequest(
hash=0
))
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>
+25
View File
@@ -0,0 +1,25 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GetPeerColorsRequest</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">Help</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_peer_colors.html">GetPeerColorsRequest</a></li></ul><h1>GetPeerColorsRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
help.getPeerColors#da80f42f hash:<a href="../../index.html#int">int</a> = <a href="../../types/help/peer_colors.html">help.PeerColors</a></pre><button onclick="cp('from telethon.tl.functions.help import GetPeerColorsRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/help/peer_colors.html">help.PeerColors</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/help/peer_colors.html">PeerColors</a></td><td><a href="../../constructors/help/peer_colors_not_modified.html">PeerColorsNotModified</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>hash</b></td><td style="text-align:center"><a href="../../index.html#int">int</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</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.help.GetPeerColorsRequest(
hash=0
))
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>
+25
View File
@@ -0,0 +1,25 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GetPeerProfileColorsRequest</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">Help</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_peer_profile_colors.html">GetPeerProfileColorsRequest</a></li></ul><h1>GetPeerProfileColorsRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
help.getPeerProfileColors#abcfa9fd hash:<a href="../../index.html#int">int</a> = <a href="../../types/help/peer_colors.html">help.PeerColors</a></pre><button onclick="cp('from telethon.tl.functions.help import GetPeerProfileColorsRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/help/peer_colors.html">help.PeerColors</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/help/peer_colors.html">PeerColors</a></td><td><a href="../../constructors/help/peer_colors_not_modified.html">PeerColorsNotModified</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>hash</b></td><td style="text-align:center"><a href="../../index.html#int">int</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</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.help.GetPeerProfileColorsRequest(
hash=0
))
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>
+23
View File
@@ -0,0 +1,23 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GetPremiumPromoRequest</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">Help</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_premium_promo.html">GetPremiumPromoRequest</a></li></ul><h1>GetPremiumPromoRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
help.getPremiumPromo#b81b93d4 = <a href="../../types/help/premium_promo.html">help.PremiumPromo</a></pre><button onclick="cp('from telethon.tl.functions.help import GetPremiumPromoRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/help/premium_promo.html">help.PremiumPromo</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/help/premium_promo.html">PremiumPromo</a></td></tr></table><h3>Parameters</h3><p>This request takes no input parameters.</p><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</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.help.GetPremiumPromoRequest())
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>
+23
View File
@@ -0,0 +1,23 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GetPromoDataRequest</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">Help</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_promo_data.html">GetPromoDataRequest</a></li></ul><h1>GetPromoDataRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
help.getPromoData#c0977421 = <a href="../../types/help/promo_data.html">help.PromoData</a></pre><button onclick="cp('from telethon.tl.functions.help import GetPromoDataRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/help/promo_data.html">help.PromoData</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/help/promo_data.html">PromoData</a></td><td><a href="../../constructors/help/promo_data_empty.html">PromoDataEmpty</a></td></tr></table><h3>Parameters</h3><p>This request takes no input parameters.</p><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</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.help.GetPromoDataRequest())
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>
+25
View File
@@ -0,0 +1,25 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GetRecentMeUrlsRequest</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">Help</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_recent_me_urls.html">GetRecentMeUrlsRequest</a></li></ul><h1>GetRecentMeUrlsRequest</h1><p><strong>Only users</strong> can use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
help.getRecentMeUrls#3dc0f114 referer:<a href="../../index.html#string">string</a> = <a href="../../types/help/recent_me_urls.html">help.RecentMeUrls</a></pre><button onclick="cp('from telethon.tl.functions.help import GetRecentMeUrlsRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/help/recent_me_urls.html">help.RecentMeUrls</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/help/recent_me_urls.html">RecentMeUrls</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>referer</b></td><td style="text-align:center"><a href="../../index.html#string">string</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</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.help.GetRecentMeUrlsRequest(
referer=<em>'some string here'</em>
))
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>
+23
View File
@@ -0,0 +1,23 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GetSupportRequest</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">Help</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_support.html">GetSupportRequest</a></li></ul><h1>GetSupportRequest</h1><p><strong>Only users</strong> can use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
help.getSupport#9cdf08cd = <a href="../../types/help/support.html">help.Support</a></pre><button onclick="cp('from telethon.tl.functions.help import GetSupportRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/help/support.html">help.Support</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/help/support.html">Support</a></td></tr></table><h3>Parameters</h3><p>This request takes no input parameters.</p><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</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.help.GetSupportRequest())
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>
+23
View File
@@ -0,0 +1,23 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GetSupportNameRequest</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">Help</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_support_name.html">GetSupportNameRequest</a></li></ul><h1>GetSupportNameRequest</h1><p><strong>Only users</strong> can use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
help.getSupportName#d360e72c = <a href="../../types/help/support_name.html">help.SupportName</a></pre><button onclick="cp('from telethon.tl.functions.help import GetSupportNameRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/help/support_name.html">help.SupportName</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/help/support_name.html">SupportName</a></td></tr></table><h3>Parameters</h3><p>This request takes no input parameters.</p><h1>Known RPC errors</h1><p>This request can cause 1 known error:</p><table><tr><td><code>UserInvalidError</code></td><td>The given user was 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.help.GetSupportNameRequest())
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>
@@ -0,0 +1,23 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GetTermsOfServiceUpdateRequest</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">Help</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_terms_of_service_update.html">GetTermsOfServiceUpdateRequest</a></li></ul><h1>GetTermsOfServiceUpdateRequest</h1><p><strong>Only users</strong> can use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
help.getTermsOfServiceUpdate#2ca51fd1 = <a href="../../types/help/terms_of_service_update.html">help.TermsOfServiceUpdate</a></pre><button onclick="cp('from telethon.tl.functions.help import GetTermsOfServiceUpdateRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/help/terms_of_service_update.html">help.TermsOfServiceUpdate</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/help/terms_of_service_update.html">TermsOfServiceUpdate</a></td><td><a href="../../constructors/help/terms_of_service_update_empty.html">TermsOfServiceUpdateEmpty</a></td></tr></table><h3>Parameters</h3><p>This request takes no input parameters.</p><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</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.help.GetTermsOfServiceUpdateRequest())
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>
+25
View File
@@ -0,0 +1,25 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GetTimezonesListRequest</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">Help</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_timezones_list.html">GetTimezonesListRequest</a></li></ul><h1>GetTimezonesListRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
help.getTimezonesList#49b30240 hash:<a href="../../index.html#int">int</a> = <a href="../../types/help/timezones_list.html">help.TimezonesList</a></pre><button onclick="cp('from telethon.tl.functions.help import GetTimezonesListRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/help/timezones_list.html">help.TimezonesList</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/help/timezones_list.html">TimezonesList</a></td><td><a href="../../constructors/help/timezones_list_not_modified.html">TimezonesListNotModified</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>hash</b></td><td style="text-align:center"><a href="../../index.html#int">int</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</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.help.GetTimezonesListRequest(
hash=0
))
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>
+25
View File
@@ -0,0 +1,25 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GetUserInfoRequest</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">Help</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="get_user_info.html">GetUserInfoRequest</a></li></ul><h1>GetUserInfoRequest</h1><p><strong>Only users</strong> can use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
help.getUserInfo#038a08d3 user_id:<a href="../../types/input_user.html">InputUser</a> = <a href="../../types/help/user_info.html">help.UserInfo</a></pre><button onclick="cp('from telethon.tl.functions.help import GetUserInfoRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/help/user_info.html">help.UserInfo</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/help/user_info.html">UserInfo</a></td><td><a href="../../constructors/help/user_info_empty.html">UserInfoEmpty</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>user_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.).</td></tr></table><h1>Known RPC errors</h1><p>This request can cause 1 known error:</p><table><tr><td><code>UserInvalidError</code></td><td>The given user was 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.help.GetUserInfoRequest(
user_id=<em>'username'</em>
))
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>
+25
View File
@@ -0,0 +1,25 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>HidePromoDataRequest</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">Help</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="hide_promo_data.html">HidePromoDataRequest</a></li></ul><h1>HidePromoDataRequest</h1><p>Both users and bots <strong>may</strong> be able to use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
help.hidePromoData#1e251c95 peer:<a href="../../types/input_peer.html">InputPeer</a> = <a href="../../index.html#bool">Bool</a></pre><button onclick="cp('from telethon.tl.functions.help import HidePromoDataRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../index.html#bool">Bool</a></td></tr></table><p>This type has no instances available.</p><table></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></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</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.help.HidePromoDataRequest(
peer=<em>'username'</em>
))
print(result)</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>
+17
View File
@@ -0,0 +1,17 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Methods/Help</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">Help</a></li></ul><h1>Methods/Help</h1><p>Click <a href="botindex.html">here</a> to view the requests that you can use as a bot.</p><h1>Available items</h1><table><tr><td><a href="accept_terms_of_service.html">AcceptTermsOfServiceRequest</a></td><td><a href="dismiss_suggestion.html">DismissSuggestionRequest</a></td></tr><tr><td><a href="edit_user_info.html">EditUserInfoRequest</a></td><td><a href="get_app_config.html">GetAppConfigRequest</a></td></tr><tr><td><a href="get_app_update.html">GetAppUpdateRequest</a></td><td><a href="get_cdn_config.html">GetCdnConfigRequest</a></td></tr><tr><td><a href="get_config.html">GetConfigRequest</a></td><td><a href="get_countries_list.html">GetCountriesListRequest</a></td></tr><tr><td><a href="get_deep_link_info.html">GetDeepLinkInfoRequest</a></td><td><a href="get_invite_text.html">GetInviteTextRequest</a></td></tr><tr><td><a href="get_nearest_dc.html">GetNearestDcRequest</a></td><td><a href="get_passport_config.html">GetPassportConfigRequest</a></td></tr><tr><td><a href="get_peer_colors.html">GetPeerColorsRequest</a></td><td><a href="get_peer_profile_colors.html">GetPeerProfileColorsRequest</a></td></tr><tr><td><a href="get_premium_promo.html">GetPremiumPromoRequest</a></td><td><a href="get_promo_data.html">GetPromoDataRequest</a></td></tr><tr><td><a href="get_recent_me_urls.html">GetRecentMeUrlsRequest</a></td><td><a href="get_support_name.html">GetSupportNameRequest</a></td></tr><tr><td><a href="get_support.html">GetSupportRequest</a></td><td><a href="get_terms_of_service_update.html">GetTermsOfServiceUpdateRequest</a></td></tr><tr><td><a href="get_timezones_list.html">GetTimezonesListRequest</a></td><td><a href="get_user_info.html">GetUserInfoRequest</a></td></tr><tr><td><a href="hide_promo_data.html">HidePromoDataRequest</a></td><td><a href="save_app_log.html">SaveAppLogRequest</a></td></tr><tr><td><a href="set_bot_updates_status.html">SetBotUpdatesStatusRequest</a></td></tr></table></div></body></html>
+30
View File
@@ -0,0 +1,30 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SaveAppLogRequest</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">Help</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="save_app_log.html">SaveAppLogRequest</a></li></ul><h1>SaveAppLogRequest</h1><p><strong>Only users</strong> can use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
help.saveAppLog#6f02f748 events:<a href="../../index.html#vector">Vector</a>&lt;<a href="../../types/input_app_event.html">InputAppEvent</a>&gt; = <a href="../../index.html#bool">Bool</a></pre><button onclick="cp('from telethon.tl.functions.help import SaveAppLogRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../index.html#bool">Bool</a></td></tr></table><p>This type has no instances available.</p><table></table><h3>Parameters</h3><table><tr><td><b>events</b></td><td style="text-align:center"><a href="../../types/input_app_event.html">InputAppEvent</a></td><td>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't cause any RPC error as far as we know.</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.help.SaveAppLogRequest(
events=[types.InputAppEvent(
time=7.13,
type=<em>'some string here'</em>,
peer=-12398745604826,
data=types.JsonNull()
)]
))
print(result)</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>
+26
View File
@@ -0,0 +1,26 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>SetBotUpdatesStatusRequest</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">Help</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="set_bot_updates_status.html">SetBotUpdatesStatusRequest</a></li></ul><h1>SetBotUpdatesStatusRequest</h1><p><strong>Both users and bots</strong> can use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
help.setBotUpdatesStatus#ec22cfcd pending_updates_count:<a href="../../index.html#int">int</a> message:<a href="../../index.html#string">string</a> = <a href="../../index.html#bool">Bool</a></pre><button onclick="cp('from telethon.tl.functions.help import SetBotUpdatesStatusRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../index.html#bool">Bool</a></td></tr></table><p>This type has no instances available.</p><table></table><h3>Parameters</h3><table><tr><td><b>pending_updates_count</b></td><td style="text-align:center"><a href="../../index.html#int">int</a></td><td></td></tr><tr><td><b>message</b></td><td style="text-align:center"><a href="../../index.html#string">string</a></td><td></td></tr></table><h1>Known RPC errors</h1><p>This request can't cause any RPC error as far as we know.</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.help.SetBotUpdatesStatusRequest(
pending_updates_count=42,
message=<em>'Hello there!'</em>
))
print(result)</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>