Class: Configuration

Configuration

This class encapsulates all Continuum configuration defined in the user-editable continuum.conf.js file and related functionality.

Classes

Proxy

Methods

(static) getAccessEngineType() → {string}

Gets the value for the 'accessEngineType' attribute defined in continuum.conf.js. Used to determine which version of Access Engine is included with this installation of Continuum and should be used.
Source:
Returns:
Type
string

(static) getAmpApiToken() → (nullable) {string}

Gets the value for the 'ampApiToken' attribute defined in continuum.conf.js. The AMP API token of the user to use to authenticate any requests to AMP that require authentication, e.g. creating/editing reports in AMP from Continuum as part of submitting test results from Continuum to AMP. Set to null if you don't want to take advantage of this functionality.
Source:
Returns:
Type
string

(static) getAmpInstanceUrl() → {string}

Gets the value for the 'ampInstanceUrl' attribute defined in continuum.conf.js. The URL to the desired AMP instance from which to pull best practice data from.
Source:
Returns:
Type
string

(static) getDefaultStandardIds() → (nullable) {Array.<number>}

Gets the set of IDs implied from the value of the 'defaultStandardIds' attribute defined in continuum.conf.js as a comma-delimited array of IDs of the accessibility standards to test for by default (invoke Continuum#getSupportedStandards for a list of these). Set the value of the 'defaultStandardIds' attribute in continuum.conf.js to null to not filter by any accessibility standards by default.
Source:
Returns:
Type
Array.<number>

(static) getIncludePotentialAccessibilityConcerns() → {boolean}

Gets the value for the 'includePotentialAccessibilityConcerns' attribute defined in continuum.conf.js. Used to determine whether or not accessibility concerns that require manual review are returned in any of Continuum's test results. If enabled, any accessibility concerns that require manual review will have AccessibilityConcern#needsReview return true. This setting can be toggled programmatically using Continuum#setIncludePotentialAccessibilityConcerns, overriding this value specified in continuum.conf.js.
Source:
Returns:
Type
boolean

(static) getProxyConfiguration() → {Configuration.Proxy}

Gets the proxy-specific configuration in Continuum represented by the 'proxy' object defined in continuum.conf.js.
Source:
Returns:
Type
Configuration.Proxy