API Reference

Plugins

Native.js


device

Device模块管理设备信息,用于获取手机设备的相关信息,如IMEI、IMSI、型号、厂商等。通过plus.device获取设备信息管理对象。

属性:

方法:

对象:

模块:

5+功能模块(permissions)


{
// ...
"permissions":{
	// ...
	"Device": {
		"description": "设备信息"
	}
}
}
			

imei

设备的国际移动设备身份码


plus.device.imei;
				

说明:

String 类型 只读属性

调用此属性获取设备的国际移动设备身份码。 如果设备不支持则返回空字符串。 如果设备存在多个身份码,则以“,”字符分割拼接,如“862470039452950,862470039452943”。

平台支持:

示例:


<!DOCTYPE html>
<html>
	<head>
	<meta charset="utf-8">
	<title>Device Example</title>
	<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
	alert( "IMEI: " + plus.device.imei );
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
	</script>
	</head>
	<body>
		获取设备的国际移动设备身份码
	</body>
</html>
				

imsi

设备的国际移动用户识别码


plus.device.imsi;
				

说明:

Array 类型 只读属性

字符串数组类型,获取设备上插入SIM的国际移动设备身份码。 如果设备支持多卡模式则返回所有SIM身份码。 如果设备不支持或没有插入SIM卡则返回空数组。

平台支持:

示例:


<!DOCTYPE html>
<html>
	<head>
	<meta charset="utf-8">
	<title>Device Example</title>
	<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
	alert( "IMSI: " + plus.device.imsi );
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
	</script>
	</head>
	<body>
		获取设备的国际移动用户识别码
	</body>
</html>
				

model

设备的型号


plus.device.model;
				

说明:

String 类型 只读属性

调用此属性获取设备的型号信息。 如果设备不支持则返回空字符串。

示例:


<!DOCTYPE html>
<html>
	<head>
	<meta charset="utf-8">
	<title>Device Example</title>
	<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
	alert( "Device: " + plus.device.model );
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
	</script>
	</head>
	<body>
		获取设备的型号
	</body>
</html>
				

vendor

设备的生产厂商


plus.device.vendor;
				

说明:

String 类型 只读属性

调用此属性获取设备的生产厂商信息。 如果设备不支持则返回空字符串。

平台支持:

示例:


<!DOCTYPE html>
<html>
	<head>
	<meta charset="utf-8">
	<title>Device Example</title>
	<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
	alert( "Vendor: " + plus.device.vendor );
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
	</script>
	</head>
	<body>
		获取设备的生产厂商
	</body>
</html>
				

uuid

设备的唯一标识


plus.device.uuid;
				

说明:

String 类型 只读属性

调用此属性获取设备的唯一标识号。

平台支持:

示例:


<!DOCTYPE html>
<html>
	<head>
	<meta charset="utf-8">
	<title>Device Example</title>
	<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
	alert( "uuid: "+plus.device.uuid );
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
	</script>
	</head>
	<body>
		获取设备的唯一标识号
	</body>
</html>
				

dial

拨打电话


void plus.device.dial( number, confirm );
				

说明:

调用系统程序拨打电话。

参数:

返回值:

void : 无

平台支持:

示例:


<!DOCTYPE html>
<html>
	<head>
	<meta charset="utf-8">
	<title>Device Example</title>
	<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
function dialTest() {
	plus.device.dial( "10086", false );
}
	</script>
	</head>
	<body>
		拨打电话<br/>
		<button onclick="dialTest()">Dial</button>
	</body>
</html>
    			

beep

发出蜂鸣声


void plus.device.beep( times );
				

说明:

调用此方法使得设备发出蜂鸣声。

参数:

返回值:

void : 无

平台支持:

示例:


<!DOCTYPE html>
<html>
	<head>
	<meta charset="utf-8">
	<title>Device Example</title>
	<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
	plus.device.beep( 3 );
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
	</script>
	</head>
	<body>
		发出蜂鸣声<br/>
	</body>
</html>
    			

vibrate

设备振动


plus.device.vibrate( milliseconds );
				

说明:

调用此方法使得设备振动。

参数:

返回值:

void : 无

平台支持:

示例:


<!DOCTYPE html>
<html>
	<head>
	<meta charset="utf-8">
	<title>Device Example</title>
	<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
	plus.device.vibrate( 2000 );
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
	</script>
	</head>
	<body>
		设备振动<br/>
	</body>
</html>
    			

