【APICloud.com】B01、API 对象【持续更新】
2016-07-31 19:24:42 0 举报AI智能生成
资料来自：http://docs.apicloud.com/Client-API/api
作者其他创作
大纲/内容
【APICloud.com】B01、API 对象
1、Attribute【变量，28个】
app 前缀【3个】
appId【应用的 ID，字符串】
appName【应用在桌面显示名称，字符串】
appVesion【应用版本号，字符串】
system 前缀（2个）
systemType【手机终端的系统类型，字符串】
systemVersion【手机平台的系统版本，字符串】
device 前缀（4个）
deviceId【用户设备的唯一标识，字符串】
deviceToken【iOS 中用于推送的 Token，若未从系统获取到则返回空字符串，字符串】
deviceModel【用户设备的型号（手机型号），字符串】
deviceName【用户设备的名称（用户手机名称），字符串】
screen 前缀（2个）
screenWidth【屏幕分辨率的宽度，数字】
screenHeight【屏幕分辨率的高度，数字】
win 前缀（3个）
winName【当前 window 名称，字符串】
winWidth【当前 window 宽度，数字】
winHeight【当前 window 高度，数字】
frame 前缀（3个）
frameName【frame 名称，字符串】
frameWidth【fram 宽度，数字】
frameHeight【frame 高度，数字】
无前缀（5个）
version【APICloud 解析引擎的版本信息，字符串】
fullScreen【应用是否全屏（iOS 专属），布尔类型】
connectionType【当前网络连接类型（2g、3g、4g、wifi），字符串】
operator【用户设备中sim卡的运营商名称，若未获取到则返回 none，字符串】
statusBarAppearance【当前应用状态栏是否支持沉浸式效果，布尔】
Param 后缀（3个）
pageParam【页面参数，用于获取页面间传递的参数值，为 openWin()、openFrame() 等方法中的 pageParam 参数对应值，JSON】
wgtParam【widget 参数，用于获取 widget 间传递的参数值，为 openWidget() 方法中的 wgtParam 参数对应值，JSON】
appParam【当应用被第三方应用打开时，传递过来的参数，字符串】
Dir 后缀（3个）
wgtRootDir【widget: //协议对应的真实目录，即 widget 网页包的根目录，字符串】
fsDir【fs: //协议对应地真实目录，字符串】
cacheDir【cache://协议对应的真实目录，字符串】
2、Constant【常量，27个】
toast 位置【字符串，用于 toast() 方法中 location 字段】
传感器类型【字符串，用于 startSensor() 方法中 type 字段】
错误码【数字】
电话类型【字符串，用于 call() 方法中 type 字段】
定位精度【字符串，根据需要来选择适当的精度来进行定位，用于 startLocation() 方法中 accuracy 字段】
动画类型【字符串，打开 window 或打开 widget 时的动画类型，Android 部分动画不支持】
动画曲线类型【字符串，指定动画开始和结束时的快慢，用于 animation() 方法中 curve 字段】
动画子类型【字符串，部分动画如 fade 可能没有过渡方向】
拾取器类型【字符串，用于 openPicker() 方法中 type 字段】
网络类型【字符串，用于 connectionType 属性】
文件操作错误码【数字，指定 readFile()、writeFile() 方法返回错误时的错误类型】
系统类型【字符串，用于 systemType 属性】
下载状态【数字，用于 download() 方法返回值中的 state 字段】
状态栏样式【字符串，用于 setStatusBarStyle() 方法中 style 字段】
屏幕旋转方向【字符串，指定屏幕旋转到特定方向，或根据重力感应自动旋转，用于 setScreenOrientation() 方法中 orientation 字段】
键盘弹出页面调整方式【字符串，指定键盘弹出时，页面如何调整其内容】
缓存策略【字符串，用于 imageCache() 方法中的 policy 字段】
用于 ajax 方法【4个】
上传状态【数字，用于 ajax() 方法上传文件时返回值中的 status 字段】
异步请求方法类型【字符串，用于 ajax() 方法中 method 字段】
异步请求错误类型【数字，用于 ajax() 方法返回错误时的 code 字段】
异步请求返回数据类型【字符串，用于 ajax() 方法中 dataType 字段】
用于 getPicture() 方法【4个】
图片源类型【字符串，用于 getPicture() 方法中 sourceType 字段】
图片编码类型【字符串，用于 getPicture() 方法中 encodingType 字段】
图片数据格式【字符串，用于 getPicture() 方法中 destinationType 字段】
媒体类型【字符串，用于 getPicture() 方法中 mediaValue 字段】
用于 showProgress() 方法【2个】
进度提示框动画类型【字符串，用于 showProgress() 方法中 animationType 字段】
进度提示框风格【字符串，用于 showProgress() 方法中 style 字段】
3、Event【事件异步函数，25个】
前台或后台事件【2个】
pause【应用进入后台事件，字符串】
resume【应用从后台回到前台事件，字符串】
用户触摸事件【7个】
swipe 前缀【4个】
swipeleft【Window 或者 Frame 的页面全局向左轻扫事件，字符串】
swipeup【Window 或者 Frame 的页面全局向上轻扫事件，字符串】
swiperight【Window 或者 Frame 的页面全局向右轻扫事件，字符串】
swipedown【Window 或者 Frame 的页面全局向下轻扫事件，字符串】
tap【Window 或者 Frame 的页面全局单击事件。监听该事件后，点击 window 或者 frame 的任意位置，都将收到 tap 回调，字符串】
scrolltobottom【Window 或者 Frame 页面滑动到底部事件，可用于实现滚动到底部，加载更多功能，字符串】
longpress【Window 或者 Frame 的页面全局长按事件，字符串】
云修复事件【1个】
smartupdatefinish【云修复使用静默修复时，更新完毕事件。可通过监听此事件来通知用户做是否强制重启应用等操作或者提示，以使更新生效如果是提示修复，则不会触发该事件，字符串】
启动页事件【1个】
launchviewclicked【启动页被用户点击后的回调，字符串】
电池事件【2个】
battery 前缀【2个】
batterylow【设备电池电量低事件，字符串】
batterystatus【设备电池状态改变事件，如电量变化或正在充电，字符串】
状态栏事件【1个】
noticeclicked【状态栏通知被用户点击后的回调，字符串】
应用调用事件【1个】
appintent【本应用被其他应用调起来时（Android 平台也可以通过 Activity 打开），收到相关数据的回调在任意页面中注册该监听后，如果本应用被其他应用调起，将触发该监听函数，同时将传给该应用的数据回调给网页，字符串】
网络事件【2个】
line 后缀【2个】
offline【监听设备断开网络的事件，字符串】
online【监听设备连接到网络的事件，字符串】
按键事件【4个】
volume 前缀【2个】
volumeup【设备音量加键被点击事件，仅 Android 平台有效，该事件必须在 Window 中注册才有效，Frame 中注册无效，并且只在当前屏幕上的 window 才能收到回调，字符串】
volumedown【设备音量减键被点击事件，仅 Android 平台有效，该事件必须在 Window 中注册才有效，Frame 中注册无效，并且只在当前屏幕上的 window 才能收到回调，字符串】
key 前缀【2个】
keyback【设备 back 键被点击事件，仅 Android 平台有效，该事件必须在 Window 中注册才有效，Frame 中注册无效，并且只在当前屏幕上的 window 才能收到回调，字符串】
keymenu【设备 menu 键被点击事件，仅 Android 平台有效，该事件必须在 Window 中注册才有效，Frame 中注册无效，并且只在当前屏幕上的 window 才能收到回调，字符串】
用户行为事件【2个】
takescreenshot【应用在前台运行期间，用户屏幕截图事件（比如同时按下了 home 键和电源键），只支持 iOS。】
shake【设备摇动事件，设置该监听后，当前 APP 将立即开启摇动检测功能，可用于实现摇一摇功能，字符串】
Window 事件【2个】
view 前缀【2个】
viewappear【Window 显示到屏幕的事件。收到 viewappear 事件回调，即标识当前 Window 已经动画结束，并且完全显示到屏幕上。该事件的作用对象为 Window，Frame 的显示不会收到事件，字符串】
viewdisappear【Window 离开屏幕的事件。收到 viewdisappear 事件回调，即标识当前 Window 已经动画结束，并且完全从屏幕上移除。该事件的作用对象为 Window，Frame 的隐藏不会收到事件。若是 Window 被关闭，此事件不会再回调，字符串】
4、Method【构造函数】
窗口系统【28个】
execScript【在指定 window 或者 frame 中执行脚本，对于 frameGroup 里面的 frame 也有效，若 name 和 frameName 都未指定，则在当前 window 中执行脚本，具体执行逻辑见补充说明。】
removeLaunchView【移除启动图】
parseTapmode【解析元素 tapmode 属性，优化点击事件处理】
window【4个，Win 标识】
openWin【打开 window】
closeToWin【关闭到指定 window】
closeWin【关闭 window】
setWinAttr【设置 window 属性】
frame【7个，Frame 标识】
openFrame【打开 frame】
closeFrame【关闭 frame】
setFrameAttr【设置 frame 属性】
bringFrameToFront【调整 frame 到前面】
sendFrameToBack【调整 frame 到后面】
setFrameClient【设置指定 frame 的页面加载监听，仅在 window 中调用生效，可以对多个 frame 进行监听。】
animation【frame 动画，支持平移，缩放，旋转和透明度变化仅支持 frame，不支持 window 以及 frameGroup 里面的 frame】
frame 组【4个，FrameGroup 标识】
setFrameGroupIndex【设置 frame 组当前可见 frame】
setFrameGroupAttr【设置 frame 组的属性】
closeFrameGroup【关闭 frame 组】
openFrameGroup【打开 frame 组】
ipad 专属【2个，Popover 标识】
closePopoverWin【关闭整个弹出层窗口，只 iPad 上面有效】
openPopoverWin【iPad 上面打开弹出层窗口，弹出层从底部往上弹出，然后显示在屏幕中间一片指定区域，周围为黑色半透明，只 iPad 上面有效】
侧滑式【5个，Slid 标识】
openSlidLayout【打开侧滑式布局】
openSlidPane【向左或右进行侧滑】
closeSlidPane【当 SlidPane 处于左或右侧滑状态时，将其收起】
lockSlidPane【锁住 SlidPane，使其不能跟随手指滑动而移动】
unlockSlidPane【解锁 SlidPane，使其能跟随手指滑动而移动】
抽屉式【3个，Drawer 标识】
openDrawerLayout【打开一个抽屉式侧滑 window，可以从当前 window 的左右边缘滑动拉出侧滑 window】
openDrawerPane【打开抽屉式侧滑 Pane】
closeDrawerPane【关闭抽屉式侧滑 Pane】
应用管理【7个】
installApp【安装应用，如果是苹果的AppStore应用地址，将会跳转到AppStore应用详情页面】
uninstallApp【卸载应用，只支持Android】
openApp【打开手机上其它应用，可以传递参数】
appInstalled【判断设备上面是否已安装指定应用】
rebootApp【重启应用，云修复完成后可以调用此方法来重启应用使云修复生效。】
openWidget【打开 Widget，若此 widget 已经被打开，则会把其调整到最前面显示】
closeWidget【关闭指定 widget】
网络通信【5个】
ajax【跨域异步请求，支持文件上传】
cancelAjax【取消异步请求】
download【下载文件】
cancelDownload【取消文件下载】
imageCache【图片缓存】
数据存储【9个】
readFile【读取文本文件内容，只支持 utf-8 编码文本类型文件】
writeFile【写入内容到文本文件】
setPrefs【设置偏好数据】
getPrefs【获取偏好设置值】
removePrefs【删除偏好设置值】
clearCache【清除缓存，包括下载的文件、拍照临时文件、网页缓存文件等，清除时可能需要消耗一定时间。】
getCacheSize【获取缓存占用空间大小，缓存包括下载的缓存文件、拍照临时文件以及网页缓存文件等，计算可能需要花费一些时间】
getFreeDiskSpace【获取剩余存储空间大小】
loadSecurevalue【从加密的 key.xml 文件中读取指定数据】
消息事件【6个】
设备访问【17个】
UI 组件【12个】
多媒体【7个】
WebApp 历史【2个】
historyForward【历史记录前进一页】
historyBack【历史记录后退一页】
其他【2个】
pageUp
pageDown
收藏
收藏
0 条评论
回复 删除
下一页
