目录

API

优质
小牛编辑
157浏览
2023-12-01

API

框架提供丰富的京东原生API,可以方便的调起京东提供的能力,如获取用户信息,本地存储,支付功能等。

说明:

  • jd.on 开头的 API 是监听某个事件发生的API接口,接受一个 CALLBACK 函数作为参数。当该事件触发时,会调用 CALLBACK 函数。
  • 如未特殊约定,其他 API 接口都接受一个OBJECT作为参数。
  • OBJECT中可以指定 success, fail, complete 来接收接口调用结果。
参数名类型必填说明
successFunction接口调用成功的回调函数
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

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说明
jd.setScreenBrightness设置屏幕亮度
jd.setKeepScreenOn设置是否保持常亮状态
jd.onUserCaptureScreen监听用户主动截屏事件
jd.offUserCaptureScreen取消监听用户主动截屏事件
jd.getScreenBrightness用户主动截屏事件
jd.getNetworkType获取网络类型
jd.onNetworkStatusChange监听网络状态变化
jd.getSystemInfo获取系统信息
jd.getSystemInfoSync获取系统信息
jd.setClipboardData设置剪贴板内容
jd.getClipboardData获取剪贴板内容
jd.scanCode扫码
jd.closeBluetoothAdapter关闭蓝牙模块
jd.getBluetoothAdapterState获取本机蓝牙适配器状态
jd.getConnectedBluetoothDevices根据 uuid 获取处于已连接状态的设备
jd.onBluetoothAdapterStateChange监听蓝牙适配器状态变化事件
jd.onBluetoothDeviceFound监听寻找到新设备的事件
jd.openBluetoothAdapter初始化蓝牙模块
jd.startBluetoothDevicesDiscovery开始搜寻附近的蓝牙外围设备
jd.stopBluetoothDevicesDiscovery停止搜寻附近的蓝牙外围设备
jd.readBLECharacteristicValue低功耗蓝牙读取特征值
jd.onBLEConnectionStateChange监听低功耗蓝牙连接状态改变
jd.onBLECharacteristicValueChange监听低功耗蓝牙特征值变化
jd.notifyBLECharacteristicValueChange低功耗蓝牙订阅特征值
jd.getBLEDeviceServices获取蓝牙设备所有服务
jd.getBLEDeviceCharacteristics获取蓝牙设备某个服务中所有特征值
jd.createBLEConnection连接低功耗蓝牙设备
jd.closeBLEConnection断开与低功耗蓝牙设备的连接
jd.writeBLECharacteristicValue向低功耗蓝牙设备特征值中写入数据
jd.getBatteryInfoSync同步获取电池电量
jd.getBatteryInfo异步获取电池电量
jd.startAccelerometer开始监听加速度数据
jd.stopAccelerometer停止监听加速度数据
jd.onAccelerometerChange监听加速度数据事件
jd.offAccelerometerChange取消监听加速度数据事件
jd.startDeviceMotionListening开始监听设备方向的变化
jd.stopDeviceMotionListening停止监听设备方向的变化
jd.onDeviceMotionChange监听设备方向变化事件
jd.offDeviceMotionChange取消监听设备方向变化事件
jd.startGyroscope开始监听陀螺仪数据
jd.stopGyroscope停止监听陀螺仪数据
jd.onGyroscopeChange监听陀螺仪数据变化事件
jd.offGyroscopeChange取消监听陀螺仪数据变化事件
jd.onMemoryWarning监听内存告警
jd.offMemoryWarning取消监听内存告警
jd.vibrateShort短振动
jd.vibrateLong长振动
jd.watchShake

界面 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:

