Runtime Document

runtime

Runtime模块管理运行环境,可用于获取当前运行环境信息、与其它程序进行通讯等。通过plus.runtime可获取运行环境管理对象。

属性:

方法:

对象:

回调方法:

权限:

permissions

"Runtime": {
	"description": "访问运行环境信息"
}
			

version

获取客户端的版本号

plus.runtime.version;
				

说明:

DOMString 类型 只读属性

客户端版本号,字符串类型,在编译环境中设置的版本号。

平台支持:

示例:

<!DOCTYPE html>
<html>
	<head>
		<meta charset="utf-8">
		<title>Version Example</title>
		<script type="text/javascript">
// 扩展API加载完毕后调用onPlusReady回调函数
document.addEventListener( "plusready", onPlusReady, false );
// 扩展API加载完毕,现在可以正常调用扩展API
function onPlusReady() {
	// 处理第三方传入的参数
	alert( " Application version: " + plus.runtime.version );
}
		</script>
	</head>
	<body>
	</body>
</html>
				

innerVersion

获取客户端运行时环境的版本号

plus.runtime.innerVersion;
				

说明:

DOMString 类型 只读属性

运行时环境版本号,格式为:[主版本号].[次版本号].[修订版本号].[编译代号]。 注:编译代号为SVN上代码版本号

平台支持:

示例:

<!DOCTYPE html>
<html>
	<head>
		<meta charset="utf-8">
		<title>Version Example</title>
		<script type="text/javascript">
// 扩展API加载完毕后调用onPlusReady回调函数
document.addEventListener( "plusready", onPlusReady, false );
// 扩展API加载完毕,现在可以正常调用扩展API
function onPlusReady() {
	// 处理第三方传入的参数
	alert( " Runtime version: " + plus.runtime.innerVersion );
}
		</script>
	</head>
	<body>
	</body>
</html>
				

arguments

获取第三方程序调用时传递给程序的参数

plus.runtime.arguments;
					

说明:

DOMString 类型 只读属性

第三方程序传递过来的参数,字符串格式类型数据。 不是由第三方程序调用启动,则返回空字符串。

平台支持:

示例:

<!DOCTYPE html>
<html>
<head>
	<meta charset="utf-8">
	<title>Runtime Example</title>
	<script type="text/javascript">
// 扩展API加载完毕后调用onPlusReady回调函数
document.addEventListener( "plusready", onPlusReady, false );
// 扩展API加载完毕,现在可以正常调用扩展API
function onPlusReady() {
	// 处理第三方传入的参数
	if ( plus.runtime.arguments != "" ) {
		try {
			var aj = JSON.parse( plus.runtime.arguments );
			// 处理JSON对象aj
		}catch( e ) {
			// 若传入的参数不是JSON格式字符,需处理异常情况
		}
	}
}
	</script>
</head>
<body>
</body>
</html>
				

appid

获取当前应用的APPID

plus.runtime.appid;
				

说明:

DOMString 类型 只读属性

当前应用的APPID,字符串类型。

平台支持:

示例:

<!DOCTYPE html>
<html>
	<head>
		<meta charset="utf-8">
		<title>Version Example</title>
		<script type="text/javascript">
// 扩展API加载完毕后调用onPlusReady回调函数
document.addEventListener( "plusready", onPlusReady, false );
// 扩展API加载完毕,现在可以正常调用扩展API
function onPlusReady() {
	// 处理第三方传入的参数
	alert( "Current APP: " + plus.runtime.appid );
}
		</script>
	</head>
	<body>
	</body>
</html>
				

getProperty

获取指定APPID对应的应用信息

void plus.runtime.getProperty( appid, getPropertyCB );
				

参数:

返回值:

void : 无

平台支持:

install

安装应用

void plus.runtime.install( wgtFilePath, options, installSuccessCB, installErrorCB);
				

说明:

安装包格式为wgt应用,其扩展名为'.wgt',使用这个方法之前,需要提前把安装包从网络处或其他位置放置到运行时环境可以访问的位置。

参数:

返回值:

void : 无

平台支持:

quit

退出客户端程序

void plus.runtime.quit();
				

参数:

返回值:

void : 无

平台支持:

示例:

<!DOCTYPE html>
<html>
	<head>
		<meta charset="utf-8">
		<title>Runtime Example</title>
		<script type="text/javascript">
// 扩展API加载完毕后调用onPlusReady回调函数
document.addEventListener( "plusready", onPlusReady, false );
// 扩展API加载完毕,现在可以正常调用扩展API
function onPlusReady() {
	document.addEventListener( "back", onKeyBack, false );
}
function onKeyBack() {
	plus.runtime.quit();
}
		</script>
	</head>
	<body>
	</body>
