Quellcode durchsuchen

:memo: Update doc of kernel API `insertBlock` Fix https://github.com/siyuan-note/siyuan/issues/8270

Liang Ding vor 2 Jahren
Ursprung
Commit
c336a4d64e
2 geänderte Dateien mit 19 neuen und 6 gelöschten Zeilen
  1. 10 3
      API.md
  2. 9 3
      API_zh_CN.md

+ 10 - 3
API.md

@@ -502,13 +502,20 @@ View API token in <kbd>Settings - About</kbd>, request header: `Authorization: T
   {
     "dataType": "markdown",
     "data": "foo**bar**{: style=\"color: var(--b3-font-color8);\"}baz",
-    "previousID": "20211229114650-vrek5x6"
+    "nextID": "",
+    "previousID": "20211229114650-vrek5x6",
+    "parentID": ""
   }
   ```
 
     * `dataType`: The data type to be inserted, the value can be `markdown` or `dom`
     * `data`: Data to be inserted
+    * `nextID`: The ID of the next block, used to anchor the insertion position
     * `previousID`: The ID of the previous block, used to anchor the insertion position
+    * `parentID`: The ID of the parent block, used to anchor the insertion position
+
+  `nextID`, `previousID`, and `parentID` must have at least one value, using
+  priority: `nextID` > `previousID` > `parentID`
 * Return value
 
   ```json
@@ -781,8 +788,8 @@ View API token in <kbd>Settings - About</kbd>, request header: `Authorization: T
   }
   ```
 
-  * `id`: Parent block ID
-  * The blocks below a heading are also counted as child blocks
+    * `id`: Parent block ID
+    * The blocks below a heading are also counted as child blocks
 * Return value
 
   ```json

+ 9 - 3
API_zh_CN.md

@@ -496,13 +496,19 @@
   {
     "dataType": "markdown",
     "data": "foo**bar**{: style=\"color: var(--b3-font-color8);\"}baz",
-    "previousID": "20211229114650-vrek5x6"
+    "nextID": "",
+    "previousID": "20211229114650-vrek5x6",
+    "parentID": ""
   }
   ```
 
     * `dataType`:待插入数据类型,值可选择 `markdown` 或者 `dom`
     * `data`:待插入的数据
+    * `nextID`:后一个块的 ID,用于锚定插入位置
     * `previousID`:前一个块的 ID,用于锚定插入位置
+    * `parentID`:父块 ID,用于锚定插入位置
+
+  `nextID`、`previousID`、`parentID` 三个参数必须至少存在一个有值,优先级为 `nextID` > `previousID` > `parentID`
 * 返回值
 
   ```json
@@ -774,8 +780,8 @@
   }
   ```
 
-  * `id`:父块 ID
-  * 标题下方块也算作子块
+    * `id`:父块 ID
+    * 标题下方块也算作子块
 * 返回值
 
   ```json