Module: EventBusManager

EventBusManager

EventBusManager Provider
Author:
  • Marco Lehmann <marco.lehmann (at) kiwigrid.com>
Source:

Classes

ketaEventBusManager
ketaEventBusManagerProvider

Methods

<inner> add(eventBus) → {EventBusManagerProvider}

Adds an EventBus instance to internal list, from which it can be retrieved later on by it's id.

Parameters:
Name Type Description
eventBus EventBus EventBus instance to add
Source:
Returns:
EventBusManagerProvider EventBusManagerProvider to chain
Example
angular.module('exampleApp', ['keta.services.EventBusManager'])
    .config(function(ketaEventBusManagerProvider) {
        ketaEventBusManagerProvider
            .add(eventBus)
            .remove(eventBus);
    });

<inner> disableDebug() → {void}

Disables debug mode which normally outputs requests and responses to console.

Source:
Returns:
void returns nothing
Example
angular.module('exampleApp', ['keta.services.EventBusManager'])
    .config(function(ketaEventBusManagerProvider) {
        ketaEventBusManagerProvider.disableDebug();
    });

<inner> enableDebug() → {void}

Enables debug mode which outputs requests and responses to console.

Source:
Returns:
void returns nothing
Example
angular.module('exampleApp', ['keta.services.EventBusManager'])
    .config(function(ketaEventBusManagerProvider) {
        ketaEventBusManagerProvider.enableDebug();
    });

<inner> get(eventBusId) → {EventBus}

Gets an EventBus instance from internal list by specified id.

Parameters:
Name Type Description
eventBusId string EventBus instance id to retrieve from internal list
Source:
Returns:
EventBus EventBus instance if found, otherwise null
Example
angular.module('exampleApp', ['keta.services.EventBusManager'])
    .config(function(ketaEventBusManagerProvider) {
        var eventBus = ketaEventBusManagerProvider.get('eventBus');
    });

<inner> getAll() → {Object}

Gets all EventBus instances from internal list.

Source:
Returns:
Object EventBus instances map (id as key)
Example
angular.module('exampleApp', ['keta.services.EventBusManager'])
    .config(function(ketaEventBusManagerProvider) {
        var eventBuses = ketaEventBusManagerProvider.getAll();
    });

<inner> inDebugMode() → {Boolean}

Returns true if currently in debug mode.

Source:
Returns:
Boolean true if debug mode is enabled
Example
angular.module('exampleApp', ['keta.services.EventBusManager'])
    .config(function(ketaEventBusManagerProvider) {
        if (ketaEventBusManagerProvider.inDebugMode()) {
            // do something useful
        }
    });

<inner> remove(eventBus) → {EventBusManagerProvider}

Removes an EventBus instance from internal list.

Parameters:
Name Type Description
eventBus EventBus EventBus instance to remove
Source:
Returns:
EventBusManagerProvider EventBusManagerProvider to chain
Example
angular.module('exampleApp', ['keta.services.EventBusManager'])
    .config(function(ketaEventBusManagerProvider) {
        ketaEventBusManagerProvider
            .add(eventBus)
            .remove(eventBus);
    });

<inner> removeAll() → {EventBusManagerProvider}

Removes all EventBus instances from internal list.

Source:
Returns:
EventBusManagerProvider EventBusManagerProvider to chain
Example
angular.module('exampleApp', ['keta.services.EventBusManager'])
    .config(function(ketaEventBusManagerProvider) {
        ketaEventBusManagerProvider
            .add(eventBus)
            .removeAll();
    });