Ref Index | 思源笔记开发文档

Skip to content

思源笔记开发文档

Main Navigation 首页指南文档首页 Kernel API 插件开发挂件开发 CSS 代码片段 JS 代码片段模板片段主题开发

Appearance

Sidebar Navigation

account

检查激活码状态 (checkActivationcode)

反激活(deactivate)

登录社区账号 (login)

开始免费试用(startFreeTrial)

使用激活码 (useActivationcode)

ai

基础 AI 对话

AI 对话（带动作）

archive

解压文件(unzip)

压缩文件(zip)

asset

全量重建资源内容索引

获取文档资源文件列表 (getDocAssets)

getDocImageAssets

getFileAnnotation

获取图片 OCR 文本

获取丢失资源

getUnusedAssets

插入本地资源

OCR 识别

删除单个未使用资源

删除所有未使用资源

重命名资源

解析资源路径

设置文件标注

设置图片 OCR 文本

获取资源统计信息

上传资源

上传到云端

attr

批量获取块属性

batchSetBlockAttrs

getBlockAttrs

获取书签标签

resetBlockAttrs

setBlockAttrs

av

添加属性视图块

添加属性视图列 (Key)

添加游离块并带值到属性视图

复制属性视图块

获取属性视图

获取属性视图的过滤和排序

获取属性视图所有列 (Keys)

通过 avID 获取属性视图列 (Keys)

获取属性视图主键列值

获取镜像数据库块

移除属性视图块

移除属性视图列 (Key)

renderAttributeView

renderHistoryAttributeView

renderSnapshotAttributeView

searchAttributeView

searchAttributeViewNonRelationKey

searchAttributeViewRelationKey

setAttributeViewBlockAttr

setDatabaseBlockView

sortAttributeViewKey

sortAttributeViewViewKey

bazaar

batchUpdatePackage

获取集市图标列表 (getBazaarIcon)

getBazaarPackageREAME

获取集市插件列表 (getBazaarPlugin)

获取集市模板列表 (getBazaarTemplate)

获取集市主题列表 (getBazaarTheme)

获取集市挂件列表 (getBazaarWidget)

getInstalledIcon

获取已安装插件列表

getInstalledTemplate

getInstalledTheme

getInstalledWidget

getUpdatedPackage

installBazaarIcon

installBazaarPlugin

installBazaarTemplate

installBazaarTheme

installBazaarWidget

uninstallBazaarIcon

uninstallBazaarPlugin

卸载集市模板

卸载集市主题

卸载集市挂件

block

追加块

appendDailyNoteBlock

批量更新块

检查块是否存在

检查块是否折叠

检查块是否为引用 (`/api/block/checkBlockRef`)

/api/block/deleteBlock

折叠块

获取块面包屑 (`/api/block/getBlockBreadcrumb`)

获取块 DOM (getBlockDOM)

通过引用文本获取定义块 ID

获取块索引

获取块信息

获取块Markdown

获取块兄弟节点 ID

获取块树信息

批量获取块索引

批量获取块字数

获取子块

获取内容块字数

获取块 DOM 纯文本

获取文档信息

/api/block/getDocsInfo

getHeadingChildrenDOM

getHeadingChildrenIDs

获取标题删除事务

获取标题级别调整事务

getRecentUpdatedBlocks

获取引用块信息 (`/api/block/getRefIDs`)

getRefIDsByFileAnnotationID

getRefText

getTailChildBlocks

getTreeStat

获取未折叠父块 ID (`/api/block/getUnfoldedParentID`)

插入块 API (`/api/block/insertBlock`)

移动块 API (`/api/block/moveBlock`)

moveOutlineHeading

前置追加块 API (`/api/block/prependBlock`)

prependDailyNoteBlock

设置块提醒

交换块引用与定义

转移块引用 API (`/api/block/transferBlockRef`)

unfoldBlock

更新块 API (`/api/block/updateBlock`)

bookmark

获取书签

移除书签

重命名书签

broadcast

获取广播频道信息

获取所有广播频道

向广播频道发送消息

发布广播消息

clipboard

读取剪贴板文件路径 (readFilePaths)

cloud

获取云端存储空间

convert

Pandoc 转换

export

导出到链滴

导出为文件

导出为 AsciiDoc

导出属性视图

导出工作空间数据

导出指定文件夹中的数据

导出文档为Word

导出为 EPUB

导出 HTML

Export Markdown

导出 Markdown 内容

导出 Markdown 为 HTML

导出多个 Markdown 文档 (exportMds)

导出为 MediaWiki

导出笔记本为 Markdown (exportNotebookMd)

导出笔记本为 .sy 包

导出为 ODT

