冰狐智能辅助
首页
文档&下载
移动端
微服务
社区
码农教程
管理中心
关于我们
登录/注册
全局函数

callScript

同步调用脚本，执行移动端脚本中的main函数，其返回值为脚本的返回值。（注意，该函数不会创建独立的线程，直接在当前线程中执行，所以不能在ui代码中使用，ui中应该使用runTask）
参数：
参数名 类型 必填 说明
scriptName string 必填 移动端脚本名，支持在线脚本和本地脚本。本地apk资源文件，asset:脚本名.js（打包app时添加的js文件）比如：'asset:temp.js'；本地js文件，比如，绝对路径:'/sdcard/temp.js'，相对路径:'temp.js'。在线脚本（网络，直接给出脚本名），比如：'temp'。
params... 可变参数 选填 任意个参数，参数直接透传给脚本。 
// 调用脚本，注意test是在冰狐在线脚本
callScript('test');

// 调用脚本，test.js在手机存储绝对目录中
callScript('/sdcard/test.js');

// 调用脚本，test.js在手机存储相对目录中
callScript('test.js');

// 调用本地脚本，可以在打包apk时添加js脚本，12和'abc'为脚本参数
callScript('asset:test.js', 12, 'abc');
// 以下是test.js文件
function main(id, name) {
    // id:12  name:abc
    console.log('id:' + id + '  name:' + name);
}

runTask

执行任务，在ui代码中执行移动端脚本，调用时会另外开启一个线程执行脚本，专门用于自定义ui任务。若在非ui代码中调用脚本，请使用callScript。
参数：
参数名 类型 必填 说明
scriptName string 必填 移动端脚本名，支持在线脚本和本地脚本。本地apk资源文件，asset:脚本名.js（打包app时添加的js文件）比如：'asset:temp.js'；本地js文件，比如，绝对路径:'/sdcard/temp.js'，相对路径:'temp.js'。在线脚本（网络，直接给出脚本名），比如：'temp'。
params... 可变参数 选填 任意个参数，参数直接透传给脚本。 
// 执行任务，注意test是在冰狐在线脚本
runTask('test');

// 执行任务，test.js在手机存储绝对目录中
runTask('/sdcard/test.js');

// 执行任务，test.js在手机存储相对目录中
runTask('test.js');

// 执行任务，可以在打包apk时添加js脚本，12和'abc'为脚本参数
runTask('asset:test.js', 12, 'abc');
// 以下是test.js文件
function main(id, name) {
    // id:12  name:abc
    console.log('id:' + id + '  name:' + name);
}

stop

停止执行当前脚本。
参数：
参数名 类型 必填 说明
refresh boolean 选填 停止后是否刷新界面，默认为true 
stop();

pause

暂停执行当前脚本，调用后会自动在手机上弹出一个暂停按钮，手动点击按钮后程序继续运行，注意：若设置了tag则出现tag后立即恢复执行。
参数：
参数名 类型 必填 说明
showResumeButton boolean 选填，默认false 是否显示带有继续运行按钮的悬浮框。 
pause();

resume

继续执行当前脚本，当使用了pause后，可以使用resume函数来恢复执行。
参数：
参数名 类型 必填 说明 
resume();

logout

退出登录。
参数：
参数名 类型 必填 说明 
logout();

launchApp

启动APP。返回integer值，1表示成功，0表示该app没有安装，-1表示启动失败。注意：如果某些app限制了启动，可以通过模拟点击桌面app图标启动。
参数：
参数名 类型 必填 说明
packageName/appName string 必填 app名称或者包名
tag string 选填 app启动后首页中出现的某个控件的tag，出现该tag就表示app启动成功。默认为空
options json object 选填 默认值：{flag:'', mode:'accessibility', debug: false, region:null, failed:null, maxStep:30, refresh: true}。flag见findView；mode表示使用什么方式来识别tag，accessibility表示使用无障碍方式来识别tag，ocr表示使用ocr方式来识别tag，默认为accessibility。debug为true时会打印出ocr的结果。region指定搜索tag的区域[left, top, width, height]，若取值在[0, 1]之间表示比例，例：0.5表示left位于屏幕x轴中点；若取值大于1表示像素值。默认值[0,0,1,1]。failed表示搜索控件失败后调用的函数(视频教程)，主要用于处理在操作期间出现弹窗的场景；maxStep表示检测app是否启动时重试的步数。refresh为true时在启动app过程中会刷新和重新启动app，可以根据具体情况来关闭该选项。 
// 使用launchApp启动app的例子
var ret = launchApp('com.tencent.mm', 'txt:我');
if (1 == ret) {
    console.log('启动成功');
}

