SimTX API/Packets/KickRequest
| Frame | ClientFrame, field 60
|
|---|---|
| Member | kick
|
| Direction | Client → server |
| Session | Moderation |
| Roles | ROLE_MODERATION.
|
| Permission | moderation.manage
|
| Answered by | KickResult or Error |
| Defined in | control.proto
|
KickRequest disconnects sessions from the server. The kicked receivers and transmitters get SessionStatus ENDED with the reason.
Definition[edit | edit source]
message KickRequest { int64 request_id = 1; string target = 2; string reason = 3; bool by_callsign = 4; }
Fields[edit | edit source]
| # | Field | Type | Description |
|---|---|---|---|
| 1 | request_id |
int64 |
Nonzero; echoed in the KickResult or Error. |
| 2 | target |
string |
A session id in text form, or a callsign. |
| 3 | reason |
string |
Reason shown to the kicked sessions in their SessionStatus ENDED. May be empty.
|
| 4 | by_callsign |
bool |
True: kick every session with that callsign. False: kick the session with that id. |