Skip to content

UI 事件通知

iframe 通过 onMessage(type, data) 把路由、生成、保存、下载和错误结果通知宿主页面。接入方只需处理当前业务使用的事件,不需要一次接入完整事件表。

通知与推送回调的区别

预装版(UI 版本)有两类消息能力:

类型触发方式适合处理
事件通知iframe 页面通过 onMessage(type, data) 主动通知宿主页面路由变化、扣费、创建任务、生成完成、保存、下载、错误、回退
事件推送回调接入方在配置中提供回调地址或回调能力,由 AiPPT 在特定业务动作后推送保存 PPT 等需要服务端感知的结果

如果只是前端页面联动,优先使用事件通知;如果接入方服务端必须记录业务结果,再配置事件推送回调。

基础事件监听

基础接入需要监听以下关键事件,其他事件可按业务需要补充:

目标建议监听用途
判断初始化和会话状态ERRORTOKEN_EXPIRE提示用户重新获取 code 或重新打开 iframe
记录生成结果OUTLINE_CONFIRMGENERATE_PPT_SUCCESS关联任务 ID、作品 ID 和业务记录
处理下载OUTLINE_DOWNLOADPPT_DOWNLOADdownload_mode=02 时获取下载结果和地址
处理编辑器保存PPT_SAVE记录用户在编辑器内的保存结果
接管权限判断SCENE_AUTH配合 scene_auth 决定当前动作是否允许继续

按生成阶段查事件

阶段事件边界说明
路由与异常ROUTERERRORTOKEN_EXPIREBACK_BUTTON页面跳转、初始化失败、Code 过期和回退处理
创建任务CREATE_TASK_BEFORECREATE_TASK_SUCCESSCHARGING生成任务创建前后,以及扣费通知
大纲与内容AI_CONTENT_COMPLETEOUTLINE_CONFIRMOUTLINE_DOWNLOADRETRY_OUTLINE_CONFIRMOUTLINE_DOWNLOAD 发生在大纲弹框位置,不属于编辑器内下载
模板与合成TEMPLATE_SELECTEDGENERATE_PPT_SUCCESSGENERATE_PPT_SUCCESS 表示合成新作品成功
编辑器内操作PPT_EDIT_FILENAMEPPT_SAVEPPT_DOWNLOADPPT_SAVE 是进入编辑器之后的保存;PPT_DOWNLOAD 是作品下载
场景鉴权SCENE_AUTH开启 scene_auth 后,iframe 暂停流程,宿主调用 sceneAuthContinue 决定继续或取消
推送回调SAVE_PPT_PUSH_CALLBACK宿主调用 事件推送 后,用于接收保存推送结果

事件边界

GENERATE_PPT_SUCCESS 是生成流程中合成新作品成功;PPT_SAVE 是进入编辑器之后的保存;OUTLINE_DOWNLOAD 发生在生成流程的大纲弹框位置,不是 PPT 编辑器内下载。

相关参数

相关代码

ts
AipptIframe.show({
  appkey: appkey,
  channel: channel,
  code: code,
  editorModel: editorModel,
  container: container,
  onMessage(type, data) {
    // 以下消息通知全部集成在此处
  } 
})

相关事件

路由通知

接口扣费通知

创建任务前

创建任务完成

AI内容接收完成

大纲点击下一步

点击下载大纲

点击换个大纲

选择模板点击下一步

PPT创建成功

PPT修改文件名称

保存PPT

下载PPT

场景鉴权

Code过期

错误消息

回退事件

事件推送回调