API Docs for: 0.9.1
Show:

ReportManager Class

Extends Base
Defined in: lib/manager.js:17

Methods

_initializeListenerRegistry

() private

Defined in lib/manager.js:115

Initializes the listener registry

_initializeReporterRegistry

() private

Defined in lib/manager.js:82

Initializes the reporter registry

_normalizeListener

(
  • listener
)
Object[] private

Defined in lib/manager.js:438

Normalizes the listener

Parameters:

Returns:

Object[]:

_normalizeReporter

(
  • reporter
)
Object[] private

Defined in lib/manager.js:282

Normalizes the reporter

Parameters:

Returns:

Object[]:

addListener

(
  • name
  • [options]
)
AbstractListener

Defined in lib/manager.js:390

Adds a new listener to the list of active listeners

Parameters:

Returns:

AbstractListener:

addListenerRange

(
  • listener
)
AbstractListener[]

Defined in lib/manager.js:419

Adds a new listener to the list of active listeners

Parameters:

Returns:

AbstractListener[]:

addReporter

(
  • name
  • [options]
)
AbstractReporter

Defined in lib/manager.js:237

Adds a new reporter to the list of active reporters

Parameters:

Returns:

AbstractReporter:

addReporterRange

(
  • reporter
)
AbstractReporter[]

Defined in lib/manager.js:263

Adds a new reporter to the list of active reporters

Parameters:

Returns:

AbstractReporter[]:

clear

()

Defined in lib/manager.js:577

Clears all run-data

getActiveListener

() AbstractListener[]

Defined in lib/manager.js:322

Gets all the active listener

Returns:

AbstractListener[]:

getActiveReporter

() AbstractReporter[]

Defined in lib/manager.js:169

Gets all the active reporter

Returns:

AbstractReporter[]:

getAllowedMessages

() String[]

Defined in lib/manager.js:477

Gets a list of allowed messages

Returns:

String[]:

getContainer

() ReportContainer

Defined in lib/manager.js:158

Gets the container of messages

Returns:

ReportContainer:

getListener

(
  • name
)
Function

Defined in lib/manager.js:354

Gets a specific registered listener

Parameters:

Returns:

Function:

getListenerList

() Object

Defined in lib/manager.js:332

Gets a dictionary of registered listener

Returns:

Object:

getLoaders

() Object static

Defined in lib/manager.js:643

Gets a list of loaders

Returns:

Object:

getMessengers

() Object static

Defined in lib/manager.js:628

Gets a list of messengers

Returns:

Object:

getOptions

() Object

Defined in lib/manager.js:148

Gets the options

Returns:

Object:

getReporter

(
  • name
)
Function

Defined in lib/manager.js:201

Gets a specific registered reporter

Parameters:

Returns:

Function:

getReporterHooks

() Object static

Defined in lib/manager.js:657

Gets a list of reporter-hooks

Returns:

Object:

getReporterList

() Object

Defined in lib/manager.js:179

Gets a dictionary of registered reporter

Returns:

Object:

hasListener

(
  • name
)
Boolean

Defined in lib/manager.js:343

Checks if a listener is registered

Parameters:

Returns:

Boolean:

hasReporter

(
  • name
)
Boolean

Defined in lib/manager.js:190

Checks if a reporter is registered

Parameters:

Returns:

Boolean:

initialize

()

Defined in lib/manager.js:67

Initializes the instance

loadHook

(
  • type
  • reportId
  • [finishedCallback]
)
Function

Defined in lib/manager.js:557

Loads a reporter hook and returns the system specific function to be supplied to the system

Parameters:

Returns:

Function:

message

() Event

Defined in lib/manager.js:528

Returns a convenience object to trigger messages

Returns:

Event:

parse

(
  • text
  • [placeholder]
)
String

Defined in lib/manager.js:539

Parses a string to see if any listener can receive messages from it

Parameters:

Returns:

String:

processMessage

(
  • messageType
  • data
)

Defined in lib/manager.js:502

Processes a message by sending it to all attached reporter

Parameters:

registerListener

(
  • name
  • contr
)

Defined in lib/manager.js:365

Registers a listener

Parameters:

registerListenerRange

(
  • list
)

Defined in lib/manager.js:376

Registers a list of listeners

Parameters:

  • list Object[]

    { name: <string>, fn: <function> }

registerReporter

(
  • name
  • contr
)

Defined in lib/manager.js:212

Registers a reporter

Parameters:

registerReporterRange

(
  • list
)

Defined in lib/manager.js:223

Registers a list of reporters

Parameters:

  • list Object[]

    Of { name: <string>, fn: <function> }

shouldCollect

() Boolean

Defined in lib/manager.js:137

Should report-manager collect events?

Returns:

Boolean:

version

() String static

Defined in lib/manager.js:671

Gets the module version

Returns:

String:

Properties

AbstractListener

AbstractListener static

Defined in lib/manager.js:599

AbstractLoader

AbstractLoader static

Defined in lib/manager.js:620

AbstractMessenger

AbstractMessenger static

Defined in lib/manager.js:606

AbstractReporter

AbstractReporter static

Defined in lib/manager.js:613