APICLOUD文档阅读记录(备忘) 　
View on GitHub wznonstop

APICLOUD文档阅读记录(备忘)

APICLOUD文档阅读记录(备忘)

昨天下午把APIcloud的api对象相关的文档全部看完了，180个，居然一下午看完了，我觉得这个很棒啊。下面是昨天记的笔记，就是一些梗概之类。

＃窗口系统：

  1. openWin

打开新窗口，包括新窗口的名字，url，请求等，以及是否弹动，页面切换动画，背景，滚动条是否显示，是否可滚动，点击上否能否回到顶部，能否缩放，滑动返回前页等，还有进度条，延迟，重新加载，是否允许编辑，以及出现键盘相关的情况，还有下拉刷新组件。

  1. closeWin

关闭窗口的名称，关闭的动画。

  1. closeToWin

关闭到指定的窗口，从最上方窗口关闭到指定的name的窗口，中间的窗口都会被关闭。

  1. setWinAttr

设置页面属性，openWin中设置的包含了这里能设置的。

  1. openFrame

理解成打开一个iframe，如果之前已存在，则显示到最前面，可能出现刷新，参数与openWin类似，多了一个rect，用来设置frame的位置大小等属性。

  1. closeFrame

参照closeWin，默认关闭当前frame，但是api中未描述关闭动画。

  1. setFrameAttr

设置frame的属性，被包含于openFrame的属性中。

  1. bringFrameToFront

把frame调整到指定的frame前面，参数from是要调整的frame的名字，to是调到的那个页面的前面。

  1. bringFrameToBack

与bringFrameToFront对应

  1. setFrameClient

指定frame页加监听，frame加载状态等回调

  1. animation

仅支持frame，参数有frame的名称，延迟，持续时间，动画曲线类型，重复次数，是否自动反转动画，整个页面透明度，位置平移，缩放，旋转，动画结束后的回调。

  1. openFrameGroup

打开后，当前页加载完成后，会预加载后面的制定个数页面。参数为frame组名，背景，frame组能否左右滚动，rect即大小位置等，index，预加载的frame个数，frames即frame(openFrame)组成的数组，当前显示的frame变化时的回调。

  1. closeFrameGroup

关闭frame组，参数只有组名name。

  1. setFrameGroupAttr

设置frame组属性，参数为名字，frame组是否隐藏，能否左右滚动，位置大小等。

  1. setFrameGroupIndex

frame组名，index，是否平滑滚动至目标窗口，是否刷新。

  1. openPopoverWin

iPad上的模态窗口，简单粗暴理解成alert，但是这里面相当于一个全新的窗口环境，只是不能再弹一个这种窗口，window和frame都可以用。参数跟openWin类似。

  1. closePopoverWin

关闭弹层。

  1. openSlidLayout

打开侧滑式布局，技巧：

关闭整个侧滑布局：api.closeWin({ name: ’slidLayout’})

把整个侧滑显示到最前面：api.openWin({ name: ‘slidLayout’})

参数：侧滑类型（左右等）；

侧滑样式：停留时露出的宽度，移动时缩放的最小倍数；

底部固定窗口样式：宽度、缩放、遮罩背景等；

底部固定层窗口，内部参数参照openWin；

侧滑窗口，内部参数参照openWin；

开始侧滑时的回调。

  1. openSlidPane

向左或向右进行侧滑，参数即指定侧滑类型（左或右）。

  1. closeSlidPane

当slidePane处于侧滑状态时，将其收起。

  1. lockSlidPane

锁住slidPane。

  1. unlockSlidPane

解锁。

  1. openDrawerLayout

打开一个抽屉式侧滑布局，比openWIn参数多了leftPane，rightPane，这两个的内部参数与openWin差不多，多了一个edge，为打开侧滑后露出的半透明区域的宽度。

  1. openDrawerPane

打开抽屉式侧滑，类似openSlidPane

  1. closeDrawerPane

关闭抽屉式侧滑

  1. execScript

在指定window或frame中执行脚本。

  1. historyBack

历史记录后退一页，参数指定frame名称，回调显示后退是否成功。

  1. historyForward

历史记录前进一页，参数同historyBack

  1. pageUp

页面向上滚动一页，参数：是否直接滚到顶部，回调返回是否滚动了

  1. pageDown

与pageUp对应，参数里是是否直接滚动到底部，回调一样

  1. removeLaunchView

移除启动图，参数：动画。

  1. parseTapmode

解析元素tapmode属性，优化点击事件处理，默认页面加载完成后，dom就被解析了，之后用代码创建的dom，要用该方法后tapmode属性才生效。

＃应用管理：

  1. installApp 安装应用，参数为安装地址

  2. uninstallApp 卸载应用，参数为包名

  3. openApp 打开手机上的其他应用，可以传递参数，回调为目标应用关闭后的返回值

  4. appInstalled 判断设备上是否已安装指定应用，有参数和回调

  5. rebootApp 重启应用，云修复完成后调用此方法使云修复生效

  6. openWidget 打开widget，若已打开，则调整到最前显示，参数：widget的id,路径，动画，回调等。

  7. closeWidget 与openWidget对应

＃网络通信：

  1. ajax 跨域异步请求，支持文件上传

  2. cancelAjax 取消指定异步请求

  3. download 下载文件

  4. cancelDownload 取消指定的下载

  5. imageCache 图片缓存

