# 接口消息

# set-appId

说明：设置 appId，用于获取 APPID 相应的域名白名单。注意，白名单需要提前在服务端配置绑定。

时机：iframe 触发 load 事件后。

必须：是。

示例：

iframeElement.contentWindow.postMessage(
  {
    action: 'set-appId',
    data: {
      appId: '<YOUR APPID>',
    },
  },
  '*'
)

# init

说明：加载编辑页面，初始化编辑器。

时机：接收到回调消息 iframe-ready 后。

必须：是。

示例：

iframeElement.contentWindow.postMessage(
  {
    action: 'init',
  },
  '*'
)

# note-custom-config

说明：设置文字文档自定义的 UI 配置。

时机：随时。

必须：否。

示例：

iframeElement.contentWnidow.postMessage(
  {
    action: 'note-custom-config',
    data: {
      config: {
        showTopBar: false, // 不展示顶部条
      },
    },
  },
  '*'
)

# insert-content

说明：向文字文档插入内容。

时机：随时。

必须：否。

示例：

iframeElement.contentWnidow.postMessage(
  {
    action: 'insert-content',
    data: {
      // 文档转换成 ops
      ops: [],
    },
  },
  '*'
)

# set-mention-user-list

说明：设置@（提及）功能的列表数据。

时机：随时。

必须：否。

示例：

iframeElement.contentWindow.postMessage(
  {
    action: 'set-mention-user-list',
    data: {
      // 联系人参数，默认取最近联系人取其中的前三个
      userInfoDTOList: [],
      // 若参数数量大于0，则最近联系人会使用此参数展示
      userRecentInfoDTOList: [],
    },
  },
  '*'
)

完整实例：

点击查看

iframeElement.contentWindow.postMessage(
  {
    action: 'set-mention-user-list',
    data: {
      // 联系人参数，默认取最近联系人取其中的前三个
      userInfoDTOList: [
        {
          uid: 10001,
          nickname: '张三',
          highLightNickname: '张三',
          headPhotoUrl:'',
          role: 'owner',
          roleName: '所有者',
        },
        {
          uid: 10002,
          nickname: '李四',
          highLightNickname: '李四',
          headPhotoUrl:
            '',
          role: 'editor',
          roleName: '可编辑',
        },
      ]
      // 若参数数量大于0，则最近联系人会使用此参数展示
      userRecentInfoDTOList: [],
    },
  },
  '*'
)

# get-doc-html

说明：获取文档 HTML 内容。通过监听回调消息 doc-html 获取结果。

时机：随时。

必须：否。

示例：

iframeElement.contentWnidow.postMessage(
  {
    action: 'get-doc-html',
  },
  '*'
)

← 起步回调消息 →