mirror of
https://github.com/siyuan-note/siyuan.git
synced 2025-12-17 07:00:12 +01:00
📝 新增内核 API localStorage Fix https://github.com/siyuan-note/siyuan/issues/6960
This commit is contained in:
parent
22a233d9b8
commit
819ce3dcb2
2 changed files with 85 additions and 2 deletions
42
API.md
42
API.md
|
|
@ -47,7 +47,6 @@
|
||||||
* [Get boot progress](#Get-boot-progress)
|
* [Get boot progress](#Get-boot-progress)
|
||||||
* [Get system version](#Get-system-version)
|
* [Get system version](#Get-system-version)
|
||||||
* [Get the current time of the system](#Get-the-current-time-of-the-system)
|
* [Get the current time of the system](#Get-the-current-time-of-the-system)
|
||||||
* [Webhook](#Webhook)
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -951,6 +950,47 @@ View API token in <kbd>Settings - About</kbd>, request header: `Authorization: T
|
||||||
```
|
```
|
||||||
* `id`:Message ID
|
* `id`:Message ID
|
||||||
|
|
||||||
|
## Storage
|
||||||
|
|
||||||
|
### Set localStorage
|
||||||
|
|
||||||
|
This API is similar to the browser's `localStorage.setItem`, but the setting parameter is the entire JSON-formatted data instead of a single key-value pair.
|
||||||
|
|
||||||
|
When developing front-end extensions, you should avoid using the browser's `localStorage`, because using the browser's `localStorage` directly will cause data to be incorrectly overwritten or lost when switching between multiple workspaces.
|
||||||
|
|
||||||
|
* `/api/storage/setLocalStorage`
|
||||||
|
* Parameters
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"val": {}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
* Return value
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"code": 0,
|
||||||
|
"msg": "",
|
||||||
|
"data": null
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Get localStorage
|
||||||
|
|
||||||
|
* `/api/storage/getLocalStorage`
|
||||||
|
* No parameters
|
||||||
|
* Return value
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"code": 0,
|
||||||
|
"msg": "",
|
||||||
|
"data": {}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
## System
|
## System
|
||||||
|
|
||||||
### Get boot progress
|
### Get boot progress
|
||||||
|
|
|
||||||
45
API_zh_CN.md
45
API_zh_CN.md
|
|
@ -43,11 +43,13 @@
|
||||||
* [通知](#通知)
|
* [通知](#通知)
|
||||||
* [推送消息](#推送消息)
|
* [推送消息](#推送消息)
|
||||||
* [推送报错消息](#推送报错消息)
|
* [推送报错消息](#推送报错消息)
|
||||||
|
* [存储](#存储)
|
||||||
|
* [设置 localStorage](#设置-localStorage)
|
||||||
|
* [获取 localStorage](#获取-localStorage)
|
||||||
* [系统](#系统)
|
* [系统](#系统)
|
||||||
* [获取启动进度](#获取启动进度)
|
* [获取启动进度](#获取启动进度)
|
||||||
* [获取系统版本](#获取系统版本)
|
* [获取系统版本](#获取系统版本)
|
||||||
* [获取系统当前时间](#获取系统当前时间)
|
* [获取系统当前时间](#获取系统当前时间)
|
||||||
* [Webhook](#Webhook)
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -945,6 +947,47 @@
|
||||||
```
|
```
|
||||||
* `id`:消息 ID
|
* `id`:消息 ID
|
||||||
|
|
||||||
|
## 存储
|
||||||
|
|
||||||
|
### 设置 localStorage
|
||||||
|
|
||||||
|
该 API 类似浏览器的 `localStorage.setItem`,但是设置参数是整个 JSON 格式的数据,而不是单个键值对。
|
||||||
|
|
||||||
|
前端开发扩展时应该避免使用浏览器的 `localStorage`,因为直接使用浏览器的 `localStorage` 会导致多工作空间切换时数据错误覆盖或丢失。
|
||||||
|
|
||||||
|
* `/api/storage/setLocalStorage`
|
||||||
|
* 参数
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"val": {}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
* 返回值
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"code": 0,
|
||||||
|
"msg": "",
|
||||||
|
"data": null
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 获取 localStorage
|
||||||
|
|
||||||
|
* `/api/storage/getLocalStorage`
|
||||||
|
* 无参数
|
||||||
|
* 返回值
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"code": 0,
|
||||||
|
"msg": "",
|
||||||
|
"data": {}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
## 系统
|
## 系统
|
||||||
|
|
||||||
### 获取启动进度
|
### 获取启动进度
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue