SimTX API/Packets/BroadcastBanner: Difference between revisions

Latest revision as of 16:42, 24 October 2026

API overviewQuick startHandshakeFramingAll messagesData typesStationsAccount serviceLimits and errorsv24 reference

BroadcastBanner
Frame	`ClientFrame`, field 62
Member	`broadcast_banner`
Direction	Client → server
Session	Moderation
Roles	`ROLE_MODERATION`.
Permission	`moderation.manage`
Answered by
Answers
Defined in	`control.proto`

BroadcastBanner sets, replaces or clears the server-wide notice. The server pushes the result to every control session as a Banner. There is no reply on success; a refusal is answered with Error.

Definition[edit | edit source]

message BroadcastBanner { int64 request_id = 1; string text = 2; int64 duration_seconds = 3; }

Fields[edit | edit source]

#	Field	Type	Description
1	`request_id`	`int64`	Nonzero. Echoed only by an Error; success has no reply.
2	`text`	`string`	Notice text, truncated to 512 characters. Empty clears the current notice.
3	`duration_seconds`	`int64`	How long the notice stays. 0 or less = no expiry.

See also[edit | edit source]

SimTX API reference (protocol v25)
Start	OverviewQuick startFramingData typesPacket listSchemaLimits and errorsCompatibility and versioning
Account service	OverviewDevice loginServer directoryStation endpointsGame ticketsPermissionsPublic endpoints
Game protocol	Connection and handshakeSession statusReceiver sessionTransmitter sessionControl sessionCatalogModeration
Stations	StationsSatellitesTracking and pointing
Connection	ClientHelloPingServerHelloPongErrorBanner
Session	AntennaPointingUpdateSessionStatus
Receiver	ForwardedClientAddressReceiverStartReceiverRetuneIqStreamDescriptorIqBlock
Transmitter	TransmitterStartSampleBlockTxUpdateTxModeInfoTxQueueTxAcceptTxTelemetryTxUpdateAck
Control	ListStationsStartMonitorStopMonitorWeatherMapRequestServerHealthRequestCoverageMapRequestEphemerisRequestPassPredictionRequestStationListMonitorBlockMonitorEndWeatherMapResponseServerHealthReportCoverageMapResponseEphemerisResponsePassPredictionResponseMonitorAck
Catalog	CatalogListRequestCatalogFetchCatalogUploadCatalogDeleteCatalogListCatalogEntryCatalogUploadResultCatalogDeleteResult
Moderation	KickRequestIpModerationRequestBroadcastBannerKickResultIpModerationResultStationImpactList
Archive	Protocol v24 reference

@@ Line 1: / Line 1: @@
-#REDIRECT [[SimTX API v24/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]]