APICLOUD中窗口通信技术总结

5. 窗口间通信机制

--

5.1 跨窗口调用函数

api.execScript()

execScript

在指定 window 或者 frame 中执行脚本，对于 frameGroup 里面的 frame 也有效，若 name 和 frameName 都未指定，则在当前 window 中执行脚本，具体执行逻辑见补充说明。

execScript({params})

params

name：

• 类型：字符串
• 默认值：无
• 描述：（可选项）window 名称，若要跨 window 执行脚本，该字段必须指定，首页的名称为 root

frameName：

• 类型：字符串
• 默认值：无
• 描述：（可选项）frame名称

script：

• 类型：字符串
• 默认值：无
• 描述：js代码

示例代码

//在当前window中执行jsfun脚本
var jsfun = 'funcGoto();';
api.execScript({
    script: jsfun
});

//在当前window中找到名为frmName的frame，并在该frame中执行jsfun脚本
var jsfun = 'funcGoto();';
api.execScript({
    frameName: 'frmName',
    script: jsfun
});

//在名为winName的window中执行jsfun脚本
var jsfun = 'funcGoto();';
api.execScript({
    name: 'winName',
    script: jsfun
});

//在名为winName的window中找到名为frmName的frame，并在该frame中执行jsfun脚本
var jsfun = 'funcGoto();';
api.execScript({
    name: 'winName',
    frameName: 'frmName',
    script: jsfun
});

补充说明

统一处理逻辑为：exec->window->frame

name 参数： 当 name 不传值，或者传空字符串的情况下，execScript 对象为调用 execScript 的window（该 window 可能位于屏幕或者后台），在该 window 中继续 frameName 的逻辑； 当 name 传值且非空字符串，但并未找到名为 name 的 window，则直接返回不处理（不论 frameName 是否有值）。若找到了对应的 window，则在该 window 中继续 frameName 的逻辑；

frameName 参数： 当 frameName 不传值，或者传空字符串的情况下，execScript 对象为调用 execScript 的 window（该 window 可能位于屏幕或者后台），在该 window 中执行 script； 当 frameName 传值且非空字符串，但并未找到名为 frameName 的 frame，则直接返回不处理。若找到了该 frame，则在该 frame 中执行 script。

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

5.2 自定义事件

api.sendEvent();

sendEvent

将任意一个自定义事件广播出去，该事件可在任意页面通过 addEventListener 监听收到。

sendEvent({params})

params

name

• 类型：字符串
• 默认值：无
• 描述：任意自定义事件的名称，比如：apprunning、appover等

extra

• 类型：字符串或 JSON 对象
• 默认值：无
• 描述：（可选项）附带的参数。在监听页面的回调里面通过 ret.value 获取。

示例代码

api.sendEvent({
    name: 'myEvent',
    extra: {
        key1: 'value1',
        key2: 'value2'
    }
});

//html页面a：
api.addEventListener({
    name: 'myEvent'
}, function(ret, err) {
    alert(JSON.stringify(ret.value));
});

//html页面b：
api.addEventListener({
    name: 'myEvent'
}, function(ret, err) {
    alert(JSON.stringify(ret.value));
});

//a、b页面都将收到 myEvent 事件

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

7. APICloud平台事件机制

--

7.1 全局事件管理

7.2 平台事件类型

事件名称全部小写

7.2.6 自定义

7.3 事件监听机制

 

• 添加监听：api.addEventListener()

addEventListener

监听事件，支持系统事件和自定义事件

addEventListener({params}, callback(ret, err))

params

name：

类型：字符串 默认值：无 描述：自定义事件或系统事件名称（详见事件）

//如监听网络连接事件
api.addEventListener({
    name: 'online'
}, function(ret, err) {
    alert('已连接网络');
});

补充说明

监听事件

可用性

iOS系统，Android系统

可提供的1.0.0及更高版本

示例代码

{
    threshold:            //当事件为scrolltobottom时，设置距离底部多少距离时触发事件，默认值为0，数字类型
    timeout:                //当事件为appidle时，设置经过多长时间不操作屏幕时触发，单位秒，数字类型
}

callback(ret, err)

ret：

extra：

 

 

• 类型：JSON 对象
• 描述：事件发生时传递的参数，可能为空
• 类型：JSON 对象
• 默认值：无
• 描述：（可选项）附加字段。一些特定事件可能需要提供额外的参数。
• 内部字段：
• 删除监听：api.removeEventListener()

removeEventListener

移除事件监听

removeEventListener({params})

params

name：

类型：字符串 默认值：无 描述：自定义事件或系统事件名称（详见事件）

iOS系统，Android系统

可提供的1.0.0及更高版本

示例代码

api.removeEventListener({
    name: 'online'
});

补充说明

停止监听事件

可用性

 

• 发送事件：api.sendEvent()