Unsubscribing from Common Events in Dynamic Mode

When to Use

You can call unsubscribe() to unsubscribe from a common event that is no longer required in dynamic mode.

Available APIs

How to Develop

1. Import the commonEventManager module.

   import Base from '@ohos.base';
   import commonEventManager from '@ohos.commonEventManager';
   import promptAction from '@ohos.promptAction';
   import Logger from '../utils/Logger';
   
   const TAG: string = 'ProcessModel';
   

2. Subscribe to an event by following the procedure described in Subscribing to Common Events in Dynamic Mode.

3. Call unsubscribe in CommonEvent to unsubscribe from the common event.

   // The subscriber object is created during event subscription.
   if (this.subscriber !== null) {
     commonEventManager.unsubscribe(this.subscriber, (err: Base.BusinessError) => {
       if (err) {
         Logger.error(TAG, `UnsubscribeCallBack err = ${JSON.stringify(err)}`);
       } else {
         promptAction.showToast({
           message: $r('app.string.unsubscribe_success_toast')
         });
         Logger.info(TAG, `Unsubscribe success`);
         this.subscriber = null;
       }
     })
   } else {
     promptAction.showToast({
       message: $r('app.string.unsubscribe_failed_toast')
     });
   }