文档中心 > 移动端开发文档

移动端JSAPI总览

更新时间:2018/12/06 访问次数:191439

对钉钉容器的H5开发者来说,钉钉提供了一些Native能力的jsapi,这些api有很多是手机的基础能力,对这些api的调用不需要进行鉴权(即不需要进行dd.config),只需要保证在dd.ready里面调用即可。对于一些钉钉业务相关、安全相关的api调用,需要开发者先进行鉴权后再调用。

JSAPI列表 是否需要dd.config 接口说明
dd.version 不需要 获取钉钉容器版本号
device.notification.alert 不需要 alert弹窗
device.notification.confirm 不需要 confirm弹窗
device.notification.prompt 不需要 prompt弹窗
device.notification.vibrate 不需要 手机震动
device.accelerometer.watchShake 不需要 监听shake
device.accelerometer.clearShake 不需要 取消监听shake
device.notification.toast 不需要 toast弹窗
device.notification.actionSheet 不需要 actionSheet弹窗
device.notification.showPreloader 不需要 显示加载中
device.notification.hidePreloader 不需要 隐藏加载中
biz.navigation.setLeft 不需要 设置左侧导航按钮文案
biz.navigation.setRight 不需要 设置导航栏右侧
biz.navigation.setTitle 不需要 设置标题
device.connection.getNetworkType 不需要 获取网络类型
device.base.getWifiStatus 不需要 获取Wifi状态
biz.microApp.openApp 不需要 打开应用
biz.util.openLink 不需要 打开一个新的H5页面
biz.util.datepicker 不需要 日期选择器
biz.util.timepicker 不需要 时间选择器
biz.util.datetimepicker 不需要 时间日期选择器
biz.navigation.goBack 不需要 返回上一级页面
biz.navigation.close 不需要 关闭当前页面
biz.navigation.setMenu 不需要 设置导航栏右侧多个按钮
biz.navigation.replace 不需要 替换页面
biz.util.previewImage 不需要 图片预览
biz.util.chosen 不需要 下拉控件
biz.calendar.chooseOneDay 不需要 月历组件,选择某天
biz.calendar.chooseDateTime 不需要 月历组件,选择某时间
biz.calendar.chooseHalfDay 不需要 月历组件,选择半天
biz.calendar.chooseInterval 不需要 月历组件,选择日期区间
ui.input.plain 不需要 输入框
ui.progressBar.setColors 不需要 设置顶部进度条颜色
ui.pullToRefresh.enable 不需要 启用下拉刷新
ui.pullToRefresh.disable 不需要 禁止下拉刷新
ui.pullToRefresh.stop 不需要 收起下拉刷新
ui.webViewBounce.disable 不需要 禁用iOS WebView弹性效果
ui.webViewBounce.enable 不需要 开启iOS WebView弹性效果
runtime.permission.requestAuthCode 不需要 获取免登授权码code
channel.permission.requestAuthCode 不需要 获取服务窗免登授权码code
device.notification.modal 不需要 modal弹浮层
device.notification.extendModal 不需要 modal弹浮层,支持自定义每一个Cell的内容
biz.util.multiSelect 不需要 多选组件
biz.util.scan 不需要 扫码
biz.navigation.setIcon 不需要 设置图标
device.nfc.nfcRead 不需要 读取NFC
util.domainStorage.setItem 不需要 插入要存储的值
util.domainStorage.getItem 不需要 获取存储的值
util.domainStorage.removeItem 不需要 删除存入的值
biz.util.share 不需要 分享
device.geolocation.get 需要 获取地理位置信息
device.geolocation.start 需要 开始持续定位
device.geolocation.stop 需要 停止持续定位
device.geolocation.status 需要 批量获取持续定位状态
device.base.getPhoneInfo 不需要 获取手机基础信息
device.base.getUUID 需要 获取uuid
device.base.getInterface 需要 获取热点接入信息
device.launcher.checkInstalledApps 需要 检测手机是否安装应用
device.launcher.launchApp 需要 打开第三方应用
biz.util.open 需要 打开一些业务逻辑页面
biz.contact.choose 需要 选人
biz.contact.chooseMobileContacts 需要 选择手机联系人
biz.user.get 需要 获取用户信息
biz.ding.create 需要 发钉
biz.ding.post 需要 发ding消息
biz.telephone.call 需要 拨打钉钉电话
biz.telephone.showCallMenu 需要 通用电话拨打接口
biz.telephone.checkBizCall 需要 检查某企业下的办公电话开通状态
biz.telephone.quickCallList 需要 拨打单人电话选项(可定制)
biz.contact.createGroup 需要 创建群聊
biz.map.locate 需要 定位到地图页面
biz.map.search 需要 地图页面支持搜索
biz.map.view 需要 地图预览
biz.customContact.multipleChoose 需要 多选自定义选人
biz.customContact.choose 需要 单选自定义选人
biz.contact.complexPicker 需要 选人选部门
biz.contact.complexChoose 需要 选人选部门(不再维护)
biz.contact.departmentsPicker 需要 选部门
biz.contact.setRule 需要 设置选人规则
biz.contact.externalComplexPicker 需要 选取外部联系人
biz.contact.externalEditForm 需要 编辑外部联系人
biz.chat.pickConversation 需要 获取会话信息
biz.intent.fetchData 需要 在聊天页面,用户通过聊天消息跳转到微应用,用于获取用户所选择消息及会话内容信息,并在微应用页面显示
biz.chat.chooseConversationByCorpId 需要 通过corpid选取会话
biz.chat.openSingleChat 需要 打开单聊会话
biz.chat.toConversation 需要 根据chatid跳转到对应会话
biz.cspace.saveFile 需要 保存钉盘文件
biz.cspace.preview 需要 预览钉盘文件
biz.cspace.chooseSpaceDir 需要 选取钉盘目录
biz.util.uploadAttachment 需要 上传钉盘文件
biz.clipboardData.setData 需要 复制到粘贴板
biz.chat.locationChatMessage 需要 打开聊天详情到某条消息
dd.biz.util.previewVideo 不需要 预览、播放视频
device.audio.startRecord 需要 开始录音
device.audio.stopRecord 需要 结束录音
device.audio.onRecordEnd 需要 录音结束
device.audio.download 需要 下载录音
device.audio.play 需要 播放录音
device.audio.pause 需要 暂停播放语音
device.audio.resume 需要 录音播放恢复
device.audio.stop 需要 录音播放停止
device.audio.onPlayEnd 需要 录音播放停止
device.audio.translateVoice 需要 语音转文字
biz.alipay.pay 需要 支付接口支付
device.nfc.nfcWrite 需要 NFC数据写入
biz.util.encrypt 需要 数据加密
biz.util.decrypt 需要 数据解密
runtime.permission.requestOperateAuthCode 需要 获取发送响应式消息Code
biz.util.scanCard 需要 扫名片
device.screen.rotateView 不需要 旋转屏幕视图到横屏状态,并隐藏页面导航栏
device.screen.resetView 不需要 重置屏幕状态

FAQ

关于此文档暂时还没有FAQ
返回
顶部