回调种类

除特殊指定的回调外,所有回调都是Json数据格式。

  • 固定使用“handle”字段表示回调方式,值“action”表示动作,值“event”表示事件,值”request”表示请求。
  • 固定使用“type”字段表示回调类型。
  • 固定使用“result”字段表示返回结果状态,0:表示失败,1:表示成功。

其它根据不同的回调类型需要,会动态增添字段以承载返回的数据内容,详见具体回调说明。

动作

一般用于外部应用或操作者主动发起的操作请求的异步结果返回。例如第三方应用调用了获取文档数据操作,则在ThinkEditor准确好数据后,通过回调函数按如下Json数据返回给外部应用使用。

{
    "handle": "action", 
    "type": "getDoc", 
    "code": 1, 
    "clusterName": "张小北-入院记录", 
    "data": "***DocUtf8Str***"
}

事件

一般用于向外部应用通知编辑器内部状态改变。例如字体格式发现了变化,ThinkEditor会通过回调函数将如下Json数据返回给外部应用使用。

{
    "handle": "event", 
    "type": "fontTypeChange", 
    "data": "方正书宋简体"
}

请求

一般用于文档请求外部应用加载资源。

{
    "handle": "request", 
    "type": "setElementCotent"
}
文档更新时间: 2022-01-24 18:30   作者:admin