应用交互-app

稳定

app

该模块允许你与其他应用程序进行交互。你可以启动其他应用程序,发送 Intent 意图,打开文件,发送电子邮件等。

app.versionCode

  • return {number}

当前软件版本号,整数值。例如 160, 256 等。
如果在 Autox.js 中运行则为 Autox.js 的版本号;在打包的软件中则为打包软件的版本号。

app.versionName

  • return {string}

当前软件的版本名称,例如"3.0.0 Beta"。
如果在 Autox.js 中运行则为 Autox.js 的版本名称;在打包的软件中则为打包软件的版本名称。

app.autojs.versionCode

  • return {number}

Autox.js 版本号,整数值。例如 160, 256 等。

app.autojs.versionName

  • return {string}

Autox.js 版本名称,例如"3.0.0 Beta"。

app.launchApp(appName)

global
  • appName {string} 应用名称
  • return {boolean}

通过应用名称启动应用。如果该名称对应的应用不存在,则返回 false; 否则返回 true。如果该名称对应多个应用,则只启动其中某一个。

app.launch(packageName)

global
  • packageName {string} 应用包名
  • return {boolean}

通过应用包名启动应用。如果该包名对应的应用不存在,则返回 false;否则返回 true。

app.launchPackage(packageName)

global
  • packageName {string} 应用包名
  • return {boolean}

相当于app.launch(packageName)

app.getPackageName(appName)

global
  • appName {string} 应用名称
  • return {string}

获取应用名称对应的已安装的应用的包名,如果该找不到该应用,返回 null 。如果该名称对应多个应用,则只返回其中某一个的包名。

app.getAppName(packageName)

global
  • packageName {string} 应用包名
  • return {string}

获取应用包名对应的已安装的应用的名称。如果该找不到该应用,返回 null

app.openAppSetting(packageName)

global
  • packageName {string} 应用包名
  • return {boolean}

打开应用的详情页(设置页)。如果找不到该应用,返回 false; 否则返回 true。

app.viewFile(path)

  • path {string} 文件路径

用其他应用查看文件。文件不存在的情况由查看文件的应用处理。

如果找不出可以查看该文件的应用,则抛出ActivityNotException

app.editFile(path)

  • path {string} 文件路径

用其他应用编辑文件。文件不存在的情况由编辑文件的应用处理。

如果找不出可以编辑该文件的应用,则抛出ActivityNotException

app.uninstall(packageName)

  • packageName {string} 应用包名

卸载应用。执行后会会弹出卸载应用的提示框。如果该包名的应用未安装,由应用卸载程序处理,可能弹出"未找到应用"的提示。

app.openUrl(url)

  • url {string} 网站的 URL,如果不以 "http://" 或 "https://" 开头则默认是 "http://"。

用浏览器打开网站 url。

如果没有安装浏览器应用,则抛出ActivityNotException

app.sendEmail(options)

  • options {object} 发送邮件的参数。包括:
    • email {string} | {array} 收件人的邮件地址。如果有多个收件人,则用字符串数组表示
    • cc {string} | {array} 抄送收件人的邮件地址。如果有多个抄送收件人,则用字符串数组表示
    • bcc {string} | {array} 密送收件人的邮件地址。如果有多个密送收件人,则用字符串数组表示
    • subject {string} 邮件主题(标题)
    • text {string} 邮件正文
    • attachment {string} 附件的路径。

根据选项options调用邮箱应用发送邮件。这些选项均是可选的。

如果没有安装邮箱应用,则抛出ActivityNotException

//发送邮件给10086@qq.com和10001@qq.com。
app.sendEmail({
  email: ["10086@qq.com", "10001@qq.com"],
  subject: "这是一个邮件标题",
  text: "这是邮件正文",
});

app.startActivity(name)

  • name {string} 活动名称,可选的值为:
    • console 日志界面
    • settings 设置界面

启动 Autox.js 的特定界面。该函数在 Autox.js 内运行则会打开 Autox.js 内的界面,在打包应用中运行则会打开打包应用的相应界面。

进阶: 意图 Intent

Intent(意图) 是一个消息传递对象,您可以使用它从其他应用组件请求操作。尽管 Intent 可以通过多种方式促进组件之间的通信,但其基本用例主要包括以下三个:

  • 启动活动(Activity):
    Activity 表示应用中的一个"屏幕"。例如应用主入口都是一个 Activity,应用的功能通常也以 Activity 的形式独立,例如微信的主界面、朋友圈、聊天窗口都是不同的 Activity。通过将 Intent 传递给 startActivity(),您可以启动新的 Activity 实例。Intent 描述了要启动的 Activity,并携带了任何必要的数据。

  • 启动服务(Service):
    Service 是一个不使用用户界面而在后台执行操作的组件。通过将 Intent 传递给 startService(),您可以启动服务执行一次性操作(例如,下载文件)。Intent 描述了要启动的服务,并携带了任何必要的数据。

  • 传递广播:
    广播是任何应用均可接收的消息。系统将针对系统事件(例如:系统启动或设备开始充电时)传递各种广播。通过将 Intent 传递给 sendBroadcast()、sendOrderedBroadcast() 或 sendStickyBroadcast(),您可以将广播传递给其他应用。

本模块提供了构建 Intent 的函数app.intent(), 启动 Activity 的函数app.startActivity(), 发送广播的函数app.sendBroadcast()

