7 uap mobile api referenceuap_plug_apiuexdevice

1、uexDevice1、简介 2、API概览 3、更新历史 1、简介设备信息插件 1.1 、说明本类封装了设备硬件参数相关信息和硬件状态相关信息.1.2 、UI展示1.3 、开源源码插件测试用例与源码下载:点击插件中心至插件详情页 (插件测试用例与插件源码已经提供)1.4 、平台版本支持本插件的所有API默认支持Android4.0+和iOS7.0+操作系统. 有特殊版本要求的API会在文档中额外说明.1.5 、接口有效性本插件所有API默认在插件版本4.0.0+可用. 在后续版本中新添加的接口会在文档中额外说明.2、API概览vibratecancelVibrategetInfoscreenC

2、apture setVolumegetVolumesetScreenAlwaysBrightsetScreenBrightness getScreenBrightnessopenWiFiInterfaceisFunctionEnablegetIPopenSettingstartNetStatusListenerstopNetStatusListeneronOrientationChange onNetStatusChanged2.1、方法vibrate /开启设备震动uexDevice.vibrate(milliseconds)说明:开启设备震动,iOS平台中,ipad,ipod不支持震动.参

3、数:参数名称参数类型是否必选说明millisecondsNumber震动持续时长,单位毫秒 是示例:uexDevice.vibrate(500);cancelVibrate /关闭设备震动uexDevice.cancelVibrate()说明:关闭设备震动参数:无示例:uexDevice.cancelVibrate();getInfo /获取设备信息uexDevice.getInfo(infoID)说明:获取设备信息参数:参数名称参数类型是否必选说明infoIDNumber设备信息类型,详见CONSTANT中设备信息类型.是返回值:String类型对应设备信息.示例:var systemVer

4、sion = uexDevice.getInfo(1);/获取系统版本alert(systemVersion);screenCapture /获取当前屏幕截图uexDevice.screenCapture(quality, callbackFunction)说明:获取当前屏幕截图 参数:参数名称参数类型是否必选说明qualityNumber图片压缩质量,取值范围0,1 为0时压缩率最大是callbackFunctionFunction回调函数,用来获取相关业务数据 是回调参数:var callbackFunction = function(error,data)参数名称参数类型说明errorN

5、umber为0时表示成功,非0时表示失败dataObject返回数据,形式见下var data = savePath:/String,屏幕截图的路径,error非零为空字符串 示例:uexDevice.screenCapture(0.8,function(error,data) if (!error) alert(截屏成功: + data.savePath); else alert(截屏失败););setVolume /设置系统音量值uexDevice.setVolume(volume)说明:设置系统音量值.特别说明,iOS需关闭设置声音用按钮调整,才有效.参数:参数名称参数类型是否必选说明v

6、olumeNumber音量大小,取值范围01 为1时音量为最大是示例:uexDevice.setVolume(0.5);/设置系统音量 getVolume /获取系统音量值uexDevice.getVolume()说明:获取系统音量值 参数:无返回值:Number类型音量值 示例:var volume = uexDevice.getVolume();/获取系统音量值alert(volume);setScreenAlwaysBright /屏幕常亮控制uexDevice.setScreenAlwaysBright(data)说明:屏幕常亮控制(应用在前台时有效)参数:参数名称参数类型是否必选说明

7、dataNumber屏幕常亮控制值,0 为取消常亮控制;1为设置屏幕常亮是示例:uexDevice.setScreenAlwaysBright(1);/设置屏幕常亮 setScreenBrightness /调整屏幕亮度uexDevice.setScreenBrightness(brightness)说明:调整屏幕亮度参数:参数名称参数类型是否必选说明brightnessNumber屏幕亮度值,取值范围0,1 为1时屏幕亮度最大是示例:uexDevice.setScreenBrightness(0.5);/设置屏幕亮度 getScreenBrightness /获取屏幕亮度值uexDevice

8、.getScreenBrightness()说明:获取屏幕亮度值 参数:无返回值:Number类型屏幕亮度值示例:var brightness = uexDevice.getScreenBrightness();/获取屏幕亮度alert(brightness);openWiFiInterface /打开WIFI设置页面uexDevice.openWiFiInterface()说明:打开WIFI设置页面参数:无示例:uexDevice.openWiFiInterface();/打开WIFI设置页面 isFunctionEnable /判断某功能是否开启uexDevice.isFunctionEn

9、able(params, callbackFunction)说明:判断某功能是否开启 参数:var params = setting:各字段含义如下:字段名称类型是否必选说明settingString功能名称,详情请参考功能 是callbackFunction回调函数,用来获取相关业务数据 函数必选回调参数:var callbackFunction = function(data)参数名称参数类型说明dataBooleantrue开启,false未开启 示例:var params = setting:GPS/位置服务功能 ;var data = JSON.stringify(params);

10、uexDevice.isFunctionEnable(data, function(data) if (data) alert(已开启); else alert(未开启););getIP /获取系统IPuexDevice.getIP()说明:获取系统IP，同步返回内网地址参数:无返回值:String 内网IP示例:var ip = uexDevice.getIP(); alert(ip);openSetting /打开设置界面uexDevice.openSetting(params)说明:打开设置界面,iOS统一打开系统设置里App的页面参数:var params = setting:各字段含

11、义如下:字段名称类型是否必选说明settingString功能名称,详情请参考功能,不传时打开设置入口界面 否示例:var params = setting:GPS/位置服务功能 ;var data = JSON.stringify(params); uexDevice.openSetting(data);startNetStatusListener /打开网络状态器uexDevice.startNetStatusListener(params)说明:打开网络状态器。 为避免内存泄露，在不需要网络状态时，必须调用stopNetStatusListener关闭网络状态器。 参数:无版本支持:iO

12、S 4.0.3+Android 4.0.2+示例:uexDevice.startNetStatusListener();stopNetStatusListener /关闭网络状态器uexDevice.stopNetStatusListener(params)说明:关闭网络状态器。 参数:无版本支持:iOS 4.0.3+Android 4.0.2+示例:uexDevice.stopNetStatusListener();2.2、方法onOrientationChange /屏幕旋转的方法uexDevice.onOrientationChange(mode)说明:该方法需要注册在主窗口中,注册在浮

13、动窗口中无效.参数:参数名称参数类型是否必选说明modeNumber屏幕方向,1-正竖屏;2-左横屏.是示例:uexDevice.onOrientationChange = function(mode) if(mode = 1)alert(正竖屏);else if(mode = 2) alert(左横屏);onNetStatusChanged /网络状态变化的方法uexDevice.onNetStatusChanged(data)说明:网络状态变化的方法。 参数:参数名称参数类型是否必选说明dataString网络状态，-1：无网络连接；0：wifi网络；1:3G网络；3:4G网络。 是平台支持:Android2.2+ iOS6.0+版本支持:3.0.0+示例:uexDevice.onNetStatusChanged = function(data) alert(data);3、更新历史iOSAPI版本: uexDevice-4.0.4最近更新时间: 2017-04-28历史发布版本更新内容4.0.4plugin.xml文件配置startNetStatusListener和stopsNetStatusListener方法 4.0.3增加onNetStatusChanged,startNetStatusListener和stopsNetSta