API
优质
小牛编辑
157浏览
2023-12-01
API
框架提供丰富的京东原生API,可以方便的调起京东提供的能力,如获取用户信息,本地存储,支付功能等。
说明:
- jd.on 开头的 API 是监听某个事件发生的API接口,接受一个 CALLBACK 函数作为参数。当该事件触发时,会调用 CALLBACK 函数。
- 如未特殊约定,其他 API 接口都接受一个OBJECT作为参数。
- OBJECT中可以指定
success
,fail
,complete
来接收接口调用结果。
参数名 | 类型 | 必填 | 说明 |
---|---|---|---|
success | Function | 否 | 接口调用成功的回调函数 |
fail | Function | 否 | 接口调用失败的回调函数 |
complete | Function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
API列表:
基础 API 列表:
API | 说明 |
---|---|
jd.arrayBufferToBase64 | 将ArrayBuffer对象转成Base64字符串 |
jd.base64ToArrayBuffer | 将Base64字符串转成ArrayBuffer对象 |
jd.offAppHide | 取消监听小程序切后台事件 |
jd.offAppShow | 取消监听小程序切前台事件 |
jd.onAppHide | 监听小程序切后台事件 |
jd.onAppShow | 监听小程序切前台事件 |
jd.onPageNotFound | 监听小程序要打开的页面不存在事件 |
jd.offPageNotFound | 取消监听小程序要打开的页面不存在事件 |
jd.onAudioInterruptionBegin | 监听音频因为受到系统占用而被中断开始事件 |
jd.onAudioInterruptionEnd | 监听音频中断结束事件 |
jd.offAudioInterruptionBegin | 取消监听音频因为受到系统占用而被中断开始事件 |
jd.offAudioInterruptionEnd | 取消监听音频中断结束事件 |
网络 API 列表:
API | 说明 |
---|---|
jd.request | 发起网络请求 |
jd.uploadFile | 上传文件 |
jd.downloadFile | 下载文件 |
jd.sendSocketMessage | 通过 WebSocket 连接发送数据 |
jd.onSocketOpen | 监听 WebSocket 连接打开事件 |
jd.onSocketMessage | 监听 WebSocket 接受到服务器的消息事件 |
jd.onSocketError | 监听 WebSocket 错误事件 |
jd.onSocketClose | 监听 WebSocket 连接关闭事件 |
jd.connectSocket | 创建一个 WebSocket 连接 |
jd.closeSocket | 关闭 WebSocket 连接 |
jd.createUDPSocket | 创建一个 UDP Socket 实例 |
UDPSocket.bind | 绑定一个系统随机分配的可用端口,或绑定一个指定的端口号 |
UDPSocket.close | 关闭 UDP Socket 实例 |
UDPSocket.offClose | 取消监听关闭事件 |
UDPSocket.offError | 取消监听错误事件 |
UDPSocket.offListening | 取消监听开始监听数据包消息的事件 |
UDPSocket.offMessage | 取消监听收到消息的事件 |
UDPSocket.onClose | 监听关闭事件 |
UDPSocket.onError | 监听错误事件 |
UDPSocket.onListening | 监听开始监听数据包消息的事件 |
UDPSocket.onMessage | 监听收到消息的事件 |
UDPSocket.send | 向指定的 IP 和 port 发送消息 |
媒体 API 列表:
API | 说明 |
---|---|
jd.chooseImage | 从相册选择图片,或者拍照 |
jd.previewImage | 预览图片 |
jd.getImageInfo | 获取图片信息 |
jd.saveImageToPhotosAlbum | 保存图片到系统相册 |
jd.compressImage | 压缩图片 |
jd.createInnerAudioContext | 创建InnerAudioContext实例 |
jd.getBackgroundAudioManager | 获取背景音频实例 |
jd.getRecorderManage | 获取全局唯一的录音管理器 RecorderManager |
jd.chooseMedia | 拍摄或从手机相册中选择图片或视频 |
jd.chooseVideo | 从手机相册中选视频 |
jd.createVideoContext | 创建 video 上下文 videoContext 对象 |
jd.createLivePlayerContext | 创建live-player 上下文 LivePlayerContext 对象 |
jd.createCameraContext | 创建 map 上下文 MapContext 对象 |
jd.createMapContext | 创建 camera上下文 CameraContext 对象 |
MapContext:
API | 说明 |
---|---|
MapContext.getCenterLocation | 获取当前地图中心的经纬度 |
MapContext.getRegion | 获取当前地图的视野范围 |
MapContext.getRotate | 获取当前地图的旋转角 |
MapContext.getScale | 获取当前地图的缩放级别 |
MapContext.getSkew | 获取当前地图的倾斜角 |
MapContext.includePoints | 缩放视野展示所有经纬度 |
MapContext.moveToLocation | 将地图中心移置当前定位点 |
MapContext.translateMarker | 平移marker,带动画 |
CameraContext:
API | 说明 |
---|---|
CameraContext.takePhoto | 拍摄照片 |
InnerAudioContext:
API | 说明 |
---|---|
InnerAudioContext.play | 播放 |
InnerAudioContext.pause | 暂停 |
InnerAudioContext.stop | 停止 |
InnerAudioContext.seek | 跳转到指定位置 |
InnerAudioContext.destroy | 销毁当前实例 |
InnerAudioContext.onCanplay | 监听音频进入可以播放状态的事件 |
InnerAudioContext.offCanplay | 取消监听音频进入可以播放状态的事件 |
InnerAudioContext.onPlay | 监听音频播放事件 |
InnerAudioContext.offPlay | 取消监听音频播放事件 |
InnerAudioContext.onPause | 监听音频暂停事件 |
InnerAudioContext.offPause | 取消监听音频暂停事件 |
InnerAudioContext.onStop | 监听音频停止事件 |
InnerAudioContext.offStop | 取消监听音频停止事件 |
InnerAudioContext.onEnded | 监听音频自然播放至结束的事件 |
InnerAudioContext.offEnded | 取消监听音频自然播放至结束的事件 |
InnerAudioContext.onTimeUpdate | 监听音频播放进度更新事件 |
InnerAudioContext.offTimeUpdate | 取消监听音频播放进度更新事件 |
InnerAudioContext.onError | 监听音频播放错误事件 |
InnerAudioContext.offError | 取消监听音频播放错误事件 |
InnerAudioContext.onWaiting | 监听音频加载中事件 |
InnerAudioContext.offWaiting | 取消监听音频加载中事件 |
InnerAudioContext.onSeeking | 监听音频进行跳转操作的事件 |
InnerAudioContext.offSeeking | 取消监听音频进行跳转操作的事件 |
InnerAudioContext.onSeeked | 监听音频完成跳转操作的事件 |
InnerAudioContext.offSeeked | 取消监听音频完成跳转操作的事件 |
BackgroundAudioManager:
API | 说明 |
---|---|
BackgroundAudioManager.play | 播放音乐 |
BackgroundAudioManager.pause | 暂停音乐 |
BackgroundAudioManager.stop | 停止音乐 |
BackgroundAudioManager.seek | 跳转到指定位置 |
BackgroundAudioManager.onCanplay | 监听背景音频进入可播放状态事件 |
BackgroundAudioManager.onPlay | 监听背景音频播放事件 |
BackgroundAudioManager.onPause | 监听背景音频暂停事件 |
BackgroundAudioManager.onStop | 监听背景音频停止事件 |
BackgroundAudioManager.onEnded | 监听背景音频自然播放结束事件 |
BackgroundAudioManager.onTimeUpdate | 监听背景音频播放进度更新事件,只有小程序在前台时会回调 |
BackgroundAudioManager.onError | 监听背景音频播放错误事件 |
BackgroundAudioManager.onWaiting | 监听音频加载中事件 |
BackgroundAudioManager.onNext | 监听用户在系统音乐播放面板点击下一曲事件(仅iOS) |
BackgroundAudioManager.onPrev | 监听用户在系统音乐播放面板点击上一曲事件(仅iOS) |
数据 API 列表:
API | 说明 |
---|---|
jd.getStorage | 获取本地数据缓存 |
jd.getStorageSync | 获取本地数据缓存 |
jd.setStorage | 设置本地数据缓存 |
jd.setStorageSync | 设置本地数据缓存 |
jd.getStorageInfo | 获取本地缓存的相关信息 |
jd.getStorageInfoSync | 获取本地缓存的相关信息 |
jd.removeStorage | 删除本地缓存内容 |
jd.removeStorageSync | 删除本地缓存内容 |
jd.clearStorage | 清理本地数据缓存 |
jd.clearStorageSync | 清理本地数据缓存 |
设备 API 列表:
界面 API 列表:
API | 说明 |
---|---|
jd.nextTick | 页面间事件通信通道 |
jd.hideKeyboard | 在input、textarea等focus拉起键盘之后,手动调用此接口收起键盘 |
jd.offKeyboardHeightChange | 取消监听键盘高度变化事件 |
jd.onKeyboardHeightChange | 监听键盘高度变化 |
jd.showToast | 显示提示框 |
jd.showLoading | 显示加载提示框 |
jd.hideToast | 隐藏提示框 |
jd.hideLoading | 隐藏提示框 |
jd.showModal | 显示模态弹窗 |
jd.showActionSheet | 显示菜单列表 |
jd.enableAlertBeforeUnload | 开启小程序页面返回询问对话框 |
jd.disableAlertBeforeUnload | 关闭小程序页面返回询问对话框 |
jd.setNavigationBarTitle | 设置当前页面标题 |
jd.showNavigationBarLoading | 显示导航条加载动画 |
jd.hideNavigationBarLoading | 隐藏导航条加载动画 |
jd.setBackgroundTextStyle | 动态设置下拉背景字体、loading 图的样式 |
jd.setBackgroundColor | 动态设置窗口的背景色 |
jd.startPullDownRefresh | 开始下拉刷新 |
jd.stopPullDownRefresh | 停止当前页面下拉刷新 |
jd.getMenuButtonBoundingClientRect | 停止当前页面下拉刷新 |
画布 API 列表:
API | 说明 |
---|---|
jd.createCanvasContext | 创建 canvas 的绘图上下文 CanvasContext 对象 |
jd.canvasToTempFilePath | 把当前画布指定区域的内容导出生成指定大小的图片 |
jd.canvasPutImageData | 将像素数据绘制到画布 |
jd.canvasGetImageData | 获取 canvas 区域隐含的像素数据 |
CanvasContext:
CanvasGradient:
API | 说明 |
---|---|
CanvasGradient.addColorStop | 添加颜色的渐变点 |
文件 API 列表:
API | 说明 |
---|---|
jd.getFileInfo | 获取文件信息 |
jd.getFileSystemManager | 获取全局唯一的文件管理器 |
jd.getSavedFileInfo | 获取本地文件的文件信息 |
jd.getSavedFileList | 获取该小程序下已保存的本地缓存文件列表 |
jd.openDocument | 新开页面打开文档 |
jd.removeSavedFile | 删除本地缓存文件 |
jd.saveFile | 保存文件到本地 |
FileSystemManager:
Stats:
API | 说明 |
---|---|
Stats.isDirectory | 判断当前文件是否一个目录 |
Stats.isFile | 判断当前文件是否一个普通文件 |
路由 API 列表:
API | 说明 |
---|---|
jd.navigateTo | 新窗口打开页面 |
jd.redirectTo | 原窗口打开页面 |
jd.switchTab | 切换到 tabbar 页面 |
jd.navigateBack | 退回上一个页面 |
jd.reLaunch | 关闭所有页面,打开到应用内的某个页面 |
EventChannel
API | 说明 |
---|---|
EventChannel.emit | 触发一个事件 |
EventChannel.on | 持续监听一个事件 |
EventChannel.once | 监听一个事件一次,触发后失效 |
EventChannel.off | 取消监听一个事件 |
JXML API 列表:
API | 说明 |
---|---|
jd.createIntersectionObserver | 创建并返回一个 IntersectionObserver 对象实例 |
IntersectionObserver.disconnect | 停止监听 |
IntersectionObserver.observe | 指定目标节点并开始监听相交状态变化情况 |
IntersectionObserver.relativeTo | 使用选择器指定一个节点,作为参照区域之一 |
IntersectionObserver.relativeToViewport | 指定页面显示区域作为参照区域之一 |
jd.createSelectorQuery | 返回一个 SelectorQuery 对象实例 |
NodesRef.fields | 获取节点的相关信息 |
NodesRef.boundingClientRect | 添加节点的布局位置的查询请求 |
NodesRef.scrollOffset | 添加节点的滚动位置查询请求 |
NodesRef.node | 获取 Node 节点实例 |
NodesRef.context | 添加节点的 Context 对象查询请求 |
SelectorQuery.in | 将选择器的选取范围更改为自定义组件 component 内 |
SelectorQuery.select | 在当前页面下选择第一个匹配选择器 selector 的节点 |
SelectorQuery.selectAll | 在当前页面下选择匹配选择器 selector 的所有节点 |
SelectorQuery.selectViewport | 选择显示区域 |
SelectorQuery.exec | 执行所有的请求 |
Worker API 列表:
API | 说明 |
---|---|
jd.createWorker | 创建一个 Worker 线程 |
Worker.onMessage | 监听主线程/Worker 线程向当前线程发送的消息的事件 Worker 线程 |
Worker.postMessage | 向主线程/Worker 线程发送的消息 |
Worker.terminate | 结束当前 Worker 线程 |
开放接口:
API | 说明 |
---|---|
jd.login | 登录 |
jd.getUserInfo | 获取用户信息 |
jd.getLocation | 获取当前位置 |