导出为 OPML

导出为 Org Mode

导出预览 HTML

导出为 RTF

导出为 reStructuredText

导出工作空间资源文件

Export SY

导出临时内容为 HTML

导出为 Textile

预览导出内容

处理 PDF 导出

extension

处理扩展复制内容 (copy)

file

复制文件/目录 API (`/api/file/copyFile`)

获取文件

获取唯一文件名

全局复制文件 API (`/api/file/globalCopyFiles`)

写入文件 API (`/api/file/putFile`)

读取目录 API (`/api/file/readDir`)

删除文件/目录 API (`/api/file/removeFile`)

重命名文件/目录 API (`/api/file/renameFile`)

filetree

更改文件树排序

创建每日笔记 (createDailyNote)

创建文档 (createDoc)

通过Markdown创建文档

文档转换为标题

复制文档

获取文档内容

获取文档创建保存路径

获取完整人类可读路径

获取文档人类可读路径 (getHPathByID)

根据路径获取人类可读路径 (getHPathByPath)

批量获取人类可读路径

根据人类可读路径获取文档ID (getIDsByHPath)

根据 ID 获取文档路径 (getPathByID)

获取引用创建时文档的默认保存路径

标题转换为文档

列表项转换为文档

列出文档树

列出指定路径下的文档 (listDocsByPath)

移动多个文档 (moveDocs)

根据ID移动多个文档 (moveDocsByID)

移动本地闪记 (moveLocalShorthands)

刷新文件树

删除文档

根据ID删除文档 (removeDocByID)

批量移除文档或文件夹

移除内核索引

重命名文档

根据ID重命名文档 (renameDocByID)

搜索文档 (searchDocs)

更新或插入内核索引

format

自动添加空格

网络资源转本地资源

网络图片转本地资源

graph

获取全局关系图

获取局部关系图

重置全局关系图配置

重置局部关系图配置

history

清理工作空间历史

获取文档历史内容

获取历史条目

获取工作空间历史记录

重建历史索引

回滚资源历史

回滚单个文档历史

回滚笔记本历史

搜索历史记录

icon

获取动态图标

import

导入数据

导入 .sy.zip 文件

导入标准 Markdown

inbox

获取速记

获取速记列表

删除速记

lute

copyStdMarkdown

HTML转块DOM

处理块级 DOM (spinBlockDOM)

network

HTTP 请求转发代理 (forwardProxy)

notebook

更改笔记本排序

关闭笔记本

创建笔记本 (createNotebook)

获取笔记本配置

获取笔记本信息

列出笔记本

打开笔记本

移除笔记本

重命名笔记本

设置笔记本配置

设置笔记本图标

notification

推送错误消息 (pushErrMsg)

推送消息

outline

获取文档大纲

petal

加载插件列表 (loadPetals)

设置挂件启用状态 (setPetalEnabled)

query

执行 SQL 查询

ref

获取块的反向链接

获取反向链接与提及 (增强版)

获取文档的反向链接

获取反向提及文档内容

刷新反向链接

repo

检出版本库快照 (checkoutRepo)

创建快照

对比快照差异 (diffRepoSnapshots)

下载云端快照 (downloadCloudSnapshot)

获取云端仓库快照列表

获取云端仓库带标签快照列表

获取本地快照文件内容 (getRepoFile)

获取本地快照列表 (getRepoSnapshots)

获取本地标签快照列表 (getRepoTagSnapshots)

导入仓库密钥

初始化仓库密钥

从口令初始化仓库密钥

打开仓库快照中的文档

purgeCloudRepo

清理本地仓库历史

移除云端仓库标签快照

移除本地仓库标签快照

重置本地仓库密钥

设置历史快照索引保留天数

设置每日历史快照索引保留数量

为快照打标签

上传本地快照至云端

riff

添加闪卡 (addRiffCards)

批量设置闪卡到期时间 (batchSetRiffCardsDueTime)

创建闪卡包 (createRiffDeck)

获取笔记本内闪卡列表 (getNotebookRiffCards)

获取笔记本内到期闪卡列表 (getNotebookRiffDueCards)

获取闪卡包内闪卡列表 (getRiffCards)

根据块ID获取闪卡信息 (getRiffCardsByBlockIDs)

获取闪卡卡组列表

获取闪卡包内到期闪卡列表 (getRiffDueCards)

获取文档树内闪卡列表 (getTreeRiffCards)

获取文档树内到期闪卡列表 (getTreeRiffDueCards)

移除闪卡 (removeRiffCards)

删除闪卡包 (removeRiffDeck)

重命名闪卡包 (renameRiffDeck)

重置闪卡复习状态 (resetRiffCards)

