Class: Interface

Interface

While not strictly an abstract class in the OOP sense it acts as an interface between the GUI and manager modules. Managers implement most of the the class methods.

new Interface()

Provides the abstract interface for all managers.

Source:
To Do:
  • Dynamically load and add managers

Methods

<static> getAvailable() → {Array}

Returns availble managers after a test is performed to ensure the manager is available

Source:
Returns:

Deferred* Array of manager module names

Type
Array

<virtual, static> getInstalled(managerName) → {Array}

Returns installed packages/dependencies

Parameters:
Name Type Description
managerName String

Manager name as defined in the managerModules array. Optional.

Source:
Returns:

Deferred* Array of Result objects

Type
Array

<static> getManagers() → {Array}

Returns manager module names added to a static array

Source:
Returns:

Manager module names

Type
Array

<virtual, static> install(managerModule, packageName) → {Status}

Install package/dependency

Parameters:
Name Type Description
managerModule String

Manager name as defined in the managerModules array

packageName String

Unique package/dependency name

Source:
Returns:

Deferred* Installed Status object

Type
Status

Searches one or more managers for a package

Parameters:
Name Type Description
searchManager String

Manager name as defined in the managerModules array. Optional

query String

Search query

Source:
Returns:

Deferred* Search result objects

Type
Array

<virtual, static> uninstall(managerModule, packageName) → {Status}

Uninstall package/dependency

Parameters:
Name Type Description
managerModule String

Manager name as defined in the managerModules array

packageName String

Unique package/dependency name

Source:
Returns:

Deferred* Uninstalled Status object

Type
Status

<virtual, static> update(managerModule, packageName) → {Status}

Update package/dependency

Parameters:
Name Type Description
managerModule String

Manager name as defined in the managerModules array

packageName String

Unique package/dependency name

Source:
Returns:

Deferred* Updated Status object

Type
Status
Copyright © Kyle Hornberg 2014
Documentation generated by JSDoc 3.2.2 on Thu Apr 03 2014 13:07:01 GMT-0500 (CDT) using the DocStrap template.