// 点击桌面app图标启动app的例子
function startup() {
    home();

    // 这里需要根据实际情况修改代码
    click('txt:微信', {click: true});
    // 判断是否启动成功
    if (findView('txt:我', {maxStep: 10}).length > 0) {
        console.log('启动成功')
        return true;
    } else {
        console.log('启动失败')
    }
    return false;
}

停止App

停止APP，由于android权限的限制，一般无法直接停止其他正在运行的app（除非root过的系统，或者定制rom）。但我们可以模拟人工来杀掉正在运行的app：1.调用home()回到桌面；2.调用recentApps()打开最近任务界面；3.点击清除按钮，由于不同的手机系统ui可能不一样，所以这一步无法做到通用，开发者需要根据实际情况来编写这里的代码；4.调用refresh()回到冰狐界面。注意：由于冰狐被锁定了，所以点击清除按钮后，冰狐不会停止运行。 
例子：
function clearApp() {
    home();

    recentApps();

    // 这里不同的手机系统界面可能不一样，我们需要根据实际情况修改这里
    click('id:com.huawei.android.launcher:id/clear_all_recents_image_button', {click: true, afterWait: 1000})

    refresh({packageName: 'com.libra.aznfz'})
}

getDeviceCustomData

获取设备自定义数据，网页端【移动端】/【设备管理】选择设备，点击"自定义数据"按钮，修改自定义数据值，返回string类型数据，如果是多个值则返回json array string。
参数：
参数名 类型 必填 说明
key string 选填 返回键为key的值，默认key为空，表示返回所有数据
defaultValue 任何类型 选填 默认值，当获取数据失败后返回该数据
useCache boolean 选填 是否优先从缓存获取值，默认值true
type string 选填 key的类型，*表示包含，^表示以key开始，$表示以key结束，默认值为空表示精确匹配 
例子：
var ret = getDeviceCustomData('name');
console.log('设备自定义数据:' + ret);

getUserCustomData

获取用户自定义数据（在「管理中心」/「账户信息」"自定义数据"中设置值，每个子账户户可以单独设置该值，子账户之间相互独立），返回结果结果为string，如果是多个值则返回json array string。
参数：
参数名 类型 必填 说明
key string 选填 返回键为key的值，默认key为空，表示返回所有数据
defaultValue 任何类型 选填 默认值，当获取数据失败后返回该数据
type string 选填 key的类型，*表示包含，^表示以key开始，$表示以key结束，默认值为空表示精确匹配 
var data = getUserCustomData('key', 123);
console.log('data:' + data);

getCustomData

获取全局自定义数据，用户在「管理中心」/「自定义数据」中创建的全局数据项（这个数据项在其所有子账户中共享使用），返回结果结果为string，如果是多个值则返回json array string。
参数：
参数名 类型 必填 说明
key string 必填 数据名
defaultValue 任何类型 选填 默认值，当获取数据失败后返回该数据
type string 选填 key的类型，*表示包含，^表示以key开始，$表示以key结束，默认值为空表示精确匹配 
var data = getCustomData('key', 123);
console.log('data:' + data);

smartGetCustomData

先获取设备的自定义数据，如果有就返回，否则获取用户自定义数据，如果有就返回，否则获取全局自定义数据。返回结果结果为string，如果是多个值则返回json array string。
参数：
参数名 类型 必填 说明
key string 必填 数据名
defaultValue 任何类型 选填 默认值，当获取数据失败后返回该数据
type string 选填 key的类型，*表示包含，^表示以key开始，$表示以key结束，默认值为空表示精确匹配 
var data = smartGetCustomData('key', 123);
console.log('data:' + data);

setCustomData

在移动端设置用户在「管理中心」/「自定义数据」中创建的全局数据项，返回结果结果为boolean（注意api不会自动创建不存在的自定义数据）。
参数：
参数名 类型 必填 说明
name string 必填 数据名
data string 必填 数据 
var ret = setCustomData('key', 123);
console.log('ret:' + ret);

