网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务
文档首页/ 华为云Astro轻应用/ API参考/ 预置API/ 标准页面中预置的API

标准页面中预置的API

更新时间:2024-10-21 GMT+08:00
分享

在开发标准页面时,可以通过编写JS代码,来实现页面组件与后台接口之间的交互。如图1所示,在编写JS代码时,可直接使用系统预置的API。

系统预置的API代码结构样例如下,提供事件上下文context,用于封装常用的对象及API。
context
├──$app  // 当前app信息
├──$user  // 当前用户信息
├──$page  // 页面相关操作
├──$component  // 组件相关操作
├──$model  // 数据模型相关操作
├──$message  // 提示消息
└──$dialog  // 对话框
└──$bp  // BPM相关操作
└──$bpm  // BPM相关操作,推荐使用该API,原子级操作
└──$params  // 获取组件事件的入参
图1 使用内置的模块代码

下面按照分类介绍标准页面中预置API。

组件类

  • 获取当前组件

    context.$component.current

  • 根据KEY获取组件

    API:context.$component.get(_compKey: number)

    入参:组件KEY,类型为number。

    出参:Component。

    示例如下:

    let _compKey = 1546395654403000
    let _component = context.$component.get(_compKey)
  • 根据名称获取组件

    API:context.$component.get(_compName: string)

    示例如下:

    let _compName = 'input_1'
    let _component = context.$component.get(_compName)
  • 获取组件绑定的模型

    API:_component.getDataModel()

    _component为当前操作的组件。

    示例如下:

    let _component = context.$component.current
    let _model = _component.getDataModel()

消息及弹框

说明:

消息及弹框的默认显示时间为5秒,可以通过传入第二个参数duration,来自定义显示时间。

例如,自定义提示成功消息时间为8秒,执行语句如下:

API:context.$message.success(message: string, duration: 8)
  • 提示成功消息

    API:context.$message.success(message: string)

    示例:

    // 成功消息
    context.$message.success('Successfully')
  • 提示错误消息

    API:context.$message.error(message: string)

    示例:

    // 失败消息
    context.$message.error('Failed')
  • 普通消息弹出框

    API:context.$dialog.info(option: object)

    入参:option,对话框参数,结构如下:

    {
     title: string,      // 标题
     content: string,    // 内容
     okText:string,     // 确认按钮名称,可选
     onOk: function      // 确认回调函数,可选
    }

    示例:

    // 普通弹出消息
    context.$dialog.info({ title: 'Info', content: 'content', okText: 'ok', onOk: () => {alert('click ok')}})
  • 确认消息弹出框

    API:context.$dialog.confirm(option: object)

    入参:option,对话框参数,结构如下:

    {
     title: string,      // 标题
     content: string,    // 内容
     okText:string,     // 确认按钮名称,可选
     cancelText:string, // 取消按钮名称,可选
     onOk: function,     // 确认回调函数,可选
     onCancel: function  // 取消回调函数,可选
    }

    示例:

    // 确认弹出消息
    context.$dialog.confirm({ title: 'Confirm', content: 'content', okText: 'ok', cancelText: 'cancel', onOk: () => {alert('click ok')}, onCancel: () => {alert('click cancel')}})
  • 成功消息弹出框

    API:context.$dialog.success(option: object)

    入参:option, 对话框参数,结构如下:

    {
     title: string,      // 标题
     content: string,    // 内容
     okText:string,     // 确认按钮名称,可选
     onOk: function      // 确认回调函数,可选
    }

    示例:

    // 成功弹出消息
    context.$dialog.success({ title: 'Info', content: 'content', okText: 'ok', onOk: () => {alert('click ok')}})
  • 错误消息弹出框

    API:context.$dialog.error(option: object)

    入参:option,对话框参数,结构如下:

    {
     title: string,      // 标题
     content: string,    // 内容
     okText:string,     // 确认按钮名称,可选
     onOk: function      // 确认回调函数,可选
    }

    示例:

    // 错误弹出消息
    context.$dialog.error({ title: 'Error', content: 'content', okText: 'ok', onOk: () => {alert('click ok')}})
  • 弹出页面

    API:context.$dialog.popup({ title: 'Error', page: 'date111',width:60,height:500, okText: 'ok',loading:true, params:{},onCancel: () => {alert('click cancel')},onOk: (data) => { data.visible = false; alert('click ok')}})

    入参:option,对话框参数,结构如下:

    {
     title: string,      // 标题
     page:string        // 弹出页面名称 
     width:integer       // 页面宽度,小于100为百分比,大于100为px
     height:integer      // 页面高度
     okText:string,     // 确认按钮名称,可选
     params:object      // 页面参数
     onCancel: function  // 取消时回调函数,可选
     onOk: function      // 确认回调函数,可选
     maskClosable: boolean //是否允许点击遮罩层关闭,默认true
     footerHide: boolean//是否隐藏按钮(确定、取消)区域,默认false
     loading: boolean //点击确定按钮时,确定按钮是否显示 loading 状态,开启则需在onOk中手动设置visible来关闭对话框
     draggable: boolean //是否可以拖动,默认false
     showCancel: boolean //是否展示取消按钮,默认true
     okFirst: boolean //是否确定按钮在取消按钮前面,默认false
    }
    说明:

    loading:false用于确定按钮是否显示loading状态,默认为false即不显示loading状态,如果设置为true显示loading,onOk里需要使用visible来关闭对话框。

    footerHide:false用于控制弹出页面上的按钮是否显示,默认为false表示不显示,设置为true可显示按钮。

  • 子页面中关闭当前页面

    API:Page.$popup.get(Page.$root.popupKey).close();

页面类

  • 获取当前页面

    API:context.$page.current

  • 当前页面绑定的数据模型

    API:context.$page.getModel()

  • 页面URL参数

    API:context.$page.params.paramName

    示例:

    // 假设当前页面URL为:https://localhost:8080/besBaas/page#/std_1?a=1&b=2, 则获取URL参数方式如下:
    let paramA = context.$page.params.a
    let paramB = context.$page.params.b
  • 在新的导航条打开页面

    API:context.$page.open(url: string, queryString: string)

    入参:url表示页面地址。queryString表示查询参数(URL参数),格式为“key=value”,多个参数用“&”符号连接。

    示例:

    context.$page.open('https://localhost:8080/besBaas/page#/std_2', 'a=1&b=2')
  • 在当前导航条打开页面

    API:context.$page.load(url: string, queryString: string)

  • 刷新当前页面

    API:context.$page.reload()

  • 在新的导航条打开标准页面

    API:context.$page.openStdPage(pageName: string, queryString: string)

    入参:pageName表示页面名称。queryString表示查询参数(URL参数),格式为“key=value”,多个参数用“&”符号连接。

    示例:

    context.$page.openStdPage('std_2', 'a=1&b=2')
  • 在当前导航条打开标准页面

    API:context.$page.loadStdPage(pageName: string, queryString: string)

  • 在新的导航条打开高级页面

    API:context.$page.openAdvPage(pageName: string, websiteName:string, queryString: string)

    入参:pageName表示页面名称。websiteName表示为高级页面的站点名称,queryString表示查询参数(URL参数),格式为“key=value”,多个参数用“&”符号连接。

  • 在当前导航条打开高级页面

    API:context.$page. loadAdvPage (pageName: string, websiteName:string, queryString: string)

  • 关闭当前页面

    API:window.close()

    图2 关闭页面语句

表单类

  • 获取当前表单

    API:context.$component.form

    如果当前组件为表单,则直接返回。否则,根据组件上下文向上查找最近的表单组件。

  • 根据组件Key值获取表单

    API:context.getFormByKey(_formKey: number)

    入参:表单组件的Key值,类型为number。

  • 校验整个表单
    • API:_form.formValidate()

      _form为已获取的表单组件,返回promise。

    • API:_form. formValidateUnPromise

      非promise,返回true/false。

  • 表单的单字段校验:

    API:_form.validateField(prop, callback)

    参数prop为需校验的属性,参数callback为检验完回调函数,返回错误信息。

    示例:

    _form.validateField("name",function(errorMsg){
         console.log("validate field", errorMsg)
     });
  • 表单重置

    API:_form.resetFields()

    _form为已获取的表单组件。

  • 表单提交

    API:_form.formSave()

    _form为已获取的表单组件。API内部实现已先进行表单校验,校验成功后进行提交保存操作。

