1.属性
appId
apiready = function () {var appId = api.appId; //比如: A6980386445546var appName = api.appName; //比如: AppLoadervar appVersion = api.appVersion; // 比如: 1.0.0var systemType = api.systemType; // 比如: iosvar systemVersion = api.systemVersion; // 比如: 8.0var deviceModel = api.deviceModel; // 比如: iPhone 5var operator = api.operator; // 比如:中国移动var connectionType = api.connectionType; //比如: wifivar fullScreen = api.fullScreen; // 比如: truevar screenWidth = api.screenWidth; // 比如: 640var screenHeight = api.screenHeight; // 比如: 960var winName = api.winName; //比如: rootvar winWidth = api.winWidth; // 比如: 320 此属性值不同于屏幕的分辨率,比如 iPhone 5 的分辨率为 640*1136,但是其 winWidth 为 320,因此前端需根据 winWidth 和 winHeight 来进行布局var winHeight = api.winHeight; // 比如: 568var frameName = api.frameName; //比如: trans-convar frameWidth = api.frameWidth; // 比如: 320,若当前环境为 window 中,则值和 winWidth 相同var frameHeight = api.frameHeight; // 比如: 504,若当前环境为 window 中,则值和 winHeight 相同var pageParam = api.pageParam; //比如: {"name" : "tans-con"} JSON用于获取页面间传递的参数值,为 openWin()、openFrame() 等方法中的 pageParam 参数对应值var wgtParam = api.wgtParam; //比如: {"name": "API Demo"},用于获取 widget 间传递的参数值,为 openWidget() 方法中的 wgtParam 参数对应值var appParam = api.appParam; // 比如: appLoader,当应用被第三方应用打开时,传递过来的参数,字符串类型var statusBarAppearance = api.statusBarAppearance; // 比如: true,当前应用状态栏是否支持沉浸式效果,布尔类型var wgtRootDir = api.wgtRootDir; //widget: //协议对应的真实目录,即 widget 网页包的根目录,字符串类型var fsDir = api.fsDir; //fs: //协议对应地真实目录,字符串类型var cacheDir = api.cacheDir; //cache://协议对应的真实目录,字符串类型}
2.常量
参考官方文档http://docs.apicloud.com/Client-API/api#c1
3.事件
apiready = function() {api.addEventListener({name: 'batterylow' // 设备电池电量低事件,字符串类型}, function(ret, err) {if (ret) {alert(JSON.stringify(ret));} else {alert(JSON.stringify(err));}});api.addEventListener({name: 'batterystatus' // 设备电池状态改变事件,如电量变化或正在充电,字符串类型}, function(ret, err) {if (ret) {alert(JSON.stringify(ret));} else {alert(JSON.stringify(err));}});// api.addEventListener({
// name: 'keyback' // 设备 back 键被点击事件,仅 Android 平台有效,字符串类型
// }, function(ret, err) {
// alert('按了返回键');
// });
//
// api.addEventListener({
// name: 'keymenu' // 设备 menu 键被点击事件,仅 Android 平台有效
// }, function(ret, err) {
// alert('按了菜单键');
// });
//
// api.addEventListener({
// name: 'volumeup' // 设备音量加键被点击事件,仅 Android 平台有效
// }, function(ret, err) {
// alert('按了音量加键');
// });api.addEventListener({name:'offline' // 断网了}, function(ret, err){alert('断网了');});api.addEventListener({name:'online' // 已经连上网络}, function(ret, err){alert('已连接到网络');});api.addEventListener({name:'scrolltobottom', // 滑动到最底事件extra:{threshold:0 //设置距离底部多少距离时触发,默认值为0,数字类型}}, function(ret, err){alert('已滚动到底部');});api.addEventListener({name:'shake' // 摇一摇}, function(ret, err){alert('触发了摇一摇事件');});// api.addEventListener({
// name:'swipedown'
// }, function(ret, err){
// alert('向下轻扫');
// });api.addEventListener({name:'swipeleft'}, function(ret, err){alert('向左轻扫');});api.addEventListener({name:'swiperight'}, function(ret, err){alert('向右轻扫');});// api.addEventListener({
// name:'swipeup'
// }, function(ret, err){
// alert('向上轻扫');
// });api.addEventListener({name:'tap'}, function(ret, err){alert('点击了页面');});api.addEventListener({name:'longpress'}, function(ret, err){alert('长按了页面');});// api.addEventListener({
// name:'viewappear'
// }, function(ret, err){
// alert('window显示');
// });}
4.方法
参考官方http://docs.apicloud.com/Client-API/api#c1