《釘釘應用開發者速成手冊》之“釘釘能力概覽——小程式API”

小程式API

基礎能力

API名稱	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	選取單個自定義聯系人。

Ding

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	打開與某個使用者的聊天頁面（單聊會話）。