Editing SimTX API/Packets/BroadcastBanner

{{SimTX API navigation}}
{{SimTX packet
| name = BroadcastBanner
| frame = ClientFrame
| field = 62
| member = broadcast_banner
| direction = c2s
| session = [[SimTX API/Moderation session|Moderation]]
| roles = <code>ROLE_MODERATION</code>.
| permission = <code>moderation.manage</code>
| group = moderation
| file = control.proto
}}
'''BroadcastBanner''' sets, replaces or clears the server-wide notice. The server pushes the result to every control session as a [[SimTX API/Packets/Banner|Banner]]. There is no reply on success; a refusal is answered with [[SimTX API/Packets/Error|Error]].

== Definition ==
<syntaxhighlight lang="protobuf">
message BroadcastBanner { int64 request_id = 1; string text = 2; int64 duration_seconds = 3; }
</syntaxhighlight>

== Fields ==
{| class="wikitable"
! # !! Field !! Type !! Description
|-
| 1 || <code>request_id</code> || <code>int64</code> || Nonzero. Echoed only by an [[SimTX API/Packets/Error|Error]]; success has no reply.
|-
| 2 || <code>text</code> || <code>string</code> || Notice text, truncated to 512 characters. Empty clears the current notice.
|-
| 3 || <code>duration_seconds</code> || <code>int64</code> || How long the notice stays. 0 or less = no expiry.
|}

== See also ==
* [[SimTX API/Packets/Banner|Banner]]
* [[SimTX API/Moderation session]]

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