Editing SimTX API/Packets/KickRequest

{{SimTX API navigation}}
{{SimTX packet
| name = KickRequest
| frame = ClientFrame
| field = 60
| member = kick
| direction = c2s
| session = [[SimTX API/Moderation session|Moderation]]
| roles = <code>ROLE_MODERATION</code>.
| permission = <code>moderation.manage</code>
| reply = [[SimTX API/Packets/KickResult|KickResult]] or [[SimTX API/Packets/Error|Error]]
| group = moderation
| file = control.proto
}}
'''KickRequest''' disconnects sessions from the server. The kicked receivers and transmitters get [[SimTX API/Packets/SessionStatus|SessionStatus]] <code>ENDED</code> with the reason.

== Definition ==
<syntaxhighlight lang="protobuf">
message KickRequest { int64 request_id = 1; string target = 2; string reason = 3; bool by_callsign = 4; }
</syntaxhighlight>

== Fields ==
{| class="wikitable"
! # !! Field !! Type !! Description
|-
| 1 || <code>request_id</code> || <code>int64</code> || Nonzero; echoed in the [[SimTX API/Packets/KickResult|KickResult]] or [[SimTX API/Packets/Error|Error]].
|-
| 2 || <code>target</code> || <code>string</code> || A session id in text form, or a callsign.
|-
| 3 || <code>reason</code> || <code>string</code> || Reason shown to the kicked sessions in their [[SimTX API/Packets/SessionStatus|SessionStatus]] <code>ENDED</code>. May be empty.
|-
| 4 || <code>by_callsign</code> || <code>bool</code> || True: kick every session with that callsign. False: kick the session with that id.
|}

== See also ==
* [[SimTX API/Moderation session]]

{{SimTX API navbox}}
[[Category:SimTX API]]