rogo/TS_WIFILED
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Files
f36bfab5aa27b08fbeb33f070951a4078d4de418
TS_WIFILED/docs/client_html/ar01s23s06.html
rogo f36bfab5aa init
2020-04-04 17:21:07 +02:00

15 lines
9.7 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Kicking clients</title><link rel="stylesheet" href="ts3doc.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><link rel="home" href="index.html" title="TeamSpeak 3 Client SDK Developer Manual"><link rel="up" href="ar01s23.html" title="Interacting with the server"><link rel="prev" href="ar01s23s05s02.html" title="Receiving"><link rel="next" href="ar01s23s07.html" title="Channel subscriptions"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><img id="logo" src="images/logo.png"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Kicking clients</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ar01s23s05s02.html"><img src="images/prev.png" alt="Prev"></a> </td><th width="60%" align="center">Interacting with the server</th><td width="20%" align="right"> <a accesskey="n" href="ar01s23s07.html"><img src="images/next.png" alt="Next"></a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="kick"></a>Kicking clients</h3></div></div></div><p>Clients can be forcefully removed from a channel or the whole server. To kick a client from a channel or server call:</p><p>
</p><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">unsigned int <b class="fsfunc">ts3client_requestClientKickFromChannel</b>(</code></td><td><var class="pdparam">serverConnectionHandlerID</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">clientID</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">kickReason</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">returnCode</var><code>)</code>;</td><td> </td></tr></table><div class="paramdef-list"><code>uint64 <var class="pdparam">serverConnectionHandlerID</var></code>;<br><code>anyID <var class="pdparam">clientID</var></code>;<br><code>const char* <var class="pdparam">kickReason</var></code>;<br><code>const char* <var class="pdparam">returnCode</var></code>;</div><div class="funcprototype-spacer"> </div></div><p>
<a class="indexterm" name="idm44835433297840"></a>
</p><p>
</p><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">unsigned int <b class="fsfunc">ts3client_requestClientKickFromServer</b>(</code></td><td><var class="pdparam">serverConnectionHandlerID</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">clientID</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">kickReason</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">returnCode</var><code>)</code>;</td><td> </td></tr></table><div class="paramdef-list"><code>uint64 <var class="pdparam">serverConnectionHandlerID</var></code>;<br><code>anyID <var class="pdparam">clientID</var></code>;<br><code>const char* <var class="pdparam">kickReason</var></code>;<br><code>const char* <var class="pdparam">returnCode</var></code>;</div><div class="funcprototype-spacer"> </div></div><p>
<a class="indexterm" name="idm44835433292288"></a>
</p><div class="itemizedlist"><ul type="disc"><li><p><em class="parameter"><code>serverConnectionHandlerID</code></em></p><p>Id of the target server connection.</p></li><li><p><em class="parameter"><code>clientID</code></em></p><p>The ID of the client to be kicked.</p></li><li><p><em class="parameter"><code>kickReason</code></em></p><p>A short message explaining why the client is kicked from the channel or server.</p></li><li><p><em class="parameter"><code>returnCode</code></em></p><p>See <a class="link" href="ar01s04.html#callingReturnCode" title="Return code">return code documentation</a>. Pass NULL if you do not need this feature.</p></li></ul></div><p>Returns <em class="structfield"><code>ERROR_ok</code></em> on success, otherwise an error code as defined in <code class="filename">public_errors.h</code>.</p><div class="literallayout"><p><br>
</p></div><p>After successfully requesting a kick, one of the following events will be called:</p><p>
</p><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">void <b class="fsfunc">onClientKickFromChannelEvent</b>(</code></td><td><var class="pdparam">serverConnectionHandlerID</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">clientID</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">oldChannelID</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">newChannelID</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">visibility</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">kickerID</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">kickerName</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">kickerUniqueIdentifier</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">kickMessage</var><code>)</code>;</td><td> </td></tr></table><div class="paramdef-list"><code>uint64 <var class="pdparam">serverConnectionHandlerID</var></code>;<br><code>anyID <var class="pdparam">clientID</var></code>;<br><code>uint64 <var class="pdparam">oldChannelID</var></code>;<br><code>uint64 <var class="pdparam">newChannelID</var></code>;<br><code>int <var class="pdparam">visibility</var></code>;<br><code>anyID <var class="pdparam">kickerID</var></code>;<br><code>const char* <var class="pdparam">kickerName</var></code>;<br><code>const char* <var class="pdparam">kickerUniqueIdentifier</var></code>;<br><code>const char* <var class="pdparam">kickMessage</var></code>;</div><div class="funcprototype-spacer"> </div></div><p>
<a class="indexterm" name="idm44835433273040"></a>
</p><p>
</p><div class="funcsynopsis"><table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0" class="funcprototype-table"><tr><td><code class="funcdef">void <b class="fsfunc">onClientKickFromServerEvent</b>(</code></td><td><var class="pdparam">serverConnectionHandlerID</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">clientID</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">oldChannelID</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">newChannelID</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">visibility</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">kickerID</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">kickerName</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">kickerUniqueIdentifier</var>, </td><td> </td></tr><tr><td> </td><td><var class="pdparam">kickMessage</var><code>)</code>;</td><td> </td></tr></table><div class="paramdef-list"><code>uint64 <var class="pdparam">serverConnectionHandlerID</var></code>;<br><code>anyID <var class="pdparam">clientID</var></code>;<br><code>uint64 <var class="pdparam">oldChannelID</var></code>;<br><code>uint64 <var class="pdparam">newChannelID</var></code>;<br><code>int <var class="pdparam">visibility</var></code>;<br><code>anyID <var class="pdparam">kickerID</var></code>;<br><code>const char* <var class="pdparam">kickerName</var></code>;<br><code>const char* <var class="pdparam">kickerUniqueIdentifier</var></code>;<br><code>const char* <var class="pdparam">kickMessage</var></code>;</div><div class="funcprototype-spacer"> </div></div><p>
<a class="indexterm" name="idm44835433263968"></a>
</p><div class="itemizedlist"><ul type="disc"><li><p><em class="parameter"><code>serverConnectionHandlerID</code></em></p><p>ID of the server connection handler on which the client was kicked</p></li><li><p><em class="parameter"><code>clientID</code></em></p><p>ID of the kicked client.</p></li><li><p><em class="parameter"><code>oldChannelID</code></em></p><p>ID of the channel from which the client has been kicked.</p></li><li><p><em class="parameter"><code>newChannelID</code></em></p><p>ID of the channel where the kicked client was moved to.</p></li><li><p><em class="parameter"><code>visibility</code></em></p><p>Describes if the moved client enters, retains or leaves visibility. See explanation of the enum <a class="link" href="ar01s23.html#visibility"><span class="structname">Visibility</span></a><a class="indexterm" name="idm44835433253984"></a> for the function <code class="function">onClientMoveEvent</code>.</p><p>When kicked from a server, visibility can be only <em class="structfield"><code>LEAVE_VISIBILITY</code></em>.</p></li><li><p><em class="parameter"><code>kickerID</code></em></p><p>ID of the client who requested the kick.</p></li><li><p><em class="parameter"><code>kickerName</code></em></p><p>Name of the client who requested the kick.</p></li><li><p><em class="parameter"><code>kickerUniqueIdentifier</code></em></p><p>Unique ID of the client who requested the kick.</p></li><li><p><em class="parameter"><code>kickerMessage</code></em></p><p>Message giving the reason why the client has been kicked.</p></li></ul></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ar01s23s05s02.html"><img src="images/prev.png" alt="Prev"></a> </td><td width="20%" align="center"><a accesskey="u" href="ar01s23.html"><img src="images/up.png" alt="Up"></a></td><td width="40%" align="right"> <a accesskey="n" href="ar01s23s07.html"><img src="images/next.png" alt="Next"></a></td></tr><tr><td width="40%" align="left" valign="top">Receiving </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a></td><td width="40%" align="right" valign="top"> Channel subscriptions</td></tr></table></div></body></html>
Reference in New Issue View Git Blame Copy Permalink