重载 Protyle 编辑器 (reloadProtyle)

接口描述

此 API 端点 POST /api/ui/reloadProtyle 用于通知前端重载指定文档 ID 或块 ID 对应的 Protyle 编辑器实例。

当一个文档的内容或其块结构通过非 Protyle 编辑器的方式发生变化（例如通过其他 API 操作），并且需要前端的 Protyle 编辑器（如果当前打开了该文档）更新其显示内容时，可以调用此接口。内核会通过 WebSocket 将 "reloadprotyle" 事件及相应的 ID 推送给前端。

请求参数

请求体为一个 JSON 对象，包含以下字段：

• id (string, 必需): 需要重载其 Protyle 编辑器视图的文档 ID 或块 ID。

请求示例:

{
    "id": "20230511230300-hijklmn"
}

响应体

成功响应 (HTTP 200 OK):

成功处理请求后，API 返回：

{
    "code": 0,
    "msg": "",
    "data": null
}

失败响应 (HTTP 200 OK, 但 code 非 0):

• 如果请求体不是有效的 JSON，或者缺少必需的 id 字段，将返回类似：

  {
      "code": -1, 
      "msg": "Request body is not valid JSON", // 或 "id is missing"
      "data": null
  }

注意: 认证失败 (如未提供 API Token、非管理员等) 会由中间件处理，并返回相应的 HTTP 错误状态码 (如 401, 403)。

认证与授权

调用此 API 端点需要有效的用户认证 (通过 Authorization HTTP头部传递 API Token)。

此外，执行此操作需要：

• 管理员角色 (model.CheckAdminRole): 通常情况下，此类 UI 控制接口可能需要管理员权限。
• 非只读模式 (model.CheckReadonly): 不能在只读模式下执行此操作。

备注

• 此接口主要用于触发前端 UI 更新，本身不直接修改数据。
• 内核通过调用 model.ReloadProtyle(id) 实现，后者会发送一个类型为 `reloadprotyle` 包含文档/块 ID 的 WebSocket 消息给客户端。