Nutzdatenreferenz
Diese Felder gehören zu den Benachrichtigungsdaten: in der JSON-Zeichenfolge des WebSocket-Umschlags oder direkt im UDP-Datagramm.
| Feld | Typ | Standard bei Auslassung | Verhalten |
|---|---|---|---|
title |
string | leer | Benachrichtigungstitel |
content |
string | leer | Benachrichtigungstext |
sourceApp |
string | leer | Absenderbezeichnung |
timeout |
number | 5 | Sekunden; auf 0.5 bis 60 begrenzt |
opacity |
number | 1 | Auf 0 bis 1 begrenzt |
volume |
number | 1 | Gelesen und auf 0 bis 1 begrenzt; Wiedergabe nutzt derzeit die globale Lautstärke |
audioPath |
string | leer | Aus Kompatibilitätsgründen gelesen; eigene Ressourcen werden nicht geladen |
icon |
string | leer | Aus Kompatibilitätsgründen gelesen; eigene Ressourcen werden nicht geladen |
useBase64Icon |
boolean | false | Aus Kompatibilitätsgründen gelesen; eigene Ressourcen werden nicht geladen |
height |
integer | 0 | Für Kompatibilität übernommen; Kartenlayout folgt dem Inhalt |
index |
integer | 0 | Für Kompatibilität übernommen; erzeugt keine getrennten Benachrichtigungsstapel |
type |
integer | 0 | Benachrichtigungsart |
messageType |
integer | 0 | Alte Schreibweise von type; ein Wert ungleich null hat Vorrang |
Mindestens eines von title und content muss Text enthalten, der nicht nur aus Leerraum besteht. Ungültiges JSON und leere Benachrichtigungen werden verworfen.
Fehlende Werte und ausdrückliche Null
Abschnitt betitelt „Fehlende Werte und ausdrückliche Null“Standards gelten bei fehlenden Feldern. Ausdrückliche Null bleibt erhalten und wird anschließend begrenzt: timeout: 0 wird beispielsweise zu 0.5 Sekunden, opacity: 0 bleibt null.
Darstellung
Abschnitt betitelt „Darstellung“Die Karte hat einen kompakten Textbereich und kürzt lange Nachrichten. Verlasse dich weder auf eine angeforderte Pixelhöhe noch auf mehrere gleichzeitig sichtbare Karten.
Vom Parser akzeptierte Felder bedeuten nicht zwingend volle XSOverlay-Funktionsunterstützung. Lies die Kompatibilitätsseite, bevor du eigene Symbole oder Audiodateien voraussetzt.