表格类

  • 获取当前表格

    API:context.$component.table

    如果当前组件为表格,则直接返回。如果当前组件有关联的表格,则返回对应的表格(如表格查询条件、分页等)。否则,根据组件上下文向上查找最近的表格组件。

  • 获取查询条件

    API:_table.getCondition()

    _table为已获取的表格组件,返回表格绑定的查询条件。

  • 设置查询条件

    API:

    // 先获取条件,再进行赋值
    
    var condition = _table.getCondition();
    // 字段满足单个条件,默认操作是contains
    condition.queryInfo = {
    	"fieldName": "1"
    }
    // 字段满足单个条件,使用自定义操作
    condition.queryInfo = {
    	"fieldName": {
    		operator: "contains",
    		value: "1"
    	}
    }
    // 字段满足多个条件
    condition.queryInfo = {
    	"fieldName": [{
    		operator: "contains",
    		value: "1"
    	},
    	{
    		operator: "contains",
    		value: "2"
    	}]
    }
    // 分页条件
    condition.pageInfo: {
    	"pageSize": 10,
    	"curPage": 1
    }

    其中,“_table”为已获取的表格组件。

    入参:表格查询条件。

  • 执行查询

    API:_table.doQuery()

    其中,“_table”为已获取的表格组件。

  • 初始化行数据

    API:_table.rowInit()

    其中,“_table”为已获取的表格组件,初始化一条新的行数据,此方法执行后,数据并未添加到表格。

  • 添加行数据

    API:_table.addrow(newRowData: object)

    其中,“_table”为已获取的表格组件,此方法将初始化好的行数据添加到表格,此方法执行后,数据仅在前端表格保存,并未持久化到后端。

    入参:行数据。

  • 获取表格当前选中的行数据

    API: _table.getSelectedData()

    其中,“_table”为已获取的表格组件。

  • 删除表格行数据

    API:_table.doDelete(rows: array)

    其中,“_table”为已获取的表格组件。

    入参:表格行数据列表。

    示例:

    // 当前表格
    let _table = context.$component.table
    // 获取当前选中的行
    let rows = _table.getSelectedData()
    // 删除选中行
    _table.doDelete(rows)
  • 获取表格修改的数据(新增、修改、删除)

    API:_table.getOperatedData()

    其中,“_table”为已获取的表格组件。

  • 保存表格数据

    API:_table.doSave(operatedData: object)

    其中,“_table”为已获取的表格组件,此方法将当前表格做的修改操作进行持久化操作。

    入参:修改的表格数据。

    示例:

    // 当前表格
    let _table = context.$component.table
    // 获取修改的数据
    let operatedData = _table.getOperatedData()
    // 提交表格修改
    _table.doSave(operatedData)

