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

35 lines
5.4 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EditGroupCallParticipantRequest</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">Phone</a></li><img src="../../img/arrow.svg" alt="/" /><li><a href="edit_group_call_participant.html">EditGroupCallParticipantRequest</a></li></ul><h1>EditGroupCallParticipantRequest</h1><p><strong>Only users</strong> can use this request. <a href="#examples">See code examples.</a></p><pre>---functions---
phone.editGroupCallParticipant#a5273abf flags:# call:<a href="../../types/input_group_call.html">InputGroupCall</a> participant:<a href="../../types/input_peer.html">InputPeer</a> muted:flags.0?<a href="../../index.html#bool">Bool</a> volume:flags.1?<a href="../../index.html#int">int</a> raise_hand:flags.2?<a href="../../index.html#bool">Bool</a> video_stopped:flags.3?<a href="../../index.html#bool">Bool</a> video_paused:flags.4?<a href="../../index.html#bool">Bool</a> presentation_paused:flags.5?<a href="../../index.html#bool">Bool</a> = <a href="../../types/updates.html">Updates</a></pre><button onclick="cp('from telethon.tl.functions.phone import EditGroupCallParticipantRequest');">Copy import to the clipboard</button><h3>Returns</h3><table><tr><td><a href="../../types/updates.html">Updates</a></td></tr></table><p>This type can be an instance of either:</p><table><tr><td><a href="../../constructors/update_short.html">UpdateShort</a></td><td><a href="../../constructors/update_short_chat_message.html">UpdateShortChatMessage</a></td></tr><tr><td><a href="../../constructors/update_short_message.html">UpdateShortMessage</a></td><td><a href="../../constructors/update_short_sent_message.html">UpdateShortSentMessage</a></td></tr><tr><td><a href="../../constructors/updates.html">Updates</a></td><td><a href="../../constructors/updates_combined.html">UpdatesCombined</a></td></tr><tr><td><a href="../../constructors/updates_too_long.html">UpdatesTooLong</a></td></tr></table><h3>Parameters</h3><table><tr><td><b>call</b></td><td style="text-align:center"><a href="../../types/input_group_call.html">InputGroupCall</a></td><td></td></tr><tr><td><b>participant</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>muted</b></td><td style="text-align:center"><a href="../../index.html#bool">Bool</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>volume</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>raise_hand</b></td><td style="text-align:center"><a href="../../index.html#bool">Bool</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>video_stopped</b></td><td style="text-align:center"><a href="../../index.html#bool">Bool</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>video_paused</b></td><td style="text-align:center"><a href="../../index.html#bool">Bool</a></td><td>This argument defaults to <code>None</code> and can be omitted.</td></tr><tr><td><b>presentation_paused</b></td><td style="text-align:center"><a href="../../index.html#bool">Bool</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 1 known error:</p><table><tr><td><code>UserVolumeInvalidError</code></td><td>The specified user volume 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.phone.EditGroupCallParticipantRequest(
call=types.InputGroupCall(
id=-12398745604826,
access_hash=-12398745604826
),
participant=<em>'username'</em>,
muted=<strong>False</strong>,
volume=42,
raise_hand=<strong>False</strong>,
video_stopped=<strong>False</strong>,
video_paused=<strong>False</strong>,
presentation_paused=<strong>False</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>