appUtils

来自于：开发者立即使用

bringAppToFront stopPageManager openStart getApps moveAppToBack getStateViewHeight getBottomViewHeight toEvaluate getInstallAppStores addShortcut addFloadWindow removeFloadWindow checkFloadPermission setGpsListener getGpsStatus checkNotificationPermission gotoAppDetail gotoSysSetPage getDeviceInfo getDeviceDbm getScreenSize getSimInfo isSystemApp getSignature setWallpaper installApk unInstallApk

概述

页面管理模块，可实现应用在后台运行时打开应用页面。

模块接口

bringAppToFront

调取页面到前台

bringAppToFront({params}, callback(ret))

parameter

packageName

  • 类型：字符串类型
  • 描述：（可选）需要打开的应用包名
  • 默认：自己应用包名

pageName

  • 类型：字符串类型
  • 描述：（可选）需要打开的页面，需要是全路径。设置此参数时必须设置packageName，此页面名称为andriod原生页面名称，例：com.api.test.TestActivity
  • 默认：打开应用首页

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:true                //布尔类型；true/状态良好，false/参考err查看错误信息
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. msg:'',                        //字符串类型；错误信息
  3. }

示例代码

  1. var appUtils = api.require('appUtils');
  2. appUtils.bringAppToFront({
  3. }, function(ret, err) {
  4.    alert(JSON.stringify(ret));
  5. });

可用性

Android系统

可提供的1.0.0及更高版本

stopPageManager

关闭页面管理者。

stopPageManager({params}, callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:true                //布尔类型；true/状态良好，false/参考err查看错误信息
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. msg:'',                        //字符串类型；错误信息
  3. }

示例代码

  1. var appUtils = api.require('appUtils');
  2. appUtils.stopPageManager({
  3. }, function(ret, err) {
  4.    alert(JSON.stringify(ret));
  5. });

可用性

Android系统

可提供的1.0.0及更高版本

openStart

开机启动,设置为开机自动启动需要手机授权开机自动启动权限。

openStart({params}, callback(ret))

parameter

bootOpenStart：

  • 类型：布尔类型
  • 描述：是否开机启动

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:true                //布尔类型；true/状态良好，false/参考err查看错误信息
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. msg:'',                        //字符串类型；错误信息
  3. }

示例代码

  1. var appUtils = api.require('appUtils');
  2. appUtils.openStart({
  3. bootOpenStart:true,
  4. }, function(ret, err) {
  5.    alert(JSON.stringify(ret));
  6. });

可用性

Android系统

可提供的1.0.0及更高版本

getApps

获取手机应用

getApps({params}, callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:true                //布尔类型；true/状态良好，false/参考err查看错误信息
  3.     appS:[                        //JSON数组类型；获取到的手机所有应用
  4.     {
  5.        packageName:'',             //字符串类型；应用包名
  6.        mainActivityName:'',      //字符串类型；应用主页面
  7.        isSystemApp:,                   //布尔类型；是否为系统应用
  8.     },
  10.     ]
  11. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. msg:'',                        //字符串类型；错误信息
  3. }

示例代码

  1. var appUtils = api.require('appUtils');
  2. appUtils.getApps({
  3. }, function(ret, err) {
  4.    alert(JSON.stringify(ret));
  5. });

可用性

Android系统

可提供的1.0.0及更高版本

moveAppToBack

应用退到后台

moveAppToBack({params}, callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:true                //布尔类型；true/状态良好，false/参考err查看错误信息
  4. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. msg:'',                        //字符串类型；错误信息
  3. }

示例代码

  1. var appUtils = api.require('appUtils');
  2. appUtils.moveAppToBack({
  3. }, function(ret, err) {
  4.    alert(JSON.stringify(ret));
  5. });

可用性

Android系统

可提供的1.0.0及更高版本

getStateViewHeight

获取状态栏高度

getStateViewHeight({params}, callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:true                //布尔类型；true/状态良好，false/参考err查看错误信息
  3.     height:,                     //数字类型；状态栏高度，获取不到返回-1
  5. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. msg:'',                        //字符串类型；错误信息
  3. }

示例代码

  1. var appUtils = api.require('appUtils');
  2. appUtils.getStateViewHeight({
  3. }, function(ret, err) {
  4.    alert(JSON.stringify(ret));
  5. });

可用性

Android系统

可提供的1.0.0及更高版本

getBottomViewHeight

获取底部虚拟按键高度

getBottomViewHeight({params}, callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:true                //布尔类型；true/状态良好，false/参考err查看错误信息
  3.     height:,                     //数字类型；状态栏高度，没有虚拟按键返回-1
  5. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. msg:'',                        //字符串类型；错误信息
  3. }

