钉钉 JS |
您所在的位置：网站首页 › 钉钉JSAPI任务提醒 › 钉钉 JS |
钉钉 JS
|
钉钉 JS-API 钉钉提供了丰富的JSAPI能力，例如原生弹框、设备信息、扫描等能力，宜搭开发者可以利用钉钉原生提供的API能力提供更好的用户体验。 钉钉JSAPI功能列表;钉钉开发者必读警告调用钉钉JS-API需要注意以下事项： 宜搭应用中，不保证 window.dd 存在 (目前仅手机端会引入一个旧版资源)，建议用户手动引入;宜搭应用中，即使不配置 dd.config 进行 JSAPI 鉴权操作，仍可调用需要鉴权后才能使用的 API。请谨慎调用;调用 JSAPI 时，需要的 corpId 参数可以从 const { corpId } = window.pageConfig || {}; 获取;使用指南步骤1：异步加载钉钉JSAPI资源由于宜搭页面中不保证 window.dd一定存在，所以保险起见，用户需要在页面的didMount生命周期中手动加载钉钉的JSAPI脚本，如下所示：
实现代码如下所示： export function didMount() { const script = document.createElement('script'); script.src = 'https://g.alicdn.com/dingding/dingtalk-jsapi/2.10.3/dingtalk.open.js'; document.body.appendChild(script);}资源引入完成后，即可通过 window.dd 调用 JSAPI 中的相关功能。 步骤2：调用钉钉JSAPI钉钉的JSAPI加载完成后，我们便可以在动作面板中通过window.dd调用钉钉的API进行相应的操作了，如下所示： export function isDingTalk() { return window.navigator && /dingtalk/i.test(window.navigator.userAgent)}export function dingAlert() { if (window.dd && this.isDingTalk()) { window.dd.device.notification.alert({ message: "测试", title: "提示",//可传空 buttonName: "收到", onSuccess: function () { }, onFail: function (err) { } }); }}钉钉端内的展示效果如下所示：  警告由于很多钉钉JSAPI要求必须端内调用，因此在调用钉钉JSAPI时，需要提前先判断一下是否在钉钉端内，判断代码如下所示： export function isDingTalk() { return window.navigator && /dingtalk/i.test(window.navigator.userAgent)}API列表容器接口说明JSAPI名称是否需要鉴权AndroidIOSPC获取容器版本号dd.version不需要支持支持不支持弹框接口说明JSAPI名称是否需要鉴权AndroidIOSPCalertdevice.notification.alert不需要支持支持支持confirmdevice.notification.confirm不需要支持支持支持promptdevice.notification.prompt不需要支持支持支持手机震动device.notification.vibrate不需要支持支持不支持toastdevice.notification.toast不需要支持支持支持actionsheetdevice.notification.actionSheet不需要支持支持支持显示加载device.notification.showPreloader不需要支持支持不支持隐藏加载device.notification.hidePreloader不需要支持支持不支持modal弹浮层device.notification.modal不需要支持支持不支持extendModaldevice.notification.extendModal不需要支持支持不支持多选组件biz.util.multiSelect不需要支持支持不支持摇一摇接口说明JSAPI名称是否需要鉴权AndroidIOSPC启动摇一摇device.accelerometer.watchShake不需要支持支持不支持停止摇一摇device.accelerometer.clearShake不需要支持支持不支持设备接口说明JSAPI名称是否需要鉴权AndroidIOSPC获取网络类型device.connection.getNetworkType不需要支持支持不支持获取wifi状态device.base.getWifiStatus不需要支持支持不支持获取手机基础信息device.base.getPhoneInfo不需要支持支持不支持获取uuiddevice.base.getUUID需要支持支持不支持获取热点接入信息device.base.getInterface需要支持支持不支持读取NFC芯片内容device.nfc.nfcRead不需要支持不支持不支持NFC数据写入device.nfc.nfcWrite需要支持不支持不支持打开iOS系统设置device.base.openSystemSetting不需要不支持支持不支持打开Android系统设置device.base.openSystemSetting不需要支持不支持不支持日期&月历接口说明JSAPI名称是否需要鉴权AndroidIOSPC日期选择器biz.util.datepicker不需要支持支持不支持时间选择器biz.util.timepicker不需要支持支持不支持日期及时间选择器biz.util.datetimepicker不需要支持支持不支持月历组件：选择某天biz.calendar.chooseOneDay不需要支持支持不支持月历组件：选择某时间biz.calendar.chooseDateTime不需要支持支持不支持月历组件：选择某天biz.calendar.chooseHalfDay不需要支持支持不支持月历组件：选择日期区间biz.calendar.chooseInterval不需要支持支持不支持导航栏接口说明JSAPI名称是否需要鉴权AndroidIOSPC设置导航栏颜色拼接dd_nav_bgcolor参数不需要支持支持不支持微应用页面支持横屏拼接dd_orientation参数不需要支持支持不支持设置左侧导航按钮文本biz.navigation.setLeft不需要不支持支持支持PC端左侧按钮点击事件addEventListener不需要不支持不支持支持PC端左侧按钮点击事件，移除监听回调函数removeEventListener不需要不支持不支持支持设置导航栏标题biz.navigation.setTitle不需要支持支持支持标题栏添加问号图标biz.navigation.setIcon不需要支持支持不支持返回上一级页面biz.navigation.goBack不需要支持支持不支持关闭当前页面biz.navigation.close不需要支持支持不支持替换页面biz.navigation.replace不需要支持支持不支持关闭页面biz.navigation.quit不需要不支持不支持支持UI控件接口说明JSAPI名称是否需要鉴权AndroidIOSPC输入框ui.input.plain不需要支持支持不支持设置顶部进度条颜色ui.progressBar.setColors不需要支持支持不支持启用下拉刷新ui.pullTorefresh.enable不需要支持支持不支持禁用下拉刷新ui.pullToRefresh.disable不需要支持支持不支持收起下拉刷新ui.pullToRefresh.stop不需要支持支持不支持禁用iOS Webview弹性效果ui.webViewBounce.disable不需要不支持支持不支持启用iOS Webview弹性效果ui.webViewBounce.enable不需要不支持支持不支持获取免登授权码接口说明JSAPI名称是否需要鉴权AndroidIOSPC获取微应用免登授权码runtime.permission.requestAuthCode不需要支持支持支持获取微应用反馈式操作的临时授权码runtime.permission.requestOperateAuthCode需要支持支持支持扫码接口说明JSAPI名称是否需要鉴权AndroidIOSPC扫条形码、二维码biz.util.scan不需要支持支持不支持扫名片biz.util.scanCard需要支持支持不支持存储接口说明JSAPI名称是否需要鉴权AndroidIOSPC设置存储信息util.domainStorage.setItem不需要支持支持不支持获取存储信息util.domainStorage.getItem不需要支持支持不支持删除存储信息util.domainStorage.removeItem不需要支持支持不支持地图接口说明JSAPI名称是否需要鉴权AndroidIOSPC获取当前地理位置信息（单次定位）device.geolocation.get需要支持支持不支持连续获取当前地理位置信息（持续定位）device.geolocation.start需要支持支持不支持停止连续定位device.geolocation.stop需要支持支持不支持批量连续定位状态device.geolocation.status不需要支持支持不支持地图定位biz.map.locate需要支持支持不支持地图页面支持搜索biz.map.search需要支持支持不支持展示位置biz.map.view需要支持支持不支持业务接口说明JSAPI名称是否需要鉴权AndroidIOSPC分享biz.util.share不需要支持支持不支持下拉控件biz.util.chosen不需要支持支持不支持复制到粘贴板biz.clipboardData.setData需要支持支持不支持打开应用biz.microApp.openApp不需要支持支持不支持文件接口说明JSAPI名称是否需要鉴权AndroidIOSPC批量检测本地文件是否存在biz.util.isLocalFileExist不需要不支持不支持支持打开本地文件biz.util.openLocalFile不需要不支持不支持支持下载文件biz.util.downLoadFile不需要不支持不支持支持图片接口说明JSAPI名称是否需要鉴权AndroidIOSPC图片预览biz.util.previewImage不需要支持支持支持打开新页面接口说明JSAPI名称是否需要鉴权AndroidIOSPC打开应用内页面biz.util.open需要支持支持支持打开目标页面biz.util.openLink不需要支持支持支持打开模态框biz.util.openModal不需要不支持不支持支持打开侧边面板biz.util.openSlidePanel不需要不支持不支持支持打开链接打开音视频链接需要支持支持支持电话接口说明JSAPI名称是否需要鉴权AndroidIOSPC拨打钉钉电话biz.telephone.call需要支持支持不支持通用电话拨打biz.telephone.showCallMenu需要支持支持不支持检查某企业的办公电话开通状态biz.telephone.checkBizCall需要支持支持不支持拨打单人电话选项（可定制）biz.telephone.quickCallList需要支持支持支持发钉接口说明JSAPI名称是否需要鉴权AndroidIOSPCDING 2.0 发钉biz.ding.create需要支持支持支持DING 1.0 发钉biz.ding.post需要不支持不支持支持通讯录选人接口说明JSAPI名称是否需要鉴权AndroidIOSPCPC端选择企业内部的人biz.contact.choose需要不支持不支持支持选取手机通讯录biz.contact.chooseMobileContacts需要支持支持不支持选择部门和人biz.contact.complexPicker需要支持支持支持选择部门信息biz.contact.departmentsPicker需要支持支持支持创建企业群biz.contact.createGroup需要支持支持不支持设定规则选人biz.contact.setRule需要支持支持不支持角色接口说明JSAPI名称是否需要鉴权AndroidIOSPC选择角色组或角色biz.contact.rolesPicker需要支持支持不支持外部联系人接口说明JSAPI名称是否需要鉴权AndroidIOSPC选择外部联系人biz.contact.externalComplexPicker需要支持支持不支持编辑外部联系人biz.contact.externalEditForm需要支持支持不支持自定义联系人接口说明JSAPI名称是否需要鉴权AndroidIOSPC单选自定义联系人biz.customContact.choose需要支持支持支持多选自定义联系人biz.customContact.multipleChoose需要支持支持支持会话接口说明JSAPI名称是否需要鉴权AndroidIOSPC获取会话信息biz.chat.pickConversation需要支持支持支持根据corpid选择会话biz.chat.chooseConversationByCorpId需要支持支持支持打开与某个用户的单聊会话biz.chat.openSingleChat需要支持支持不支持根据chatId跳转到对应会话biz.chat.toConversation需要支持支持不支持钉盘接口说明JSAPI名称是否需要鉴权AndroidIOSPC保存文件到钉盘biz.cspace.saveFile需要支持支持不支持预览钉盘文件biz.cspace.preview需要支持支持支持选取钉盘目录biz.cspace.chooseSpaceDir需要支持支持不支持上传附件到钉盘/从钉盘选择文件biz.util.uploadAttachment需要支持支持支持音频接口接口说明JSAPI名称是否需要鉴权AndroidIOSPC开始录音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需要支持支持不支持视频会议接口说明JSAPI名称是否需要鉴权AndroidIOSPC发起视频会议biz.conference.videoConfCall需要支持支持支持在线课堂接口说明JSAPI名称是否需要鉴权AndroidIOSPC发起在线课堂biz.live.startClassRoom需要不支持不支持支持支付接口说明JSAPI名称是否需要鉴权AndroidIOSPC支付接口biz.alipay.pay需要支持支持不支持数据加解密接口说明JSAPI名称是否需要鉴权AndroidIOSPC数据加密biz.util.encrypt需要支持支持不支持数据解密biz.util.decrypt需要支持支持不支持转屏横屏接口说明JSAPI名称是否需要鉴权AndroidIOSPC微应用页面支持转屏拼接dd_orientation=auto参数不需要支持支持不支持微应用页面支持横屏拼接dd_orientation参数不需要支持支持不支持微应用页面全屏展示拼接dd_full_screen=true参数不需要支持支持不支持微应用页面导航栏透明拼接dd_nav_translucent=true参数不需要支持支持不支持旋转屏幕device.screen.rotateView不需要支持支持不支持重置旋转屏幕device.screen.resetView不需要支持支持不支持授权接口说明JSAPI名称是否需要鉴权AndroidIOSPC授权获取审批实例数据biz.auth.requestAuthInfo需要支持支持不支持服务窗-获取用户授权biz.auth.requestAuthInfo需要支持支持不支持服务窗-单聊消息授权biz.auth.requestAuthInfo需要支持支持不支持办公电话接口说明JSAPI名称是否需要鉴权AndroidIOSPC查询企业是否已开办公电话biz.conference.getCloudCallInfo需要支持支持支持发起办公电话呼叫biz.conference.createCloudCall需要支持支持支持查询话单列表biz.conference.getCloudCallList需要支持支持支持专属钉钉接口说明JSAPI名称是否需要鉴权AndroidIOSPC获取钉钉客户端是否为专属钉钉biz.realm.getUserExclusiveInfo不需要支持支持支持 |
【本文地址】