对象操作

  • 获取对象

    API:context.object(objectName)

    入参:objectName,对象名称。

    出参:对象。

    示例如下:

    let _object = context.object("objectName")
  • 查询对象所有数据

    API:

    _object.query().then(function (response) {
        // TODO: Your business logic
    })
  • 查询满足条件数据

    例如,查询满足name = 'test' 条件的对象数据,代码如下:

    let _condition = {conjunction: 'AND', conditions: [{ field: 'name', operator: 'eq', value: 'test' }] }
    _object.query({condition:_condition}).then(function (response) {
        // TODO: Your business logic
    })
  • 统计满足条件的对象数据数量

    API:_object.count(_condition)

    其中,“_object”为对象名称。

    入参:_condition,查询条件,可选。

    出参:Promise。

    示例:

    // 统计所有数据
    _object.count().then(function (response) {
        // TODO: Your business logic
    })
    
    // 统计满足条件数据
    _object.count(_condition).then(function (response) {
        // TODO: Your business logic
    })
  • 查询满足条件数据, 且只查询部分字段
    let _fields = 'id,name'
    _object.query({condition:_condition}, _fields).then(function (response) {
        // TODO: Your business logic
    })
  • 查询满足条件数据, 且只查询部分字段, 支持分页和排序
    例如,根据name字段降序排序,跳过前10条记录分页,每页最多显示10条数据。示例代码如下:
    let _fields = 'id,name'
    let _options= {'skip': 10,'limit': 10,'orderby': [{'field': 'name','order': 'desc'}]}
    _object.query({condition:_condition}, _fields, _options).then(function (response) {
        // TODO: Your business logic
    })
  • 通用对象数据查询

    API:_object.query({condition:_condition}, fields: string)

    入参:_condition,查询条件,可选,参考如下结构。

    { 
        conjunction: 'AND',    // 条件连接符,AND 或 OR
        conditions: [
            { 
                field: 'name', // 条件字段
                operator: 'eq',// 条件比较符
                value: 'test'  // 条件值
            },
            {
                condition: {   // 嵌入条件
                    conjunction: 'OR',
                    conditions: [
                        {
                            field: 'status',
                            operator: 'eq',
                            value: '1'
                        },
                        {
                            field: 'status',
                            operator: 'eq',
                            value: '2'
                        }                
                    ]
                }
            }
        ]
    }

    以上示例表达内容为:name = 'test' && ( status = '1' || status = '2')

    fields:查询字段(只返回指定的字段),多个字段以逗号分隔,可选。

    出参:Promise。

  • 插入对象数据,支持批量操作

    API:_object.insert(data: Object[])

    入参:data,待插入数据,对象数组。

    出参:Promise,返回新插入数据的记录ID。

    示例:

    let data = [{ name: 'test', label: 'test' }]
    _object.insert(data).then(function (response){
        if (response && '0' === response.resCode) {
            let _id = response.result[0].id}})
  • 根据记录ID更新对象数据

    API:_object.updateByID(_id: string, data: Object)

    入参:id表示记录ID,data表示对象更新内容。

    出参:Promise。

    示例:

    let _id = '{{ id }}'
    // 根据记录ID更新数据
    _object.updateByID(_id, { label: 'test2' }).then(function (response) {
        // TODO: Your business logic
    })
  • 根据记录ID查询对象数据

    API:_object.queryByID(_id: string)

    入参:id表示记录ID。

    出参:Promise。

    示例:

    let _id = '{{ id }}'
    // 根据记录ID查询单条数据
    _object.queryByID(_id).then(function (response) {
        // TODO: Your business logic
    })
  • 根据记录ID删除对象数据

    API:_object.deleteByID(_id: string)

    入参:id表示对象记录ID。

    出参:Promise。

    示例:

    let _id = '{{ id }}'
    // 根据记录ID删除数据
    _object.deleteByID(_id).then(function (response) {
        // TODO: Your business logic
    })
  • 根据记录ID批量查询对象数据

    API:_object.batchQueryByIDs(_ids: string, fields: string)

    入参:ids表示记录ID,多个ID以逗号分隔。fields表示查询字段,多个字段以逗号分隔,可选。

    出参:Promise。

    示例:

    _object.batchQueryByIDs('id1,id2,id3').then(function (response) {
        // TODO: Your business logic
    })
  • 根据记录ID批量删除对象数据

    API:_object.batchDeleteByIDs(_ids: string)

    入参:ids表示记录ID,多个ID以逗号分隔。

    出参:Promise。

    示例:

    _object.batchDeleteByIDs('id1,id2,id3').then(function (response) {
        // TODO: Your business logic
    })
  • 批量插入或更新对象数据

    API:_object.batchUpsert(data: Object[])

    入参:data,待插入或更新的数据对象,包含id时表示进行更新。

    出参:Promise。

    示例:

    let data = [{id: '1538033158273005', label: 'test'}, {name: 'test', label: 'test'}]
    
    _object.batchUpsert(data).then(function (response) {
        // TODO: Your business logic
    })

