m8-mcp-server 1.0.0

package/dist/data/ejs-doc/api_io/api_io.md

@@ -0,0 +1,369 @@
+# ejs.io
+
+## downloadFile
+
+下载文件
+
+EJS 默认下载地址`sdk路径/epointapp7/xxx`，H5 端为本地临时路径。
+
+在各个小程序平台运行时，网络相关的 API 在使用前需要配置域名白名单。在 h5 上是跨域的，用户需要处理好跨域问题。
+
+**平台差异**
+
+| ejs（H5 应用) | ejs（新点小程序） |      H5      | 钉钉   | 微信小程序 | 支付宝小程序 |
+| :------------ | :---------------: | :----------: | :----- | :--------- | :----------- |
+| 支持(3.1.2)   |    支持(3.1.2)    | 跨端框架支持 | 不支持 | 支持       | 支持         |
+
+**使用示例**
+
+```js
+ejs.io.downloadFile({
+    url: 'http://app.epoint.com.cn/staticResource/img_head.png',
+    fileName: 'img_head.png',
+    reDownloaded: 0,
+    success: function (result) {},
+    error: function (error) {}
+});
+```
+
+**参数说明**
+
+| 参数              |    参数类型     | 说明                                                                                                    |                                平台差异说明                                 |
+| :---------------- | :-------------: | :------------------------------------------------------------------------------------------------------ | :-------------------------------------------------------------------------: |
+| url               |     String      | `必填`，下载文件的地址                                                                                  |
+| fileName          |     String      | EJS 端`必填`，下载文件的名称                                                                            |                                 仅 ejs 支持                                 |
+| reDownloaded      | Number / String | 当已经下载过时，是否重新下载，为`0`代表已经存在时会直接打开，为`1`代表会重新下载文件并重命名，默认为`0` |                                 仅 ejs 支持                                 |
+| isBackground      | Number / String | 是否在后台下载，如果为`1`，则静默后台下载，否则为`0`时会专门跳到一个下载页面，默认为`1`                 |                                 仅 ejs 支持                                 |
+| openAfterComplete | Number / String | **仅在后台静默下载时有用**，请慎重使用，如果有参数(譬如为`1`)，代表下载后强制打开，默认请不要传递       |                                 仅 ejs 支持                                 |
+| autoStart         | Number / String | EJS`3.4.0`新增，是否自动打开下载文件，`1`自动打开，默认为`0`                                            | 仅 ejs、微信小程序、支付宝小程序支持，支付宝小程序仅支持打开图片和 pdf 文件 |
+| previewUrl        |     String      | 文件预览地址，若不传此参数，则不显示预览按钮                                                            |                                 仅 ejs 支持                                 |
+| filePath          |     String      | 指定文件下载后存储的路径 (本地路径)                                                                     |    仅微信小程序支持（IOS 小程序保存到相册需要添加此字段才可以正常保存）     |
+
+**返回说明**
+
+| 参数     | 参数类型 | 说明                                                                                                   |
+| :------- | :------: | :----------------------------------------------------------------------------------------------------- |
+| filePath |  String  | 返回的文件本地路径，H5 端为本地临时路径，注意`isBackground`为`0`时，会跳转下载页面，此时不会返回该参数 |
+
+## selectFile
+
+选择文件，主要用于选择非媒体文件。
+
+注：微信小程序不支持拉起本地文件目录，该 API 仅能获取微信聊天里的文件。
+
+**平台差异**
+
+| ejs（H5 应用) | ejs（新点小程序） |      H5      | 钉钉   | 微信小程序 | 支付宝小程序 |
+| :------------ | :---------------: | :----------: | :----- | :--------- | :----------- |
+| 支持(3.1.2)   |    支持(3.1.2)    | 跨端框架支持 | 不支持 | 支持       | 不支持       |
+
+**使用示例**
+
+```js
+ejs.io.selectFile({
+    multi: 0, // 是否为多选，ejs组件版本v3.2.7.e后支持
+    success: function (result) {
+        /**
+         * 选择文件后返回（非多选）默认保持原有API返回参数
+         * {
+                resultData: "/storage/emulated/0/DCIM/Camera/IMG_20170703_133717.jpg"
+           }
+         *
+         * 选择文件后返回（多选）
+         * {
+                resultData: ["/storage/emulated/0/DCIM/Camera/IMG_20170703_133717.jpg","/storage/emulated/0/DCIM/Camera/IMG_20170703_133717.jpg"]
+           }
+         *
+         */
+    },
+    error: function (error) {}
+});
+```
+
+![](images/util.selectfile.png)
+
+**参数说明**
+
+| 参数  |    参数类型     | 说明                                                                       |   平台差异说明   |
+| :---- | :-------------: | :------------------------------------------------------------------------- | :--------------: |
+| multi | Number / String | 是否为多选模式。 `1`：多选；`0`：单选（默认） ejs 组件版本 v3.2.7.e 后支持 |                  |
+| count | Number / String | 多选时，最大可选数量，默认 999                                             | 仅微信小程序支持 |
+
+**返回说明**
+
+| 参数       |       参数类型       | 说明               |                              平台差异说明                               |
+| :--------- | :------------------: | :----------------- | :---------------------------------------------------------------------: |
+| resultData | String/Array[String] | 返回文件的本地路径 |                         微信端返回的是临时路径                          |
+| tempFiles  |    Array[Object]     | 返回本地文件列表   | 仅 H5 端和微信端支持，H5 端每一项是一个 File 对象，微信端是一个普通对象 |
+
+## openFile
+
+打开本地文件
+
+**平台差异**
+
+| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
+| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
+| 支持(3.1.2)   |    支持(3.1.2)    | 不支持 | 不支持 | 支持       | 支持         |
+
+**使用示例**
+
+```js
+ejs.io.openFile({
+    path: '/storage/emulated/0/DCIM/Camera/IMG_20170703_133717.jpg',
+    success: function (result) {},
+    error: function (error) {}
+});
+```
+
+**参数说明**
+
+| 参数 | 参数类型 | 说明                                                   |         平台差异说明          |
+| :--- | :------: | :----------------------------------------------------- | :---------------------------: |
+| path |  String  | `必填`，需要被打开的本地文件路径，`/storage`开头的这种 | 支付宝端只支持打开 pdf 及图片 |
+
+## renameFile
+
+重命名文件
+
+**平台差异**
+
+| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
+| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
+| 支持(3.1.2)   |    支持(3.1.2)    | 不支持 | 不支持 | 不支持     | 不支持       |
+
+**使用示例**
+
+```js
+ejs.io.renameFile({
+    path: '/storage/emulated/0/DCIM/Camera/IMG_20170703_133717.jpg',
+    // 如果仅仅是想重命名名字，传newName即可
+    newName: 'IMG_20170703_133718',
+    // 如果想要重命名后缀，传后缀就可以了，没有后缀请不要传这个参数（即为undefined）
+    // 或者 'jpg'
+    newSuffix: 'jpg',
+    success: function (result) {},
+    error: function (error) {}
+});
+```
+
+**参数说明**
+
+| 参数      | 参数类型 | 说明                                                     |
+| :-------- | :------: | :------------------------------------------------------- |
+| path      |  String  | `必填`，需要被重命名的本地文件路径，`/storage`开头的这种 |
+| newName   |  String  | `必填`，新的名称，不包含后缀                             |
+| newSuffix |  String  | 新的后缀，注意，**如果不想改变后缀，请不要传这个参数**   |
+
+## copyFile
+
+复制一个文件到新路径，复制后原有文件会保留
+
+注意，前提是对原生路径比较熟悉，而且 Android 与 iOS 有差异
+
+**平台差异**
+
+| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
+| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
+| 支持(3.1.2)   |    支持(3.1.2)    | 不支持 | 不支持 | 不支持     | 不支持       |
+
+**使用示例**
+
+```js
+ejs.io.copyFile({
+    path: '/storage/emulated/0/DCIM/Camera/IMG_20170703_133717.jpg',
+    // 新的路径-注意，文件夹变了
+    newPath: '/storage/emulated/0/DCIM/Camera2/IMG_20170703_133717.jpg',
+    success: function (result) {},
+    error: function (error) {}
+});
+```
+
+**参数说明**
+
+| 参数    | 参数类型 | 说明                                                   |
+| :------ | :------: | :----------------------------------------------------- |
+| path    |  String  | `必填`，需要被复制的本地文件路径，`/storage`开头的这种 |
+| newPath |  String  | `必填`，新的路径地址，一样需要完整的路径               |
+
+## deleteFile
+
+删除一个本地文件
+
+微信和支付宝小程序端仅支持删除本地存储的文件
+
+**平台差异**
+
+| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
+| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
+| 支持(3.1.2)   |    支持(3.1.2)    | 不支持 | 不支持 | 支持       | 支持         |
+
+**使用示例**
+
+```js
+ejs.io.deleteFile({
+    path: '/storage/emulated/0/DCIM/Camera/IMG_20170703_133717.jpg',
+    success: function (result) {},
+    error: function (error) {}
+});
+```
+
+**参数说明**
+
+| 参数 | 参数类型 | 说明                             |
+| :--- | :------: | :------------------------------- |
+| path |  String  | `必填`，需要被删除的本地文件路径 |
+
+## getFileSize
+
+获取本地图片大小
+
+**平台差异**
+
+| ejs（H5 应用) | ejs（新点小程序） |      H5      | 钉钉         | 微信小程序 | 支付宝小程序 |
+| :------------ | :---------------: | :----------: | :----------- | :--------- | :----------- |
+| 支持(3.1.7)   |    支持(3.1.7)    | 跨端框架支持 | 跨端框架支持 | 支持       | 支持         |
+
+**使用示例**
+
+```js
+ejs.io.getFileSize({
+    path: '/storage/emulated/0/DCIM/Camera/IMG_20170703_133717.jpg',
+    success: function (result) {
+        /**
+         * 选择完图片后返回
+         * {
+                size: 4488 // 单位是b
+           }
+         */
+    },
+    error: function (error) {}
+});
+```
+
+**参数说明**
+
+| 参数 | 参数类型 | 说明                 |
+| :--- | :------: | :------------------- |
+| path |  String  | `必填`，本地图片路径 |
+
+**返回说明**
+
+| 参数 |    参数类型     | 说明                         |
+| :--- | :-------------: | :--------------------------- |
+| size | Number / String | 返回文件的大小，以字节为单位 |
+
+## screenShot
+
+截屏
+
+**平台差异**
+
+| ejs（H5 应用) |            ejs（新点小程序）            |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
+| :------------ | :-------------------------------------: | :----: | :----- | :--------- | :----------- |
+| 支持(3.2.5a)  | 支持(3.2.5a)<br>（ejs-weex 环境不支持） | 不支持 | 不支持 | 不支持     | 不支持       |
+
+**使用示例**
+
+```js
+ejs.io.screenShot({
+    captureType: 1,
+    success: function (result) {
+        /**
+         * 截屏后返回图片的本地路径
+         * {
+                picPath: ""
+           }
+         */
+    },
+    error: function (error) {}
+});
+```
+
+**参数说明**
+
+| 参数        |    参数类型     | 说明                                  |
+| :---------- | :-------------: | :------------------------------------ |
+| captureType | Number / String | 0：截当前屏幕，1：长截图 默认：长截图 |
+
+## report
+
+埋点统计
+
+**平台差异**
+
+| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
+| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
+| 支持(4.0.0)   |    支持(4.0.0)    | 不支持 | 不支持 | 不支持     | 不支持       |
+
+**使用示例**
+
+```js
+ejs.io.report({
+    // url地址
+    url: '',
+    // 响应时间(毫秒)
+    responsetime: '',
+    // 请求内容（请求出错才有）
+    request: '',
+    // 响应内容（请求出错才有）
+    response: '',
+    // 0容器，1小程序，2H5
+    belong: '',
+    // 成功或者失败标示，'0'失败，'1'成功
+    successorfail: '',
+    success: function (result) {},
+    error: function (error) {}
+});
+```
+
+**参数说明**
+
+| 参数          | 参数类型 | 说明                                                          |
+| :------------ | :------: | :------------------------------------------------------------ |
+| url           |  String  | url 地址                                                      |
+| responsetime  |  String  | 响应时间(毫秒)                                                |
+| request       |  String  | 请求内容（请求出错才有）                                      |
+| response      |  String  | 响应内容（请求出错才有）                                      |
+| belong        |  String  | 网络请求是来自小程序/H5/容器的标识, `0`容器，`1`小程序，`2`H5 |
+| successorfail |  String  | 成功或者失败标示，'0'失败，'1'成功                            |
+
+
+## record
+
+基座埋点统计
+
+**平台差异**
+
+| ejs（H5 应用) | ejs（新点小程序） |   H5   | 钉钉   | 微信小程序 | 支付宝小程序 |
+| :------------ | :---------------: | :----: | :----- | :--------- | :----------- |
+| 支持(4.2.22)   |    支持(4.2.22)    | 不支持 | 不支持 | 不支持     | 不支持       |
+
+**使用示例**
+
+```js
+ejs.io.record({
+    // 按钮点击id，需产生点击行为
+    clickid: '',
+    // 按钮点击名称(如有)
+    clicktitle: '',
+    // 当前流程的标识
+    eventid: '',
+    // 流程中当前步骤的名称
+    eventname: '',
+    // 流程中当前步骤的详细日志说明
+    eventcontent: '',
+    success: function (result) {},
+    error: function (error) {}
+});
+```
+
+**参数说明**
+
+| 参数          | 参数类型 | 说明                                                          |
+| :------------ | :------: | :------------------------------------------------------------ |
+| clickid       |  String  | 按钮点击id，需产生点击行为                                    |
+| clicktitle    |  String  | 按钮点击名称(如有)                                            |
+| eventid       |  String  | 当前流程的标识                                              |
+| eventname     |  String  | 流程中当前步骤的名称                                        |
+| eventcontent  |  String  | 流程中当前步骤的详细日志说明                                |