API对象

2022-06-16 18:00 更新

概述

api 对象是您入门 APICloud 必须了解和熟练掌握的一个基础对象。api 对象提供了构建应用程序所需要的一些基本的方法[Method],如窗口操作、相册和网络数据访问等;以及一些常见的属性[Attribute],如屏幕宽度(screenWidth),系统类型(systemType)等;还有一些常用事件[Event],如电量低(batterylow)事件、应用进入后台(pause)事件。api 对象不需要 require 引用,可以直接在 js 中使用。

Attribute

appId appName appVersion systemType
systemVersion version language deviceId
deviceToken deviceModel deviceName uiMode
platform operator connectionType fullScreen
screenWidth screenHeight winName winWidth
winHeight frameName frameWidth frameHeight
safeArea pageParam wgtParam appParam
statusBarAppearance wgtRootDir fsDir cacheDir
boxDir debug channel jailbreak
isRecoveryMode

Constant

toast位置 传感器类型 电话类型 定位精度
动画类型 动画曲线类型 动画子类型 进度提示框动画类型
进度提示框风格 媒体类型 拾取器类型 图片编码类型
图片数据格式 图片源类型 网络类型 文件操作错误码
系统类型 下载状态 异步请求错误类型 异步请求返回数据类型
异步请求方法类型 状态栏样式 屏幕旋转方向 错误码
上传状态 键盘弹出页面调整方式 缓存策略

event

apiready batterylow batterystatus keyback
keymenu volumeup volumedown offline
online pause resume active
inactive scrolltobottom backtotop shake
takescreenshot appidle swipedown swipeleft
swiperight swipeup tap longpress
viewappear viewdisappear noticeclicked appintent
smartupdatefinish launchviewclicked keyboardshow keyboardhide
safeareachanged interfacestylechanged navtitle navbackbtn
navitembtn tabitembtn tabframe

method

窗口系统

openWin closeWin closeToWin windows
setWinAttr openFrame closeFrame frames
setFrameAttr bringFrameToFront sendFrameToBack setFrameClient
animation openFrameGroup closeFrameGroup setFrameGroupAttr
setFrameGroupIndex openPopoverWin closePopoverWin openSlidLayout
openSlidPane closeSlidPane lockSlidPane unlockSlidPane
openDrawerLayout openDrawerPane closeDrawerPane loadData
execScript setBlurEffect removeLaunchView showLaunchView
parseTapmode

高级窗口

openTabLayout setTabLayoutAttr setNavBarAttr getNavBarAttr
setTabBarAttr setTabBarItemAttr

应用管理

installApp uninstallApp openApp appInstalled
rebootApp openWidget closeWidget

网络通信

ajax cancelAjax download cancelDownload
imageCache applyCertificates

数据存储

readFile writeFile setPrefs getPrefs
removePrefs setGlobalData getGlobalData clearCache
getCacheSize getTotalSpace getFreeDiskSpace loadSecureValue

消息事件

addEventListener removeEventListener sendEvent accessNative
notification cancelNotification

设备访问

startLocation stopLocation getLocation startSensor
stopSensor call sms mail
openContacts setFullScreen setStatusBarStyle setScreenOrientation
setKeepScreenOn toLauncher setScreenSecure setAppIconBadge
getPhoneNumber hasPermission requestPermission getInterfaceStyle
setInterfaceStyle

UI组件

alert confirm prompt actionSheet
showProgress hideProgress toast openPicker
setRefreshHeaderInfo setCustomRefreshHeaderInfo refreshHeaderLoading refreshHeaderLoadDone
showFloatBox setMenuItems

多媒体

getPicture saveMediaToAlbum screenCapture startRecord
stopRecord startPlay pausePlay stopPlay
openVideo

应用管理

require

应用管理

historyBack historyForward

应用管理

pageUp pageDown setFocus
以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号