Telethon/methods/account/upload_wall_paper.html
2024-11-17 22:32:52 +01:00

38 lines
4.0 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>UploadWallPaperRequest</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">Account</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="upload_wall_paper.html">UploadWallPaperRequest</a></li></ul><h1>UploadWallPaperRequest</h1><p><strong>Only users</strong> can use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
account.uploadWallPaper#e39a8f03 flags:# for_chat:flags.0?<a href="../../index.html#true">true</a> file:<a href="../../types/input_file.html">InputFile</a> mime_type:<a href="../../index.html#string">string</a> settings:<a href="../../types/wall_paper_settings.html">WallPaperSettings</a> = <a href="../../types/wall_paper.html">WallPaper</a></pre><button onclick="cp('from telethon.tl.functions.account import UploadWallPaperRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/wall_paper.html">WallPaper</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/wall_paper.html">WallPaper</a></td><td><a href="../../constructors/wall_paper_no_file.html">WallPaperNoFile</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>file</b></td><td style="text-align:center"><a href="../../types/input_file.html">InputFile</a></td><td></td></tr><tr><td><b>mime_type</b></td><td style="text-align:center"><a href="../../index.html#string">string</a></td><td></td></tr><tr><td><b>settings</b></td><td style="text-align:center"><a href="../../types/wall_paper_settings.html">WallPaperSettings</a></td><td></td></tr><tr><td><b>for_chat</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></table><h1>Known RPC errors</h1><p>This request can cause 2 known errors:</p><table><tr><td><code>WallpaperFileInvalidError</code></td><td>The given file cannot be used as a wallpaper.</td></tr><tr><td><code>WallpaperMimeInvalidError</code></td><td>The specified wallpaper MIME type 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.account.UploadWallPaperRequest(
file=client.upload_file(<em>'/path/to/file.jpg'</em>),
mime_type=<em>'some string here'</em>,
settings=types.WallPaperSettings(
blur=<strong>True</strong>,
motion=<strong>True</strong>,
background_color=42,
second_background_color=42,
third_background_color=42,
fourth_background_color=42,
intensity=42,
rotation=42,
emoticon=<em>'some string here'</em>
),
for_chat=<strong>True</strong>
))
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>