sleep

等待/延时一段时间。
参数：
参数名 类型 必填 说明
time integer 必填 延迟时间，单位毫秒 
sleep(1000);

sendMessage

发送消息到客户端程序，用于在自定义ui场景，任务脚本发送消息给ui脚本, 返回boolean值。例：在任务脚本中调用sendMessage('run_msg', '正在初始化对象...')，在ui脚本中定义 function cbMessage(msgId, param1) {}，自动会自动调用cbMessage回调函数;。(仅用于移动端脚本)
参数：
参数名 类型 必填 说明
msgId string 必填 消息的唯一标识,系统内置消息id「run_msg」，用于显示程序内部运行的信息。
params... 可变参数 选填 任意个参数 
sendMessage('msg_id', 'test', 123);

getVersion

获取当前冰狐版本号。返回string。(仅用于移动端脚本)
参数：
参数名 类型 必填 说明 
var ret = getVersion();
console.log('ret:' + ret);

getLatestVersion

获取最新冰狐版本号。返回string。(仅用于移动端脚本)
参数：
参数名 类型 必填 说明 
var ret = getLatestVersion();
console.log('ret:' + ret);

getAppName

通过包名获取已经安装的app的名称。返回string。(仅用于移动端脚本)
参数：
参数名 类型 必填 说明
packageName string 必填 表示获取包名对应的app名。 
var ret = getAppName('com.libra.aznfz');
console.log('ret:' + ret);

getCurAppName

获取前台正在运行的app名称。返回string。(仅用于移动端脚本)
参数：
参数名 类型 必填 说明 
var ret = getCurAppName();
console.log('ret:' + ret);

getCurPackageName

获取前台正在运行的app包名。返回string。(仅用于移动端脚本)
参数：
参数名 类型 必填 说明 
var ret = getCurPackageName();
console.log('ret:' + ret);

isAccessibilityEnabled

是否开启无障碍功能。返回boolean。(仅用于移动端脚本)
参数：
参数名 类型 必填 说明 
var ret = isAccessibilityEnabled();
console.log('ret:' + ret);

prob

根据概率返回boolean值。
参数：
参数名 类型 必填 说明
probability integer 必填 0-100的整数，如果为30，表示概率为30%，如果落在30%内返回true，否则返回false 
var ret = prob(50);
console.log('ret:' + ret);

alert

显示警告框
参数：
参数名 类型 必填 说明
message string 必填 显示的内容 
alert('hello');

randInt

生成[start, end)之间的随机整数，包含start，不包含end。
参数：
参数名 类型 必填 说明
start integer 必填 起始值
end integer 必填 结束值 
// 生成[10, 50）之间的随机整数
var ret = randInt(10, 50);
console.log('ret:', ret);

randFloat

生成[start, end)之间的随机浮点数，包含start，不包含end。
参数：
参数名 类型 必填 说明
start float 必填 起始值
end float 必填 结束值 
// 生成[10, 50）之间的随机浮点数
var ret = randFloat(10, 50);
console.log('ret:', ret);

floatDim2int

将浮点尺寸转换成整数值，比如坐标，宽高等，浮点尺寸[0-1]表示比例，比如0.5表示一半，大于1表示实际像素值。
参数：
参数名 类型 必填 说明
value float 必填 浮点值
isWidth boolean 必填 是否宽 
int x = 0.3, y = 0.6;
var ax = floatDim2int(x, true);
var ay = floatDim2int(y, false);
console.log('ax:', ax, 'ay:', ay);

parseInt

解析字符串返回integer（字符串转整数），或者将float转换成integer
参数：
参数名 类型 必填 说明
data string/float 必填 数据 
var ret = parseInt('123');
console.log('ret:', ret);

int2bytes

int转byte数组
参数：
参数名 类型 必填 说明
data integer 必填 数据
size integer 选填 目标字节数，默认为4 
var arr = int2bytes(100);
console.log('arr:', arr);

parseFloat

解析字符串返回float（字符串转浮点数），或者将integer转换成float
参数：
参数名 类型 必填 说明
data string/integer 必填 数据 
var ret = parseFloat('123.11');
console.log('ret:', ret);

parseBoolean