脚本操作

  • 初始化Script

    API:context.script(scriptName)

    入参:scriptName,表示Script名称。

    出参:Script

    示例:

    // 初始化脚本
    let _script = context.script('{{ scriptName }}')
  • 运行Script

    API:_script.run()

    入参:无。

    出参:Promise。

    示例:

    // 初始化脚本
    let _script = context.script('{{ scriptName }}')
    
    // 运行脚本
    _script.run().then(function(response) {
        // TODO: Your business logic
    })

服务编排相关

  • 初始化Flow

    API:context.flow(flowName)

    入参:flowName表示Flow名称。

    出参:Flow

    示例:

    // 初始化Flow
    let _flow = context.flow("flowName")
  • 设置Flow版本号

    API:_flow.version(version: string)

    入参:version表示flow版本号。

    出参:Flow。

    示例:

    // 设置Flow版本号
    _flow.version("0.0.1")
  • 运行Flow

    API:flow.run(params: Object)

    入参:params,输入参数,如下示例:

    {
        param1: 'param1', 
        param2: { 
            param21: 'param21', 
            param22: 'param22'
        } 
    }

    出参:Promise。

    示例:

    // 适用于一次调用,Flow即完成的场景
    // 运行Flow
    _flow.run({ param1: 'param1' }).then(function (res) {
        // TODO: Youre business logic
    })
  • 启动Flow

    API:_flow.start(params: Object)

    入参:params,输入参数,如下示例:

    {
        param1: 'param1', 
        param2: { 
            param21: 'param21', 
            param22: 'param22'
        } 
    }

    出参:Promise。

    示例:

    // 以下适用于多步操作的业务场景
    _flow.start({ param1: 'param1' }).then(function (res) {
        // TODO: Youre business logic
    })
  • 执行Flow下一步

    API:_flow.next(interviewID: string, params: Object)

    入参:interviewID为Flow运行实例ID,params为输入参数。

    {
        param1: 'param1', 
        param2: { 
            param21: 'param21', 
            param22: 'param22'
        } 
    }

    出参:Promise。

    示例:

    // 下一步
    _flow.next("{{ interviewID }}", { param1: 'param1' }).then(function (res) {
        // TODO: Youre business logic
    })
  • 返回Flow上一步

    API:_flow.back(interviewID: string, params: Object)

    入参:interviewID为Flow运行实例ID,params为输入参数。

    {
        param1: 'param1', 
        param2: { 
            param21: 'param21', 
            param22: 'param22'
        } 
    }

    出参:Promise。

    示例:

    // 上一步
    _flow.back("{{ interviewID }}", { param1: 'param1' }).then(function (res) {
        // TODO: Youre business logic
    })
  • 正常完成Flow

    API:_flow.finish(interviewID: string, params: Object)

    入参:interviewID表示Flow运行实例ID;params:输入参数,如下示例:

    {
        param1: 'param1', 
        param2: { 
            param21: 'param21', 
            param22: 'param22'
        } 
    }

    出参:Promise。

    示例:

    // 完成Flow
    _flow.finish("{{ interviewID }}", { param1: 'param1' }).then(function (res) {
        // TODO: Youre business logic
    })
  • 恢复Flow运行

    API:_flow.resume(interviewID: string, params: Object)

    入参:interviewID表示Flow运行实例ID;params:输入参数,如下示例:

    {
        param1: 'param1', 
        param2: { 
            param21: 'param21', 
            param22: 'param22'
        } 
    }

    出参:Promise。

    示例:

    // 恢复Flow
    _flow.resume("{{ interviewID }}", { param1: 'param1' }).then(function (res) {
        // TODO: Youre business logic
    })
  • 删除Flow实例

    API:_flow.terminate(interviewID: string, params: Object)

    入参:interviewID表示Flow运行实例ID;params:输入参数,如下示例:

    {
        param1: 'param1', 
        param2: { 
            param21: 'param21', 
            param22: 'param22'
        } 
    }

    出参:Promise。

    示例:

    // 删除Flow
    _flow.terminate("{{ interviewID }}", { param1: 'param1', param2: { param21: 'param21', param22: 'param22' } }).then(function (res) {
        // TODO: Youre business logic
    })

