> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# System Messages 集合

`systemmessages` 儲存管理員向所有已登入使用者發布的全站橫幅。一份文件是一則訊息。由 `web` 負責；結構描述為 `services/web/app/src/models/SystemMessage.mjs`，程式碼為 `services/web/app/src/Features/SystemMessages/SystemMessageManager.mjs`。

#### 欄位

| 欄位 | 型別 | 意義 | 來源 |
| - | - | - | - |
| `_id` | ObjectId | 訊息 id。瀏覽器透過此 id 記住使用者關閉了哪些訊息（`services/web/frontend/js/shared/components/system-message.tsx:10`）。 | `SystemMessage.mjs:5` |
| `content` | String | 訊息文字，預設 `''`。 | `SystemMessage.mjs:7` |
| `__v` | Number | Mongoose 版本鍵，由 `message.save()` 加入。 | `SystemMessageManager.mjs:29-30` |

#### 誰寫入

| 程式碼 | 作用 |
| - | - |
| `SystemMessageManager.mjs:28-33` (`createMessage`) | `POST /admin/messages` (`services/web/app/src/router.mjs:1150-1152`, `services/web/app/src/Features/ServerAdmin/AdminController.mjs:151-159`): 新增一則訊息。 |
| `SystemMessageManager.mjs:22-26` (`clearMessages`) | `POST /admin/messages/clear` (`router.mjs:1155-1157`, `AdminController.mjs:161-168`): 刪除所有訊息。無法只刪除其中一則。 |

#### 誰讀取

| 程式碼 | 作用 |
| - | - |
| `SystemMessageManager.mjs:50-65` | 每個 `web` 程序都在記憶體中保存所有訊息，每 20 到 30 秒重新載入一次，並在自己建立或清除後立即重新載入。 |
| `services/web/app/src/Features/SystemMessages/SystemMessageController.mjs:6-24` | `GET /system/messages` (`router.mjs:331`): 向已登入使用者傳回快取的訊息。網站關閉期間（`siteIsOpen` 為 false），改為傳回一則固定通知，該通知不儲存在 Mongo 中。 |
| `AdminController.mjs:83-84` | `/admin` 頁面直接從 Mongo 列出訊息。 |

#### 索引

沒有遷移在 `systemmessages` 上建立索引；只有預設的 `_id` 索引。

#### 說明

* 設定 `notifyOnSystemMessageChanges` 後，建立或清除也會發布到 Redis 頻道 `refresh-system-messages`，讓其他 `web` 程序立即重新載入（`SystemMessageManager.mjs:9`、`:35-48`、`:75-87`）。未設定時，它們會在下一次定時重新載入時取得變更。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.