公共事件發(fā)布

場(chǎng)景介紹

當(dāng)需要發(fā)布某個(gè)自定義公共事件時(shí)，可以通過publish()方法發(fā)布事件。發(fā)布的公共事件可以攜帶數(shù)據(jù)，供訂閱者解析并進(jìn)行下一步處理。

接口說明

詳細(xì)接口見接口文檔。

發(fā)布不攜帶信息的公共事件

不攜帶信息的公共事件，只能發(fā)布無序公共事件。

1. 導(dǎo)入CommonEvent模塊。

   import commonEvent from '@ohos.commonEventManager';

2. 傳入需要發(fā)布的事件名稱和回調(diào)函數(shù)，發(fā)布事件。

   // 發(fā)布公共事件
   commonEvent.publish("usual.event.SCREEN_OFF", (err) => {
       if (err) {
           console.error(`[CommonEvent] PublishCallBack err=${JSON.stringify(err)}`);
       } else {
           console.info(`[CommonEvent] Publish success`);
       }
   })

發(fā)布攜帶信息的公共事件

攜帶信息的公共事件，可以發(fā)布為無序公共事件、有序公共事件和粘性事件，可以通過參數(shù)CommonEventPublishData的isOrdered、isSticky的字段進(jìn)行設(shè)置。

1. 導(dǎo)入CommonEvent模塊。

   import commonEvent from '@ohos.commonEventManager';

2. 傳入需要發(fā)布的事件名稱和回調(diào)函數(shù)，發(fā)布事件。

   // 公共事件相關(guān)信息
   let options = {
       code: 1, // 公共事件的初始代碼
       data: "initial data", // 公共事件的初始數(shù)據(jù)
   }

3. 傳入需要發(fā)布的事件名稱、需要發(fā)布的指定信息和回調(diào)函數(shù)，發(fā)布事件。

   // 發(fā)布公共事件
   commonEventManager.publish("custom_event", options, (err) => {
       if (err) {
           console.error('[CommonEvent] PublishCallBack err=' + JSON.stringify(err));
       } else {
           console.info('[CommonEvent] Publish success')
       }
   })