ab-plugin-embed @前端内嵌类组件

# ab-plugin-embed @前端内嵌类组件

1.引入

import { MfcIe } from "@agree/ab-plugin-embed"
import { OleIe } from "@agree/ab-plugin-embed"
import { OleFrame } from "@agree/ab-plugin-embed"
import { MfcOcx } from "@agree/ab-plugin-embed"
import { Embed } from "@agree/ab-plugin-embed"

2.使用

# Embed

# creatEmbedFrame --76版创建内嵌画面

支持柜面渠道

let handle = ''+this.pub;
let intersectionSize = { 
        x: 50, 
        y: 120, 
        w: 1500, 
        h: 500 
      };
let actualSize = { 
        x: 50, 
        y: 120, 
        w: 1500, 
        h: 500 
      };
let path  = "EMBED";
let actualSize2 = JSON.stringify(actualSize);
let intersectionSize2 = JSON.stringify(intersectionSize);
let result = await Embed.creatEmbedFrame(handle,path,intersectionSize2,actualSize2);
  • 参数列表:
参数 类型 必填参数 默认值 说明
intersectionSize string x 内嵌形成的外围画布的坐标和大小
actualSize string x 内嵌的窗体的坐标和大小
path string x 内嵌对象的标识ID
handle string x 需要内嵌的窗口的句柄
  • 返回值: Object
参数 类型 说明
res.result string true代表内嵌成功false代表内嵌失败

对应柜面原SDK: EMBED.creatEmbedFrame(handle,path,intersectionSize2,actualSize2)


# embeddedRefresh --刷新内嵌画面的大小和位置

支持柜面渠道

let intersectionSize = { 
        x: 50, 
        y: 120, 
        w: 1500, 
        h: 500 
      };
let actualSize = { 
        x: 50, 
        y: 120, 
        w: 1500, 
        h: 500 
      };
let path  = "EMBED";
let actualSize2 = JSON.stringify(actualSize);
let intersectionSize2 = JSON.stringify(intersectionSize);
let result = await Embed.embeddedRefresh(path,intersectionSize2,actualSize2);
  • 参数列表:
参数 类型 必填参数 默认值 说明
intersectionSize string x 内嵌形成的外围画布的坐标和大小
actualSize string x 内嵌的窗体的坐标和大小
path string x 内嵌对象的标识ID
  • 返回值: Object
参数 类型 说明
res.result string 内嵌画面刷新的返回值

对应柜面原SDK: EMBED.embeddedRefresh(path,intersectionSize2,actualSize2)


# embeddedDestroy --销毁指定的内嵌画面

支持柜面渠道

let path  = "EMBED";  //标识ID
let result = await Embed.embeddedDestroy(path);
  • 参数列表:
参数 类型 必填参数 默认值 说明
path string x 内嵌对象的标识ID
  • 返回值: Object
参数 类型 说明
res.result string success代表销毁成功,fail代表销毁失败。

对应柜面原SDK: EMBED.embeddedDestroy(path)


# embeddedVisible --显示指定内嵌画面

支持柜面渠道

let path  = "EMBED";
let result = await Embed.embeddedVisible(path);
  • 参数列表:
参数 类型 必填参数 默认值 说明
path string x 内嵌对象的标识ID
  • 返回值: Object
参数 类型 说明
res.result string 显示内嵌画面的返回值

对应柜面原SDK: EMBED.embeddedVisible(path)


# embedVisibleScreenshot --隐藏对应的内嵌画面

支持柜面渠道

let path  = "EMBED";  
let visible = true; 
let result = await Embed.embedVisibleScreenshot(path,visible);
  • 参数列表:
参数 类型 必填参数 默认值 说明
path string x 内嵌对象的标识ID
visible Boolean x 是否需要返回内嵌画面截图的base64字符串
  • 返回值: Object
参数 类型 说明
res.result string 执行结果

对应柜面原SDK: EMBED.embedVisibleScreenshot(path,visible)


# getVisibleStatus --获取内嵌窗体的状态

支持柜面渠道

let path  = "EMBED";  //标识ID
let result = await Embed.getVisibleStatus(path);
  • 参数列表:
参数 类型 必填参数 默认值 说明
path string x 内嵌对象的标识ID
  • 返回值: Object
参数 类型 说明
res.result string 执行结果

对应柜面原SDK:EMBED.getVisibleStatus(path)


# HideWindow --隐藏传入句柄对应的窗口

支持柜面渠道

let handle  = "00020808"; 
let result = await Embed.HideWindow(handle);
  • 参数列表:
参数 类型 必填参数 默认值 说明
handle string x 窗口的句柄
  • 返回值: Object
参数 类型 说明
res.result string 执行结果

对应柜面原SDK: EMBED.HideWindow(handle)


# screenShoot --内嵌截图

支持柜面渠道