示例代码

  1. var appUtils = api.require('appUtils');
  2. appUtils.getBottomViewHeight({
  3. }, function(ret, err) {
  4.    alert(JSON.stringify(ret));
  5. });

可用性

Android系统

可提供的1.0.0及更高版本

toEvaluate

跳转应用市场评价

toEvaluate({params}, callback(ret))

parameter

packageName

  • 类型：字符串类型
  • 描述：（可选项）应用市场包名，如果不填写则自动搜索手机应用市场，含有多个应用市场则调用系统选择框

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:true                //布尔类型；true/状态良好，false/参考err查看错误信息
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. msg:'',                        //字符串类型；错误信息
  3. }

示例代码

  1. var appUtils = api.require('appUtils');
  2. appUtils.toEvaluate({
  3. }, function(ret, err) {
  4.    alert(JSON.stringify(ret));
  5. });

可用性

Android系统

可提供的1.0.0及更高版本

getInstallAppStores

获取已安装的应用市场

getInstallAppStores({params}, callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:true,                //布尔类型；true/状态良好，false/参考err查看错误信息
  3.     stores:[                       //JSON数组；返回已安装应用市场信息
  4.     { packageName:'',        //字符串类型；应用市场包名
  5.       appName:''.               //字符串类型；应用名称
  6.       versionCode:,            //数字类型；应用版本号
  7.       versionName:'',        //字符串类型；应用版本
  8.     },
  9.     ]
  10. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. msg:'',                        //字符串类型；错误信息
  3. }

示例代码

  1. var appUtils = api.require('appUtils');
  2. appUtils.getInstallAppStores({
  3. }, function(ret, err) {
  4.    alert(JSON.stringify(ret));
  5. });

可用性

Android系统

可提供的1.0.0及更高版本

addShortcut

创建快捷方式

addShortcut({params}, callback(ret))

parameter

shortName

  • 类型：字符串类型
  • 描述：快捷方式名称

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:true,                //布尔类型；true/状态良好，false/参考err查看错误信息
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. msg:'',                        //字符串类型；错误信息
  3. }

示例代码

  1. var appUtils = api.require('appUtils');
  2. appUtils.addShortcut({
  3. shortName:'',
  4. }, function(ret, err) {
  5.    alert(JSON.stringify(ret));
  6. });

可用性

Android系统

可提供的1.0.0及更高版本

addFloadWindow

添加悬浮框

addFloadWindow({params}, callback(ret))

parameter

rect：

  • 类型：JSON对象
  • 描述：（可选项）显示控件位置

  • 内部字段：

    1. {
    2.  x:,       //数字类型；控件左上角x坐标；默认值：0
    3.  y:,      //数字类型；控件左上角y坐标；默认值：0
    4.  w:,     //数字类型；控件宽；默认值：50
    5.  h:,     //数字类型；控件高；默认值：50
    6. }

text：

  • 类型：JSON对象
  • 描述：（可选项）悬浮框内文字设置

  • 内部字段：

    1. {
    2. content:'',      //字符串类型；文字内容
    3. size:,               //数字类型；文字大小；默认：14
    4. color:'',          //字符串类型；文字颜色；默认：‘#000000’
    5. leftMargin:,  //数字类型；左边距；默认：0
    6. }

background：

  • 类型：JSON对象
  • 描述：（可选项）背景颜色；默认白色

  • 内部字段：

    1. {
    2. color:'',      //字符串类型；背景颜色，支持rgb，rgba
    3. image:'',    //字符串类型；背景图片路径，支持widget，fs；此参数有效时color无效
    4. }

move：

  • 类型：布尔类型
  • 描述：（可选项）是否可拖动；
  • 默认值：true

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:true,                //布尔类型；true/状态良好，false/参考err查看错误信息
  3.     action:'',                  //字符串类型；事件；取值范围：‘open’/打开，‘click’/点击，‘move’/移动
  4.     location:{               //JSON对象；左上角当前位置，仅action为move时返回
  5.     x:,                            //数字类型；x坐标
  6.     y:,                           //数字类型；y坐标
  7.     }
  8. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. msg:'',                        //字符串类型；错误信息
  3. }

示例代码

  1. var appUtils = api.require('appUtils');
  2. appUtils.addFloadWindow({
  3. }, function(ret, err) {
  4.    alert(JSON.stringify(ret));
  5. });

可用性

Android系统

可提供的1.0.0及更高版本

removeFloadWindow

移除悬浮框

removeFloadWindow({params}, callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:true,                //布尔类型；true/状态良好，false/参考err查看错误信息
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. msg:'',                        //字符串类型；错误信息
  3. }