解析字符串返回boolean（字符串转布尔值）
参数：
参数名 类型 必填 说明
data string 必填 数据 
var ret = parseBoolean('true');
console.log('ret:', ret);

strIsEmpty

判断一个变量是否为空的字符串，返回boolean
参数：
参数名 类型 必填 说明
data object 必填 数据 
var ret = strIsEmpty('');
console.log('ret:', ret);

strIsNotEmpty

判断一个变量是否为非空的字符串，返回boolean
参数：
参数名 类型 必填 说明
data object 必填 数据 
var ret = strIsNotEmpty('');
console.log('ret:', ret);

strEquals

判断两个字符串是否相等，返回boolean
参数：
参数名 类型 必填 说明
data1 string 必填 数据
data2 string 必填 数据 
var ret = strEquals('abc', 'aaa');
console.log('ret:', ret);

setClipboardData

设置剪切板数据，返回boolean值
参数：
参数名 类型 必填 说明
data string 必填 数据 
setClipboardData('hello');

getClipboardData

获取剪切板数据，注意：由于android10以后限制了后台程序获取剪切板内容，若获取的数据为空，请将冰狐app切换到前台后再次调用该函数即可获取剪切板数据。
参数：
参数名 类型 必填 说明 
var data = getClipboardData();
console.log('data:', data);

toast

弹出框，可用于调试，或者显示信息。当x>=0且y>=0时，按坐标来显示，否则显示在屏幕中央，
注意：左上角为(0, 0)，x坐标向为正，y坐标向下为正。
参数：
参数名 类型 必填 说明
text string 必填 文本
duration integer 选填 toast持续时间，默认值1000，单位毫秒
x integer 选填 x坐标值，默认值-1，单位像素
y integer 选填 y坐标值，默认值-1，单位像素 
toast('test', 2000);

startActivity

启动/打开页面（通过url、scheme打开页面）
参数：
参数名 类型 默认值 说明
intent Intent 必填 用于描述启动哪个页面
intent对象支持如下函数（每个函数都返回当前intent对象）：
函数名 参数 说明
setAction string 用于描述意图抽象动作
addCategory string 用于为action增加额外的类别信息
setData string 用于向action提供操作数据
setType string 设置数据类型
setClassName string,string 两个参数分别表示className和packageName 
// 显示桌面
var intent = new Intent();
intent.setAction('android.intent.action.MAIN').addCategory('android.intent.category.HOME');
startActivity(intent);

// 打开抖音中用户的主页
var intent = new Intent();
intent.setData('snssdk1128://user/detail/111186289832');
startActivity(intent);

// 打开淘宝商品页面
var intent = new Intent();
intent.setData('taobao://item.taobao.com/item.htm?id=' + item_id);
startActivity(intent);

// 打开淘宝店铺首页
var intent = new Intent();
intent.setData('taobao://shop.m.taobao.com/shop/shop_index.htm?shop_id=' + shop_id);
startActivity(intent);

shell

shell，返回字符串
参数：
参数名 类型 默认值 说明
cmd string 必填 shell命令 
shell('cp /sdcard/aznfz/temp.txt /sdcard/aznfz/file.txt');

getCurrentThreadId

getCurrentThreadId，获取线程id，返回integer
参数：
参数名 类型 默认值 说明 
var threadId = getCurrentThreadId();
console.log('threadId:', threadId);

enableWifi

enableWifi，开启或者关闭wifi，返回boolean
参数：
参数名 类型 默认值 说明
enable boolean 必填 true表示开启wifi，false表示关闭wifi 
var ret = enableWifi(false);
console.log('ret:', ret);

开启或关闭重启自动运行

enableRebootAutoRun，开启或关闭重启自动运行。
参数：
参数名 类型 默认值 说明
enable boolean 必填 true表示开启，false表示关闭 
enableRebootAutoRun(true);

开启或关闭音量键启停脚本

enableVolumeRun，开启或关闭音量键启停脚本。
参数：
参数名 类型 默认值 说明
enable boolean 必填 true表示开启，false表示关闭 
enableVolumeRun(true);

打开无障碍设置

如果没有开启无障碍权限，则打开无障碍权限设置框
参数：
参数名 类型 默认值 说明 
openAccessibilitySetting();

getIp

获取当前设备的外网ip，返回字符串
参数：
参数名 类型 默认值 说明 
var ret = getIp();
console.log('ret:', ret);

