AppCan文档中心-uexDevice
 
下载文档

uexDevice
更新时间:2016-07-11

1、简介

设备信息插件

1.1、说明

本类封装了设备硬件参数相关信息和硬件状态相关信息。

1.2、UI展示

1.3、开源源码

插件测试用例与源码下载:点击 插件中心至插件详情页 (插件测试用例与插件源码已经提供)

2、API概览

2.1、方法

vibrate 开启设备震动

uexDevice.vibrate(milliseconds)

说明:

开启设备震动,iOS平台中,ipad,ipod不支持震动。

参数:

参数名称 参数类型 是否必选 说明
milliseconds Number 震动持续时长,单位毫秒

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexDevice.vibrate(500);

cancelVibrate 关闭设备震动

uexDevice.cancelVibrate()

说明:

关闭设备震动

参数:

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexDevice.cancelVibrate();

getInfo 获取设备信息

uexDevice.getInfo(infoID)

说明:

获取设备信息,回调方法cbGetInfo

参数:

参数名称 参数类型 是否必选 说明
infoID Number 设备信息类型,详见CONSTANT中设备信息类型。

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexDevice.getInfo('1');//获取系统版本

screenCapture 屏幕截图

uexDevice.screenCapture(quality)

说明:

获取当前屏幕截图,回调方法cbScreenCapture

参数:

参数名称 参数类型 是否必选 说明
quality Number 图片压缩质量,取值范围[0,1] 为0时压缩率最大

平台支持:

Android2.2+
iOS6.0+

版本支持:

iOS3.0.4+
Android3.0.1+

示例:

  1. uexDevice.screenCapture(0.8);//获取屏幕截图

setVolume 调整音量

uexDevice.setVolume(volume)

说明:

设置系统音量值

参数:

参数名称 参数类型 是否必选 说明
volume Number 音量大小,取值范围[0,1] 为1时音量为最大

平台支持:

Android2.2+
iOS6.0+

版本支持:

iOS3.0.4+
Android3.0.1+

示例:

  1. uexDevice.setVolume(0.5);//设置系统音量

getVolume 获取系统音量值

uexDevice.getVolume()

说明:

获取系统音量值,回调方法cbGetVolume

参数:

平台支持:

Android2.2+
iOS6.0+

版本支持:

iOS3.0.4+
Android3.0.1+

示例:

  1. uexDevice.getVolume();//获取系统音量值

setScreenAlwaysBright 屏幕常亮控制

uexDevice.setScreenAlwaysBright(data)

说明:

屏幕常亮控制(应用在前台时有效)用于屏幕保护

参数:

参数名称 参数类型 是否必选 说明
data Number 屏幕常亮控制值,0 为取消常亮控制;1为设置屏幕常亮

平台支持:

Android2.2+
iOS6.0+

版本支持:

iOS3.0.4+
Android3.0.1+

示例:

  1. uexDevice.setScreenAlwaysBright(1);//设置屏幕常亮

getScreenBrightness 获取屏幕亮度

uexDevice.getScreenBrightness(brightness)

说明:

获取屏幕亮度值,回调方法cbGetScreenBrightness

参数:

平台支持:

Android2.2+
iOS6.0+

版本支持:

iOS3.0.4+
Android3.0.1+

示例:

  1. uexDevice.getScreenBrightness();//获取屏幕亮度

setScreenBrightness 调整屏幕亮度

uexDevice.setScreenBrightness(brightness)

说明:

调整屏幕亮度

参数:

参数名称 参数类型 是否必选 说明
brightness Number 屏幕亮度值,取值范围[0,1] 为1时屏幕亮度最大

平台支持:

Android2.2+
iOS6.0+

版本支持:

iOS3.0.4+
Android3.0.1+

示例:

  1. uexDevice.setScreenBrightness(0.5);//设置屏幕亮度

openWiFiInterface 打开WIFI设置页

uexDevice.openWiFiInterface()

说明:

打开WIFI设置页面

参数:

平台支持:

Android2.2+
iOS8.0+

版本支持:

iOS3.0.4+
Android3.0.1+

示例:

  1. uexDevice.openWiFiInterface();//打开WIFI设置页面

isFunctionEnable 判断某功能是否开启

uexDevice.isFunctionEnable(params)

说明:

判断某功能是否开启,回调方法cbIsFunctionEnable

参数:

  1. var params = {
  2. setting:
  3. }

各字段含义如下:

字段名称 类型 是否必选 说明
setting String 功能名称,详情请参考功能

平台支持:

Android2.2+
iOS8.0+

版本支持:

iOS3.0.5+
Android3.0.3+

示例:

  1. var params = {
  2. setting:"GPS"//位置服务功能
  3. };
  4. var data = JSON.stringify(params);
  5. uexDevice.isFunctionEnable(data);

openSetting 打开设置界面

uexDevice.openSetting(params)

说明:

打开设置界面,回调方法cbOpenSetting

参数:

  1. var params = {
  2. setting:
  3. }

各字段含义如下:

字段名称 类型 是否必选 说明
setting String 功能名称,详情请参考功能,不传时打开设置入口界面

平台支持:

Android2.2+
iOS8.0+(插件3.0.10后支持iOS7.0+)

版本支持:

iOS3.0.7+
Android3.0.3+

示例:

  1. var params = {
  2. setting:"GPS"//位置服务功能
  3. };
  4. var data = JSON.stringify(params);
  5. uexDevice.openSetting(data);

2.2、回调方法

cbGetInfo 获取设备信息的回调方法

