API Reference

逻辑型 初始化 (
    调试模式,     // 逻辑型, default 假 — enable DevTools, debug shortcuts, etc.
    日志路径,     // 文本型, default "" — log file path; empty = no log file
    数据目录,     // 文本型, default "" — data root; empty = auto-selected
    应用名,       // 文本型 — display name (about dialog, notifications, …)
    应用标识,     // 文本型 — unique id, ≥6 chars reverse-domain recommended;
                  // used for the data dir and single-instance pipe; the JADE:// host in JAPK mode
    单实例        // 逻辑型, default 真 — relaunches forward their command line to
                  // the first instance (fires the 第二实例 event)
)

整数 运行消息循环 ()

逻辑型 退出程序 ()

文本型 取版本 ()         // JadeView version string (includes build number), static
文本型 取WebView版本 ()   // WebView2 runtime version

整数 创建窗口 (
    地址,        // 文本型 — initial URL (http(s):// or a protocol-service local address)
    父窗口ID,    // 整数, default 0 — 0 = top-level window
    窗口选项,    // JadeWindowOptions, default empty object
    视图设置     // JadeViewOptions, default empty object
)
// returns window_id (>0 success, 0 failure — e.g. called before 应用就绪)

整数 创建无边框窗口 (地址, 视图设置)

文本型 置协议服务目录 (
    根目录,     // 文本型, default "" — frontend dir / .japk path; empty = serve the JAPK already loaded in memory
    热载模式    // 逻辑型, default 假 — file-system mode only: refresh on file change (150ms debounce)
)
// returns a local address you can pass straight to 创建窗口

文本型 注册安全资源 (窗口ID, 本地目录, 过期时长)
// 窗口ID: 0 = global; 过期时长: seconds, 0 = never expires.
// returns a jade:// URL on success, empty text on failure
逻辑型 注销安全资源 (令牌或路径)

整数   订阅事件 (事件名称)     // returns a callback id; re-subscribing returns the existing id
逻辑型 注销订阅事件 (事件名称)  // affects only this object's subscription

Jade.订阅事件 (订阅_视图事件.请求新窗口)
Jade.订阅事件 (订阅_视图事件.文件拖放)

逻辑型 置IPC频道回调 (对象实例, 方法)
// 对象实例: pass 本对象; 方法: the callback's export name (literal or constant)
逻辑型 注册IPC通道 (通道名)    // re-registering the same channel returns 真
逻辑型 注销IPC通道 (通道名)
逻辑型 清除IPC频道回调 ()

方法 IPC频道消息 <公开 类型 = 文本型 @强制输出 = 真 @输出名 = "ipcChannelMessageCallback">
参数 通道名 <类型 = 文本型>
参数 窗口ID <类型 = 整数>
参数 数据 <类型 = 文本型>
{
    返回 ("")   // empty text = no reply; non-empty = resolves the frontend jade.invoke Promise
}

整数 发送IPC消息 (窗口ID, 事件名称, 消息内容)
// frontend receives via jade.on('事件名称', payload => ...)

文本型 打开文件对话框 (窗口ID, 标题, 默认路径, 按钮文本, 过滤器, 属性文本)
文本型 保存文件对话框 (窗口ID, 标题, 默认路径, 按钮文本, 过滤器)
文本型 消息框 (窗口ID, 标题, 正文, 详情, 按钮列表, 默认按钮索引, 取消按钮索引, 类型名)
整数   显示错误框 (窗口ID, 标题, 内容)
逻辑型 打开关于对话框 (窗口ID)   // app name from 初始化, icon from the window

逻辑型 显示打开文件对话框_异步 (窗口ID, 标题, 默认路径, 按钮文本, 过滤器, 属性文本, 对象实例, 方法)
逻辑型 显示保存文件对话框_异步 (窗口ID, 标题, 默认路径, 按钮文本, 过滤器, 对象实例, 方法)
逻辑型 显示消息框_异步 (窗口ID, 标题, 正文, 详情, 按钮列表, 默认按钮索引, 取消按钮索引, 类型名, 对象实例, 方法)

方法 对话框结果 <公开 类型 = 整数 @强制输出 = 真 @输出名 = "dialogBoxCallback">
参数 数据文本 <类型 = 文本型>
{
    调试输出 (数据文本)
    返回 (0)
}

逻辑型 显示通知 (参数对象)   // JadeNotificationOptions

整数   注册全局热键 (修饰键, 键码)   // returns hotkey id (>0) or 0 on failure
逻辑型 注销全局热键 (热键ID)

逻辑型 创建 ()                       // returns 真 if already created
逻辑型 销毁 ()
逻辑型 置可见 (可见)
逻辑型 置提示 (提示内容)              // hover tooltip
逻辑型 置图标 (图标路径)              // .ico file
逻辑型 置图标2 (图标数据)             // byte set (ICO/PNG content), no temp file needed

整数   添加菜单项 (菜单类型, 键名称, 显示名称, 父键名称, 禁止, 风险项目)
// 菜单类型: 托盘菜单项类型.普通项 / .子菜单 / .分隔线 / .分组
// 键名称: business key, unique across the table (dividers too);
//         clicks dispatch by key via the 托盘菜单命令事件 event
逻辑型 置菜单禁止 (键名称, 是否禁止)
逻辑型 置菜单危险 (键名称, 是否危险)   // dangerous items (e.g. "Exit" rendered red)
逻辑型 置菜单标题 (键名称, 显示标题)
逻辑型 删除菜单 (键名称)
逻辑型 清空菜单 ()

整数   创建 (显示名称, 菜单类型, 父菜单ID, 菜单ID)
// 菜单类型: 菜单类型.命令 / .复选框 / .单选 / .分隔线 / .子菜单 / .默认菜单项
// default items (kind=5): pass an 原生菜单项 constant (e.g. 原生菜单项.复制) as 显示名称 —
//   WebView2 performs the native action, no 自定义菜单事件 fires
// 菜单ID: custom id returned via 自定义菜单事件 (ignored for default items)
// returns menu_id (0 = failure)
逻辑型 置启用 (菜单ID, 是否启用)
逻辑型 置选中 (菜单ID, 是否选中)      // checkbox / radio items
逻辑型 置显示 (窗口ID, 菜单ID数组)    // call inside 菜单事件回调; takes an 整数数组类
逻辑型 销毁 (菜单ID)                 // destroys the item and its children

变量 数据解构 <类型 = json_object>
如果真 (数据解构.创建自文本 (数据))
{
    变量 名字 <类型 = 文本型>
    名字 = 数据解构.取文本 ("user.name", "")        // "/user/name" JSON Pointer also works

    变量 应答 <类型 = json_object>
    应答.置逻辑 ("success", 真)
    应答.置文本 ("echo", 名字)
    返回 (应答.到文本 ())
}