# [android]()
Native.js for Android封装一条通过JS语法直接调用Native Java接口通道,通过plus.android可调用几乎所有的系统API。
### 方法:
- [importClass](http://www.dcloud.io/docs/api/zh_cn/android.shtml#plus.android.importClass): 导入Java类对象
- [newObject](http://www.dcloud.io/docs/api/zh_cn/android.shtml#plus.android.newObject): 创建实例对象
- [getAttribute](http://www.dcloud.io/docs/api/zh_cn/android.shtml#plus.android.getAttribute): 获取对象(类对象/示例对象)的属性值
- [setAttribute](http://www.dcloud.io/docs/api/zh_cn/android.shtml#plus.android.setAttribute): 设置对象(类对象/示例对象)的属性值
- [invoke](http://www.dcloud.io/docs/api/zh_cn/android.shtml#plus.android.invoke): 调用对象(类对象/示例对象)的方法
- [implements](http://www.dcloud.io/docs/api/zh_cn/android.shtml#plus.android.implements): 实现Interface的方法
- [runtimeMainActivity](http://www.dcloud.io/docs/api/zh_cn/android.shtml#plus.android.runtimeMainActivity): 获取应用主Activity实例对象
- [currentWebview](http://www.dcloud.io/docs/api/zh_cn/android.shtml#plus.android.currentWebview): 获取当前Webview窗口对象的native层android.webkit.Webview实例对象
### 对象:
- [ClassObject](http://www.dcloud.io/docs/api/zh_cn/android.shtml#plus.android.ClassObject): Java类对象
- [InstanceObject](http://www.dcloud.io/docs/api/zh_cn/android.shtml#plus.android.InstanceObject): Java实例对象
### 权限:
permissions
~~~
"Invocation": {
"description": "Javascript桥"
}
~~~
# [importClass]()
导入Java类对象
~~~
ClassObject plus.android.importClass( String classname );
~~~
### 说明:
导入类对象后,就可以通过.操作符直接调用对象(类对象/示例对象)的常量和方法。 注意:导入类对象将会消耗较多的系统资源,通常不应该导入过多的类对象。
### 参数:
- classname: *( String ) 必选 *要导入的Java类名,使用"."分割命名空间
在类名中可以使用"*"来导入指定命名空间下的所有类对象; 如果指定的类名无效,则导入类对象失败;
### 返回值:
ClassObject : Java类对象,如果导入类对象失败则返回null。
### 示例:
~~~
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no"/>
<title>Android Native.js</title>
<script type="text/javascript">
// 监听plusready事件
document.addEventListener( "plusready", function(){
// 扩展API加载完毕,现在可以正常调用扩展API
// 导入android.content.Intent类对象
var Intent = plus.android.importClass("android.content.Intent");
// 导入后可以使用new方法创建类的示例对象
var intent=new Intent();
}, false );
</script>
</head>
<body>
</body>
</html>
~~~
# [newObject]()
创建实例对象
~~~
void plus.android.newObject( String classname, Object..args );
~~~
### 参数:
- classname: *( String ) 必选 *要创建实例对象的类名,使用"."分割命名空间
如果指定的类名不存在,则创建对象失败,不会抛出异常。
- args: *( Object ) 可选 *创建实例对象的构造参数
如果指定的构造参数类型不区配,则创建对象失败,不会抛出异常。
### 返回值:
InstanceObject : Android实例对象,如果创建对象失败则返回null。
### 示例:
~~~
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no"/>
<title>Android Native.js</title>
<script type="text/javascript">
// 监听plusready事件
document.addEventListener( "plusready", function(){
// 扩展API加载完毕,现在可以正常调用扩展API
// 直接创建android.content.Intent类的示例对象
var intent = plus.android.newObject("android.content.Intent");
}, false );
</script>
</head>
<body>
</body>
</html>
~~~
# [getAttribute]()
获取对象(类对象/示例对象)的属性值
~~~
Object plus.android.getAttribute( Object obj, String name );
~~~
### 参数:
- obj: *( Object ) 必选 *要获取属性值的对象,也可以是类的名称
如果obj为类对象,则获取的是类的静态属性值;如果obj为实例对象,则获取的是实例的属性值; 如果obj为字符串类型,其值必须是类的名称,则获取是类的静态属性值;
- name: *( String ) 必选 *要获取的属性名称
如果指定的属性名称不存在,则获取属性失败,不会抛出异常。
### 返回值:
Object : 属性值对象,如果获取属性失败则返回null。
### 示例:
~~~
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no"/>
<title>Android Native.js</title>
<script type="text/javascript">
// 监听plusready事件
document.addEventListener( "plusready", function(){
// 扩展API加载完毕,现在可以正常调用扩展API
// 通过以下方法获取内存信息
var Context = plus.android.importClass("android.content.Context");
var ActivityManager = plus.android.importClass("android.app.ActivityManager");
var mi = new ActivityManager.MemoryInfo();
var activityService = plus.android.runtimeMainActivity().getSystemService(Context.ACTIVITY_SERVICE);
activityService.getMemoryInfo(mi);
// 获取mi对象的availMem属性值
memoryInfo = plus.android.getAttribute(mi,"availMem");
}, false );
</script>
</head>
<body>
</body>
</html>
~~~
# [setAttribute]()
设置对象(类对象/示例对象)的属性值
~~~
void plus.android.setAttribute( Object obj, String name, Object value );
~~~
### 参数:
- obj: *( Object ) 必选 *要设置属性值的对象,也可以是类的名称
如果obj为类对象,则设置的是类的静态属性值;如果obj为实例对象,则设置的是实例的属性值; 如果obj为字符串类型,其值必须是类的名称,则设置是类的静态属性值;
- name: *( String ) 必选 *要设置的属性名称
如果指定的属性名称不存在,则操作不生效,不会抛出异常。
- value: *( Object ) 必选 *要设置的属性值
如果指定的属性值类型不区配,则操作不生效,不会抛出异常。
### 返回值:
void : 无
### 示例:
~~~
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no"/>
<title>Android Native.js</title>
<script type="text/javascript">
// 监听plusready事件
document.addEventListener( "plusready", function(){
// 扩展API加载完毕,现在可以正常调用扩展API
}, false );
</script>
</head>
<body>
</body>
</html>
~~~
# [invoke]()
调用对象(类对象/示例对象)的方法
~~~
Object plus.android.invoke( Object obj, String name, Object... args );
~~~
### 参数:
- obj: *( Object ) 必选 *调用方法所属的对象,也可以是类的名称
如果obj为类对象,则调用的是类的静态方法;如果obj为实例对象,则调用的是实例的方法; 如果obj为字符串类型,其值必须是类的名称,则调用的是类的静态方法;
- name: *( String ) 必选 *要调用的方法名称
方法名称中使用":"分隔参数。 如果指定的方法名称不存在,则调用方法失败,不会抛出异常。
- args: *( Object ) 可选 *调用方法的参数
如果指定的参数数目或类型不区配,则调用方法失败,不会抛出异常。
### 返回值:
Object : 调用方法的返回值,如果调用方法失败,则返回undefined。
### 示例:
~~~
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no"/>
<title>Android Native.js</title>
<script type="text/javascript">
// 监听plusready事件
document.addEventListener( "plusready", function(){
// 扩展API加载完毕,现在可以正常调用扩展API
// 调用native API弹出提示框
// 由于Builder类是android.app.AlertDialog类的内部类,这里需要使用$符号分割
var dlg = plus.android.newObject("android.app.AlertDialog$Builder",mainActivity);
// 设置提示框标题
plus.android.invoke(dlg,"setTitle","自定义标题");
// 设置提示框内容
plus.android.invoke(dlg,"setMessage","使用NJS的原生弹出框,可自定义弹出框的标题、按钮");
// 设置提示框按钮
plus.android.invoke(dlg,"setPositiveButton","确定(或者其他字符)",null);
// 显示提示框
plus.android.invoke(dlg,"show");
}, false );
</script>
</head>
<body>
</body>
</html>
~~~
# [implements]()
实现Interface的方法
~~~
Object plus.android.implements( String name, Object obj );
~~~
### 参数:
- name: *( String ) 必选 *Interface的名称,也可以是自定的字符串名称
如果name为自定的字符串名称,则自定义一个Interface;
- obj: *( Object ) 必选 *JSON对象类型,Interface实现方法的定义
JSON对象中key值为Interface方法的名称;value值为Function。
### 返回值:
InstanceObject : Interface实例对象。
### 示例:
~~~
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no"/>
<title>Android Native.js</title>
<script type="text/javascript">
// 监听plusready事件
document.addEventListener( "plusready", function(){
// 扩展API加载完毕,现在可以正常调用扩展API
}, false );
</script>
</head>
<body>
</body>
</html>
~~~
# [runtimeMainActivity]()
获取应用主Activity实例对象
~~~
InstanceObject plus.android.runtimeMainActivity();
~~~
### 参数:
无
### 返回值:
InstanceObject : 主Activity实例对象。
### 示例:
~~~
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no"/>
<title>Android Native.js</title>
<script type="text/javascript">
// 监听plusready事件
document.addEventListener( "plusready", function(){
// 扩展API加载完毕,现在可以正常调用扩展API
// 获取应用主Activity实例对象
var main = plus.android.runtimeMainActivity();
}, false );
</script>
</head>
<body>
</body>
</html>
~~~
# [currentWebview]()
获取当前Webview窗口对象的native层android.webkit.Webview实例对象
~~~
InstanceObject plus.android.currentWebview();
~~~
### 参数:
无
### 返回值:
InstanceObject : Webview窗口对象的native层android.webkit.Webview实例对象,如果调用方法失败,则返回null。
### 示例:
~~~
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no"/>
<title>iOS Javascript Bridge</title>
<script type="text/javascript">
var nwv=null;
// 监听plusready事件
document.addEventListener( "plusready", function(){
// 扩展API加载完毕,现在可以正常调用扩展API
// 获取当前Webview窗口对象的native层实例对象
nwv = plus.android.currentWebview();
}, false );
</script>
</head>
<body>
</body>
</html>
~~~
# [ClassObject]()
Java类对象
~~~
interface ClassObject {
// ...
function Object plusGetAttribute( String name );
function Object plusSetAttribute( String name, Object value );
// ...
}
~~~
### 说明:
Java类对象,可通过其属性获取类的常量,可通过方法来操作类的静态变量和方法,也通过new方法来创建类的实例对象。 对于类的常量,则直接通过.后面跟随常量名称调用即可。
### 方法:
- [plusGetAttribute](http://www.dcloud.io/docs/api/zh_cn/android.shtml#plus.android.ClassObject.plusGetAttribute): 获取Java类对象的静态属性
- [plusSetAttribute](http://www.dcloud.io/docs/api/zh_cn/android.shtml#plus.android.ClassObject.plusSetAttribute): 设置Java类对象的静态属性
# [plusGetAttribute]()
获取Java类对象的静态属性
~~~
Object clsobj.plusGetAttribute( String name );
~~~
### 参数:
- name: *( String ) 必选 *要获取的静态属性名称
如果指定的属性名称不存在,则返回null。
### 返回值:
Object : 静态属性实例对象
### 示例:
~~~
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no"/>
<title>Android Native.js</title>
<script type="text/javascript">
// 监听plusready事件
document.addEventListener( "plusready", function(){
// 扩展API加载完毕,现在可以正常调用扩展API
}, false );
</script>
</head>
<body>
</body>
</html>
~~~
# [plusSetAttribute]()
设置Java类对象的静态属性
~~~
void clsobj.plusSetAttribute( String name, Object value );
~~~
### 参数:
- name: *( String ) 必选 *要设置的静态属性名称
如果指定的属性名称不存在,则操作不生效,不会抛出异常。
- value: *( Object ) 必选 *要设置的静态属性值
如果指定的属性值类型不区配,则操作不生效,不会抛出异常。
### 返回值:
void : 无
### 示例:
~~~
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no"/>
<title>Android Native.js</title>
<script type="text/javascript">
// 监听plusready事件
document.addEventListener( "plusready", function(){
// 扩展API加载完毕,现在可以正常调用扩展API
}, false );
</script>
</head>
<body>
</body>
</html>
~~~
# [InstanceObject]()
Java实例对象
~~~
interface InstanceObject {
// ...
function Object plusGetAttribute( String name );
function Object plusSetAttribute( String name, Object value );
// ...
}
~~~
### 说明:
Java实例对象,可通过其方法来操作示例的变量和方法。 注意:必须通过plusGetAttribute()方法读取示例对象的属性值,通过plusSetAttribute()方法设置示例对象的属性值。
### 方法:
- [plusGetAttribute](http://www.dcloud.io/docs/api/zh_cn/android.shtml#plus.android.InstanceObject.plusGetAttribute): 获取Java实例对象的属性
- [plusSetAttribute](http://www.dcloud.io/docs/api/zh_cn/android.shtml#plus.android.InstanceObject.plusSetAttribute): 设置Java示例对象的属性
# [plusGetAttribute]()
获取Java实例对象的属性
~~~
Object insobj.plusGetAttribute( String name );
~~~
### 参数:
- name: *( String ) 必选 *实例属性的名称
如果指定的属性名称不存在,则返回null。
### 返回值:
Object : 属性的实例对象
### 示例:
~~~
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no"/>
<title>Android Native.js</title>
<script type="text/javascript">
// 监听plusready事件
document.addEventListener( "plusready", function(){
// 扩展API加载完毕,现在可以正常调用扩展API
}, false );
</script>
</head>
<body>
</body>
</html>
~~~
# [plusSetAttribute]()
设置Java示例对象的属性
~~~
void insobj.plusSetAttribute( String name, Object value );
~~~
### 参数:
- name: *( String ) 必选 *要设置的属性名称
如果指定的属性名称不存在,则操作不生效,不会抛出异常。
- value: *( Object ) 必选 *要设置的属性值
如果指定的属性值类型不区配,则操作不生效,不会抛出异常。
### 返回值:
void : 无
### 示例:
~~~
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8"/>
<meta name="viewport" content="initial-scale=1.0, maximum-scale=1.0, user-scalable=no"/>
<title>Android Native.js</title>
<script type="text/javascript">
// 监听plusready事件
document.addEventListener( "plusready", function(){
// 扩展API加载完毕,现在可以正常调用扩展API
}, false );
</script>
</head>
<body>
</body>
</html>
~~~
- API参考
- Accelerometer
- Audio
- Camera
- Contacts
- Device
- Downloader
- Events
- Gallery
- Geolocation
- IO
- Key
- Messaging
- NativeUI
- Navigator
- Orientation
- Proximity
- SplashScreen
- Storage
- UI
- Uploader
- InterfaceOrientation
- Runtime
- WebView
- XMLHttpRequest
- Zip
- Plugins
- Barcode
- Maps
- Payment
- Push
- Share
- Speech
- Statistic
- Native.js
- Android
- iOS