DingTalk JS-API

DingTalkは、ネイティブポップアップ、デバイス情報、スキャンなどの豊富なJSAPI機能を提供しており、宜搭開発者はDingTalkがネイティブで提供するAPI機能を利用することで、より良いユーザーエクスペリエンスを提供できます。

• DingTalk JSAPI機能リスト;
• DingTalk開発者必読。

注意

DingTalk JS-APIを呼び出す際は、以下の点に注意してください：

• 宜搭アプリケーションでは、window.ddが存在することを保証していません（現在のところ、携帯端末のみに旧バージョンのリソースが導入されています）。ユーザーには手動で導入することを推奨します。
• 宜搭アプリケーションでは、dd.configを設定してJSAPI認証操作を行わなくても、認証後に使用できるAPIを呼び出すことができます。注意して呼び出してください。
• JSAPIを呼び出す際、必要なcorpIdパラメータは const { corpId } = window.pageConfig || {}; から取得できます。

使用ガイド

ステップ1：DingTalk JSAPIリソースの非同期読み込み

宜搭ページでwindow.ddが必ず存在するとは限らないため、安全のため、ユーザーはページのdidMountライフサイクルでDingTalkのJSAPIスクリプトを手動で読み込む必要があります。以下のように：

実装コードは以下の通りです：

export function didMount() {
  this.utils.loadScript('https://g.alicdn.com/dingding/dingtalk-jsapi/3.0.25/dingtalk.open.js');
}

リソースの導入が完了すると、window.dd経由でJSAPIの関連機能を呼び出せるようになります。

ステップ2：DingTalk JSAPIの呼び出し

DingTalkのJSAPIが読み込まれた後、アクションパネルでwindow.dd経由でDingTalkの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) { }
    });
  }
}

DingTalk端末内での表示効果は以下の通りです：

注意

多くのDingTalk JSAPIは端末内での呼び出しが必須であるため、DingTalk JSAPIを呼び出す際は、まずDingTalk端末内かどうかを事前に判断する必要があります。判断コードは以下の通りです：

export function isDingTalk() {
  return window.navigator && /dingtalk/i.test(window.navigator.userAgent)
}

APIリスト

サポートされているAPIリストはDingTalkオープンプラットフォームドキュメントを参照してください。