移动模板Hook Api文档

需求背景

在客户APP对接的过程中，因为原生APP拥有强大的原生能力，对一些网页基本功能能提供更加友好的用户体验接口，比如：下载、文件预览、图片预览等。但是因为每家厂商设计的接口不一致，为了让这些需求能及时的、甚至自行处理，移动模板将常用的操作通过hook api 的形式暴露出来，APP厂商可以自行通过编写 cm_broker.js 文件自行实现方法的重写。

⚠️ 注意：该便捷交付功能仅在移动模板 v4.5 以上得到支持；以下版本请直接走内部 REQ 二开流程
⚠️ 注意：低版本的 Android 手机浏览器无法兼容 ES6 语法，请不要使用 ES6 语法编写 cm_broker.js 文件

使用方式

一、 如果 APP 开发人员有时间自己写 JavaScript 文件
① 下载我们提供的的 cm_broker.js
② 按照下面的文档重写里面需要重写的方法
③ 交由我们前线的同事或相关有权限操作部署 coremail 系统的人员覆盖到 /home/coremail/web/webapp/hxphone/static/js 目录中

二、如果 APP 开发人员没有时间自己写 JavaScript 文件
① 提供 APP JS-SDK 对应需要重写方法的文档
② 内部走 REQ 进行二开定制
③ 交由我们前线的同事或相关有权限操作部署 coremail 系统的人员覆盖到 /home/coremail/web/webapp/hxphone/static/js 目录中
注：该方式双方需要不断的沟通联调，耗时会很长

APIs

📌 示范文件可以从此处预览/下载 -> cm_broker.js

@function customSSO 作用：单点拦截方法，可在此方法内做单点。界面初始化将会暂停，直到函数执行回调 initApp

@function isAppEmbed
作用：重新定义内嵌模式判断条件，提供给无法修改 UA 的客户端使用

@function handleAttachmentPreview
原操作：读信页面点击单个附件整个区域触发，如果支持预览的格式，则进入预览页面，否则进入到附件详情展示页面
作用：重写后，可自行定义附件预览操作，交由原生 APP 进行预览

@function handleAttachmentDownload
原操作：读信页面点击单个附件中的下载按钮触发下载操作
作用：重写后，可自行定义附件下载操作，交由原生 APP 进行下载

@function handleInvalidSession
原操作：全局会话过期之后，将弹出会话过期的弹框，点击确定返回登陆页
作用：重写后，可自行定义会话过期操作，阻止原先的交互，原生 APP 自行处理会话过期

@function handleCloseHxphone
原操作：开启全屏模式下，左上角出现 < 返回箭头，点击关闭当前webview页面
作用：重写后，可自行定义该关闭操作