数据存储：

  1. readFile 读取文本文件内容，utf-8编码only，有回调

  2. writeFile 写内容到文本中，有回调

  3. setPrefs 设置偏好设置

  4. getPrefs 获取偏好设置值

  5. removePrefs 移除偏好值

  6. clearCache 清除缓存，下载文件，零时文件等，可选时间，有回调

  7. getCacheSize 获取缓存占用大小，计算需要时间，有回调

  8. getFreeDiskSpace 获取剩余存储空间大小，有回调

  9. loadSecureValue 从加密文件中读取指定数据

消息事件：

  1. addEventListener 监听事件，包括系统和自定义

  2. removeEventListener 移除监听

  3. sendEvent 将任意一个自定义事件广播出去，任意页面均可监听到

  4. accessNative js向原生发送消息

  5. notification 向用户发出各种消息提醒

  6. cancelNotification 取消指定的提醒

设备访问：

  1. startLocation 调用系统自带定位功能，开始定位。参数：精度，位置更新所需最小距离，自动停止定位，有回调 （安卓用baiduLocation）

  2. stopLocation 停止定位

  3. getLocation 获取位置信息

  4. startSensor 开启传感器

  5. stopSensor 停止传感器

  6. call 拨打电话或face time，参数为类型和号码

  7. sms 调用系统短信界面发送短信，或后台直接发短信。参数为号码，内容等，有回调。

  8. mail 发邮件，参数为收件人，主题，内容，附件地址等，有回调。

  9. openContacts 在应用内打开系统通讯录界面选择联系人，有回调

  10. setFullScreen 设置是否全屏

  11. setStatusBarStyle 设置状态栏样式

  12. setScreenOrientation 设置屏幕旋转方向

  13. setKeepScreenOn 设置是否禁止屏幕休眠

  14. toLauncher 回到系统桌面

  15. setScreenSecure 设置是否禁止截屏

  16. setAppIconBadge 设置应用图标右上角数字

  17. getPhoneNumber 获取本机号码

UI组件：

  1. alert 一个按钮的对话框，参数：标题，内容，按钮内容

  2. confirm 两个或三个按钮的对话框，参数类似alert

  3. prompt 比confirm多了输入框

  4. actionSheet 底部弹出框

  5. showProgress 显示进度提示框

  6. hideProgress 隐藏进度提示框

  7. toast 弹出一个定时自动关闭的提示框，参数为内容，显示时间，位置，是否为全局

  8. openPicker 打开时间选择器

  9. setRefreshHeaderInfo 显示顶部下拉刷新组件，页面必须设置为弹动

  10. setCustomRefreshHeaderInfo 自定义，其他同上

  11. refreshHeaderLoading 设置下拉刷新组件为刷新中状态

  12. refreshHeaderLoadDone 通知刷新组件回到默认状态

  13. showFloatBox 显示一个悬浮框

多媒体：

  1. getPicture 通过系统相册或拍照获取图片和视频。参数为图片源，返回图片类型，媒体类型等

  2. saveMediaToAlbum 保存图片和视频到系统相册

  3. startRecord 录制amr格式音频

  4. stopRecord 停止录音

  5. startPlay 开始播放音频

  6. stopPlay 停止播放音频

  7. openVideo 打开系统视频播放器

模块加载： 引用模块

Attribute: 总个数：31

  1. appId

  2. appName 在桌面显示的名称

  3. appVersion

  4. systemType

  5. systemVersion

  6. version 引擎版本信息

  7. deviceId 设备唯一标识

  8. deviceToken IOS中用于推送的Token

  9. deviceModel 设备型号

  10. deviceName 设备名称

  11. operator 运营商名称（中国移动）

  12. connectionType 当前网络连接类型(2g, 3g, 4g, wifi…)

  13. fullScreen 应用是否全屏

  14. screenWidth 屏幕分辨率宽

  15. screenHeight 屏幕分辨率高

  16. winName

  17. winWidth

  18. winHeight

  19. frameName

  20. frameWidth

  21. frameHeight

  22. pageParam

  23. wgtParam

  24. appParam 当应用被第三方应用打开时，传递过来的参数

  25. statusBarAppearance 状态栏是否支持沉浸式效果

  26. wgtRootDir widget网页包的根目录，只读

  27. fsDir fs://协议的真实目录

  28. cacheDir cache://协议对应的真实目录

  29. boxDir box://协议对应的真实目录

  30. debug 获取配置中debug字段的值

  31. channel 获取渠道号

Constants（属性参数之类的取值）

Event: 总数：25

  1. batterylow 电量低事件

  2. batterystatus 设备电池状态改变事件，如电量变化或正在充电

  3. keyback 安卓，back键被点击

  4. keymenu 安卓，menu键被点击

  5. volumeup 安卓，设备音量加键被点击事件

  6. volumedown 与上对应

  7. offline 监听设备断开网络事件

  8. online 监听连接到网络的事件

  9. pause 应用进入到后台的事件

  10. resume 应用从后台回到前台事件

  11. scrolltobottom 页面滑倒底部事件

  12. shake 摇动事件（摇一摇功能）

  13. takescreenshot 应用前台运行期间，用户截屏事件

  14. swipedown 页面全局向下轻扫

  15. swipeleft

  16. swiperight

  17. swipeup

  18. tap 页面全局单击事件

  19. longpress 长按

  20. viewappear 当前window动画结束，已完全显示到屏幕上

  21. viewdisappear 动画结束，已完全从屏幕上移除

  22. noticeclicked 状态栏通知被点击

  23. appintent 本应用被其他应用调用起来，收到相关数据的回调

  24. smartupdatefinish 云修复使用静默修复时，更新完毕事件。

  25. launchviewclicked 启动页被用户点击之后的回调