API说明
CanvasContext.arc创建一条弧线
CanvasContext.arcTo根据控制点和半径绘制圆弧路径
CanvasContext.beginPath开始创建一个路径
CanvasContext.bezierCurveTo创建三次方贝塞尔曲线路径
CanvasContext.clearRect清除画布上在该矩形区域内的内容
CanvasContext.clip从原始画布中剪切任意形状和尺寸
CanvasContext.closePath关闭一个路径
CanvasGradient CanvasContext.createCircularGradient创建一个圆形的渐变颜色
CanvasGradient CanvasContext.createLinearGradient创建一个线性的渐变颜色
CanvasContext.createPattern对指定的图像创建模式的方法,可在指定的方向上重复元图像
CanvasContext.draw将之前在绘图上下文中的描述(路径、变形、样式)画到 canvas 中
CanvasContext.drawImage绘制图像到画布
CanvasContext.fill对当前路径中的内容进行填充
CanvasContext.fillRect填充一个矩形
CanvasContext.fillText在画布上绘制被填充的文本
CanvasContext.lineTo增加一个新点,然后创建一条从上次指定点到目标点的线
CanvasContext.measureText测量文本尺寸信息
CanvasContext.moveTo把路径移动到画布中的指定点,不创建线条
CanvasContext.quadraticCurveTo创建二次贝塞尔曲线路径
CanvasContext.rect创建一个矩形路径
CanvasContext.restore恢复之前保存的绘图上下文
CanvasContext.rotate以原点为中心顺时针旋转当前坐标轴
CanvasContext.save保存绘图上下文
CanvasContext.scale在调用后,之后创建的路径其横纵坐标会被缩放
CanvasContext.setFillStyle设置填充色
CanvasContext.setFontSize设置字体的字号
CanvasContext.setGlobalAlpha设置全局画笔透明度
CanvasContext.setLineCap设置线条的端点样式
CanvasContext.setLineDash设置虚线样式
CanvasContext.setLineJoin设置线条的交点样式
CanvasContext.setLineWidth设置线条的宽度
CanvasContext.setMiterLimit设置最大斜接长度
CanvasContext.setShadow设定阴影样式
CanvasContext.setStrokeStyle设置描边颜色
CanvasContext.setTextAlign设置文字的对齐
CanvasContext.setTextBaseline设置文字的竖直对齐
CanvasContext.setTransform使用矩阵重新设置(覆盖)当前变换的方法
CanvasContext.stroke画出当前路径的边框
CanvasContext.strokeRect画一个矩形(非填充)
CanvasContext.strokeText给定的 (x, y) 位置绘制文本描边的方法
CanvasContext.transform使用矩阵多次叠加当前变换的方法
CanvasContext.translate对当前坐标系的原点 (0, 0) 进行变换

CanvasGradient:

API说明
CanvasGradient.addColorStop添加颜色的渐变点

文件 API 列表:

API说明
jd.getFileInfo获取文件信息
jd.getFileSystemManager获取全局唯一的文件管理器
jd.getSavedFileInfo获取本地文件的文件信息
jd.getSavedFileList获取该小程序下已保存的本地缓存文件列表
jd.openDocument新开页面打开文档
jd.removeSavedFile删除本地缓存文件
jd.saveFile保存文件到本地

FileSystemManager:

API说明
FileSystemManager.access判断文件/目录是否存在
FileSystemManager.accessSyncFileSystemManager.access 的同步版本
FileSystemManager.appendFile在文件结尾追加内容
FileSystemManager.appendFileSyncFileSystemManager.appendFile 的同步版本
FileSystemManager.copyFile复制文件
FileSystemManager.copyFileSyncFileSystemManager.copyFile 的同步版本
FileSystemManager.getFileInfo获取该小程序下的本地临时文件或本地缓存文件信息
FileSystemManager.getSavedFileList获取该小程序下已保存的本地缓存文件列表
FileSystemManager.mkdir创建目录
FileSystemManager.mkdirSyncFileSystemManager.mkdir 的同步版本
FileSystemManager.readdir读取目录内文件列表
FileSystemManager.readdirSyncFileSystemManager.readdir 的同步版本
FileSystemManager.readFile读取本地文件内容
FileSystemManager.readFileSyncFileSystemManager.readFile 的同步版本
FileSystemManager.removeSavedFile删除该小程序下已保存的本地缓存文件
FileSystemManager.rename重命名文件。可以把文件从 oldPath 移动到 newPath
FileSystemManager.renameSyncFileSystemManager.rename 的同步版本
FileSystemManager.rmdir删除目录
FileSystemManager.rmdirSyncFileSystemManager.rmdir 的同步版本
FileSystemManager.saveFile保存临时文件到本地。
FileSystemManager.saveFileSyncFileSystemManager.saveFile 的同步版本
FileSystemManager.stat获取文件 Stats 对象
FileSystemManager.statSyncFileSystemManager.stat 的同步版本
FileSystemManager.unlink删除文件
FileSystemManager.unlinkSyncFileSystemManager.unlink 的同步版本
FileSystemManager.unzip解压文件
FileSystemManager.writeFile写文件
FileSystemManager.writeFileSyncFileSystemManager.writeFile 的同步版本

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获取当前位置