全局函数-文档-冰狐智能辅助

全局函数

开发者可以使用全局函数来访问系统的功能。callScript、callMicroService、callWebService、getCustomData、setCustomData、sleep、sendMessage、getAppName、getCurAppName、getDeviceName、getDeviceModel、getManufacturer、getSystemVersion、prob、base64Encode、base64Decode、encodeUri、decodeUri、alert、parseInt、parseFloat、parseBoolean、setTimeout、clearTimeout、setInterval、clearInterval、setCronTask、clearCronTask、toast、writeLocalData、readLocalData、deleteLocalData、screenShot、ocrPrepare、ocrGetText、ocrEnd、wakeUp、requestLockScreen、lockScreen、playAudio、stopAudio、getScreenColor、httpGet、httpPost

callScript

执行移动端脚本中的main函数，其返回值为脚本的返回值。

属性：

属性名	类型	必填	说明
scriptName	string	必填	移动端脚本名
params...	object	选填	任意个参数，参数直接透传给脚本。

callMicroService

调用自定义的微服务，返回微服务的运行结果。(仅用于移动端脚本)

属性：

属性名	类型	必填	说明
interfaceName	string	必填	接口名
params	json array	选填	接口参数，参数透传给接口对应的脚本

callWebService

调用第三方的服务。以pos方式请求，注意：body参数为json数据，返回结果结果为json数据，目标url不能有权限限制。(仅用于移动端脚本)

属性：

属性名	类型	必填	说明
url	string	必填	服务url
params	json object	选填	body参数

getCustomData

在移动端获取用户在「微服务」/「自定义数据」中创建的数据项，返回结果结果为string。

属性：

属性名	类型	必填	说明
name	string	必填	数据名

setCustomData

在移动端设置用户在「微服务」/「自定义数据」中创建的数据项，返回结果结果为boolean（注意api不会自动创建不存在的自定义数据）。

属性：

属性名	类型	必填	说明
name	string	必填	数据名
data	string	必填	数据

sleep

等待一段时间。

属性：

属性名	类型	必填	说明
time	integer	必填	延迟时间，单位毫秒

sendMessage

发送消息到客户端程序，可以用于显示引擎正在做的事情，比如：显示下载进度等,例：sendMessage('run_msg', '正在初始化对象...');。返回boolean值。(仅用于移动端脚本)

属性：

属性名	类型	必填	说明
消息id	string	必填	消息的唯一标识,系统内置消息id「run_msg」，用于显示程序内部运行的信息。
params...	object	选填	任意个参数

getAppName

通过包名获取已经安装的app的名称。返回string。(仅用于移动端脚本)

属性：

属性名	类型	必填	说明
packageName	string	选填	默认为空，表示获取当前客户端的程序名。

getCurAppName

获取当前正在运行的app名称。返回string。(仅用于移动端脚本)

属性：

属性名	类型	必填	说明

getDeviceName

获取当前设备名（冰狐app显示的设备名）。返回string。(仅用于移动端脚本)

属性：

属性名	类型	必填	说明

getDeviceModel

获取当前设备型号。返回string。(仅用于移动端脚本)

属性：

属性名	类型	必填	说明

getManufacturer

获取当前设备制造商。返回string。(仅用于移动端脚本)

属性：

属性名	类型	必填	说明

getSystemVersion

获取当前系统版本。返回string。(仅用于移动端脚本)

属性：

属性名	类型	必填	说明

prob

根据概率返回boolean值。

参数：

参数名	类型	必填	说明
probability	integer	必填	0-100的整数，如果为30，表示概率为30%，如果落在30%内返回true，否则返回false

base64Encode

base64编码，返回string。

参数：

参数名	类型	必填	说明
data	byte[]	必填	被编码的数据

base64Decode

base64解码，返回byte[]。

参数：

参数名	类型	必填	说明
data	string	必填	待解码的数据

encodeUri

使用utf-8，encode uri，返回string

参数：

参数名	类型	必填	说明
data	string	必填	待编码的数据

decodeUri

decode uri，返回string

参数：

参数名	类型	必填	说明
data	string	必填	待解码的数据

alert

显示警告框

参数：

参数名	类型	必填	说明
message	object	必填	显示的内容

parseInt

解析字符串返回integer

参数：

参数名	类型	必填	说明
data	string	必填	数据

parseFloat

解析字符串返回float

参数：

参数名	类型	必填	说明
data	string	必填	数据

parseBoolean

解析字符串返回boolean

参数：

参数名	类型	必填	说明
data	string	必填	数据

setTimeout

定时器，返回定时器id

参数：

参数名	类型	必填	说明
cb	function	必填	定时器函数（不支持匿名函数）
time	long	必填	毫秒

clearTimeout

取消定时

参数：

参数名	类型	必填	说明
id	string	必填	定时器id

setInterval

周期定时器，返回定时器id

参数：