示例代码

  1. var appUtils = api.require('appUtils');
  2. appUtils.removeFloadWindow({
  3. }, function(ret, err) {
  4.    alert(JSON.stringify(ret));
  5. });

可用性

Android系统

可提供的1.0.0及更高版本

checkFloadPermission

检测悬浮框权限，权限未开启则只能在应用内显示

checkFloadPermission({params}, callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:true,                //布尔类型；true/状态良好，false/参考err查看错误信息
  3.     permission:,              //布尔类型；是否已获取悬浮框权限
  4. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. msg:'',                        //字符串类型；错误信息
  3. }

示例代码

  1. var appUtils = api.require('appUtils');
  2. appUtils.checkFloadPermission({
  3. }, function(ret, err) {
  4.    alert(JSON.stringify(ret));
  5. });

可用性

Android系统

可提供的1.0.0及更高版本

setGpsListener

添加gps开关监听

setGpsListener({params}, callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:true,                //布尔类型；true/打开，false/关闭
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. msg:'',                        //字符串类型；错误信息
  3. }

示例代码

  1. var appUtils = api.require('appUtils');
  2. appUtils.setGpsListener({
  3. }, function(ret, err) {
  4.    alert(JSON.stringify(ret));
  5. });

可用性

Android系统

可提供的1.0.0及更高版本

getGpsStatus

获取gps状态

getGpsStatus({params}, callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:true,                //布尔类型；true/打开，false/关闭
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. msg:'',                        //字符串类型；错误信息
  3. }

示例代码

  1. var appUtils = api.require('appUtils');
  2. appUtils.getGpsStatus({
  3. }, function(ret, err) {
  4.    alert(JSON.stringify(ret));
  5. });

可用性

Android系统

可提供的1.0.0及更高版本

checkNotificationPermission

检查通知权限

checkNotificationPermission({params}, callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:true,                //布尔类型；true/打开，false/关闭
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. msg:'',                        //字符串类型；错误信息
  3. }

示例代码

  1. var appUtils = api.require('appUtils');
  2. appUtils.checkNotificationPermission({
  3. }, function(ret, err) {
  4.    alert(JSON.stringify(ret));
  5. });

可用性

Android系统

可提供的1.0.0及更高版本

gotoAppDetail

跳转应用详情页面，可进行权限设置

gotoAppDetail({params}, callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:true,                //布尔类型；true/打开，false/关闭
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. msg:'',                        //字符串类型；错误信息
  3. }

示例代码

  1. var appUtils = api.require('appUtils');
  2. appUtils.gotoAppDetail({
  3. }, function(ret, err) {
  4.    alert(JSON.stringify(ret));
  5. });

可用性

Android系统

可提供的1.0.0及更高版本

gotoSysSetPage

跳转系统设置页面

gotoSysSetPage({params}, callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:true,                //布尔类型；true/打开，false/关闭
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. msg:'',                        //字符串类型；错误信息
  3. }

示例代码

  1. var appUtils = api.require('appUtils');
  2. appUtils.gotoSysSetPage({
  3. }, function(ret, err) {
  4.    alert(JSON.stringify(ret));
  5. });

可用性

Android系统

可提供的1.0.0及更高版本

getDeviceInfo

获取设备信息

getDeviceInfo({params}, callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:true,                //布尔类型；true/成功，false/失败，详情剪err返回msg
  3.     info:{                           //JSON对象类型；设备信息
  4.         device:'',                //字符串类型；设备参数
  5.         model:'',                //字符串类型；版本
  6.         product:'',              //字符串类型；设备厂商
  7.         cpuAbi:'',                //字符串类型；设备cpuabi
  8.          cpuAbi2:'',                //字符串类型；设备cpuabi2
  9.          sdkVersion:'',         //数字类型；设备sdk版本号
  10.     }
  11. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. msg:'',                        //字符串类型；错误信息
  3. }

示例代码

  1. var appUtils = api.require('appUtils');
  2. appUtils.getDeviceInfo({
  3. }, function(ret, err) {
  4.    alert(JSON.stringify(ret));
  5. });

可用性

Android系统

可提供的1.0.0及更高版本

getDeviceDbm

获取设备信号

getDeviceDbm({params}, callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:true,                //布尔类型；true/成功，false/失败，详情剪err返回msg
  3.     dbms:[{                           //JSON数组类型；设备信息
  4.         type:'',                       //字符串类型；信号类型
  5.         value:,                        //数字类型；信号强度
  6.     },]
  7. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. msg:'',                        //字符串类型；错误信息
  3. }

示例代码

  1. var appUtils = api.require('appUtils');
  2. appUtils.getDeviceDbm({
  3. }, function(ret, err) {
  4.    alert(JSON.stringify(ret));
  5. });

可用性

Android系统