uexDevice.cbGetInfo(opId,dataType,data)

参数:

参数名称 参数类型 是否必选 说明
opId Number 操作ID,在此函数中不起作用,可忽略
dataType Number 数据类型,详见CONSTENT中Callback方法数据类型
data String 返回设备的相关信息,json格式数据,参数说明详见CONSTANT中设备信息类型

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexDevice.cbGetInfo=function (opCode,dataType,data){
  2. alert(data);
  3. };

cbScreenCapture 获取屏幕截图的回调方法

uexDevice.cbScreenCapture(savePath)

参数:

参数名称 参数类型 是否必选 说明
data String 返回屏幕截图本地存储地址

平台支持:

Android2.2+
iOS6.0+

版本支持:

iOS3.0.4+
Android3.0.1+

示例:

  1. uexDevice.cbScreenCapture =function(data){
  2. var data = JSON.parse(data);
  3. alert(data.savePath);
  4. };

cbGetVolume 获取系统音量值的回调方法

uexDevice.cbGetVolume(data)

参数:

参数名称 参数类型 是否必选 说明
data String 系统音量值信息,音量值范围为[0,1]

平台支持:

Android2.2+
iOS6.0+

版本支持:

iOS3.0.4+
Android3.0.1+

示例:

  1. uexDevice.cbGetVolume=function(data){
  2. var data = JSON.parse(data);
  3. alert(data.volume);
  4. };

cbGetScreenBrightness 获取系统屏幕亮度值的回调方法

uexDevice.cbGetScreenBrightness(data)

参数:

参数名称 参数类型 是否必选 说明
data String 系统屏幕亮度值信息,值范围为[0,1]

平台支持:

Android2.2+
iOS6.0+

版本支持:

iOS3.0.4+
Android3.0.1+

示例:

  1. uexDevice.cbGetVolume=function(data){
  2. var data = JSON.parse(data);
  3. alert(data.brightness);
  4. };

cbIsFunctionEnable 判断某功能是否开启的回调方法

uexDevice.cbIsFunctionEnable(data)

参数:

  1. var data = {
  2. setting:,
  3. isEnable:
  4. }

各字段含义如下:

字段参数名称 类型 是否必选 说明
setting String 与isFunctionEnable中的setting字段对应
isEnable boolean 是否开启

平台支持:

Android2.2+
iOS6.0+

版本支持:

iOS3.0.4+
Android3.0.3+

示例:

  1. uexDevice.cbIsFunctionEnable = function(data){
  2. var data = JSON.parse(data);
  3. alert(data.isEnable);
  4. };

cbOpenSetting 打开设置界面的回调方法

uexDevice.cbOpenSetting(data)

参数:

  1. var data = {
  2. setting:,
  3. errorCode:
  4. }

各字段含义如下:

字段参数名称 类型 是否必选 说明
setting String 与openSetting中的setting字段对应
errorCode int 状态码,0-打开设置成功,1-打开设置失败

平台支持:

Android2.2+
iOS6.0+

版本支持:

iOS3.0.4+
Android3.0.3+

示例:

  1. uexDevice.cbOpenSetting = function(data){
  2. var data = JSON.parse(data);
  3. alert(data.errorCode);
  4. };

2.3、监听方法

onOrientationChange 屏幕旋转的监听方法

uexDevice.onOrientationChange(mode)

参数:

参数名称 参数类型 是否必选 说明
mode Number 屏幕方向,1-正竖屏;2-左横屏;4-倒竖屏;8-右横屏。

平台支持:

Android2.2+
iOS6.0+

版本支持:

3.0.0+

示例:

  1. uexDevice.onOrientationChange = function(mode){
  2. if(mode == 1){
  3. alert("正竖屏");
  4. }else if(mode == 2){
  5. alert("左横屏");
  6. }else if(mode == 4){
  7. alert("倒竖屏");
  8. }else if(mode == 8){
  9. alert("右横屏");
  10. }
  11. };

3、更新历史

iOS

API版本:uexDevice-3.0.10

最近更新时间:2016-7-5

历史发布版本 更新内容
3.0.10 openSetting接口支持ios7.0+
3.0.9 修改获取设备型号的方式,添加设备型号
3.0.8 修改工程为arc;部分接口支持同步回调;设备型号现在可以识别iPad Pro
3.0.7 openSetting接口支持打开推送通知设置
3.0.6 添加判断功能是否开启,以及打开设置界面接口
3.0.5 添加IDE支持
3.0.4 新增屏幕截图、调节屏幕亮度、调节系统音量、屏幕常亮控制、跳转WIFI界面相关接口
3.0.3 设备列表更新
3.0.2 支持获取4G网络状态
3.0.1 修复在不显示状态栏时无法获取当前网络状态的bug
3.0.0 设备能力功能插件

Android

API版本:uexDevice-3.0.6

最近更新时间:2016-4-11

历史发布版本 更新内容
3.0.6 Android6.0支持获取wifi mac地址
3.0.5 修复多次截图都是同一张图片的问题
3.0.4 解决多次截屏失效的问题
3.0.3 添加判断功能是否开启,以及打开设置界面接口
3.0.2 添加截图,听筒和扩音器切换, 设置/获取音量等接口
3.0.1 新增屏幕截图、调节屏幕亮度、调节系统音量、屏幕常亮控制、跳转WIFI界面相关接口
3.0.0 设备能力功能插件

4、附录

Settings

value 说明
GPS GPS功能
BLUETOOTH 蓝牙功能
NOTIFICATION 推送通知设置(仅iOS)