参数名	类型	必填	说明
cb	function	必填	定时器函数（不支持匿名函数）
time	long	必填	毫秒

clearInterval

取消定时器

参数：

参数名	类型	必填	说明
id	string	必填	定时器id

setCronTask

cron调度器，返回调度器id

参数：

参数名	类型	必填	说明
cb	function	必填	定时器函数（不支持匿名函数）
cron	string	必填	cron表达式，支持cron4j，cron4j表达式的语法中文文档参考这里
forceRun	boolean	选填	若已有定时任务在运行时是否强制停止运行的任务后再执行该任务，默认值false。
stopMainTask	boolean	选填	执行前是否停止主任务，默认值false。
exeDefaultTaskWhenFinished	boolean	选填	当任务结束后是否执行默认任务，默认值false。

clearCronTask

取消cron调度

参数：

参数名	类型	必填	说明
id	string	必填	cron调度器id

toast

弹出框，可用于调试，或者显示信息。当x>=0且y>=0时，按坐标来显示，否则显示在屏幕中央，
注意：左上角为(0, 0)，x坐标向为正，y坐标向下为正。

参数：

参数名	类型	必填	说明
text	string	必填	文本
duration	integer	选填	toast持续时间，默认值1000，单位毫秒
x	integer	选填	x坐标值，默认值-1，单位像素
y	integer	选填	y坐标值，默认值-1，单位像素

writeLocalData

把数据存入手机（仅移动端使用），返回boolean

参数：

参数名	类型	必填	说明
fileName	string	必填	文件名
key	string	必填	存放数据的key
data	object	必填	数据

readLocalData

从手机读取数据（仅移动端使用）,返回获取的值

参数：

参数名	类型	必填	说明
fileName	string	必填	文件名
key	string	必填	存放数据的key
type	string	必填	数据类型，支持string，integer，float, boolean

deleteLocalData

删除所有数据（仅移动端使用）

参数：

参数名	类型	必填	说明
fileName	string	必填	文件名

screenShot

截屏，截屏图片存在sdcard/aznfz中，支持png和jpg格式，返回boolean，true表示截屏成功。

参数：

参数名	类型	默认值	说明
fileName	string	必填	截图存放的文件名，存放的路径在sdcard/aznfz/下，支持png和jpg后缀，例：screenShot('a.png');

ocrPrepare

准备文字识别相关工作，必须在launchApp之前调用（仅需调用一次），返回boolean，true表示截屏成功。

参数：

参数名	类型	默认值	说明

ocrGetText

识别当前界面的文本，注意识别区域指定越小、越精确，识别效率越短，调用前请确保ocrPrepare已经成功调用，可以调用多次。返回string。

参数：

参数名	类型	默认值	说明
left	integer	必填	识别区域的left
top	integer	必填	识别区域的top
width	integer	必填	识别区域的width
height	integer	必填	识别区域的height

ocrEnd

结束文本识别工作，与ocrPrepare相对应，仅需调用一次。

参数：

参数名	类型	默认值	说明

wakeUp

亮屏。

参数：

参数名	类型	默认值	说明

requestLockScreen

请求锁屏权限，调用后需要人工点击同意，必须在launchApp之前调用，建议在程序的最前面调用，返回boolean，true表示权限请求成功。注意该权限只需要设置一次，除非卸载冰狐app

参数：

参数名	类型	默认值	说明
maxWaitTime	integer	选填	最长等待多长时间设置完成，单位毫秒，默认值1000*40

lockScreen

熄灭屏幕，锁屏。

参数：

参数名	类型	默认值	说明

playAudio

播放音频。

参数：

参数名	类型	默认值	说明
path	string	必填	音频文件路径，例:/sdcard/sample.mp3，https://afn.com/sample.mp3

stopAudio

停止播放音频。

参数：

参数名	类型	默认值	说明

getScreenColor

获取屏幕某点的颜色值，颜色值为ARGB格式，黑色为:0xFF000000，红色为:0xFFFF000000，透明为:0x00000000。

参数：

参数名	类型	默认值	说明
x	integer	必填	x坐标
y	integer	必填	y坐标

httpGet

对地址url进行一次HTTP GET 请求

参数：

参数名	类型	默认值	说明
url	string	必填	目标地址
header	object	选填	请求头

返回值（对象）：

属性名	类型	说明
state	string	成功为success,失败为failed
data	string	成功时返回的数据，失败时表示失败原因

httpPost

对地址url进行一次HTTP POST请求

参数：

参数名	类型	默认值	说明
url	string	必填	目标地址
data	object	必填	数据，键值对
headers	string/object	选填	如果为string表示contentType：支持x-www-form-urlencoded，json，默认为x-www-form-urlencoded。如果为object则表示http请求头

返回值（对象）：

属性名	类型	说明
state	string	成功为success,失败为failed
data	string	成功时返回的数据，失败时表示失败原因