Script#

Script 模块为 Scripting App 中的脚本执行提供上下文和实用函数。它允许你访问运行时元数据、通过结果终止脚本、以编程方式运行其他脚本，并构造 URL Scheme 启动或打开脚本。

属性（Properties）#

name: string#

当前正在运行的脚本名称。

1console.log(Script.name) // 示例: "MyScript"

directory: string#

当前脚本所在的目录路径。

1console.log(Script.directory) // 示例: "/private/var/mobile/Containers/..."

env: string#

表示当前脚本运行的环境类型，用于根据上下文动态调整脚本行为，例如判断是否处于主应用、组件、通知或扩展中。

可选值说明：#

示例：#

1if (Script.env === "widget") {
2  Widget.present(<MyWidget />)
3} else if (Script.env === "index") {
4  Navigation.present({ element: <MainPage /> })
5}

widgetParameter: string#

从小组件启动脚本时传入的参数。

1if (Script.widgetParameter) {
2  console.log("Widget input:", Script.widgetParameter)
3}

queryParameters: Record<string, string>#

通过 run URL Scheme 传入的键值对参数。

1// URL: scripting://run/MyScript?user=John&id=123
2console.log(Script.queryParameters.user) // "John"
3console.log(Script.queryParameters.id)   // "123"

metadata: { ... }#

当前脚本的元数据信息。

• icon: 脚本图标，可以是系统图标(SFSymbol)名称

• color: 脚本颜色，可以是十六进制颜色字符串（如 #FF0000）或 CSS 颜色名称（如 "red"）

• localizedName: 当前系统语言下的脚本本地化名称

• localizedNames: 不同语言下的本地化名称，键为语言代码，值为对应的名称

• description: 脚本的英文描述

• localizedDescription: 当前系统语言下的本地化描述

• localizedDescriptions: 不同语言下的本地化描述，键为语言代码，值为对应描述

• version: 脚本的版本字符串

• author: 作者信息对象：

  • name: 作者姓名
  • email: 作者电子邮箱
  • homepage: 作者个人主页（可选）

• contributors: 贡献者信息数组，每项结构同 author

• remoteResource: 远程资源信息：

  • url: 远程资源地址（可以是 zip 文件或 Git 仓库）
  • autoUpdateInterval: 自动更新间隔时间（单位：秒），若未设置则不自动更新

1console.log(Script.metadata.localizedName) // 示例: "天气助手"
2console.log(Script.metadata.version)       // 示例: "1.2.0"

方法（Methods）#

Script.exit(result?): void#

终止当前脚本，并可选地返回一个结果。必须调用该方法来正确释放资源。

• result?: any | IntentValue: 要返回的值，可以是任意类型，也可以是 IntentValue 对象（例如返回给快捷指令或其他脚本）

1Script.exit("Done")
2
3// 或返回结构化数据
4Script.exit(Intent.json({ status: "ok" }))

Script.run<T>(options): Promise<T | null>#

以编程方式运行另一个脚本，并等待其结果。

• options.name: 要运行的脚本名称
• options.queryParameters: 可选参数，作为 URL 参数传递
• options.singleMode: 若为 true，确保同一脚本只能同时运行一个实例

返回目标脚本中 Script.exit(result) 返回的值。

1const result = await Script.run({
2  name: "ProcessData",
3  queryParameters: { input: "abc" }
4})
5
6console.log(result)

Script.createRunURLScheme(scriptName, queryParameters?): string#

生成一个 scripting://run URL，可用于启动并执行脚本。

1const url = Script.createRunURLScheme("MyScript", { user: "Alice" })
2// "scripting://run/MyScript?user=Alice"

Script.createRunSingleURLScheme(scriptName, queryParameters?): string#

生成一个 scripting://run_single URL，确保脚本不会并行运行多个实例。

1const url = Script.createRunSingleURLScheme("MyScript", { id: "1" })
2// "scripting://run_single/MyScript?id=1"

Script.createOpenURLScheme(scriptName): string#

生成一个 scripting://open URL，用于在编辑器中打开脚本。

1const url = Script.createOpenURLScheme("MyScript")
2// "scripting://open/MyScript"

Script.createDocumentationURLScheme(title?): string#

生成用于打开 Scripting App 内文档页面的 URL。

• title: （可选）若传入标题，将直接打开该文档主题页面。

1const url = Script.createDocumentationURLScheme("Widgets")
2// "scripting://doc?title=Widgets"

createImportScriptsURLScheme(urls): string#

根据提供的 URL 数组生成导入脚本的 URL Scheme。

• urls: string[]: 要导入的脚本资源 URL 列表（支持 zip 或单文件）

1const urlScheme = Script.createImportScriptsURLScheme([
2  "https://github.com/schl3ck/scripting-app-lib",
3  "https://example.com/my-script.zip",
4])
5// "scripting://import_scripts?urls=..."

hasFullAccess(): boolean#

判断用户是否具有完整的 Scripting PRO 访问权限。

返回:true 如果用户具有完整的 Scripting PRO 访问权限，否则返回 false。

1if (Script.hasFullAccess()) {
2  // 有完整的 Scripting PRO 访问权限
3  Assistant.requestStructedData(...)
4}

注意事项（Notes）#

• 请务必调用 Script.exit() 正确终止脚本并释放内存资源
• 使用 Script.run() 可以实现脚本的模块化和调用链，获取结构化返回值
• URL Scheme 可用于从外部应用（如快捷指令）触发脚本执行
• 对于需要避免并发执行的脚本，建议使用 singleMode 或 run_single URL Scheme