思源笔记 API 文档

/api/sync/setSyncPerception

方法: POST

认证: `model.CheckAuth`, `model.CheckAdminRole`, `model.CheckReadonly` (需要登录,管理员权限,非只读模式)

功能: 设置是否启用同步感知。

同步感知指的是在编辑器中实时感知其他客户端的修改,并在当前编辑器中进行相应的更新提示或自动合并。开启后可以减少多端编辑时的冲突概率,但可能会略微增加网络和性能开销。

请求参数 (JSON Body)

参数名 类型 是否必需 描述
enabled boolean true 启用同步感知, false 禁用同步感知。

请求示例


{
    "enabled": true
}
        

响应结果

成功时,返回的 JSON 对象中 code 为 0,msg 为空字符串,datanull


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

失败时,code 非 0,msg 包含错误信息。

在线测试



请求体:


            

响应: