API
框架提供丰富的京东原生API,可以方便的调起京东提供的能力,如获取用户信息,本地存储,支付功能等。
说明:
- jd.on 开头的 API 是监听某个事件发生的API接口,接受一个 CALLBACK 函数作为参数。当该事件触发时,会调用 CALLBACK 函数。
- 如未特殊约定,其他 API 接口都接受一个OBJECT作为参数。
- OBJECT中可以指定
success
,fail
,complete
来接收接口调用结果。
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
success | Function | 否 | 接口调用成功的回调函数 |
fail | Function | 否 | 接口调用失败的回调函数 |
complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
API列表:
网络 API 列表:
API | 说明 |
---|---|
jd.request | 发起网络请求 |
jd.uploadFile | 上传文件 |
jd.downloadFile | 下载文件 |
媒体 API 列表:
API | 说明 |
---|---|
jd.chooseImage | 从相册选择图片,或者拍照 |
jd.previewImage | 预览图片 |
文件 API 列表:
API | 说明 |
---|---|
jd.saveFile | 保存文件 |
jd.getSavedFileList | 获取已保存的文件列表 |
jd.getSavedFileInfo | 获取已保存的文件信息 |
jd.removeSavedFile | 删除已保存的文件信息 |
jd.openDocument | 打开文件 |
数据 API 列表:
API | 说明 |
---|---|
jd.getStorage | 获取本地数据缓存 |
jd.getStorageSync | 获取本地数据缓存 |
jd.setStorage | 设置本地数据缓存 |
jd.setStorageSync | 设置本地数据缓存 |
jd.getStorageInfo | 获取本地缓存的相关信息 |
jd.getStorageInfoSync | 获取本地缓存的相关信息 |
jd.removeStorage | 删除本地缓存内容 |
jd.removeStorageSync | 删除本地缓存内容 |
jd.clearStorage | 清理本地数据缓存 |
jd.clearStorageSync | 清理本地数据缓存 |
位置 API 列表:
API | 说明 |
---|---|
jd.getLocation | 获取当前位置 |
jd.openLocation | 打开内置地图 |
设备 API 列表:
API | 说明 |
---|---|
jd.getNetworkType | 获取网络类型 |
jd.onNetworkStatusChange | 监听网络状态变化 |
jd.getSystemInfo | 获取系统信息 |
jd.getSystemInfoSync | 获取系统信息 |
jd.setClipboardData | 设置剪贴板内容 |
jd.getClipboardData | 获取剪贴板内容 |
jd.makePhoneCall | 拨打电话 |
jd.scanCode | 扫码 |
界面 API 列表:
API | 说明 |
---|---|
jd.showToast | 显示提示框 |
jd.showLoading | 显示加载提示框 |
jd.hideToast | 隐藏提示框 |
jd.hideLoading | 隐藏提示框 |
jd.showModal | 显示模态弹窗 |
jd.showActionSheet | 显示菜单列表 |
jd.setNavigationBarTitle | 设置当前页面标题 |
jd.showNavigationBarLoading | 显示导航条加载动画 |
jd.hideNavigationBarLoading | 隐藏导航条加载动画 |
jd.navigateTo | 新窗口打开页面 |
jd.redirectTo | 原窗口打开页面 |
jd.switchTab | 切换到 tabbar 页面 |
jd.navigateBack | 退回上一个页面 |
开放接口:
API | 说明 |
---|---|
jd.login | 登录 |
jd.getUserInfo | 获取用户信息 |