</html>
				

restart

重启当前的应用

void plus.runtime.restart();
				

参数:

返回值:

void : 无

平台支持:

setBadgeNumber

设置程序快捷方式上显示的提示数字

void plus.runtime.setBadgeNumber( number );
				

参数:

返回值:

void : 无

平台支持:

openURL

调用第三方程序打开指定的URL

void plus.runtime.openURL( url, errorCB, identity );
				

参数:

返回值:

void : 无

平台支持:

openFile

调用第三方程序打开指定的文件

void plus.runtime.openFile( filepath, options, errorCB );
				

参数:

返回值:

void : 无

平台支持:

示例:

<!DOCTYPE html>
<html>
	<head>
		<meta charset="utf-8">
		<title>Runtime Example</title>
		<script type="text/javascript">
// 扩展API加载完毕后调用onPlusReady回调函数
document.addEventListener( "plusready", onPlusReady, false );
// 扩展API加载完毕,现在可以正常调用扩展API
function onPlusReady() {

}
// 打开文件操作
function testFile() {
	plus.runtime.openFile( "_doc/a.pdf" );
}
		</script>
	</head>
	<body>
		<input type="button" value="Open File" onclick="testFile();"/>
	</body>
</html>
				

launchApplication

调用第三方程序

void plus.runtime.launchApplication( appInf, errorCB );
				

参数:

返回值:

void : 无

平台支持:

示例:

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Runtiem Example</title>
<script type="text/javascript">
// 扩展API加载完毕后调用onPlusReady回调函数
document.addEventListener( "plusready", onPlusReady, false );
// 扩展API加载完毕,现在可以正常调用扩展API
function onPlusReady() {

}
// 调用第三方程序
function launchTest() {
	if ( plus.os.name == "Android" ) {
		plus.runtime.launchApplication( {pname:"com.android.browser"
			,extra:{url:"http://www.html5plus.org"}}, function ( e ) {
				alert( "Open system default browser failed: " + e.message );
		} );
	} else if ( plus.os.name == "iOS" ) {
		plus.runtime.launchApplication( {action:"http://www.html5plus.org"}, function ( e ) {
			alert( "Open system default browser failed: " + e.message );
		} );
	}
}
</script>
</head>
<body>
<input type="button" value="Launch Application" onclick="launchTest();"/>
</body>
</html>
				

WidgetOption

JSON对象,应用安装参数

说明:

可通过对象设置安装的应用是否进行appid校验、版本号校验等。

属性:

WidgetInfo

JSON对象,应用信息

属性:

OpenFileOption

JSON对象,打开文件参数

属性:

ApplicationInf

JSON对象,打开第三方程序参数

属性:

InstallSuccessCallback

安装应用成功回调函数

void onSuccess(widgetInfo){
	// Code here
}
				

参数:

返回值:

void : 无

平台支持:

InstallErrorCallback

安装应用失败回调函数

void onError(error){
	// Handle the error
}
				

参数:

返回值:

void : 无

平台支持:

GetPropertyCallBack

获取应用属性成功回调函数

void onGetPropertyCB(widgetInfo){
	// Code here
}
				

参数:

返回值:

void : 无

平台支持:

示例:

<!DOCTYPE html>
<html>
	<head>
		<meta charset="UTF-8"/>
		<script type="text/javascript">
function onload() {
	var xmlHttp = new plus.net.XMLHttpRequest();
	if (xmlHttp!=null) {
		xmlhttp.onreadystatechange=state_Change;
		xmlHttp.open("GET", "note.xml");
		xmlHttp.send(null);
	}
	else {
		alert("Your runtime does not support XMLHTTP.");
	}
}

function state_Change() {
	if (xmlhttp.readyState==4) {
		// 4 = "loaded"
		if (xmlhttp.status==200) {
			// 200 = OK
			// ...our code here...
			alert(xmlhttp.responseText);
		}
		else {
			alert("Problem retrieving XML data");
		}
	}
}
		</script>
	</head>
	<body onload="onload();">
	</body>
</html>
				

OpenErrorCallback

打开本地文件或URL失败回调函数

void onError(error){
	// Handle the error
}
				

参数:

返回值:

void : 无

平台支持:

LaunchErrorCallback

调用第三方程序失败回调函数

void onError(error){
	// Handle the error
}
				

参数:

返回值:

void : 无

平台支持: