Skip to content

指令与跳转 ​

在运行时添加搜索入口、跳转到其他插件或自己的入口、发系统通知。都不需要权限。

动态入口 ​

除了 plugin.json 里写死的入口,插件可以在运行时添加入口,比如每个书签、每个片段各一个。动态入口立即出现在搜索结果中,重启后仍在。

方法说明
setFeature(feature: PluginFeature): Promise<void>新建或替换动态入口(同 code 整项替换)。结构与 plugin.json 的入口相同,可以只有匹配指令
removeFeature(code: string): Promise<boolean>删除动态入口
getFeatures(codes?: string[]): Promise<PluginFeature[]>本插件的动态入口(不含 plugin.json 里的)
ts
await window.ling.setFeature({
  code: `bm-${bookmark.id}`,
  explain: bookmark.title,
  cmds: [bookmark.title, bookmark.keyword],
  icon: bookmark.iconDataUrl, // 插件目录内的文件,或不超过 256 KiB 的图片 data URL
})

window.ling.onPluginEnter(({ code }) => {
  if (code.startsWith('bm-')) openBookmark(code.slice(3))
})
  • code 不能与 plugin.json 里的入口重名;动态入口数量不限。
  • icon 只能是插件目录内存在的文件,或 data:image/png|jpeg|gif|svg+xml|webp;base64,…,不接受绝对路径和网址。
  • 字段不合法时以 invalid_params 失败。

跳转 ​

redirect ​

ts
redirect(label: string | [string, string], payload?: string | string[]): Promise<boolean>

打开某个入口,就像用户在搜索框里选中了它:

  • label 为 [插件名, 指令]:在该插件里找;为指令文字:在全部插件里找,恰好一个时直接打开,多个时唤起搜索框让用户选。
  • 目标插件收到 onPluginEnter,from 为 'redirect',payload 为传入的内容(省略时为指令文字)。
  • 找不到功能指令时按匹配指令的 label 找,payload 的形状决定类型:路径数组 → files;图片 Data URL → img;其他文字须命中 regex / over。
  • 找不到时返回 false,不会打开插件市场。
ts
// 把一段 JSON 交给 JSON 编辑器
await window.ling.redirect(['json-editor', 'json'], text)

redirectSelf ​

ts
redirectSelf(label: string, payload?: string | string[]): Promise<boolean>

跳到自己插件的入口,规则同 redirect,但不用知道自己的插件名(开发版是 dev-<name>,正式版是 <name>)。主要给搜索卡片的动作用:「在插件中打开」。插件页面里调用时自己已经打开,返回 false。

接收方用 from === 'redirect' 区分「被带着内容打开」与用户自己打开。

redirectHotKeySetting ​

ts
redirectHotKeySetting(cmdLabel: string, autocopy?: boolean): Promise<boolean>

打开 lingtools 设置的「快捷方式」页并预填一行,让用户给本插件的某条指令设置全局快捷键。只负责跳转,用户录入快捷键后才生效。

  • 支持功能指令,以及 regex / over 类型的匹配指令。
  • autocopy 为 true 时,按下快捷键会先读取用户选中的文字,用它去匹配该匹配指令;为 false 时用剪贴板里的文字。
  • 找不到指令时返回 false。

适合「悬浮翻译」「快速记一条」这类需要随时呼出的功能。

通知 ​

ts
showNotification(body: string, clickFeatureCode?: string): Promise<void>

发一条系统通知,标题为插件名称。用户点击通知时打开插件的 clickFeatureCode 入口(from 为 'notification')。正文 1–1000 个字符。点击能否收到取决于系统的通知服务。