setWakelock

设置应用是否保持唤醒(屏幕常亮)状态


plus.device.setWakelock( lock );
				

说明:

调用此方法设置应用是否一直保持唤醒状态,保持唤醒状态将会导致程序屏幕常亮、系统不会自动锁屏,从而导致消耗更多的电量。若未设置一直保持唤醒状态则会根据系统设置自动锁定屏幕。

参数:

返回值:

void : 无

示例:


<!DOCTYPE html>
<html>
	<head>
	<meta charset="utf-8">
	<title>Device Example</title>
	<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
	// 开启一直保持程序唤醒状态
	plus.device.setWakelock( true );
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
	</script>
	</head>
	<body>
		设置应用保持唤醒(屏幕常亮)状态<br/>
		<button onclick="plus.device.setWakelock(false)">UnWakelock</button>
	</body>
</html>
    			

isWakelock

获取程序是否一直保持唤醒(屏幕常亮)状态


Boolean plus.device.isWakelock();
				

说明:

调用此方法获取程序是否一致保持唤醒状态。

参数:

返回值:

Boolean : 返回ture表示程序已设置为一直保持唤醒状态,返回false表示程序未设置为一直保持唤醒状态。

setVolume

设置设备的系统音量


plus.device.setVolume( volume );
				

说明:

调用此方法调节设备的系统音量。

参数:

返回值:

void : 无

平台支持:

示例:


<!DOCTYPE html>
<html>
	<head>
	<meta charset="utf-8">
	<title>Device Example</title>
	<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
	// 设置音量
	plus.device.setVolume( 0.5 );
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
	</script>
	</head>
	<body>
		设备的系统音量值<br/>
	</body>
</html>
				

getVolume

获取设备的系统音量


Number plus.device.getVolume();
				

说明:

系统音量值范围为0到1,0表示静音,1表示最大音量值。

参数:

返回值:

Number : 系统的音量值

平台支持:

screen

Screen模块管理设备屏幕信息

属性:

方法:

resolutionHeight

设备屏幕高度分辨率


plus.screen.resolutionHeight;
						

说明:

Number 类型 只读属性

设备屏幕区域包括系统状态栏显示区域和应用显示区域,screen获取的是设备屏幕总区域的逻辑分辨率,单位为px。 如果需要获取实际分辨率则需要乘以比例值scale。

示例:


<!DOCTYPE html>
<html>
	<head>
	<meta charset="utf-8">
	<title>Device Example</title>
	<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
	alert( "Screen height: " + plus.screen.resolutionHeight*plus.screen.scale + "px" );
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
	</script>
	</head>
	<body>
		设备屏幕高度分辨率<br/>
	</body>
</html>
    					

resolutionWidth

设备屏幕宽度分辨率


plus.screen.resolutionWidth;
						

说明:

Number 类型 只读属性

设备屏幕区域包括系统状态栏显示区域和应用显示区域,screen获取的是设备屏幕总区域的分辨率,单位为px。 如果需要获取实际分辨率则需要乘以比例值scale。

示例:


<!DOCTYPE html>
<html>
	<head>
	<meta charset="utf-8">
	<title>Device Example</title>
	<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
	alert( "Screen width: " + plus.screen.resolutionWidth*plus.screen.scale + "px" );
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
	</script>
	</head>
	<body>
		设备屏幕宽度分辨率<br/>
	</body>
</html>
    					

scale

逻辑分辨率与实际分辨率的比例


plus.screen.scale;
						

说明:

Number 类型 只读属性

屏幕分辨率分逻辑分辨率率和实际分辨率,在html页面中使用的像素值都是相对于逻辑分辨率,此值就是逻辑分辨率和实际分辨率的比例,实际分辨率=逻辑分辨率*比例。

平台支持:

示例:


<!DOCTYPE html>
<html>
	<head>
	<meta charset="utf-8">
	<title>Device Example</title>
	<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
	alert( "Screen resolution: " + plus.screen.resolutionWidth*plus.screen.scale + " x " + plus.screen.resolutionHeight*plus.screen.scale );
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
	</script>
	</head>
	<body>
		逻辑分辨率与实际分辨率的比例<br/>
	</body>
</html>
						

dpiX

设备屏幕水平方向的密度


plus.screen.dpiX;
						

说明:

Number 类型 只读属性

设备屏幕的密度为每英寸所显示的像素点数,密度越高显示清晰度越高,单位为dpi。

平台支持:

