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

47 lines
6.4 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>RequestWebViewRequest</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="request_web_view.html">RequestWebViewRequest</a></li></ul><h1>RequestWebViewRequest</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---
messages.requestWebView#269dc2c1 flags:# from_bot_menu:flags.4?<a href="../../index.html#true">true</a> silent:flags.5?<a href="../../index.html#true">true</a> compact:flags.7?<a href="../../index.html#true">true</a> fullscreen:flags.8?<a href="../../index.html#true">true</a> peer:<a href="../../types/input_peer.html">InputPeer</a> bot:<a href="../../types/input_user.html">InputUser</a> url:flags.1?<a href="../../index.html#string">string</a> start_param:flags.3?<a href="../../index.html#string">string</a> theme_params:flags.2?<a href="../../types/data_json.html">DataJSON</a> platform:<a href="../../index.html#string">string</a> reply_to:flags.0?<a href="../../types/input_reply_to.html">InputReplyTo</a> send_as:flags.13?<a href="../../types/input_peer.html">InputPeer</a> = <a href="../../types/web_view_result.html">WebViewResult</a></pre><button onclick="cp('from telethon.tl.functions.messages import RequestWebViewRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/web_view_result.html">WebViewResult</a></td></tr></table><p>This type can only be an instance of:</p><table><tr><td><a href="../../constructors/web_view_result_url.html">WebViewResultUrl</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>bot</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>platform</b></td><td style="text-align:center"><a href="../../index.html#string">string</a></td><td></td></tr><tr><td><b>from_bot_menu</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>silent</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>compact</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>fullscreen</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>url</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>start_param</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>theme_params</b></td><td style="text-align:center"><a href="../../types/data_json.html">DataJSON</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>reply_to</b></td><td style="text-align:center"><a href="../../types/input_reply_to.html">InputReplyTo</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>send_as</b></td><td style="text-align:center"><a href="../../types/input_peer.html">InputPeer</a></td><td>This argument defaults to <code>None</code> and can be omitted. 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.messages.RequestWebViewRequest(
peer=<em>'username'</em>,
bot=<em>'username'</em>,
platform=<em>'some string here'</em>,
from_bot_menu=<strong>True</strong>,
compact=<strong>True</strong>,
fullscreen=<strong>True</strong>,
url=<em>'some string here'</em>,
start_param=<em>'some string here'</em>,
theme_params=types.DataJSON(
data=<em>'some string here'</em>
),
reply_to=types.InputReplyToMessage(
reply_to_msg_id=42,
top_msg_id=42,
reply_to_peer_id=<em>'username'</em>,
quote_text=<em>'some string here'</em>,
quote_entities=[types.MessageEntityUnknown(
offset=42,
length=42
)],
quote_offset=42
),
send_as=<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>