《钉钉应用开发者速成手册》之“钉钉能力概览——小程序API”

dd.canIUse

判断小程序的API、回调、参数、组件等是否在当前版本可用。

支持

支持

支持

获取基础库版本号

获取基础库版本号。

支持

支持

支持

dd.canIUse

判断小程序的API、回调、参数、组件等是否在当前版本可用。

支持

支持

支持

获取基础库版本号

获取基础库版本号。

支持

支持

支持

dd.getUpdateManager

获取全局唯一的版本更新管理器，用于管理小程序更新。

支持

支持

支持

UpdateManager.applyUpdate()

强制小程序重启并使用新版本。

支持

支持

支持

UpdateManager.onCheckForUpdate(function callback)

监听向钉钉后台请求检查更新结果事件。

支持

支持

支持

UpdateManager.onUpdateReady(function callback)

监听小程序有版本更新事件。

支持

支持

支持

dd.UpdateManager.onUpdateFaile(function callback)

监听小程序更新失败事件。

支持

支持

支持

发网络请求

dd.httpRequest

发送HTTP网络请求。

支持

支持

支持

上传下载

dd.uploadFile

将本地资源上传到服务器。

支持

支持

支持

dd.downloadFile

下载文件资源到本地。

支持

支持

支持

WebSocket

dd.connectSocket

创建WebSocket的连接。

支持

支持

支持

dd.onSocketOpen

监听WebSocket连接打开事件。

支持

支持

支持

dd.offSocketOpen

取消监听WebSocket连接打开事件。

支持

支持

支持

dd.onSocketError

监听WebSocket错误。

支持

支持

支持

dd.offSocketError

取消监听WebSocket错误。

支持

支持

支持

dd.sendSocketMessage

通过WebSocket连接发送数据。

支持

支持

支持

dd.onSocketMessage

监听WebSocket接受到服务器的消息事件。

支持

支持

支持

dd.offSocketMessage

取消监听WebSocket接受到服务器的消息事件。

支持

支持

支持

dd.closeSocket

关闭WebSocket连接。

支持

支持

支持

dd.onSocketClose

监听WebSocket关闭。

支持

支持

支持

dd.offSocketClose

取消监听WebSocket关闭。

支持

支持

支持

图片

dd.chooseImage

选择图片。

支持

支持

支持

dd.previewImage

预览图片。

支持

支持

支持

dd.saveImage

保存在线、本地临时或者永久地址图片到手机相册。

支持

支持

支持

dd.compressImage

压缩图片。

支持

支持

支持

dd.getImageInfo

获取图片信息。

支持

支持

支持

图片编辑

dd.editPicture

编辑图片（支持远程https图片地址和本地虚拟路径），提供涂鸦、裁剪、马赛克等功能。

支持

支持

支持

录音管理

dd.getRecorderManager

获取当前小程序全局唯一的录音管理器 recordManager。

支持

支持

支持

背景音频管理

dd.getBackgroundAudioManager

获取当前小程序全局唯一的背景音频管理 backgroundAudioManager。

支持

支持

支持

视频

dd.chooseVideo

选择视频。

支持

支持

支持

dd.createIntersectionObserver

创建并返回一个IntersectionObserver对象实例。

支持

支持

支持

dd.createSelectorQuery

节点查询。

支持

支持

支持

导航栏

dd.navigateTo

保留当前页面，跳转到应用内的某个指定页面，可以使用dd.navigateBack 返回到原来页面。

支持

支持

支持

dd.redirectTo

关闭当前页面，跳转到应用内的某个指定页面。

支持

支持

支持

dd.navigateBack

关闭当前页面，返回上一级或多级页面。

支持

支持

支持

dd.reLaunch

关闭当前所有页面，跳转到应用内的某个指定页面。

支持

支持

支持

dd.setNavigationBar

设置导航栏文字及样式。

支持

支持

支持

TabBar

dd.switchTab

跳转到指定 tabBar 页面，并关闭其他所有非 tabBar 页面。

支持

支持

支持

dd.setTabBarBadge

为 tabBar 某一项的右上角添加文本。

支持

支持

支持

dd.removeTabBarBadge

移除 tabBar 某一项右上角的文本。

支持

支持

支持

dd.showTabBarRedDot

显示 tabBar 某一项的右上角的红点。

支持

支持

支持

dd.addTabBarItem

添加 tabBar页面。

支持

支持

支持

dd.hideTabBarRedDot

隐藏 tabBar 某一项的右上角的红点。

支持

支持

支持

交互反馈

dd.alert

alert 警告框。

支持

支持

支持

dd.confirm

confirm 确认框。

支持

支持

支持

dd.showToast

显示一个弱提示，可选择多少秒之后消失。

支持

支持

支持

dd.showLoading

显示加载提示。

支持

支持

支持

dd.hideToast

隐藏加载提示。

支持

支持

支持

dd.showActionSheet

显示操作菜单。

支持

支持

支持

离开页面二次确认

dd.enableLeaveConfirm

对当前页面进行离开二次确认配置。

支持

支持

支持

dd.disableLeaveConfirm

取消当前页面的离开二次确认配置。

支持

支持

支持

下拉刷新

onPullDownRefresh

下拉刷新。

支持

支持

支持

dd.stopPullDownRefresh

停止当前页面的下拉刷新。

