common-event-remove-sticky.md 1.1 KB
Newer Older
F
fangJinliang1 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
# 移除粘性公共事件


## 场景介绍

已发出的粘性公共事件后来订阅者也可以接收到,如果这个事件不再转发,需要事件发布者进行移除。OpenHarmony提供了粘性公共事件移除接口。

## 接口说明

参考[接口文档](../reference/apis/js-apis-commonEventManager.md)

| 接口名 | 接口描述 |
| -------- | -------- |
| removeStickyCommonEvent(event: string, callback: AsyncCallback<void>): void | 移除粘性公共事件 |


## 开发步骤

1. 导入模块。
   
   ```ts
   import commonEventManager from '@ohos.commonEventManager';
   ```

2. 移除的粘性公共事件,必须是本应用之前已发布的粘性公共事件,发布粘性公共事件参考[公共事件发布](common-event-publish.md)章节。

   ```ts
   CommonEventManager.removeStickyCommonEvent("sticky_event", (err) => {  // sticky_event粘性公共事件名
       if (err) {
           console.info(`Remove sticky event AsyncCallback failed, errCode: ${err.code}, errMes: ${err.message}`);
           return;
       }
       console.info(`Remove sticky event AsyncCallback success`);
       }
   });
   ```