示例:


<!DOCTYPE html>
<html>
	<head>
	<meta charset="utf-8">
	<title>Device Example</title>
	<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
	alert( "Screen dip in X: " + plus.screen.dpiX );
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
	</script>
	</head>
	<body>
		设备屏幕水平方向的密度<br/>
	</body>
</html>
						

dpiY

设备屏幕垂直方向的密度


plus.screen.dpiY;
						

说明:

Number 类型 只读属性

设备屏幕的密度为每英寸所显示的像素点数,密度越高显示清晰度越高,单位为dpi。

平台支持:

示例:


<!DOCTYPE html>
<html>
	<head>
	<meta charset="utf-8">
	<title>Device Example</title>
	<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
	alert( "Screen dip in Y: " + plus.screen.dpiY );
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
	</script>
	</head>
	<body>
		设备屏幕垂直方向的密度<br/>
	</body>
</html>
						

setBrightness

设置屏幕亮度


plus.screen.setBrightness( brightness );
						

说明:

调用此方法调节设备屏幕亮度。

参数:

返回值:

void : 无

示例:


<!DOCTYPE html>
<html>
	<head>
	<meta charset="utf-8">
	<title>Device Example</title>
	<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
	// 设置屏幕亮度
	plus.screen.setBrightness( 0.5 );
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
	</script>
	</head>
	<body>
		设置屏幕亮度<br/>
	</body>
</html>
						

getBrightness

获取屏幕亮度值


Number plus.screen.getBrightness();
						

说明:

屏幕亮度值范围为0到1,0表示最低亮度值,1表示最高亮度值。

参数:

返回值:

Number : 返回程序的屏幕亮度值

lockOrientation

锁定屏幕方向


void plus.screen.lockOrientation( String orientation );
						

说明:

锁定屏幕方向后屏幕只能按锁定的屏幕方向显示,关闭当前页面后仍然有效。 可再次调用此方法修改屏幕锁定方向或调用unlockOrientation()方法恢复到应用的默认值。

参数:

返回值:

void : 无

unlockOrientation

解除锁定屏幕方向


void plus.screen.unlockOrientation();
						

说明:

解除锁定屏幕方向后将恢复应用默认的屏幕显示方向(通常为应用打包发布时设置的方向)。

参数:

返回值:

void : 无

display

Display模块管理应用可使用的显示区域信息

属性:

resolutionHeight

应用可使用的屏幕高度逻辑分辨率


plus.display.resolutionHeight;
						

说明:

Number 类型 只读属性

设备屏幕区域包括系统状态栏显示区域和应用显示区域,display获取的是应用显示区域的逻辑分辨率,单位为px。 如果需要获取实际分辨率则需要乘以比例值scale。

平台支持:

示例:


<!DOCTYPE html>
<html>
	<head>
	<meta charset="utf-8">
	<title>Device Example</title>
	<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
	alert( "Display height: " + plus.display.resolutionHeight*plus.screen.scale + "px" );
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
	</script>
	</head>
	<body>
		应用可使用的屏幕高度逻辑分辨率<br/>
	</body>
</html>
						

resolutionWidth

应用可使用的屏幕宽度逻辑分辨率


plus.display.resolutionWidth;
						

说明:

Number 类型 只读属性

设备屏幕区域包括系统状态栏显示区域和应用显示区域,display获取的是应用显示区域的逻辑分辨率,单位为px。 如果需要获取实际分辨率则需要乘以比例值scale。

示例:


<!DOCTYPE html>
<html>
	<head>
	<meta charset="utf-8">
	<title>Device Example</title>
	<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
	alert( "Display width: " + plus.display.resolutionWidth*plus.screen.scale + "px" );
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
	</script>
	</head>
	<body>
		应用可使用的屏幕宽度逻辑分辨率<br/>
	</body>
</html>
						

networkinfo

networkinfo模块用于获取网络信息

常量:

方法:

CONNECTION_UNKNOW

网络连接状态未知


plus.networkinfo.CONNECTION_UNKNOW;
						

说明:

Number 类型

网络状态常量,表示当前设备网络状态未知,固定值为0。

平台支持

CONNECTION_NONE

未连接网络


plus.networkinfo.CONNECTION_NONE;
						

说明:

Number 类型

网络状态常量,当前设备网络未连接网络,固定值为1。

平台支持

CONNECTION_ETHERNET

有线网络


plus.networkinfo.CONNECTION_ETHERNET;
						

