1. 事件机制

QAP-SDK 支持 3 种类型的事件机制： 页面级别事件 应用级别事件 全局级别事件

• 页面级别事件 —— 只能在当前页面被监听和触发。
  • 事件名的前缀为 Page.。如：Page.hello。
• 应用级别事件 —— 能在整个应用插件的任一页面被监听和触发。
  • 事件名的前缀为 App.。如：App.hello。
• 全局级别事件 —— 能在千牛内的任一页面被监听，但是应用插件不能触发此类型事件。
  • 事件名的前缀为 Global.。如：Global.hello。

注意： 如果事件不含上述的前缀，则默认为页面级别事件，前缀为 Page.。即事件 hello 和 Page.hello 等同。

1.1. 内置事件

为了提升应用体验和开发效率，QAP-SDK 内置了以下事件：

1.2. API 调用

1.2.1. QN.on(event, callback)

注册事件

API 调用入参

API 响应结果

事件回调入参

调用示例

QN.on('Page.hello', (data) => {
    console.log(data);
});

// 如果想知道事件注册是成功还是失败
QN.on('Page.hello', (data) => {
    console.log(data);
})
.then(result => {
    console.log('注册成功');
})
.catch(error => {
    console.log('注册失败');
});

1.2.2. QN.off(event, callback)

注销事件

API 调用入参

API 响应结果

调用示例

// 注销事件时传递对应的回调函数。此时只会注销该回调函数，其他的事件回调函数不受影响。
QN.off('Page.hello', (data) => {
    console.log(data);
});
// 注销事件时不传递事件回调函数，此时会注销所有该事件下的回到函数。
QN.off('Page.hello');

// 如果想知道注销事件是成功还是失败
QN.off('Page.hello', (data) => {
    console.log(data);
})
.then(result => {
    console.log('注销成功');
})
.catch(error => {
    console.log('注销失败');
});

1.2.3. QN.emit(event, data, options)

触发事件

API 调用入参

API 响应结果

调用示例

let data = {msg: 'msg from Page.hello'};
// 仅触发事件
QN.emit('Page.hello');

// 触发事件，并发送数据
QN.emit('Page.hello', data);

// 触发粘性事件
QN.emit('Page.hello', {sticky: true});

// 触发粘性事件，并发送数据
QN.emit('Page.hello', data, {sticky: true});

// 触发事件，并希望得知触发是否成功
QN.emit('Page.hello')
.then(result => {
    console.log('触发成功');
})
.catch(error => {
    console.log('触发失败');
});