通知のフィールド
次のフィールドは通知ペイロードに含めます。WebSocket ではエンベロープ内の JSON 文字列、UDP ではデータグラムに直接入れます。
| フィールド | 型 | 省略時の既定値 | 動作 |
|---|---|---|---|
title |
string | 空 | 通知の見出し |
content |
string | 空 | 通知の本文 |
sourceApp |
string | 空 | 送信元の表示名 |
timeout |
number | 5 | 秒数。0.5 から 60 に制限 |
opacity |
number | 1 | 0 から 1 に制限 |
volume |
number | 1 | 解析して 0 から 1 に制限。現在の再生は全体音量設定を使用 |
audioPath |
string | 空 | 互換性のため解析。独自アセットの読み込みは未実装 |
icon |
string | 空 | 互換性のため解析。独自アセットの読み込みは未実装 |
useBase64Icon |
boolean | false | 互換性のため解析。独自アセットの読み込みは未実装 |
height |
integer | 0 | 互換性のため保持。カードの配置は内容に従う |
index |
integer | 0 | 互換性のため保持。別の通知スタックは作成しない |
type |
integer | 0 | 通知の種類 |
messageType |
integer | 0 | type の旧名称。ゼロでない値を優先 |
title と content の少なくとも一方に、空白以外のテキストが必要です。無効な JSON と空の通知は破棄します。
省略と明示的なゼロ
Section titled “省略と明示的なゼロ”フィールドを省略したときに既定値を使います。明示的なゼロは保持した後で範囲内に制限します。たとえば timeout: 0 は 0.5 秒になり、opacity: 0 はゼロのままです。
カードの本文はコンパクトで、長いメッセージは切り詰めます。要求したピクセル高や、複数カードの同時表示を前提にしないでください。
パーサーが受け取るフィールドが、XSOverlay の全機能への対応を意味するとは限りません。独自アイコンや音声を使う前に互換性のページを確認してください。