服务请求

调用服务的API

API:context.service('{{url}}').run(_inputParams)

入参:“url”为服务接口的URL,在APP或者BO视图下单击“服务”,可查看到封装Flow、脚本或者对象操作接口的URL。“_inputParams”为输入参数。

示例:

var _inputParams = {};
// 调用服务
context.service('{{ url }}').run(_inputParams).then(function(response) {
    // TODO: Your business logic
});

BPM相关(非原子级)

  • 获取参数信息

    API:context.$bp.loadVariables()

    入参:无。

    出参:参数对象。

    示例:

    context.$bp.loadVariables().then(function (data) {
        context.$model.ref("loanRequestData").setData(data.result.LoanRequestData);
        context.$model.ref("statusUpdates").setData(data.result.Status);
        context.$model.ref("negotiateCount").setData(data.result.NegotiateCount);
    });
  • 设置BPM中的变量

    API:context.$bp.putVariables (variables:object, instId: string)

    入参:“variables”为参数对象,必选;“instId”为实例ID,可选。

    出参:执行结果。

    示例:

    context.$bp.putVariables({
      LoanRequest: "test"
    });
  • 数据提交到BPM

    API:context.$bp.submitTask (variables:object)

    入参:“variables”为参数对象,必选。

    出参:无。

    示例:

    var data = context.$model.ref("loanRequestData").getData();
    context.$bp.submitTask({
      LoanRequest: data
    });

BPM相关(原子级)

说明:

context.$bp和context.$bpm的区别在于后者保证了操作的原子性。例如,调用context.$bp.submitTask (variables:object)数据提交成功时,会有弹框提示且点击“确定”按钮会自动关闭当前页面。而调用context.$bpm.submitTask (variables:object)提交时,只会提交任务而不会有后续的弹框提示等操作;并且当不在BPM上下文环境中提交任务时(即当BPM实例没有运行时提交任务),会有相关提示信息。

推荐使用context.$bpm。

  • 获取参数信息

    API:context.$bpm.loadVariables()

    入参:无。

    出参:参数对象。

    示例:

    context.$bpm.loadVariables().then(function (data) {
        context.$model.ref("loanRequestData").setData(data.result.LoanRequestData);
        context.$model.ref("statusUpdates").setData(data.result.Status);
        context.$model.ref("negotiateCount").setData(data.result.NegotiateCount);
    });
  • 设置BPM中的变量

    API:context.$bpm.putVariables (variables:object, instId: string)

    入参:“variables”为参数对象,必选;“instId”为实例ID,可选。

    出参:执行结果。

    示例:

    context.$bpm.putVariables({
      LoanRequest: "test"
    });
  • 数据提交到BPM

    API:context.$bpm.submitTask (variables:object)

    入参:“variables”为参数对象,必选。

    出参:无。

    示例:

    var data = context.$model.ref("loanRequestData").getData();
    context.$bpm.submitTask({
      LoanRequest: data
    });
  • 获取BPM实例中的所有变量和变量值

    API:context.$bpm.getVarsByInstanceId("instance_id")

    入参:“instance_id”为BPM实例的ID。

    出参:BPM实例中的所有变量和变量值。

    示例:

    context.$bpm.getVarsByInstanceId("instance_id").then(function (resp) {
        // 回调逻辑
    });
  • 获取一个BPM实例数据

    API:context.$bpm.getBPinstance("instance_id")

    入参:“instance_id”为BPM实例的ID。

    出参:BPM实例数据。

    示例:

    context.$bpm.getBPinstance("instance_id").then(function (resp) {
        // 回调逻辑
    });

公共API

获取csrf token