可提供的1.0.0及更高版本

getScreenSize

获取屏幕宽高

getScreenSize({params}, callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:true,                //布尔类型；true/成功，false/失败，详情剪err返回msg
  3.     width:,                        //数字类型；屏幕宽，单位px
  4.     height:,                      //数字类型；屏幕高，单位px
  5.     density :                   //小数类型；屏幕像素密度
  6. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. msg:'',                        //字符串类型；错误信息
  3. }

示例代码

  1. var appUtils = api.require('appUtils');
  2. appUtils.getScreenSize({
  3. }, function(ret, err) {
  4.    alert(JSON.stringify(ret));
  5. });

可用性

Android系统

可提供的1.0.0及更高版本

getSimInfo

获取sim卡信息

getSimInfo({params}, callback(ret))

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:true,                //布尔类型；true/成功，false/失败，详情剪err返回msg
  3.     phoneNumber:'',       //字符串类型；手机号
  4.     operatorName:'',       //字符串类型；网络运营商名字
  5.     networkOperator:'' ,    //字符串类型；跨国网络运营商
  6.     networkCountroy:'',      //字符串类型；网络运营商国家代码
  7.     simCountroy:'',               //字符串类型；sim卡运营商国家代码
  8.     simOperatorName:'',      //字符串类型；sim卡运营商名字
  9.     simNo:'',                           //字符串类型；sim卡序列号
  10.     operator:'',                        //字符串类型；sim卡MNC号
  11. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. msg:'',                        //字符串类型；错误信息
  3. }

示例代码

  1. var appUtils = api.require('appUtils');
  2. appUtils.getSimInfo({
  3. }, function(ret, err) {
  4.    alert(JSON.stringify(ret));
  5. });

可用性

Android系统

可提供的1.0.0及更高版本

isSystemApp

判断是否为系统应用

isSystemApp({params}, callback(ret))

parameter

packageName：

  • 类型：字符串类型
  • 描述：（可选项）需要查询应用包名
  • 默认：本应用包名

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:true,                //布尔类型；true/是系统应用，false/不是系统应用，详情剪err返回msg
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. msg:'',                        //字符串类型；错误信息
  3. }

示例代码

  1. var appUtils = api.require('appUtils');
  2. appUtils.isSystemApp({
  3. }, function(ret, err) {
  4.    alert(JSON.stringify(ret));
  5. });

可用性

Android系统

可提供的1.0.0及更高版本

getSignature

获取应用签名

getSignature({params}, callback(ret))

parameter

packageName：

  • 类型：字符串类型
  • 描述：（可选项）需要查询应用包名
  • 默认：本应用包名

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:true,                //布尔类型；true/成功，false/失败，详情剪err返回msg
  3.     sha1:'',                      //字符串类型；签名SHA1值
  4.     md5:'',                      //字符串类型；签名md5值
  5.     sha256:'',                  //字符串类型；签名sha256值
  6. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. msg:'',                        //字符串类型；错误信息
  3. }

示例代码

  1. var appUtils = api.require('appUtils');
  2. appUtils.getSignature({
  3. }, function(ret, err) {
  4.    alert(JSON.stringify(ret));
  5. });

可用性

Android系统

可提供的1.0.0及更高版本

setWallpaper

设置壁纸

setWallpaper({params}, callback(ret))

parameter

imgPath：

  • 类型：字符串类型
  • 描述：壁纸图片地址；支持widget以及fs路径

callback(ret)

ret：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2.     status:true,                //布尔类型；true/成功，false/失败，详情剪err返回msg
  3. }

err：

  • 类型：JSON 对象
  • 内部字段：
  1. {
  2. msg:'',                        //字符串类型；错误信息
  3. }

示例代码

  1. var appUtils = api.require('appUtils');
  2. appUtils.setWallpaper({
  3. imgPath:'',
  4. }, function(ret, err) {
  5.    alert(JSON.stringify(ret));
  6. });

可用性

Android系统

可提供的1.0.0及更高版本

installApk

安装应用包

installApk({params}, callback(ret))

parameter

apkPath：

  • 类型：字符串类型
  • 描述：apk路径；支持fs路径

示例代码

  1. var appUtils = api.require('appUtils');
  2. appUtils.installApk({
  3. apkPath:'',
  4. });

可用性

Android系统

可提供的1.0.0及更高版本

unInstallApk

卸载应用

unInstallApk({params}, callback(ret))

parameter

packageName：

  • 类型：字符串类型
  • 描述：需要卸载的应用包名

示例代码

  1. var appUtils = api.require('appUtils');
  2. appUtils.unInstallApk({
  3. packageName:'',
  4. });

可用性

Android系统

可提供的1.0.0及更高版本