let id  = "EMBED";  //内嵌对象的标识ID
let result = await Embed.screenShoot(id);
  • 参数列表:
参数 类型 必填参数 默认值 说明
id string x 内嵌对象的标识ID
  • 返回值: Object
参数 类型 说明
res.result string 执行结果

对应柜面原SDK: EMBED.screenShoot(id)


MfcIe

# init --发送请求初始化

支持柜面渠道

let id = "MFC_IE";
let res = await MfcIe.initMfcIE(id);
  • 参数列表:
参数 类型 必填参数 默认值 说明
id string x 标识id
  • 返回值: Object
参数 类型 说明
res.result string 成功标识
res.msg string 返回句柄

对应柜面原SDK: MFC_IE.initMfcIE(id)


# refreshUrl --网页刷新

支持柜面渠道

let id = "MFC_IE";
let res = await MfcIe.refreshUrl(id);
  • 参数列表:
参数 类型 必填参数 默认值 说明
id string x 标识id
  • 返回值: Object
参数 类型 说明

对应柜面原SDK: MFC_IE.refreshUrl(id)


# getLocationURL --获取当前浏览器url地址

支持柜面渠道

let id = "MFC_IE";
let res = await MfcIe.getLocationURL(id);
  • 参数列表:
参数 类型 必填参数 默认值 说明
id string x 标识id
  • 返回值: Object
参数 类型 说明
res.result string 成功标识
res.msg string 返回url地址

对应柜面原SDK: MFC_IE.getLocationURL(id)


# setSilent --设置ie是否禁用警告窗口

支持柜面渠道

let id = "MFC_IE";  //当前内嵌组件id
let silent = true;  //是否禁用标识S
let res = await MfcIe.setSilent(id,silent);
  • 参数列表:
参数 类型 必填参数 默认值 说明
id string x 标识id
silent string x 是否禁用标识S
  • 返回值: Object
参数 类型 说明

对应柜面原SDK:MFC_IE.setSilent(id,silent)


# setUrl --设置ie浏览器地址

支持柜面渠道

let id = "MFC_IE";  //当前内嵌组件id
let url = "http://www.baidu.com/";  //访问地址
let res = await MfcIe.setUrl(id,url);
  • 参数列表:
参数 类型 必填参数 默认值 说明
id string x 标识id
url string x 访问地址
  • 返回值: Object
参数 类型 说明

对应柜面原SDK: MFC_IE.setUrl(id,url)


# execute --执行浏览器脚本

支持柜面渠道

let id = "MFC_IE";  //当前内嵌组件id
let script = `document.getElementById('username').value='${this.username}';document.getElementById('userTypePwd').value='${this.password}';`;   //执行script脚本
let res = await MfcIe.execute(id,script);
  • 参数列表:
参数 类型 必填参数 默认值 说明
id string x 标识id
script string x 执行script脚本
  • 返回值: Object
参数 类型 说明

对应柜面原SDK: MFC_IE.execute(id,script)


# finish --执行销毁浏览器 注意:不允许在vue beforeDestroy中使用

支持柜面渠道

let id = "MFC_IE";  //当前内嵌组件id
let res = await MfcIe.finish(id);
  • 参数列表:
参数 类型 必填参数 默认值 说明
id string x 标识id
  • 返回值: Object
参数 类型 说明

对应柜面原SDK: MFC_IE.finish(id)


# delay_finish --延迟执行销毁浏览器 注意:不允许在vue beforeDestroy中使用

支持柜面渠道

let id = "MFC_IE";  //当前内嵌组件id
let delayTime = 1000; //延时时间(毫秒)
let res = await MfcIe.delay_finish(id,delayTime);
  • 参数列表:
参数 类型 必填参数 默认值 说明
id string x 标识id
delayTime int x 延时时间(毫秒)
  • 返回值: Object
参数 类型 说明

对应柜面原SDK: MFC_IE.delay_finish(id,delayTime)


# setValue --为浏览器中某个dom对象设置值

支持柜面渠道

let componentId = "MFC_IE";  //当前内嵌组件id
let id = "username"; //浏览器内操作dom元素的id
let value ="wang";  //浏览器内操作dom元素的value值
let res = await MfcIe.setValue(componentId,id,value);
  • 参数列表:
参数 类型 必填参数 默认值 说明
id string x 浏览器内操作dom元素的id
componentId string x 当前内嵌组件id
value string x 浏览器内操作dom元素的value值
  • 返回值: Object
参数 类型 说明

对应柜面原SDK: MFC_IE.setValue(componentId,id,value)


# submit --浏览器中提交表单

支持柜面渠道

let id = "MFC_IE";  //当前内嵌组件id
let formName = "login";  //浏览器内操作表单的dom元素名称
let res = await  MfcIe.submit(id,formName);
  • 参数列表:
参数 类型 必填参数 默认值 说明
id string x 标识id
formName string x 浏览器内操作表单的dom元素名称
  • 返回值: Object
参数 类型 说明

对应柜面原SDK: MFC_IE.submit(id,formName)


# submitById --根据浏览器中提交表单提交按钮dom-id来触发表单提交

支持柜面渠道

let id = "MFC_IE";  //当前内嵌组件id
let formId = "test";  //浏览器内操作表单的dom元素Id
let res = await  MfcIe.submitById(id,formId);
  • 参数列表:
参数 类型 必填参数 默认值 说明
id string x 标识id
formId string x 浏览器内操作表单的dom元素Id
  • 返回值: Object
参数 类型 说明

对应柜面原SDK: MFC_IE.submitById(id,formId)


# getHtml --获取某个指定内嵌浏览器的全部html(返回的为html的Base64串)

支持柜面渠道

let id = "MFC_IE";  //当前内嵌组件id
let res = await MfcIe.getHtml(id);
  • 参数列表:
参数 类型 必填参数 默认值 说明
id string x 标识id
  • 返回值: Object
参数 类型 说明
res.result string success成功标识
res.htmlScript string html的base64字符串

对应柜面原SDK: MFC_IE.getHtml(id)


OleIe

# init --OLE_IE初始化

支持柜面渠道

let id = "OLE_IE";  //当前内嵌组件id
let res = await OleIe.init(id);
  • 参数列表:
参数 类型 必填参数 默认值 说明
id string x 标识ID
  • 返回值: Object
参数 类型 说明
res.result string 获取到的handle

对应柜面原SDK: OLE_IE.init(id)


# setUrl --给浏览器设置url地址

支持柜面渠道

let id = "OLE_IE";  //当前内嵌组件id
let url = "http://www.baidu.com/" //url地址
let res = await OleIe.setUrl(id,url);
  • 参数列表:
参数 类型 必填参数 默认值 说明
id string x 标识ID
url string x 设置的网址
  • 返回值: Object
参数 类型 说明
res.result string 成功的标识true字符串

对应柜面原SDK: OLE_IE.setUrl(id,url)


# execute --OLE_IE执行浏览器脚本

支持柜面渠道

let id = "OLE_IE";
let script = `document.getElementById('username').value='${this.username}';document.getElementById('userTypePwd').value='${this.password}';`;
let res = await OleIe.execute(id,script);
  • 参数列表:
参数 类型 必填参数 默认值 说明
id string x 标识ID
script string x 脚本命令
  • 返回值: Object
参数 类型 说明

对应柜面原SDK: OLE_IE.execute(id,script)


# finish --OLE_IE执行销毁浏览器

支持柜面渠道

let id = "OLE_IE";
let res = await OleIe.finish(id);
  • 参数列表:
参数 类型 必填参数 默认值 说明
id string x 标识ID
  • 返回值: Object
参数 类型 说明
res.result string 成功的标识

对应柜面原SDK: OLE_IE.finish(id)


# delay_finish --OLE_IE延迟执行销毁浏览器

支持柜面渠道

let id = "OLE_IE";  //当前内嵌组件id
let delayTime = 1000; //延时时间(毫秒)
let res = await OleIe.delay_finish(id,delayTime);
  • 参数列表:
参数 类型 必填参数 默认值 说明
id string x 标识ID
delayTime int x 延迟时间
  • 返回值: Object
参数 类型 说明
res.result string 成功的标识true或false

对应柜面原SDK: OLE_IE.delay_finish(id,delayTime)


# setValue --OLE_IE为浏览器中某个dom对象设置值

支持柜面渠道

let componentId = "OLE_IE";  //当前内嵌组件id
let id = "username"; //浏览器内操作dom元素的id
let value ="wang";  //浏览器内操作dom元素的value值
let res = await OleIe.setValue(componentId,id,value);
  • 参数列表:
参数 类型 必填参数 默认值 说明
id string x 标识ID
componentId string x 电脑标识ID
value string x value值
  • 返回值: Object
参数 类型 说明

对应柜面原SDK: OLE_IE.setValue(componentId,id,value)


# submit --OLE_IE浏览器中提交表单

支持柜面渠道

let id = "OLE_IE";
let formName = "login";
let res = await OleIe.submit(id,formName);
  • 参数列表:
参数 类型 必填参数 默认值 说明
id string x 标识ID
formName string x 浏览器内操作表单的dom元素名称
  • 返回值: Object
参数 类型 说明
res.result string 成功的标识

对应柜面原SDK: OLE_IE.submit(id,formName)


# submitById --OLE_IE根据浏览器中提交表单提交按钮dom-id来触发表单提交

支持柜面渠道

let id = "OLE_IE";
let formId = "test";
let res = await OleIe.submitById(id,formId);
  • 参数列表:
参数 类型 必填参数 默认值 说明
id string x 标识ID
formId string x 浏览器内操作表单的dom元素Id
  • 返回值: Object
参数 类型 说明
res.result string 成功的标识

对应柜面原SDK: OLE_IE.submitById(id,formId)


# doLogin --OLE_IE浏览器登录操作

支持柜面渠道

let id = "OLE_IE";  //当前内嵌组件id
let url = "mail.agree.com.cn"; //登录url路径
let res = await OleIe.doLogin(id,url);
  • 参数列表:
参数 类型 必填参数 默认值 说明
id string x 标识ID
url string x 设置的网址
  • 返回值: Object
参数 类型 说明
res.result string 返回信息

对应柜面原SDK: OLE_IE.doLogin(id,url)


# doLogout --OLE_IE浏览器登出操作

支持柜面渠道

let id = "OLE_IE";  //当前内嵌组件id
let url = "mail.agree.com.cn"; //退出url路径
let res = await OleIe.doLogout(id,url);
  • 参数列表:
参数 类型 必填参数 默认值 说明
id string x 标识ID
url string x 设置的网址
  • 返回值: Object
参数 类型 说明
res.result string 成功的标识

对应柜面原SDK: OLE_IE.doLogout(id,url)


# getHtml --OLE_IE获取某个指定内嵌浏览器的全部html(返回的为html的Base64串)

支持柜面渠道

let id = "OLE_IE";  //当前内嵌组件id
let res = await OleIe.getHtml(id);
  • 参数列表:
参数 类型 必填参数 默认值 说明
id string x 标识ID
  • 返回值: Object
参数 类型 说明
res.result string 成功标识
res.htmlScript string html脚本

对应柜面原SDK: OLE_IE.getHtml(id)


OleFrame

# init --oleFrame初始化操作

支持柜面渠道

let id = "OLE_Frame"; 
let res = await OleFrame.init(id);
  • 参数列表:
参数 类型 必填参数 默认值 说明
id string x 标识id
  • 返回值: Object
参数 类型 说明
res.result string 获取到的handle

对应柜面原SDK: OLE_Frame.init(id)


# dispose --oleFrame销毁操作

支持柜面渠道

let id = "OLE_Frame"; 
let res = await OleFrame.dispose(id);
  • 参数列表:
参数 类型 必填参数 默认值 说明
id string x 标识id
  • 返回值: Object
参数 类型 说明

对应柜面原SDK: OLE_Frame.dispose(id)


# openFile --打开文件

支持柜面渠道

let id = "OLE_Frame";
let filePath = 'C:/Users/CrownHwang/Desktop/test.docx'
let res = await OleFrame.openFile(id,filePath);
  • 参数列表:
参数 类型 必填参数 默认值 说明
id string x 标识id
filePath string x 文件路径
  • 返回值: Object
参数 类型 说明

对应柜面原SDK: OLE_Frame.openFile


# searchWords --查找文字

支持柜面渠道

let id = "OLE_Frame";  //当前内嵌组件id
let words = 'hello'
let res = await OleFrame.searchWords(id,words)
  • 参数列表:
参数 类型 必填参数 默认值 说明
id string x 标识id
words string x 查找的文字
  • 返回值: Object
参数 类型 说明

对应柜面原SDK: OLE_Frame.searchWords


MfcOcx

# init --MFC_OCX初始化操作

支持柜面渠道

let id = "MFC_OCX";  //当前内嵌组件id
let res = await MfcOcx.init(id);
  • 参数列表:
参数 类型 必填参数 默认值 说明
id String x 标识ID
  • 返回值: Object
参数 类型 说明
res.result string 返回handle结果

对应柜面原SDK: MFC_OCX.init(id)


# finish --MFC_OCX销毁操作

支持柜面渠道

let res = await MfcOcx.finish();
  • 参数列表:
参数 类型 必填参数 默认值 说明
x x
  • 返回值: Object
参数 类型 说明

对应柜面原SDK: MFC_OCX.finish()


# retMsg --有返回值,发送信息。

支持柜面渠道

let param = "";  //对应的参数
let res = await MfcOcx.retMsg(param);
  • 参数列表:
参数 类型 必填参数 默认值 说明
param string x 请求参数
  • 返回值: Object
参数 类型 说明
res.result string 执行结果

对应柜面原SDK: MFC_OCX.retMsg(param)


# noRetMsg --无返回值,发送信息。

支持柜面渠道

let param = "";  //对应的参数
let res = await MfcOcx.noRetMsg(param);
  • 参数列表:
参数 类型 必填参数 默认值 说明
param string x 请求参数
  • 返回值: Object
参数 类型 说明
res.result string 成功的标识

对应柜面原SDK: MFC_OCX.noRetMsg(param)


Last Updated: 2022/4/15 下午5:07:24