使用这些方法可以用来方便的调用其他应用。例如直接打开某个 QQ 号的个人卡片页,打开某个 QQ 号的聊天窗口等。

var qq = "2732014414";
app.startActivity({
  action: "android.intent.action.VIEW",
  data: "mqq://im/chat?chat_type=wpa&version=1&src_type=web&uin=" + qq,
  packageName: "com.tencent.mobileqq",
});

app.intent(options)

  • options {object} 选项,包括:
    • action {string} 意图的 Action,指意图要完成的动作,是一个字符串常量,比如"android.intent.action.SEND"。当 action 以"android.intent.action"开头时,可以省略前缀,直接用"SEND"代替。参见Actionsopen in new window
    • type {string} 意图的 MimeType,表示和该意图直接相关的数据的类型,表示比如"text/plain"为纯文本类型。
    • data {string} 意图的 Data,表示和该意图直接相关的数据,是一个 Uri, 可以是文件路径或者 Url 等。例如要打开一个文件, action 为"android.intent.action.VIEW", data 为"file:///sdcard/1.txt"。
    • category {array} 意图的类别。比较少用。参见Categoriesopen in new window
    • packageName {string} 目标包名
    • className {string} 目标 Activity 或 Service 等组件的名称
    • extras {object} 以键值对构成的这个 Intent 的 Extras(额外信息)。提供该意图的其他信息,例如发送邮件时的邮件标题、邮件正文。参见Extrasopen in new window
    • flags {array} intent 的标识,字符串数组,例如["activity_new_task", "grant_read_uri_permission"]。参见Flagsopen in new window
    • root {boolean} 是否以 root 权限启动、发送该 intent。使用该参数后,不能使用`context.

根据选项,构造一个意图 Intent 对象。

例如:

//打开应用来查看图片文件
var i = app.intent({
  action: "VIEW",
  type: "image/png",
  data: "file:///sdcard/1.png",
});
context.startActivity(i);

需要注意的是,除非应用专门暴露 Activity 出来,否则在没有 root 权限的情况下使用 intent 是无法跳转到特定 Activity、应用的特定界面的。例如我们能通过 Intent 跳转到 QQ 的分享界面,是因为 QQ 对外暴露了分享的 Activity;而在没有 root 权限的情况下,我们无法通过 intent 跳转到 QQ 的设置界面,因为 QQ 并没有暴露这个 Activity。

但如果有 root 权限,则在 intent 的参数加上"root": true即可。例如使用 root 权限跳转到 Autox.js 的设置界面为:

app.startActivity({
  packageName: "org.autojs.autoxjs.v6",
  className: "org.autojs.autojs.ui.settings.SettingsActivity_",
  root: true,
});

另外,关于 intent 的参数如何获取的问题,一些 intent 是意外发现并且在网络中传播的(例如跳转 QQ 聊天窗口是因为 QQ 给网页提供了跳转到客服 QQ 的方法),如果要自己获取活动的 intent 的参数,可以通过例如"intent 记录","隐式启动"等应用拦截内部 intent 或者查询暴露的 intent。其中拦截内部 intent 需要 XPosed 框架,或者可以通过反编译等手段获取参数。总之,没有简单直接的方法。

更多信息,请百度安卓 Intent 或参考Android 指南: Intentopen in new window

app.startActivity(options)

  • options {object} 选项

根据选项构造一个 Intent,并启动该 Activity。

app.startActivity({
  action: "SEND",
  type: "text/plain",
  data: "file:///sdcard/1.txt",
});

app.sendBroadcast(options)

  • options {object} 选项

根据选项构造一个 Intent,并发送该广播。

app.startService(options)

  • options {object} 选项

根据选项构造一个 Intent,并启动该服务。

app.sendBroadcast(name)

  • name {string} 特定的广播名称,包括:
    • inspect_layout_hierarchy 布局层次分析
    • inspect_layout_bounds 布局范围

发送以上特定名称的广播可以触发 Autox.js 的布局分析,方便脚本调试。这些广播在 Autox.js 发送才有效,在打包的脚本上运行将没有任何效果。

app.sendBroadcast("inspect_layout_bounds");

app.intentToShell(options)

  • options {object} 选项

根据选项构造一个 Intent,转换为对应的 shell 的 intent 命令的参数。

例如:

shell(
  "am start " +
    app.intentToShell({
      packageName: "org.autojs.autoxjs.v6",
      className: "org.autojs.autojs.ui.settings.SettingsActivity_",
    }),
  true
);

参见intent 参数的规范open in new window

app.parseUri(uri)

  • uri {string} 一个代表 Uri 的字符串,例如"file:///sdcard/1.txt", "https://www.autojs.org"
  • return {Uri} 一个代表 Uri 的对象,参见android.net.Uriopen in new window

解析 uri 字符串并返回相应的 Uri 对象。即使 Uri 格式错误,该函数也会返回一个 Uri 对象,但之后如果访问该对象的 scheme, path 等值可能因解析失败而返回null

需要注意的是,在高版本 Android 上,由于系统限制直接在 Uri 暴露文件的绝对路径,因此如果 uri 字符串是文件file://...,返回的 Uri 会是诸如content://...的形式。

app.getUriForFile(path)

从一个文件路径创建一个 uri 对象。需要注意的是,在高版本 Android 上,由于系统限制直接在 Uri 暴露文件的绝对路径,因此返回的 Uri 会是诸如content://...的形式。