支持

支持

支持

选择日期

dd.datePicker

选择日期。

支持

支持

支持

创建动画

dd.createAnimation

创建动画。

支持

支持

支持

画布

dd.createCanvasContext

画布。

支持

支持

支持

键盘

dd.onKeyboardShow

监听键盘弹起事件，并返回键盘高度。

支持

支持

支持

dd.onKeyboardHide

监听键盘收起事件。需要在page中设置该回调。

支持

支持

支持

dd.hideKeyboard

隐藏键盘。

支持

支持

支持

滚动

dd.pageScrollTo

滚动到页面的目标位置。

支持

支持

支持

dd.getLocation

获取用户当前的地理位置信息。

支持

支持

支持

dd.openLocation

使用内置地图查看位置。

支持

支持

支持

dd.setStorage

将数据存储在本地缓存中指定的key中，会覆盖掉原来该key对应的数据。

支持

支持

支持

dd.setStorageSync

同步将数据存储在本地缓存中指定的 key 中。

支持

支持

支持

dd.getStorage

获取缓存数据。

支持

支持

支持

dd.getStorageSync

同步获取缓存数据。

支持

支持

支持

dd.removeStorage

删除缓存数据。

支持

支持

支持

dd.removeStorageSync

同步删除缓存数据。

支持

支持

支持、

dd.createMapContext

地图组件。

支持

支持

支持

系统信息

dd.getSystemInfo

获取系统信息。

支持

支持

支持

dd.getSystemInfoSyn

获取系统信息，返回值同 getSystemInfo success 回调参数。

支持

支持

支持

网络状态

dd.getNetworkType

获取网络状态。

支持

支持

支持

剪切板

dd.getClipboard

获取剪切板数据。

支持

支持

支持

dd.setClipboard

设置剪切板数据。

支持

支持

支持

震动

dd.vibrate

调用震动功能。

支持

支持

支持

dd.vibrateShort

使用短振动功能。

支持

支持

支持

dd.vibrateLong

使用长振动功能。

支持

支持

支持

蓝牙

dd.openBluetoothAdapter

初始化蓝牙接口。

支持

支持

支持

dd.onBluetoothAdapterStateChange

蓝牙适配器状态监听。

支持

支持

支持

dd.onBluetoothDeviceFound

蓝牙发现事件监听。

支持

支持

支持

dd.onBLEConnectionStateChanged

蓝牙连接状态事件监听。

支持

支持

支持

dd.startBluetoothDevicesDiscovery

搜索设备。

支持

支持

支持

dd.connectBLEDevice

查找设备并连接。

支持

支持

支持

dd.stopBluetoothDevicesDiscovery

停止搜索设备。

支持

支持

支持

dd.getBLEDeviceServices

获取服务。

支持

支持

支持

dd.getBLEDeviceCharacteristics

获取特征。

支持

支持

支持

dd.onBLECharacteristicValueChange

监听特征值变化事件通知。

支持

支持

支持

dd.notifyBLECharacteristicValueChange

设置读特征通知模式。

支持

支持

支持

dd.writeBLECharacteristicValue

向设备的特征值写数据。

支持

支持

支持

dd.readBLECharacteristicValue

向设备的特征值读数据。

支持

支持

支持

dd.disconnectBLEDevice

断开连接。

支持

支持

支持

dd.closeBluetoothAdapter

关闭蓝牙适配器。

支持

支持

支持

dd.scan

调用扫一扫功能。

支持

支持

支持

dd.onShareAppMessage

分享。

支持

支持

支持

dd.complexChoose

选人与部门。选择部门后把该部门转换成对应部门下的人。

支持

支持

不支持

dd.chooseDepartments

选择部门信息。调用该接口会返回部门的信息，是以部门为纬度，不是以人为纬度。

支持

支持

不支持

dd.creatGroupChat

创建群聊天。

支持

支持

不支持

dd.choosephonebook

选择手机通讯录。

支持

支持

不支持

dd.chooseExternalUsers

选择外部联系人。

支持

支持

不支持

dd.editExternalUser

编辑外部联系人。

支持

支持

不支持

dd.chooseUserFromList

选取单个自定义联系人。

支持

支持

不支持

dd.creatDing

发钉接口支持唤起DING、任务、日程等创建界面。

支持

支持

不支持

dd.callUsers

拨打钉钉电话。

支持

支持

不支持

dd.showCallMenu

唤起拨打电话菜单。

支持

支持

支持

dd.checkBizCall

检查某企业办公电话开通状态。

支持

支持

不支持

dd.pay

支付。

支持

支持

支持

dd.saveFileToDingTalk

转存文件到钉盘。

支持

支持

不支持

dd.previewFileInDingTalk

钉盘文件预览。

支持

支持

不支持

dd.uploadAttachmentToDingTalk

上传附件到钉盘/从钉盘选择文件。

支持

支持

不支持

dd.chooseDingTalkDir

选取钉盘目录。

支持

支持

不支持

dd.chooseChatForNormalMsg

获取会话信息。

支持

支持

不支持

dd.chooseChat

选择会话。

支持

支持

不支持

dd.openChatByChatId

根据chatId跳转到对应会话。

支持

支持

不支持

dd.openChatByUserId

打开与某个用户的聊天页面（单聊会话）。

支持

支持

不支持