AutoJs6 Documentation

语言 (Languages)

• 简体中文 [zh-Hans] # 当前
• [繁體中文 (香港) [zh-Hant-HK]](http://docs-project.autojs6.com/blob/master/.readme/README-zh-Hant-HK.md)
• [繁體中文 (台灣) [zh-Hant-TW]](http://docs-project.autojs6.com/blob/master/.readme/README-zh-Hant-TW.md)
• [English [en]](http://docs-project.autojs6.com/blob/master/.readme/README-en.md)
• [Français [fr]](http://docs-project.autojs6.com/blob/master/.readme/README-fr.md)
• [Español [es]](http://docs-project.autojs6.com/blob/master/.readme/README-es.md)
• [日本語 [ja]](http://docs-project.autojs6.com/blob/master/.readme/README-ja.md)
• [한국어 [ko]](http://docs-project.autojs6.com/blob/master/.readme/README-ko.md)
• [Русский [ru]](http://docs-project.autojs6.com/blob/master/.readme/README-ru.md)
• [العربية [ar]](http://docs-project.autojs6.com/blob/master/.readme/README-ar.md)

简介

AutoJs6 应用文档, 克隆自 hyb1996/AutoJs-Docs. 模板, 样式及 Generator 来自 Node.js. 在线站点与离线文档插件共用同一内容源.

关联项目

AutoJs4 是 Auto.js 最终开源版本 4.1.1 Alpha2 的克隆项目, 保留原始源码, 并做必要更新使其可以正常构建并在新版 Android 中运行. 它也是 AutoJs6 的行为基准: 除少数特定情况外, 能在 AutoJs4 正常运行的脚本, 在 AutoJs6 上也应正常运行且效果与结果完全一致. AutoJs6 是 Android 平台的 JavaScript 自动化工具, 是 Auto.js 的二次开发项目.

AutoJs4-Documentation 保留 Auto.js 4.1.0 文档的最终源码, 并作为 AutoJs6-Documentation (当前项目) 的参考基准. AutoJs4 及其文档用于历史保留与行为对照; AutoJs6 及当前文档继续维护现行 API.

阅读

在线阅读 AutoJs6 文档

开发与发布

api/*.md 是在线与离线文档正文的唯一内容源. 在线 Docsify 站点随 master 更新; project.json 中的 targetAutoJs6Version 固定可复现的离线 HTML 内容版本. 编辑完成后, 以下命令全量生成离线 HTML, 应用离线插件规范化规则并安全同步到 AutoJs6-Plugin-Offline-Docs. 成功后, 本项目 versionName 与插件内容版本对齐 targetAutoJs6Version, 插件独立发行版本保持不变, 两个项目的 versionCode / VERSION_BUILD 各增加 1.

generator\auto-generate-for-autojs6.bat

离线插件的本机路径在不纳入版本控制的 generator/local-config.json 中配置, 示例见 generator/local-config.example.json. 文档站构建需要 Python 3.10+, Node.js 16+ 与 npm.

.github/workflows/pages.yml 直接将 api/ 部署到 GitHub Pages. 在仓库 Pages Settings 中将 Source 设置为 GitHub Actions 后, 日常提交并推送 master 即可, 无需维护 gh-pages. 自定义域名 docs.autojs6.com 仍由 Pages Settings 管理. 同步脚本只更新两个本地工作树: 在线文档在本仓库审查并提交; 离线文档需在 AutoJs6-Plugin-Offline-Docs 中另行审查, 提交并按插件流程发版.

更多生成, 只读检查, 增量构建和插件校验命令参阅 generator/README.md.

说明与进度

文档可能随时更新, 部分内容与实际代码行为可能存在出入. 问题可提交至本项目的 Issues, 常见问题参阅 疑难解答. 文档基于 Auto.js 4.1.0 修改完善, 部署进度 可能相对缓慢.

更新日志

v6.8.0

• 更新 AutoJs4 运行时 (AutoJs4 Runtime) 增加 "对照模式" 小节, 说明 "使用 AutoJs4 运行并对照" 的两次运行, 结果页摘要与差异标记, 以及 issue 模板的复制
• 新增 AutoJs4 运行时 (AutoJs4 Runtime), 说明 AutoJs4 Runtime 插件的用途, 安装与权限, 文件管理器 "使用 AutoJs4 运行" 入口, 日志回传与任务停止, 运行限制以及差异反馈方式
• 更新 设备 (Device) 的 getAndroidId(useSystemId) 重载, 说明通过 Shizuku/Root 获取运行应用所属 Android 用户的系统值, 失败抛出异常及 Android 8.0 以前忽略参数的行为
• 新增 Terminal, TerminalSession, TerminalOpenOptions 与 TerminalError, 说明 3-Shell Terminal 插件依赖, 同步和异步会话管理, 输出事件, npm 脚本, 权限与生命周期
• 新增 颜色 (Color) 的 OKLab / OKLCH 转换 (oklab, oklch, toOklab, toOklch), ensureContrast, harmony, tones, derive, nightVariant, simulate 与 extract 条目, 以及 ColorDetectionAlgorithm 的 oklab 算法
• 新增 颜色 (Color) 的 colors.theme 主题色控制条目 (get, set, reset, libraries, activate, deactivate, next, state, current), 说明脚本修改的合并, 历史来源与撤销, 以及智能颜色库的 "脚本状态" 状态源与 "脚本启动" 换组时机

• 更新 安装器 (Installer) 的高级安装选项, optimizing 阶段及所有权/手动编译观察结果, 补充本地签名门禁, 包名/共享 UID 黑名单和选中分包的权限预览边界
• 更新 安装器 (Installer) 的持久默认边界: Dhizuku API 26-33, Root 独立 system 身份与 user 0, 按模式选择自动授权, 本地配置回执和未确认写入语义
• 更新 AI Agent 1.2.0 开发版本的 mcp 工具组, 默认关闭, 服务器配置与工具选择, 逐服务器风险和远端取消边界
• 更新 AI Agent 1.1.0 开发版本的 script_dynamic 工具组, 默认关闭, 每份源码单独确认, 私有步骤记录与保存登记脚本的流程
• 更新 AI Agent 1.0.0 的 Android, 宿主构建与 3-Stone AI 模型运行条件, 区分插件附着与完整任务 API, 说明模型可用性和当前观察能力
• 更新 AI Agent 构建号 60 的全局设置与预算合并规则, 区分初始默认值和协议硬上限, 说明工具组与审慎模式只能由预设及单次参数进一步收紧
• 新增 电子书 (EPUB), EpubBook, EpubReaderSession 与 EpubLocator 文档, 覆盖 Readium EPUB Reader 插件的元数据, 目录, 正文提取, 封面与资源导出, 全文搜索, 阅读器会话事件与控制, 阅读偏好, 位置对象与错误代码
• 更新 电子书 (EPUB) 增加高亮与笔记: EpubBook#annotations 与便捷层 epub.annotations 读取阅读器为一本书保存的高亮与笔记 (Readium EPUB Reader 插件 1.1.0, EPUB 契约版本 2), EpubReaderSession 增加 highlight 事件 (action 为 added / updated / removed), EpubLocator 的携带位置随之补充
• 新增 邮件 (Mail), MailClient, MailMessage, MailAccountOptions 与 MailSearchQuery 文档, 覆盖 Angus Mail 插件的 IMAP / POP3 / SMTP 收发, 搜索, 附件, 标记, 文件夹, 新邮件监听, 账户选项, 服务商预设与错误代码
• 更新 邮件 (Mail) 增加 "邮件到达时运行脚本" 示例: Angus Mail 插件 1.1.0 的后台守望与 AutoJs6 定时任务 "邮件到达时" (邮件契约版本 2), 脚本经 engines.myEngine().execArgv.mail 读取守望名, 账户别名, 文件夹, 信封与到达时间
• 更新 邮件 (Mail) 的 mail.accounts.list() 条目增加可选 oauth 对象: Angus Mail 插件 1.2.0 在设置页经浏览器以 Google / Microsoft 账号登录的账户的登录状态 (provider, authorizedAt, expiresAt, needsReauth), 令牌本身不出现
• 更新 Flow 坐标点击系列, maxAttempts 默认 0 的无限尝试语义, 以及异常的任务调用栈和控制台输出
• 更新 Flow 可选步骤 whenPresent, 有界循环 repeatUntil, 链式候选查找与点击, 集合稳定性及 snapshot 快照选项, 并校正 stableFor 的默认值为 0
• 新增 文本间距 (Pangu) 文档, 覆盖内置 pangu.js 10.1.0 的全局对象, 文本排版, 间距检查及运行环境
• 更新 HTTP 与 HttpRequestBuilderOptions 的 isInsecure / insecure 请求范围, 共享客户端配置及证书信任, CT, ECH 和本地网络权限的区别
• 更新 多媒体, 设备, TTS 和 设置 的 Android 17 后台音频运行条件, 静默抑制, 可见界面恢复操作及引擎进程边界
• 修复 离线同步器将插件独立发行版本覆盖为文档内容版本的问题, 保留插件版本并继续核对 contentVersion 和 provenance
• 更新 运行时 的本地网络权限名称, Android 17 / targetSdk 37 条件, 异步授权与重试及原生 Socket / MQTT 和插件权限边界
• 新增 设备 的 pageSize 只读属性, 说明当前系统页大小的字节单位及 4 KB / 16 KB 用例
• 更新 OCR 的动态自动选择, 插件启停热切换, mode/tap 重置规则及单次调用选项
• 更新 MediaInfo 增加 streamNumber 多流查询, countGet 流计数, infoKind 单位与说明查询, 能力协商及 Complete name 原始路径语义
• 新增 流程 (Flow), Flow 与 FlowError 文档, 覆盖异步等待与动作链, 全局起点函数, 等待选项与错误对象
• 新增 自动化 章节增加工具集 (smartClick, clickIfExists, clickAny, findAny, scrollUntil, typeInto, dismissPopups, collectList, launchAndWait, backUntil, backToApp, toggle, retry), 事件驱动等待 (waitForIdle, waitForEvent, waitForToast, waitForNotification) 以及 auto 的 wait, findWindows, findWindowRoots, explain, dump, stats 条目
• 新增 选择器 章节增加 select(syntax) 字符串选择器语法, find(max) 与 findIterator 条目; 控件节点 章节增加 isStale, waitUntilGone, waitForStable, fingerprint, toJSON, dumpSubtree, contentInvalid, contextClickable, multiLine, dismissable 条目; 控件集合 章节增加 at, first, last, nonNull, slice 与 performActionEach 等逐个执行条目
• 新增 全局对象 章节增加 waitAsync, waitThenClick, waitForStable, waitForStableThenClick, waitForVisible, waitForHidden, clickWhenStableAfter 条目
• 更新 按 AutoJs6 6.8.0 无障碍自动化重构修订 automator.isServiceRunning 语义, auto.setFlags (appWindowsFallback, eventAssistedPolling), auto.registerEvent 过滤选项, auto.setWindowFilter 对象形式与 auto.state 的 adoptedByEvent, 罗盘 k 段返回 null 的行为, xxxContains 字面匹配, 控件集合的数组包装方式, 并标注可能永久阻塞的方法
• 新增 AI, TTS, 电源管理, 应用设置, 持久化任务 和 系统属性 文档
• 新增 YOLO 目标检测 文档
• 新增 Converter, Formatter, Jsox, MediaInfo, MIME, NanoID, Pinyin, Pinyin4j, SQLite 和 Zip 文档
• 更新 根据 AutoJs6 6.8.0 Augmentable API 修订全局对象, 应用, 自动化, 设备, 引擎, 图像, HTTP, 任务, UI 和工具模块的签名, 重载, 默认值及运行条件
• 更新 补充双开应用, 异步截图, 引擎生命周期事件, WorkManager 兼容接口, OCR Rapid 模式和 WebSocket 字节串等现行 API
• 更新 刷新 引擎 API, 说明本地 Python 文件通过独立 Python Runtime 插件启动, 且失败时不会回退到 JavaScript
• 更新 标明条码, 二维码, OCR, OpenCC 和 OpenCV 相关功能的插件运行条件
• 更新 完成条码, 二维码, 记录器, 上下文, Shell 和运行时章节, 并按 AutoJs6 6.8.0 源码修订签名, 返回值及运行条件
• 优化 统一 Markdown API 参考格式, 内部类型链接和版本标签, 并将无法从源码确认的旧内容移入 存疑内容
• 优化 统一 CJK 文本与英文, 数字, 行内代码, 链接及 ASCII 符号混排时的空格
• 优化 全量生成离线 HTML, JSON 和本地搜索索引, 增加可重复的内容 freshness 检查
• 修复 聚合页中名称互为前缀的 Markdown include 可能被错误替换的问题

v1.1.8

###### 2023/12/01

• 新增 中文转换 (OpenCC) 文档
• 新增 OpenCCConversion 类型
• 新增 选择器 章节增加 plus / append 条目
• 新增 控制台 (Console) 章节增加 setTouchable 条目
• 新增 ConsoleBuildOptions 章节增加 touchable 条目
• 优化 光学字符识别 (OCR) 章节增加 Paddle 工作模式使用提示
• 优化 完善 Shizuku 章节
• 优化 完善 选择器 章节

v1.1.7

###### 2023/10/30

• 新增 Shizuku 文档
• 新增 WebSocket 文档
• 新增 条码 (Barcode) 文档
• 新增 二维码 (QR Code) 文档
• 优化 完善 颜色 (Color) 章节
• 优化 完善 光学字符识别 (OCR) 章节

多语言文档

本机制仅翻译仓库 README 和更新日志, 不翻译 API 站点. README 文案源在 .readme/lang_*.json, 共用模板在 .readme/template_readme.md; 根目录 README 为简体中文. api/changelog.md 保持文档站中文历史来源, 将其变更同步到 .changelog/lang_zh-Hans.json 后逐条更新其他 9 种语言, 保留版本, 日期批次, 条目顺序和链接. 不直接编辑生成 Markdown. 以下命令只需 Python 3.10+, 不依赖 Node.js 或额外 Python 包; Windows 可用 py 替代 python. --check 不写文件, CI 在 Ubuntu 和 Windows 上检查源文件, 历史同步和生成产物. 文档站生成与仓库文档生成独立运行.

python .python/generate_markdown.py
python .python/generate_markdown.py --check
python -m unittest discover -s .python/tests