复习闪卡 (reviewRiffCard)

跳过闪卡复习 (skipReviewRiffCard)

search

查找替换

资源文件内容全文搜索

全文搜索块

获取资源文件内容片段

获取动态嵌入块内容

列出失效的块引用

删除模板片段

搜索资源文件

查询嵌入块

搜索引用块

搜索标签

搜索模板

搜索挂件块

更新嵌入块

setting

添加虚拟引用排除关键词

思源笔记 Kernel

思源笔记 Kernel

思源笔记 Kernel

使用 2FA 登录云用户

登出云用户

刷新虚拟块引用缓存

配置 AI 设置

设置账户显示选项

设置外观

/api/setting/setBazaar

/api/setting/setEditor

/api/setting/setEditorReadOnly

/api/setting/setEmoji

设置导出配置

设置文件树配置

设置闪卡配置

setKeymap

setPublish

setSearch

setSnippet

snippet

获取代码片段 (getSnippet)

删除代码片段 (removeSnippet)

创建/更新代码片段 (setSnippet)

sqlite

强制刷新事务队列 (flushTransaction)

storage

获取搜索/替换条件列表 (getCriteria)

获取本地存储

获取最近文档列表 (getRecentDocs)

删除搜索/替换条件 (removeCriterion)

批量删除 LocalStorage 条目 (removeLocalStorageVals)

创建/更新搜索替换条件 (setCriterion)

设置本地存储

设置 LocalStorage 条目 (setLocalStorageVal)

sync

创建云端同步目录 (createCloudSyncDir)

导出S3同步配置 (exportSyncProviderS3)

导出 WebDAV 同步配置

触发启动时同步

获取同步状态信息

导入 S3 同步配置

导入 WebDAV 同步配置

列出云端同步目录

执行启动时同步

/api/sync/performSync

/api/sync/removeCloudSyncDir

API: /api/sync/setCloudSyncDir

API: /api/sync/setSyncEnable

API: /api/sync/setSyncGenerateConflictDoc

API: /api/sync/setSyncInterval

API: /api/sync/setSyncMode

setSyncPerception

setSyncProvider

setSyncProviderLocal

setSyncProviderS3

setSyncProviderWebDAV

system

addMicrosoftDefenderExclusion

获取启动进度

检查更新

检查工作空间目录 (checkWorkspaceDir)

创建工作空间目录 (createWorkspaceDir)

获取当前时间

退出程序 (exit)

exportConf

导出日志 (exportLog)

获取验证码图片 (getCaptcha)

获取更新日志 (getChangelog)

获取应用配置 (getConf)

获取 Emoji 配置 (getEmojiConf)

获取移动端工作空间列表 (getMobileWorkspaces)

获取网络设置 (getNetwork)

获取系统字体列表 (getSysFonts)

获取工作空间信息 (getWorkspaceInfo)

获取工作空间列表 (getWorkspaces)

忽略添加 Microsoft Defender 排除项 (ignoreAddMicrosoftDefenderExclusion)

导入配置 (importConf)

访问授权码登录 (LoginAuth)

访问授权码登出 (LogoutAuth)

重新加载UI (reloadUI)

移除工作空间目录 (removeWorkspaceDir)

物理删除工作空间目录 (removeWorkspaceDirPhysically)

设置API Token (setAPIToken)

设置访问授权码 (setAccessAuthCode)

设置外观模式 (setAppearanceMode)

设置自动启动 (setAutoLaunch)

设置自动下载安装包 (setDownloadInstallPkg)

设置跟随系统锁屏 (setFollowSystemLockScreen)

设置谷歌分析 (setGoogleAnalytics)

设置网络代理 (setNetworkProxy)

设置网络伺服 (setNetworkServe)

设置界面布局 (setUILayout)

设置工作空间目录 (setWorkspaceDir)

注册 UI 进程 (addUIProcess)

获取思源笔记版本

tag

获取标签

移除标签

重命名标签

template

文档保存为模板

渲染模板

使用Sprig渲染模板

transactions

执行事务操作 (performTransactions)

ui

重载属性面板 (reloadAttributeView)

重载文件树 (reloadFiletree)

重载 Protyle 编辑器 (reloadProtyle)

重载标签树 (reloadTag)

重载 UI (reloadUI)

websocket

WebSocket 广播订阅 (/ws/broadcast)

On this page

/api/ref/getBacklink
/api/ref/getBacklink2
/api/ref/getBacklinkDoc
/api/ref/getBackmentionDoc
/api/ref/refreshBacklink

在 GitHub 上编辑此页

最后更新于:

Pager

Next page检查激活码状态 (checkActivationcode)