API:context.$utils.getCSRFToken()

其他

  • 启动定时任务

    API:context.timerTask(_timerHandler, _timeout, _executionCondition);

    入参:分别是定时执行的业务逻辑、任务时间间隔、执行条件。

    示例:

    // 任务间隔时间,毫秒
    var _timeout = 1000;
    
    // 定时执行业务逻辑
    var _timerHandler = function() {
        // TODO: Your business logic 
    };
    
    // 执行条件
    var _executionCondition = function() {
        return true;
    };
    // 启动定时任务
    context.timerTask(_timerHandler, _timeout, _executionCondition);
  • 下载EDM上存储的文档,EDM是系统预置的EDM类型存储器。

    API:context.$edm.download()

    示例:

    // 下载文档
    context.$edm.download(' {{docId}} ', ' {{docType}} ', ' {{subClassName}} ', ' {{docVersion}} ', function() {
    	// 下载失败回调方法
    });
  • 预览EDM上存储的文档,EDM是系统预置的EDM类型存储器。

    API:context.$edm.preview()

    示例:

    // 预览文档
    context.$edm.preview(' {{hw_doc_id}} ', ' {{hw_doc_version}} ', ' {{docFormat}} ', function() {
    	// 预览后回调方法
    }, ' {{container}} ', function() {
    	// 预览失败回调方法
    });
  • 拦截请求

    API:

    // 提供三个参数,url:指定的URL;successFun:请求成功回调方法;failFun:请求失败回调方法。
    // 根据需要填写,例:若不需要successFun可不提供。例如:{url:'', failFun:function(err){ }} 
    context.filter({
        url: '',
        successFun: function (response) {
            // TODO: Your business logic
        },
        failFun: function (error) {
            // TODO: Your business logic
        }
    });
  • 获取当前语言下的国际化信息。

    API:context.$t(name: string)

    入参:“name”为多语言条目的唯一名称,必选。

    出参:当前语言的值。

    示例:

    context.$t("app1.button.label")
  • 获取入参

    有些组件开放的事件是有入参的,在事件自定义代码中可以通过“context.$params”获取入参。context.$params值为数组,对应事件的多个入参。查看入参定义的方法是:请在标准页面设计界面左侧组件区域,将鼠标悬浮在组件上,组件右上会出现问号图标,单击该图标会出现该组件的使用说明,说明中包含事件入参定义。

    图3 查看组件说明

    举例如下:

    1. 在表格的“事件”页签,单击“点击行”事件后的加号。

    2. 在“添加动作”窗口中输入如下代码:
      var data = context.$params[0];
      console.log(data);
    3. 单击页面上方保存按钮,再单击页面上方预览按钮
    4. 在弹出的预览浏览器页面按“F12”可开启调试工具。单击表格某一行触发事件。在“Console”页签查看日志相关信息。日志中会打印事件的入参,即点击的当前行数据。

模型相关

  • 获取data model= model_1实例的数据。

    API:$model.ref("model_1").getData()

  • 设置data model= model_1实例的数据,入参data和model_1定义结构一致,当改变整个模型数据时使用。

    API:$model.ref("model_1").setData(data)

  • 设置data model= model_1实例的字段值,只改变已有模型数据某个字段值时使用。

    API:$model.ref("model_1").setValue(field, value)

Tab页相关

仅支持平台的运行态使用,可使用portal框架暴露的API来实现,平台运行态会暴露一个 bingo 全局变量供使用,标准页面由于在 iframe 内,需要使用 window.parent.bingo 访问:

  • 打开tab页,返回tabId。

    API:openTab(name, url)

  • 切换tab页。

    API:switchTab(tabId)

  • 关闭指定Tab页。

    API:removeTab(tabId)

  • 当前Tab页。

    API:getCurrentTab()

  • 默认Tab页。

    API:getDefaultTab()

  • 打开指定Tab。

    API:open({type:'Tab', id: tabId})

  • 打开指定Tab。

    API:openTabByMenuName(menuName)

  • 返回上一个路由。

    API:back()

提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容