GitHub開發檔案
input([i, ]text)
i {number} 表示要輸入的為第i + 1個輸入框
text {string} 要輸入的文字
App
app模組提供一系列函數,用於使用其他應用、與其他應用互動。例如傳送意圖、開啟檔案、傳送郵件等。
app.launchApp(appName)
appName {string} 應用名稱
通過應用名稱啟動應用。如果該名稱對應的應用不存在,則返回false; 否則返回true。如果該名稱對應多個應用,則只啟動其中某一個。
該函數也可以作為全域性函數使用。
app.getPackageName(appName)
appName {string} 應用名稱
獲取應用名稱對應的已安裝的應用的包名。如果該找不到該應用,返回null;如果該名稱對應多個應用,則只返回其中某一個的包名。
該函數也可以作為全域性函數使用。
app.launch(packageName)
packageName {string} 應用包名
通過應用包名啟動應用。如果該包名對應的應用不存在,則返回false;否則返回true。
該函數也可以作為全域性函數使用
app.getAppName(packageName)
packageName {string} 應用包名
獲取應用包名對應的已安裝的應用的名稱。如果該找不到該應用,返回null。
該函數也可以作為全域性函數使用。
app.openAppSetting(packageName)
packageName {string} 應用包名
開啟應用的詳情頁(設定頁)。如果找不到該應用,返回false; 否則返回true。
該函數也可以作為全域性函數使用。
app.uninstall(packageName)
packageName {string} 應用包名
解除安裝應用。執行後會會彈出解除安裝應用的提示框。如果該包名的應用未安裝,由應用解除安裝程式處理,可能彈出"未找到應用"的提示。
不是全域性變數不能直接使用,需要使用app.unistall(packageName)
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。
app.sendEmail({
email: ["10086@qq.com", "10001@qq.com"],
subject: "這是一個郵件標題",
text: "這是郵件正文"
});
app.startActivity(name)
name {string} 活動名稱,可選的值為:
console 紀錄檔介面
settings 設定介面
啟動Auto.js的特定介面。該函數在Auto.js內執行則會開啟Auto.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",
});
全域性變數與函數
全域性變數和函數在所有模組中均可使用。 但以下變數的作用域只在模組內,詳見 module:
exports
module
require() 以下的物件是特定於 Auto.js 的。 有些內建物件是 JavaScript 語言本身的一部分,它們也是全域性的。
一些模組中的函數為了使用方便也可以直接全域性使用,這些函數在此不再贅述。例如timers模組的setInterval, setTimeout等函數
sleep(n)
n {number} 毫秒數
暫停執行n毫秒的時間。1秒等於1000毫秒。
currentPackage()
返回 {string}
返回最近一次監測到的正在執行的應用的包名,一般可以認為就是當前正在執行的應用的包名。
此函數依賴於無障礙服務,如果服務未啟動,則丟擲異常並提示使用者啟動。
currentActivity()
返回 {string}
返回最近一次監測到的正在執行的Activity的名稱,一般可以認為就是當前正在執行的Activity的名稱。
此函數依賴於無障礙服務,如果服務未啟動,則丟擲異常並提示使用者啟動。
setClip(text)
text {string} 文字
設定剪貼簿內容。此剪貼簿即系統剪貼簿,在一般應用的輸入框中"貼上"既可使用。
getClip()
返回 {string}
返回系統剪貼簿的內容。
toast(message)
message {string} 要顯示的資訊
以氣泡顯示資訊message幾秒。(具體時間取決於安卓系統,一般都是2秒)
注意,資訊的顯示是"非同步"執行的,並且,不會等待資訊消失程式才繼續執行。如果在迴圈中執行該命令,可能出現指令碼停止執行後仍然有不斷的氣泡資訊出現的情況。
toastLog(message)
message {string} 要顯示的資訊
相當於toast(message);log(message)。顯示資訊message並在控制檯中輸出。參見console.log。
Type to search
Auto.js檔案
首頁
Q&A
如何閱讀本檔案 - Documentation
應用 - App
一般全域性函數 - Globals
sleep(n)
currentPackage()
currentActivity()
setClip(text)
getClip()
toast(message)
toastLog(message)
waitForActivity(activity[, period = 200])
waitForPackage(package[, period = 200])
exit()
random(min, max)
random()
requiresApi(api)
requiresAutojsVersion(version)
runtime.requestPermissions(permissions)
runtime.loadJar(path)
runtime.loadDex(path)
context
控制檯 - Console
基於座標的操作 - CoordinatesBasedAutomation
裝置 - Device
對話方塊 - Dialogs
指令碼引擎 - Engines
事件與監聽 - Events
懸浮窗 - Floaty
檔案系統 - Files
HTTP - Http
圖片與顏色 - Images
畫布 - Canvas
按鍵模擬 - Keys
多媒體 - Media
模組 - Modules
基於控制元件的操作 - WidgetsBaseAutomation
感測器 - Sensor
Shell - Shell
本地儲存 - Storages
多執行緒 - Threads
定時器 - Timers
使用者介面 - UI
呼叫Java - Work with Java
全域性變數與函數
全域性變數和函數在所有模組中均可使用。 但以下變數的作用域只在模組內,詳見 module:
exports
module
require() 以下的物件是特定於 Auto.js 的。 有些內建物件是 JavaScript 語言本身的一部分,它們也是全域性的。
一些模組中的函數為了使用方便也可以直接全域性使用,這些函數在此不再贅述。例如timers模組的setInterval, setTimeout等函數。
sleep(n)
n {number} 毫秒數
暫停執行n毫秒的時間。1秒等於1000毫秒。
sleep(5000);
currentPackage()
返回 {string}
返回最近一次監測到的正在執行的應用的包名,一般可以認為就是當前正在執行的應用的包名。
此函數依賴於無障礙服務,如果服務未啟動,則丟擲異常並提示使用者啟動。
currentActivity()
返回 {string}
返回最近一次監測到的正在執行的Activity的名稱,一般可以認為就是當前正在執行的Activity的名稱。
此函數依賴於無障礙服務,如果服務未啟動,則丟擲異常並提示使用者啟動。
setClip(text)
text {string} 文字
設定剪貼簿內容。此剪貼簿即系統剪貼簿,在一般應用的輸入框中"貼上"既可使用。
setClip("剪貼簿文字");
getClip()
返回 {string}
返回系統剪貼簿的內容。
toast("剪貼簿內容為:" + getClip());
toast(message)
message {string} 要顯示的資訊
以氣泡顯示資訊message幾秒。(具體時間取決於安卓系統,一般都是2秒)
注意,資訊的顯示是"非同步"執行的,並且,不會等待資訊消失程式才繼續執行。如果在迴圈中執行該命令,可能出現指令碼停止執行後仍然有不斷的氣泡資訊出現的情況。 例如:
for(var i = 0; i < 100; i++){
toast(i);
}
執行這段程式以後,會很快執行完成,且不斷彈出訊息,在任務管理中關閉所有指令碼也無法停止。 要保證氣泡訊息才繼續執行可以用:
for(var i = 0; i < 100; i++){
toast(i);
sleep(2000);
}
或者修改toast函數:
var _toast_ = toast;
toast = function(message){
_toast_(message);
sleep(2000);
}
for(var i = 0; i < 100; i++){
toast(i);
}
toastLog(message)
message {string} 要顯示的資訊
相當於toast(message);log(message)。顯示資訊message並在控制檯中輸出。參見console.log。
waitForActivity(activity[, period = 200])
activity Activity名稱
period 輪詢等待間隔(毫秒)
等待指定的Activity出現,period為檢查Activity的間隔。
waitForPackage(package[, period = 200])
package 包名
period 輪詢等待間隔(毫秒)
等待指定的應用出現。例如waitForPackage("com.tencent.mm")為等待當前介面為微信。
exit()
立即停止指令碼執行。
立即停止是通過丟擲ScriptInterrupttedException來實現的,因此如果用try...catch把exit()函數的異常捕捉,則指令碼不會立即停止,仍會執行幾行後再停止。
random(min, max)
min {number} 亂數產生的區間下界
max {number} 亂數產生的區間上界
返回 {number}
返回一個在[min...max]之間的亂數。例如random(0, 2)可能產生0, 1, 2。
random()
返回 {number}
返回在[0, 1)的隨機浮點數。
requiresApi(api)
api Android版本號
表示此指令碼需要Android API版本達到指定版本才能執行。例如requiresApi(19)表示指令碼需要在Android 4.4以及以上執行。
呼叫該函數時會判斷執行指令碼的裝置系統的版本號,如果沒有達到要求則丟擲異常。
可以參考以下Android API和版本的對照表:
平臺版本: API級別
Android 7.0: 24
Android 6.0: 23
Android 5.1: 22
Android 5.0: 21
Android 4.4W: 20
Android 4.4: 19
Android 4.3: 18
runtime.requestPermissions(permissions)
permissions {Array} 許可權的字串陣列
動態申請安卓的許可權。例如:
runtime.requestPermissions(["access_fine_location"]);
儘管安卓有很多許可權,但必須寫入Manifest才能動態申請,為了防止許可權的濫用,目前Auto.js只能額外申請兩個許可權:
access_fine_location GPS許可權
record_audio 錄音許可權
context
全域性變數。一個android.content.Context物件。
注意該物件為ApplicationContext,因此不能用於介面、對話方塊等的建立。
Console
控制檯模組提供了一個和Web瀏覽器中相似的用於偵錯的控制檯。用於輸出一些偵錯資訊、中間結果等。 console模組中的一些函數也可以直接作為全域性函數使用,例如log, print等。
console.show()
顯示控制檯。這會顯示一個控制檯的懸浮窗(需要懸浮窗許可權)。
console.hide()
隱藏控制檯懸浮窗。
console.clear()
清空控制檯。
console.log([data][, ...args])
data {any}
...args {any}
列印到控制檯,並帶上換行符。 可以傳入多個引數,第一個引數作為主要資訊,其他引數作為類似於 printf(3) 中的代替值(引數都會傳給 util.format())。
const count = 5;
console.log('count: %d', count);
console.log('count:', count);
詳見 util.format()。
該函數也可以作為全域性函數使用。
console.verbose([data][, ...args])
data {any}
...args {any}
與console.log類似,但輸出結果以灰色字型顯示。輸出優先順序低於log,用於輸出觀察性質的資訊。
console.info([data][, ...args])
data {any}
...args {any}
與console.log類似,但輸出結果以綠色字型顯示。輸出優先順序高於log, 用於輸出重要資訊。
console.warn([data][, ...args])
data {any}
...args {any}
與console.log類似,但輸出結果以藍色字型顯示。輸出優先順序高於info, 用於輸出警告資訊。
console.error([data][, ...args])
data {any}
...args {any}
與console.log類似,但輸出結果以紅色字型顯示。輸出優先順序高於warn, 用於輸出錯誤資訊。
console.assert(value, message)
value {any} 要斷言的布林值
message {string} value為false時要輸出的資訊
斷言。如果value為false則輸出錯誤資訊message並停止指令碼執行。
var a = 1 + 1;
console.assert(a == 2, "加法出錯啦");
console.time([label])
[v4.1.0新增]
label {String} 計時器標籤,可省略
啟動一個定時器,用以計算一個操作的持續時間。 定時器由一個唯一的 label 標識。 當呼叫 console.timeEnd() 時,可以使用相同的 label 來停止定時器,並以毫秒為單位將持續時間輸出到控制檯。 重複啟動同一個標籤的定時器會覆蓋之前啟動同一標籤的定時器。
console.timeEnd(label)
[v4.1.0新增]
label {String} 計時器標籤
停止之前通過呼叫 console.time() 啟動的定時器,並列印結果到控制檯。 呼叫 console.timeEnd() 後定時器會被刪除。如果不存在標籤指定的定時器則會列印 NaNms。
console.time('求和');
var sum = 0;
for(let i = 0; i < 100000; i++){
sum += i;
}
console.timeEnd('求和');
console.trace([data][, ...args])
[v4.1.0新增]
data {any}
...args {any}
與console.log類似,同時會列印出呼叫這個函數所在的呼叫棧資訊(即當前執行的檔案、行數等資訊)。
console.trace('Show me');
console.input(data[, ...args])
data {any}
...args {any}
與console.log一樣輸出資訊,並在控制檯顯示輸入框等待輸入。按控制檯的確認按鈕後會將輸入的字串用eval計算後返回。
部分機型可能會有控制檯不顯示輸入框的情況,屬於bug。
例如:
var n = console.input("請輸入一個數位:");
toast(n + 1);
console.rawInput(data[, ...args])
data {any}
...args {any}
與console.log一樣輸出資訊,並在控制檯顯示輸入框等待輸入。按控制檯的確認按鈕後會將輸入的字串直接返回。
部分機型可能會有控制檯不顯示輸入框的情況,屬於bug。
例如:
var n = console.rawInput("請輸入一個數位:");
toast(n + 1);
console.setSize(w, h)
w {number} 寬度
h {number} 高度
設定控制檯的大小,單位畫素。
console.show();
console.setSize(device.width / 2, device.height / 2);
console.setPosition(x, y)
x {number} 橫座標
y {number} 縱座標
設定控制檯的位置,單位畫素。
console.show();
console.setPosition(100, 100);
console.setGlobalLogConfig(config)
[v4.1.0新增]
config {Object} 紀錄檔設定,可選的項有:
file {string} 紀錄檔檔案路徑,將會把紀錄檔寫入該檔案中
maxFileSize {number} 最大檔案大小,單位位元組,預設為512 * 1024 (512KB)
rootLevel {string} 寫入的紀錄檔級別,預設為"ALL"(所有紀錄檔),可以為"OFF"(關閉), "DEBUG", "INFO", "WARN", "ERROR", "FATAL"等。
maxBackupSize {number} 紀錄檔備份檔案最大數量,預設為5
filePattern {string} 紀錄檔寫入格式,參見PatternLayout
設定紀錄檔儲存的路徑和設定。例如把紀錄檔儲存到"/sdcard/1.txt":
console.setGlobalLogConfig({
"file": "/sdcard/1.txt"
});
注意該函數會影響所有指令碼的紀錄檔記錄。
print(text)
text {string} | {Object} 要列印到控制檯的資訊
相當於log(text)。
基於座標的觸控模擬
本章節介紹了一些使用座標進行點選、滑動的函數。這些函數有的需要安卓7.0以上,有的需要root許可權。
要獲取要點選的位置的座標,可以在開發者選項中開啟"指標位置"。
基於座標的指令碼通常會有解析度的問題,這時可以通過setScreenMetrics()函數來進行自動座標放縮。這個函數會影響本章節的所有點選、長按、滑動等函數。通過設定指令碼設計時的解析度,使得指令碼在其他解析度下自動放縮座標。
控制元件和座標也可以相互結合。一些控制元件是無法點選的(clickable為false), 無法通過.click()函數來點選,這時如果安卓版本在7.0以上或者有root許可權,就可以通過以下方式來點選
setScreenMetrics(width, height)
width {number} 螢幕寬度,單位畫素
height {number} 螢幕高度,單位畫素
設定指令碼座標點選所適合的螢幕寬高。如果指令碼執行時,螢幕寬度不一致會自動放縮座標。
click(x, y)
x {number} 要點選的座標的x值
y {number} 要點選的座標的y值
模擬點選座標(x, y),並返回是否點選成功。只有在點選執行完成後指令碼才繼續執行。
一般而言,只有點選過程(大約150毫秒)中被其他事件中斷(例如使用者自行點選)才會點選失敗。
使用該函數模擬連續點選時可能有點選速度過慢的問題,這時可以用press()函數代替。
longClick(x, y)
x {number} 要長按的座標的x值
y {number} 要長按的座標的y值
模擬長按座標(x, y), 並返回是否成功。只有在長按執行完成(大約600毫秒)時指令碼才會繼續執行。
一般而言,只有長按過程中被其他事件中斷(例如使用者自行點選)才會長按失敗。
longClick(x, y)
x {number} 要長按的座標的x值
y {number} 要長按的座標的y值
模擬長按座標(x, y), 並返回是否成功。只有在長按執行完成(大約600毫秒)時指令碼才會繼續執行。
一般而言,只有長按過程中被其他事件中斷(例如使用者自行點選)才會長按失敗。
swipe(x1, y1, x2, y2, duration)
x1 {number} 滑動的起始座標的x值
y1 {number} 滑動的起始座標的y值
x2 {number} 滑動的結束座標的x值
y2 {number} 滑動的結束座標的y值
duration {number} 滑動時長,單位毫秒
模擬從座標(x1, y1)滑動到座標(x2, y2),並返回是否成功。只有滑動操作執行完成時指令碼才會繼續執行。
一般而言,只有滑動過程中被其他事件中斷才會滑動失敗。
gesture(duration, [x1, y1], [x2, y2], ...)
duration {number} 手勢的時長
[x, y] ... 手勢滑動路徑的一系列座標
模擬手勢操作。例如gesture(1000, [0, 0], [500, 500], [500, 1000])為模擬一個從(0, 0)到(500, 500)到(500, 100)的手勢操作,時長為2秒。
Tap(x, y)
x, y {number} 要點選的座標。
點選位置(x, y), 您可以通過"開發者選項"開啟指標位置來確定點選座標。
Swipe(x1, y1, x2, y2, [duration])
x1, y1 {number} 滑動起點的座標
x2, y2 {number} 滑動終點的座標
duration {number} 滑動動作所用的時間
滑動。從(x1, y1)位置滑動到(x2, y2)位置。