说明:

Number 类型

网络状态常量,当前设备连接到有线网络,固定值为2。

平台支持

CONNECTION_WIFI

无线WIFI网络


plus.networkinfo.CONNECTION_WIFI;
						

说明:

Number 类型

网络状态常量,当前设备连接到无线WIFI网络,固定值为3。

平台支持

CONNECTION_CELL2G

蜂窝移动2G网络


plus.networkinfo.CONNECTION_CELL2G;
						

说明:

Number 类型

网络状态常量,当前设备连接到蜂窝移动2G网络,固定值为4。

平台支持

CONNECTION_CELL3G

蜂窝移动3G网络


plus.networkinfo.CONNECTION_CELL3G;
						

说明:

Number 类型

网络状态常量,当前设备连接到蜂窝移动3G网络,固定值为5。

平台支持

CONNECTION_CELL4G

蜂窝移动4G网络


plus.networkinfo.CONNECTION_CELL4G;
						

说明:

Number 类型

网络状态常量,当前设备连接到蜂窝移动4G网络,固定值为6。

平台支持

getCurrentType

获取设备当前连接的网络类型


Number plus.networkinfo.getCurrentType();
						

说明:

获取当前设备连接的网络类型,返回值为网络类型常量,可取值CONNECTION_*常量。

参数:

返回值:

Number : 设备当前网络类型

平台支持:

示例:


<!DOCTYPE html>
<html>
	<head>
	<meta charset="utf-8">
	<title>Device Example</title>
	<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
	var types = {}; 
	types[plus.networkinfo.CONNECTION_UNKNOW] = "Unknown connection"; 
	types[plus.networkinfo.CONNECTION_NONE] = "None connection"; 
	types[plus.networkinfo.CONNECTION_ETHERNET] = "Ethernet connection"; 
	types[plus.networkinfo.CONNECTION_WIFI] = "WiFi connection"; 
	types[plus.networkinfo.CONNECTION_CELL2G] = "Cellular 2G connection"; 
	types[plus.networkinfo.CONNECTION_CELL3G] = "Cellular 3G connection"; 
	types[plus.networkinfo.CONNECTION_CELL4G] = "Cellular 4G connection"; 

	alert( "Network: " + types[plus.networkinfo.getCurrentType()] );
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
	</script>
	</head>
	<body>
		获取设备当前连接的网络类型<br/>
	</body>
</html>
						

os

OS模块管理操作系统信息

属性:

language

系统语言信息


plus.os.language;
						

说明:

String 类型 只读属性

获取当前操作系统设置的系统语言,字符串类型数据。

平台支持:

示例:


<!DOCTYPE html>
<html>
	<head>
	<meta charset="utf-8">
	<title>Device Example</title>
	<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
	alert( "OS language: " + plus.os.language );
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
	</script>
	</head>
	<body>
		获取系统语言信息<br/>
	</body>
</html>
						

version

系统版本信息


plus.os.version;
						

说明:

String 类型 只读属性

获取当前操作系统的版本信息,字符串类型数据。

平台支持:

示例:


<!DOCTYPE html>
<html>
	<head>
	<meta charset="utf-8">
	<title>Device Example</title>
	<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
	alert( "OS version: " + plus.os.version );
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
	</script>
	</head>
	<body>
		获取系统版本信息<br/>
	</body>
</html>
						

name

系统的名称


plus.os.name;
						

说明:

String 类型 只读属性

获取当前操作系统的名称,字符串类型数据。

平台支持:

示例:


<!DOCTYPE html>
<html>
	<head>
	<meta charset="utf-8">
	<title>Device Example</title>
	<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
	alert( "OS name: " + plus.os.name );
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
	</script>
	</head>
	<body>
		获取系统的名称<br/>
	</body>
</html>
						

vendor

系统的供应商信息


plus.os.vendor;
						

说明:

String 类型 只读属性

获取当前操作系统的供应商名称,字符串类型数据。

平台支持:

示例:


<!DOCTYPE html>
<html>
	<head>
	<meta charset="utf-8">
	<title>Device Example</title>
	<script type="text/javascript">
// H5 plus事件处理
function plusReady(){
	alert( "OS name: " + plus.os.vendor );
}
if(window.plus){
	plusReady();
}else{
	document.addEventListener("plusready",plusReady,false);
}
	</script>
	</head>
	<body>
		获取系统的供应商信息<br/>
	</body>
</html>