Support removing multiple handlers from an event with client.off

[neemski]

Hello!

Why exactly is the handler a required parameter to the off method in client.js? Sometimes you don't have the exact reference to the handler in memory and this can be problematic. Other times, you would just like to clean every handler up too, and in this case we should be able to call something like:

client.off('myEvent');

No?

[neemski]

Hi, can I get an update on this? This is really affecting the way we clean up handlers when we switch between ticket_sidebar and user_sidebar apps. Aka, when switching between those apps (on app.activated and app.deactivated), I'd like to bind/clean up all handlers without keeping reference to each bound handler.

For reference, my use case looks like this (using the app_scaffold):

// legacy_app.js
let App = {

  events: {
    'app.activated': 'activateHandler',
    'app.deactivated': 'deactivateHandler',
  },

  activateHandler: function() {
    this.handlerList = [
      {
        evtName: 'myEvent',
        callback: this.myEventHandler,
      },
      ...
    ];

    this.handlerList.forEach((handler) => {
      this.zafClient.on(handler.evtName, handler.callback);
    });
  },

  deactivateHandler: function() {
    // Would be really nice if I could just do
    // this.zafClient.off();
    // But I'll even settle for:
    this.handlerList.forEach((handler) => {
      // Note that this.zafClient.off(handler.evtName, handler.callback); doesn't work
      this.zafClient.off(handler.evtName);
    });
  },

  myEventHandler: function() {
    // ...
  },

  ...

};

export default BaseApp.extend(App);

/cc @danielbreves @Mehul-Porwal

[danielbreves]

Hi @kneem, we don't have plans to implement this at the moment, but I don't see any issues with the idea itself. As this project is open-source you're free to submit a pull request. We'll review and merge as soon as time allows. Thanks, Daniel.