接口说明
目录
- 1. 初始化SDK
- 2. 配置说明
- 需要权限:
- 参数说明:
- 示例:
- 3. 调起第三方应用
- 需要权限:
- 参数说明:
- 示例:
- 4. 获取电池信息
- 需要权限:
- 参数说明:
- 返回参数说明:
- 示例:
- 5. 获取当前网络连接方式
- 需要权限:
- 参数说明:
- 返回参数说明:
- 示例:
- 6. 获取设备IMEI信息
- 需要权限:
- 参数说明:
- 返回参数说明:
- 示例:
- 7. 获取设备的系统版本信息
- 需要权限:
- 参数说明:
- 返回参数说明:
- 示例:
- 8. 获取设备的名称
- 需要权限:
- 参数说明:
- 返回参数说明:
- 示例:
- 9. 获取设备的屏幕分辨率
- 需要权限:
- 参数说明:
- 返回参数说明:
- 示例:
- 10. 获取当前GPS经纬度
- 需要权限:
- 参数说明:
- 返回参数说明:
- 示例:
- 11. 调取本地图库,选择图片
- 需要权限:
- 参数说明:
- 返回参数说明:
- 示例:
- 12. 启动二维码扫描与识别
- 需要权限:
- 参数说明:
- 返回参数说明:
- 示例:
- 13. 获取SSOTicket
- 需要权限:
- 参数说明:
- 返回参数说明:
- 示例:
- 14. 网络请求 POST
- 需要权限:
- 参数说明:
- 返回参数说明:
- 示例:
- 15. 网络请求 GET
- 需要权限:
- 参数说明:
- 返回参数说明:
- 示例:
- 16. 上传文件
- 需要权限:
- 参数说明:
- 返回参数说明:
- 示例:
- 17. 下载文件
- 需要权限:
- 参数说明:
- 返回参数说明:
- 示例:
- 18. 应用密码锁
- 需要权限:
- 描述:
- 参数说明:
- 返回参数说明:
- 示例:
- 19. 从组织架构选人
- 需要权限:
- 参数说明:
- 返回参数说明:
- 示例:
- 20. 从常用联系人选择人员
- 需要权限:
- 参数说明:
- 返回参数说明:
- 示例:
- 21. 打开门户通讯录
- 需要权限:
- 参数说明:
- 返回参数说明:
- 示例:
- 22. 本地存储数据操作
- 需要权限:
- 描述:
- 参数说明:
- 返回参数说明:
- 示例:
- 23. 设置标题背景颜色
- 需要权限:
- 参数说明:
- 返回参数说明:
- 示例:
- 24. 设置标题颜色
- 需要权限:
- 参数说明:
- 返回参数说明:
- 示例:
- 25. 设置标题内容
- 需要权限:
- 参数说明:
- 返回参数说明:
- 示例:
- 26. 关闭webView
- 需要权限:
- 参数说明:
- 返回参数说明:
- 示例:
- 27. 设置标题更多按钮
- 需要权限:
- 描述:
- 参数说明:
- 返回参数说明:
- 示例:
- 28. 获取指定ID人员的信息
- 需要权限:
- 参数说明:
- 返回参数说明:
- 示例:
- 29. 唤起指定ID的人员详情页
- 需要权限:
- 描述:
- 参数说明:
- 返回参数说明:
- 示例:
- 30. 获取指定ID部门的信息
- 需要权限:
- 参数说明:
- 返回参数说明:
- 示例:
- 31. 从组织架构选择部门
- 需要权限:
- 参数说明:
- 返回参数说明:
- 示例:
- 32. 图片浏览器
- 需要权限:
- 参数说明:
- 返回参数说明:
- 示例:
- 33. 获取个人信息
- 需要权限:
- 描述:
- 参数说明:
- 返回参数说明:
- 示例:
- 34. 分享
- 需要权限:
- 描述:
- 参数说明:
- 返回参数说明:
- 示例:
- 35. 打开安全键盘
- 需要权限:
- 描述:
- 参数说明:
- 返回参数说明:
- 示例:
- 36. 选择云文件
- 需要权限:
- 参数说明:
- 返回参数说明:
- 示例:
- 37. SSO单点登录
- 描述:
- 需要权限:
- 参数说明:
- 返回参数说明:
- 示例:
- 38. 注销当前登录账号
- 需要权限:
- 参数说明:
- 返回参数说明:
- 示例:
- 39. 设备类型判断
- 需要权限:
- 参数说明:
- 返回参数说明:
- 示例:
- 40. 调起其它轻应用并传参
- 需要权限:
- 参数说明:
- 返回参数说明:
- 示例:
- 41. 隐藏原生Title
- 需要权限:
- 参数说明:
- 返回参数说明:
- 示例:
- 42. 调起相机
- 需要权限:
- 参数说明:
- 返回参数说明:
- 示例:
1. 初始化SDK
需要权限:无
示例:
ns.ready();
2. 配置说明
需要权限:
LIGHT_USER_MESSAGE
参数说明:
参数 | 参数类型 | 必须 | 说明 |
push | Object | 客户端接收到推送消息时调用的方法 | |
intent | Object | 轻应用A调用轻应用B时,轻应用B用于接收处理轻应用A传递参数的方法。 | |
pluginInit | Object | 当客户端组件加载完毕后调用此方法 |
示例:
ns.ready({
“push”:function(msg){
// do something
},
“intent”:function(msg){
//do something
},
"pluginInit":function(){
userinfo();// 当客户端组件初始化完毕后调用此方法,获取当前用户信息
}
})
3. 调起第三方应用
ns.device.start
需要权限:
无
参数说明:
参数 | 参数类型 | 必须 | 说明 |
intent | string | 否 | Android:应用包名 |
URLScheme | string | 否 | IOS URLScheme |
onSuccess | object | 否 | 成功回调函数 |
onFail | object | 否 | 失败回调函数 |
示例:
ns.device.start({
"intent": "qq",
"URLScheme": "qq",
"onSuccess": function(msg) {
alert("成功" + JSON.stringify(msg));
},
"onFail": function(msg) {
alert("失败" + JSON.stringify(msg));
}
});
4. 获取电池信息
ns.device.getBatteryinfo
需要权限:
LIGHT_USER_BATTERTY
参数说明:
参数 | 参数类型 | 必须 | 说明 |
onSuccess | object | 否 | 成功回调函数 |
onFail | object | 否 | 失败回调函数 |
返回参数说明:
参数 | 说明 |
isPlugged | 是否处于充电状态 |
level | 现有电量0~1 |
示例:
ns.device.getBatteryinfo({
"onSuccess": function(msg) {
alert("成功" + JSON.stringify(msg));
},
"onFail": function(msg) {
alert("失败" + JSON.stringify(msg));
}
});
5. 获取当前网络连接方式
ns.device.getConnection
需要权限:
LIGHT_USER_WIFI
参数说明:
参数 | 参数类型 | 必须 | 说明 |
onSuccess | object | 否 | 成功回调函数 |
onFail | object | 否 | 失败回调函数 |
返回参数说明:
参数 | 说明 |
obj | 1. 代表未知;2. 代表WIFI;3. 代表移动网络; |
示例:
ns.device.getConnection({
"onSuccess": function(msg) {
alert("成功" + JSON.stringify(msg));
},
"onFail": function(msg) {
alert("失败" + JSON.stringify(msg));
}
});
6. 获取设备IMEI信息
ns.device.getDeviceImei
需要权限:
无
参数说明:
参数 | 参数类型 | 必须 | 说明 |
onSuccess | object | 否 | 成功回调函数 |
onFail | object | 否 | 失败回调函数 |
返回参数说明:
参数 | 说明 |
obj | 设备IEMI |
示例:
ns.device.getDeviceImei({
"onSuccess": function(msg) {
alert("成功" + JSON.stringify(msg));
},
"onFail": function(msg) {
alert("失败" + JSON.stringify(msg));
}
});
7. 获取设备的系统版本信息
ns.device.getDeviceSysVersion
需要权限:
无
参数说明:
参数 | 参数类型 | 必须 | 说明 |
onSuccess | object | 否 | 成功回调函数 |
onFail | object | 否 | 失败回调函数 |
返回参数说明:
参数 | 说明 |
obj | 设备系统版本 |
示例:
ns.device.getDeviceSysVersion({
"onSuccess": function(msg) {
alert("成功" + JSON.stringify(msg));
},
"onFail": function(msg) {
alert("失败" + JSON.stringify(msg));
}
});
8. 获取设备的名称
ns.device.getDeviceModelName
需要权限:
无
参数说明:
参数 | 参数类型 | 必须 | 说明 |
onSuccess | object | 否 | 成功回调函数 |
onFail | object | 否 | 失败回调函数 |
返回参数说明:
参数 | 说明 |
obj | 设备名称 |
示例:
ns.device.getDeviceModelName({
"onSuccess": function(msg) {
alert("成功" + JSON.stringify(msg));
},
"onFail": function(msg) {
alert("失败" + JSON.stringify(msg));
}
})
9. 获取设备的屏幕分辨率
ns.device.getScreenSize
需要权限:
无
参数说明:
参数 | 参数类型 | 必须 | 说明 |
onSuccess | object | 否 | 成功回调函数 |
onFail | object | 否 | 失败回调函数 |
返回参数说明:
参数 | 说明 |
heightPixels | 设备屏幕的高度(px) |
widthPixels | 设备屏幕的宽度(px) |
示例:
ns.device.getScreenSize({
"onSuccess": function(msg) {
alert("成功" + JSON.stringify(msg));
},
"onFail": function(msg) {
alert("失败" + JSON.stringify(msg));
}
});
10. 获取当前GPS经纬度
ns.device.location
需要权限:
LIGHT_USER_LOCATION
参数说明:
参数 | 参数类型 | 必须 | 说明 |
onSuccess | object | 否 | 成功回调函数 |
onFail | object | 否 | 失败回调函数 |
返回参数说明:
参数 | 说明 |
latitude | 纬度 |
lontitude | 经度 |
radius | 半径 |
time | 定位时间 |
示例:
ns.device.location({
"onSuccess": function(msg) {
alert("成功" + JSON.stringify(msg));
},
"onFail": function(msg) {
alert("失败" + JSON.stringify(msg));
}
});
11. 调取本地图库,选择图片
ns.device.imagePicker
需要权限:
LIGHT_USER_CAMERA LIGHT_USER_PIC
参数说明:
参数 | 参数类型 | 必须 | 说明 |
maxCount | string | 是 | 选取图片的最大数量 |
onSuccess | object | 否 | 成功回调函数 |
onFail | object | 否 | 失败回调函数 |
返回参数说明:
参数 | 类型 | 说明 |
obj | Array | 被选择图片的路径 |
示例:
ns.device.imagePicker({
"maxCount": "3",
"onSuccess": function(msg) {
alert("成功" + JSON.stringify(msg));
imgSrc = msg.obj[0];
},
"onFail": function(msg) {
alert("失败" + JSON.stringify(msg));
}
});
12. 启动二维码扫描与识别
ns.device.startCaptureQRCode
需要权限:
LIGHT_USER_SCAN
参数说明:
参数 | 参数类型 | 必须 | 说明 |
needResult | Boolean | 否 |
true:返回二维码信息; false:不返回二维码信息,门户内部处理; 默认false。 |
onSuccess | object | 否 | 成功回调函数(当needResult为true时调用) |
onFail | object | 否 | 失败回调函数 |
返回参数说明:
参数 | 说明 |
obj | 扫描获得的二维码信息 |
示例:
ns.device.startCaptureQRCode({
"needResult": true,
"onSuccess": function(msg) {
alert("成功" + JSON.stringify(msg));
},
"onFail": function(msg) {
alert("失败" + JSON.stringify(msg));
}
})
13. 获取SSOTicket
ns.runtime.appAuthorization
需要权限:
无
参数说明:
参数 | 参数类型 | 必须 | 说明 |
onSuccess | object | 否 | 成功回调函数 |
onFail | object | 否 | 失败回调函数 |
返回参数说明:
参数 | 说明 |
ssoTicket |
示例:
ns.runtime.appAuthorization({
"onSuccess": function(msg) {
alert("成功" + JSON.stringify(msg));
},
"onFail": function(msg) {
alert("失败" + JSON.stringify(msg));
}
})
14. 网络请求 POST
ns.runtime.networkPost
需要权限:
LIGHT_USER_NETWORK
参数说明:
参数 | 参数类型 | 必须 | 说明 |
Interface | string | 是 | 调取AppNest接口名 |
method | string | 是 | 调取AppNest服务名称 |
group | string | 否 | 调取AppNest组名称(默认””) |
isCompres | Boolean | 否 | 是否压缩(默认false) |
isSalt | Boolean | 否 | 是否加盐(默认false) |
encryptionType | string | 否 | 加密类型: 01 无加密 02 3des 03 rsa(默认01) |
Ishttps | string | 否 | 是否是https 请否 :01 http 02 单向https 03 双向https(默认02) |
targetUrl | string | 否 | 前置服务地址URL,默认空(使用门户内置的URL) |
isExternal | Boolean | 否 | 是否使用外部的targetUrl。默认false。当值为true时,targetUrl为必填项。 |
body | object | 是 | 请求接口需要的参数 |
onSuccess | object | 否 | 成功回调函数 |
onFail | object | 否 | 失败回调函数 |
返回参数说明:
参数 | 说明 |
obj | 请根据实际业务需求与后台开发人员商定 |
示例:
ns.runtime.networkPost({
"Interface": "com.nqsky.meap.api.notice.service.INoticeApiService",
"method": "findNoticeList",
"group": "",
"isCompres": false,
"isSalt": false,
"encryptionType": "01",
"Ishttps": "02",
"targetUrl": "http://192.168.1.153:8088/nqsky-meap-front/service.jws",
"body": {
"ssoTicket": ssoTicket,
"offset": 1,
"maxLength": 10
},
"onSuccess": function(msg) {
alert("网络请求返回:::" + JSON.stringify(msg));
},
"onFail": function(msg) {
alert("失败网络请求返回:::" + JSON.stringify(msg));
}
});
15. 网络请求 GET
ns.runtime.networkGet
需要权限:
LIGHT_USER_NETWORK
参数说明:
参数 | 参数类型 | 必须 | 说明 |
Interface | string | 是 | 调取AppNest接口名 |
method | string | 是 | 调取AppNest服务名称 |
group | string | 否 | 调取AppNest组名称(默认””) |
isCompres | Boolean | 否 | 是否压缩(默认false) |
isSalt | Boolean | 否 | 是否加盐(默认false) |
encryptionType | string | 否 | 加密类型: 01 无加密 02 3des 03 rsa(默认01) |
Ishttps | string | 否 | 是否是https 请否 :01 http 02 单向https 03 双向https(默认02) |
targetUrl | string | 否 | 前置服务地址URL,默认空(使用门户内置的URL) |
isExternal | Boolean | 否 | 是否使用外部的targetUrl。默认false。当值为true时,targetUrl为必填项。 |
body | object | 是 | 请求接口需要的参数 |
onSuccess | object | 否 | 成功回调函数 |
onFail | object | 否 | 失败回调函数 |
返回参数说明:
参数 | 说明 |
obj | 请根据实际业务需求与后台开发人员商定 |
示例:
ns.runtime.networkGet({
"Interface": "com.nqsky.meap.api.notice.service.INoticeApiService",
"method": "findNoticeList",
"group": "",
"isCompres": false,
"isSalt": false,
"encryptionType": "01",
"Ishttps": "02",
"targetUrl": "http://192.168.1.153:8088/nqsky-meap-front/service.jws",
"body": {
"ssoTicket": ssoTicket,
"offset": 1,
"maxLength": 10
},
"onSuccess": function(msg) {
alert("网络请求返回:::" + JSON.stringify(msg));
},
"onFail": function(msg) {
alert("失败网络请求返回:::" + JSON.stringify(msg));
}
});
16. 上传文件
ns.runtime.uploadFile
需要权限:
LIGHT_USER_FILE_UPLOAD
参数说明:
参数 | 参数类型 | 必须 | 说明 |
fileName | string | 否 | 上传文件的名字(默认””) |
filePath | string | 是 | 上传文件的完整路径 |
uploadCallBack | object | 否 | 上传进度回调函数。如果此文件已经在文件中心存在,则此方法获得的progress始终是0,请以onsuccess为最终依据 |
onSuccess | object | 否 | 成功回调函数 |
onFail | object | 否 | 失败回调函数 |
返回参数说明:
参数 | 说明 |
progress | uploadCallBack方法返回的实时进度 |
filePath | 上传文件的完整路径 |
fileToken | 上传文件在文件中心的fileToken |
* uploadCallBack返回的参数为字符串需要解析为JSON
示例:
ns.runtime.uploadFile({
"fileName": "测试文件",
"filePath": imgSrc, //调用本地图库方法获得imgSrc
"uploadCallBack": function(msg) {
var msg = JSON.parse(msg);
$('#progress').text(msg.progress);
},
"onSuccess": function(msg) {
alert("成功" + JSON.stringify(msg));
},
"onFail": function(msg) {
alert("失败" + JSON.stringify(msg));
}
});
17. 下载文件
ns.runtime.downloadFile
需要权限:
LIGHT_USER_FILE_DOWLOAD
参数说明:
参数 | 参数类型 | 必须 | 说明 |
url | string | 文件全链接路径。url与fileToken只能填写一个 | |
fileToken | string | 文件在文件中心的token。url与fileToken只能填写一个 | |
dowloadCallBack | object | 否 | 下载进度回调函数 |
onSuccess | object | 否 | 成功回调函数 |
onFail | object | 否 | 失败回调函数 |
返回参数说明:
参数 | 说明 |
progress | dowloadCallBack方法返回的实时进度 |
filePath | 下载文件的保存路径 |
* dowloadCallBack返回的参数为字符串需要解析为JSON
示例:
ns.runtime.downloadFile({
'url': 'http://dx2.7down.net/soft/V/vscodesetup.zip',
'dowloadCallBack': function(msg) {
var data = JSON.parse(msg);
$('#progress1').text(data.progress);
},
"onSuccess": function(msg) {
$('#progress').text('100%');
alert("成功" + JSON.stringify(msg));
},
"onFail": function(msg) {
alert("失败" + JSON.stringify(msg));
}
});
18. 应用密码锁
ns.runtime.showPasswordLock
需要权限:
LIGHT_USER_LOCK
描述:
调起客户端密码锁设置界面
参数说明:
参数 | 参数类型 | 必须 | 说明 |
无 |
返回参数说明:
参数 | 说明 |
无 |
示例:
ns.runtime.showPasswordLock();
19. 从组织架构选人
ns.runtime.contact
需要权限:
无
参数说明:
参数 | 参数类型 | 必须 | 说明 |
maxSelectNum | int | 否 | 最大选取数量(默认1) |
onSuccess | object | 否 | 成功回调函数 |
onFail | object | 否 | 失败回调函数 |
返回参数说明:
参数 | 说明 |
obj | 人员信息(数组) |
示例:
ns.runtime.contact({
"onSuccess": function(msg) {
alert("成功" + JSON.stringify(msg));
},
"onFail": function(msg) {
alert("失败" + JSON.stringify(msg));
}
})
20. 从常用联系人选择人员
ns.runtime.selectUserFromContact
需要权限:
LIGHT_USER_CONTACTS
参数说明:
参数 | 参数类型 | 必须 | 说明 |
maxSelectNum | int | 否 | 最大选取数量(默认1) |
onSuccess | object | 否 | 成功回调函数 |
onFail | object | 否 | 失败回调函数 |
返回参数说明:
参数 | 说明 |
obj | 人员信息(数组) |
示例:
ns.runtime.selectUserFromContact({
"onSuccess": function(msg) {
alert("成功" + JSON.stringify(msg));
},
"onFail": function(msg) {
alert("失败" + JSON.stringify(msg));
}
})
21. 打开门户通讯录
ns.runtime.addressBook
需要权限:
LIGHT_USER_CONTACTS
参数说明:
参数 | 参数类型 | 必须 | 说明 |
无 |
返回参数说明:
参数 | 说明 |
无 |
示例:
ns.runtime.addressBook();
22. 本地存储数据操作
ns.runtime.sharePerence
需要权限:
无
描述:
当opt值为get和remove时需要key参数,不需要value参数。当opt值为clear时,key、value均不需要。
参数说明:
参数 | 参数类型 | 必须 | 说明 |
opt | string | 是 | set:设置key:value; get:获取对应key的value; remove:删除对应key的value; clear:清空本地存储的数据(所有的keyValue) |
key | string | 否 | |
value | string | 否 | |
onSuccess | object | 否 | 成功回调函数 |
onFail | object | 否 | 失败回调函数 |
返回参数说明:
参数 | 说明 |
obj | 设置成功后返回 success |
示例:
ns.runtime.sharePerence({
"key": "name",
"value": "hyman",
"opt": "set",
"onSuccess": function(msg) {
alert("成功" + JSON.stringify(msg));
},
"onFail": function(msg) {
alert("失败" + JSON.stringify(msg));
}
})
23. 设置标题背景颜色
ns.runtime.setTitleBG
需要权限:
无
参数说明:
参数 | 参数类型 | 必须 | 说明 |
BGColor | string | 是 | 8位16进制颜色 |
onSuccess | object | 否 | 成功回调函数 |
onFail | object | 否 | 失败回调函数 |
返回参数说明:
参数 | 说明 |
obj | 设置成功后返回success |
示例:
ns.runtime.setTitleBG({
"BGColor": "#000000",
"onSuccess": function(msg) {
alert("成功" + JSON.stringify(msg));
},
"onFail": function(msg) {
alert("失败" + JSON.stringify(msg));
}
})
24. 设置标题颜色
ns.runtime.setTitleColor
需要权限:
无
参数说明:
参数 | 参数类型 | 必须 | 说明 |
titleColor | string | 是 | 8位16进制颜色 |
onSuccess | object | 否 | 成功回调函数 |
onFail | object | 否 | 失败回调函数 |
返回参数说明:
参数 | 说明 |
obj | 设置成功后返回success |
示例:
ns.runtime.setTitleColor({
"titleColor": "#FFFFFF",
"onSuccess": function(msg) {
alert("成功" + JSON.stringify(msg));
},
"oFail": function(msg) {
alert("失败" + JSON.stringify(msg));
}
})
25. 设置标题内容
ns.runtime.setTitle
需要权限:
无
参数说明:
参数 | 参数类型 | 必须 | 说明 |
title | string | 是 | 设置标题内容 |
onSuccess | object | 否 | 成功回调函数 |
onFail | object | 否 | 失败回调函数 |
返回参数说明:
参数 | 说明 |
obj | 设置成功后返回success |
示例:
ns.runtime.setTitle({
"title": "自定义标题",
"onSuccess": function(msg) {
alert("成功" + JSON.stringify(msg));
},
"onFail": function(msg) {
alert("失败" + JSON.stringify(msg));
}
})
26. 关闭webView
ns.runtime.closePage
需要权限:
无
参数说明:
参数 | 参数类型 | 必须 | 说明 |
无 |
返回参数说明:
参数 | 说明 |
无 |
示例:
ns.runtime.closePage();
27. 设置标题更多按钮
ns.runtime.menu
需要权限:
无
描述:
设置标题栏右侧按钮,分为两种情况。设置单一按钮时,请将items参数设置为空数组,此时用户点击按钮即触发methodFn方法。设置为菜单时,请将method、methodFn设置为空字符串,此时用户点击时会展开菜单,点击子菜单即会触发对应的items[index].methodFn方法。
参数说明:
参数 | 参数类型 | 必须 | 说明 |
method | string | 是 | 点击按钮时触发的方法名,可以为””。 |
methodFn | object | 是 | 点击按钮时触发的方法。可以为””。当method为空时,此方法不会触发。 |
name | string | 是 | 设置按钮的文字。 |
visible | Boolean | 是 | 设置按钮的可见状态 |
items | JSONArray | 是 | 设置子菜单中的按钮,可以为空[]。只有当method为空字符串时起作用。其每个值都是一个object(JSON)。items[index].method,items[index].methodFn,items[index].name可以参照上边的设置方式,但不可为空。当method和items同时不为空时,items的设置不起作用 |
onSuccess | object | 否 | 成功回调函数 |
onFail | object | 否 | 失败回调函数 |
返回参数说明:
参数 | 说明 |
obj | 设置成功后会返回success |
示例:
ns.runtime.menu({
'method': '',
'methodFn': function(data) {
alert("setM")
},
'name': '菜单',
'visible': 'true',
'items': [{
'method': 'children',
'methodFn': function() {
alert("1");
},
'name': '弹出1'
}, {
'method': 'item2',
'methodFn': function() {
alert("2")
},
'name': '弹出2'
}],
"onSuccess": function(msg) {
alert("成功" + JSON.stringify(msg));
},
"onFail": function(msg) {
alert("失败" + JSON.stringify(msg))
}
})
28. 获取指定ID人员的信息
ns.runtime.getUserInfoById
需要权限:
LIGHT_USER_READ
参数说明:
参数 | 参数类型 | 必须 | 说明 |
userID | string | 是 | 该员的ID |
onSuccess | object | 否 | 成功回调函数 |
onFail | object | 否 | 失败回调函数 |
返回参数说明:
参数 | 说明 |
obj | 该ID的人员信息 |
示例:
ns.runtime.getUserInfoById({
"userID": "",
"onSuccess": function(msg) {
alert("成功" + JSON.stringify(msg));
},
"onFail": function(msg) {
alert("失败" + JSON.stringify(msg))
}
})
29. 唤起指定ID的人员详情页
ns.runtime.showUserInfoById
需要权限:
LIGHT_USER_READ
描述:
直接打开指定ID人员在AppNest中的详情页
参数说明:
参数 | 参数类型 | 必须 | 说明 |
userID | string | 是 | 人员的ID |
onSuccess | object | 否 | 成功回调函数 |
onFail | object | 否 | 失败回调函数 |
返回参数说明:
参数 | 说明 |
obj | success |
示例:
ns.runtime.showUserInfoById({
"userID": "8aac34e6528bf5ba01529fbdecd909fd",//233阿里云服务器的
"onSuccess": function(msg) {
alert("成功" + JSON.stringify(msg));
},
"onFail": function(msg) {
alert("失败" + JSON.stringify(msg))
}
})
30. 获取指定ID部门的信息
ns.runtime.getDepartmentInfoById
需要权限:
LIGHT_USER_READ
参数说明:
参数 | 参数类型 | 必须 | 说明 |
teamID | string | 是 | 部门ID |
onSuccess | object | 否 | 成功回调函数 |
onFail | object | 否 | 失败回调函数 |
返回参数说明:
参数 | 说明 |
obj | 返回指定ID部门的信息 |
示例:
ns.runtime.getDepartmentInfoById({
"teamID": "",
"onSuccess": function(msg) {
alert("成功" + JSON.stringify(msg));
},
"onFail": function(msg) {
alert("失败" + JSON.stringify(msg))
}
})
31. 从组织架构选择部门
ns.runtime.selectDepartmentFromOrgan
需要权限:
无
参数说明:
参数 | 参数类型 | 必须 | 说明 |
maxSelectNum | int | 否 | 最大选取数量(默认1) |
onSuccess | object | 否 | 成功回调函数 |
onFail | object | 否 | 失败回调函数 |
返回参数说明:
参数 | 说明 |
obj | 返回选择的部门信息 |
示例:
ns.runtime.selectDepartmentFromOrgan({
"onSuccess": function(msg) {
alert("成功" + JSON.stringify(msg));
},
"onFail": function(msg) {
alert("失败" + JSON.stringify(msg))
}
})
32. 图片浏览器
ns.runtime.photoBorwser
需要权限:
无
参数说明:
参数 | 参数类型 | 必须 | 说明 |
urls | Array | 是 | 图片路径,可以是网络图片 |
isFullPath | boolean | 是 | 是否绝对路径 |
index | number | 是 | 从第几张图片开始展示,index从0开始计数。 |
onSuccess | object | 否 | 成功回调函数 |
onFail | object | 否 | 失败回调函数 |
返回参数说明:
参数 | 说明 |
obj | 设置成功后返回null |
示例:
ns.runtime.photoBorwser({
'urls':['/res/imgs/li_tag.png', '/res/imgs/slider2.png', '/res/pj_imgs/articl_one.jpg'],
'index': 2,
'isFullPath': false,
"onSuccess": function(msg) {
alert("成功" + JSON.stringify(msg));
},
"onFail": function(msg) {
alert("失败" + JSON.stringify(msg))
}
})
33. 获取个人信息
ns.runtime.userinfo
需要权限:
LIGHT_USER_BASE
描述:
获取当前登录账号的个人信息
参数说明:
参数 | 参数类型 | 必须 | 说明 |
onSuccess | object | 否 | 成功回调函数 |
onFail | object | 否 | 失败回调函数 |
返回参数说明:
参数 | 说明 |
obj | 返回当前登录账号的个人信息 |
示例:
ns.runtime.userinfo({
"onSuccess": function(msg) {
alert("成功" + JSON.stringify(msg));
},
"onFail": function(msg) {
alert("失败" + JSON.stringify(msg))
}
})
34. 分享
ns.runtime.share
需要权限:
无
描述:
当文章被设置分享的时候,在更多菜单按钮可以选择要分享到的平台
参数说明:
参数 | 参数类型 | 必须 | 说明 |
url | string | 是 | 分享的链接 |
title | string | 是 | 分享的标题 |
content | string | 是 | 分享的内容 |
image | string | 是 | 分享的图片地址(可以为空) |
onSuccess | object | 否 | 成功回调函数 |
onFail | object | 否 | 失败回调函数 |
返回参数说明:
参数 | 说明 |
obj | 分享成功后返回success |
示例:
ns.runtime.share({
"url": "http://www.baidu.com",
"title": "分享的标题",
"content": "分享的内容",
"image": "",
"onSuccess": function(msg) {
alert("成功" + JSON.stringify(msg));
},
"onFail": function(msg) {
alert("失败" + JSON.stringify(msg))
}
})
35. 打开安全键盘
ns.runtime.keyboard
需要权限:
无
描述:
调用内置键盘
参数说明:
参数 | 参数类型 | 必须 | 说明 |
callBack | object | 是 | 用于处理AppNest返回的用户输入数据的方法。返回用户输入的内容(上次+本次) |
onSuccess | object | 否 | 成功回调函数 |
onFail | object | 否 | 失败回调函数 |
返回参数说明:
参数 | 说明 |
obj | 用户点击完成按钮后一次性返回用户所输入的所有内容 |
示例:
ns.runtime.keyboard({
"callBack": function(msg) {
alert(msg);
},
"onSuccess": function(msg) {
alert("成功" + JSON.stringify(msg));
},
"onFail": function(msg) {
alert("失败" + JSON.stringify(msg))
}
})
36. 选择云文件
ns.runtime.selectDocuments
需要权限:
无
参数说明:
参数 | 参数类型 | 必须 | 说明 |
multiple | boolean | 是 | 是否多选(默认false) |
onSuccess | object | 否 | 成功回调函数 |
onFail | object | 否 | 失败回调函数 |
返回参数说明:
参数 | 说明 |
obj | 返回所选文件的信息fileToken,name,size |
示例:
ns.runtime.selectDocuments({
"multiple": true,
"onSuccess": function(msg) {
alert("成功" + JSON.stringify(msg));
},
"onFail": function(msg) {
alert("失败" + JSON.stringify(msg))
}
})
37. SSO单点登录
ns.runtime.login
描述:
检测当前当前登录账户ssoTicket是否失效,有效则直接返回当前登录用户信息;无效则调起账号登录浮层,登录后返回当前登录用户信息
需要权限:
无
参数说明:
参数 | 参数类型 | 必须 | 说明 |
onSuccess | object | 否 | 成功回调函数 |
onFail | object | 否 | 失败回调函数 |
返回参数说明:
参数 | 说明 |
obj | 返回当前登录用户的信息 |
示例:
function login() {
ns.runtime.login({
"onSuccess": function(msg) {
alert("成功" + JSON.stringify(msg));
},
"onFail": function(msg) {
alert("失败" + JSON.stringify(msg))
}
})
}
38. 注销当前登录账号
ns.runtime.loginout
需要权限:
无
参数说明:
参数 | 参数类型 | 必须 | 说明 |
onSuccess | object | 否 | 成功回调函数 |
onFail | object | 否 | 失败回调函数 |
返回参数说明:
参数 | 说明 |
obj | 登出成功 |
示例:
ns.runtime.loginout()
39. 设备类型判断
ns.android
ns.ios
需要权限:
无
参数说明:
参数 | 参数类型 | 必须 | 说明 |
无 |
返回参数说明:
参数 | 说明 |
boolean | 返回boolean |
示例:
ns.android
ns.ios
40. 调起其它轻应用并传参
ns.runtime.startLightApp
需要权限:
无
参数说明:
参数 | 参数类型 | 必须 | 说明 |
toKey | String | 否 | 指定的轻应用key,默认空 |
action | String | 否 | 指定的action,默认空 |
data | string | 是 | 需要传递的参数 |
onSuccess | Object | 否 | 成功回调函数 |
onFail | Object | 否 | 失败回调函数 |
* tokey与action至少传一个,两个参数同时传递时tokey优先判断。action的取值请参考《NQSky APPNEST客户端开发文档》的3.3.main.xml 文件详细说明。
返回参数说明:
参数 | 说明 |
obj | 成功或失败的信息 |
示例:
ns.runtime.startLightApp({
"toKey":”zq2LmkEtYxyGn1jR5s7dNEJj”,
"action":”abcde”,
"data":”这里填写要传递的参数”,
"onSuccess": function(msg) {
alert("成功" + JSON.stringify(msg));
},
"onFail": function(msg) {
alert("失败" + JSON.stringify(msg))
}
})
41. 隐藏原生Title
ns.runtime.hiddenNavBar
需要权限:
无
参数说明:
参数 | 参数类型 | 必须 | 说明 |
onSuccess | object | 否 | 成功回调函数 |
onFail | object | 否 | 失败回调函数 |
isHidden | Boolean | 是 |
返回参数说明:
参数 | 说明 |
obj | 成功或失败的信息 |
示例:
ns.runtime.hiddenNavBar({
"isHidden": true,
"onSuccess": function(msg) {
alert("成功:" + JSON.stringify(msg));
},
"onFail": function(msg) {
alert("失败" + JSON.stringify(msg))
}
});
42. 调起相机
ns.runtime.camera
需要权限:
LIGHT_USER_CAMERA
参数说明:
参数 | 参数类型 | 必须 | 说明 |
onSuccess | object | 否 | 成功回调函数 |
onFail | object | 否 | 失败回调函数 |
返回参数说明:
参数 | 说明 |
obj |
onSuccess返回图片保存地址 onFail返回错误描述 |
示例:
ns.runtime.camera({
"onSuccess": function(msg) {
alert("成功:" + JSON.stringify(msg));
},
"onFail": function(msg) {
alert("失败" + JSON.stringify(msg))
}
});