killBackgroundApp

杀掉后台app（注意：由于部分app加入了防杀掉功能，调用可能失败，如果失败建议使用模拟人工杀app的方式杀掉app）
参数：
参数名 类型 默认值 说明
packageName string 必填 app对应的包名 
killBackgroundApp('com.xx.tt');

installApp

安装app
参数：
参数名 类型 默认值 说明
apkFilename string 必填 apk的全路径文件名 
installApp('/sdcard/xx.apk');

uninstallApp

卸载app
参数：
参数名 类型 默认值 说明
包名/app名 string 必填 app包名或者app名称
tag string 选填 卸载app时自动点击的“卸载”按钮的tag，可以用｜连接多个tag，比如"卸载|删除"等，默认为“卸载”。 
uninstallApp('com.hupu.shihuo');

openUrl

使用默认浏览器打开url
参数：
参数名 类型 默认值 说明
url string 必填 url 
openUrl('http://www.baidu.com');

vibrate(震动手机)

震动手机
参数：
参数名 类型 默认值 说明
duration integer 选填 震动持续时间，单位ms，默认值1000ms 
vibrate(1000);

setDefaultScript(设置默认脚本)

设置默认脚本,调用该函数后永久有效，除非重新设置默认脚本。取消默认脚本可以通过填入空字符串参数实现。
参数：
参数名 类型 默认值 说明
scriptName string 必填 脚本名，支持资源文件，比如asset:xxx.js。支持绝对路径，比如：/sdcard/xxx.js。支持相对路径，比如：xxx.js。支持服务器脚本，比如：xxx（注意没有.js后缀） 
setDefaultScript('main.js');

setOrientation

设置屏幕方向
参数：
参数名 类型 默认值 说明
orientation integer 必填 0表示默认，1表示竖屏， 2表示横屏。 
setOrientation(2);

setLogLevel(设置Log级别)

设置显示Log的级别
参数：
参数名 类型 默认值 说明
level integer 必填 log级别，1表示error， 2表示warn，3表示debug，4表示info。比如设置为2时表示仅显示error和warn日志，显示所有日志可以设置为4 
setLogLevel(4);

getLogLevel(获取Log级别)

获取显示Log的级别
参数：
参数名 类型 默认值 说明 
console.log('level:' + getLogLevel());

setOfflineLogFile

设置本地log日志名，设置后调用console.log等函数会立即写入文件，用于调试一些不能必现的问题（注意prod和dev模式都可以写入离线日志）。设置离线文件名后，日志支持在线和离线日志，如果没有设置则仅支持在线日志。
参数：
参数名 类型 必填 说明
filename 字符串 必填 离线文件名，可以带目录，也可以不带目录。
enableOnlineLog boolean 选填 是否开启或关闭在线log，默认为true。
saveDays integer 选填 保存多少天的日志，默认为0，每次启动脚本都会重新创建日志，停止脚本时不会自动删除日志。

updatePhotoAlbum(更新相册)

当把图片保存到手机后或者删除图片后，需要调用该函数来通知相册更新内容（注意：如果调用该函数后相册还是无法正常识别图片，请将图片存储在手机DCIM目录后再次调用该函数即可）。
参数：
参数名 类型 默认值 说明
path string 必填 图片的路径 
var path = downloadFile('https://xxx.com/abc.png', 'DCIM');
updatePhotoAlbum(path);

qrEncode(生成二维码)

生成二维码，返回Bitmap，可以使用writeImage方法将二维码写入图片文件
参数：
参数名 类型 默认值 说明
content string 必填 待编码的字符串
width integer 选填 生成二维码的宽度，默认200
height integer 选填 生成二维码的高度，默认200 
var bitmap = qrEncode('https://aznfz.com');
if (null != bitmap) {
    var b = writeImage(bitmap, '/sdcard/a.png', 'png');
    console.log('b:' + b);
}

qrDecode(解码二维码)

解码二维码，返回字符串，将二维码图像解码为字符串
参数：
参数名 类型 默认值 说明
path/InputStream/Bitmap string/InputStream/Bitmap 必填 或者为path（表示图片路径），或者为InputStream（表示图片输入流），或者为Bitmap（位图） 
var content = qrDecode('/sdcard/ad.png');
console.log('content:' + content);