|
Continuum for C#
|
This class encapsulates all of the helper functionality Access Continuum offers for running Access Engine to test web projects. More...
Public Types | |
| enum | TestContext { Web } |
| Defines the type of testing environment. More... | |
Public Member Functions | |
| Continuum (string configurationPath) | |
| Initialize the Continuum SDK for accessibility testing. | |
| void | SetUp (WebDriver webDriver, TestContext context=TestContext.Web) |
| Sets up Continuum for web testing. | |
| Metadata | GetPageMetadata () |
| Gets information about the current page on the WebDriver instance. | |
| List< AccessibilityConcern > | RunAllTests () |
| Runs all automatic Access Engine tests against the current page, as defined by the web driver used previously to invoke SetUp. Make sure to invoke one of the setUp methods before invoking this method. | |
| List< AccessibilityConcern > | RunAllTests (bool includeIframeContent) |
| Runs all automatic Access Engine tests against the current page, as defined by the web driver used previously to invoke SetUp. Make sure to invoke one of the setUp methods before invoking this method. | |
| List< AccessibilityConcern > | RunAllTests (List< String > xpathExclusions) |
| Runs all automatic Access Engine tests against the current page, as defined by the web driver used previously to invoke SetUp. Make sure to invoke one of the setUp methods before invoking this method. | |
| List< AccessibilityConcern > | RunAllTests (bool includeIframeContent, List< String > xpathExclusions, Filter filter) |
| Runs all automatic Access Engine tests against the current page, as defined by the web driver used previously to invoke SetUp. Make sure to invoke one of the setUp methods before invoking this method. | |
| List< AccessibilityConcern > | RunAllTestsOnNode (string selectorForNodeToTest) |
| Runs all automatic Access Engine tests against the current page for only the specified node and all its children, as defined by the web driver used previously to invoke SetUp and the specified CSS selector. Make sure to invoke one of the setUp methods before invoking this method. | |
| List< AccessibilityConcern > | RunAllTestsOnNode (string selectorForNodeToTest, bool includeIframeContent) |
| Runs all automatic Access Engine tests against the current page for only the specified node and all its children, as defined by the web driver used previously to invoke SetUp and the specified CSS selector. Make sure to invoke one of the setUp methods before invoking this method. | |
| List< AccessibilityConcern > | RunAllTestsOnNode (string selectorForNodeToTest, List< String > xpathExclusions) |
| Runs all automatic Access Engine tests against the current page for only the specified node and all its children, as defined by the web driver used previously to invoke SetUp and the specified CSS selector. Make sure to invoke one of the setUp methods before invoking this method. | |
| List< AccessibilityConcern > | RunAllTestsOnNode (string selectorForNodeToTest, bool includeIframeContent, List< String > xpathExclusions, Filter filter) |
| Runs all automatic Access Engine tests against the current page for only the specified node and all its children, as defined by the web driver used previously to invoke SetUp and the specified CSS selector. Make sure to invoke one of the setUp methods before invoking this method. | |
| List< AccessibilityConcern > | RunTests (int[] engineTestIds) |
| Runs only the specified automatic Access Engine tests against the current page, as defined by the web driver used previously to invoke SetUp and, for specific test IDs, AMP. Make sure to invoke one of the setUp methods before invoking this method. | |
| List< AccessibilityConcern > | TestForStandards (int[] standardIds) |
| Runs only the automatic Access Engine tests corresponding to the specified accessibility standards against the current page, as defined by the web driver used previously to invoke SetUp and, for specific accessibility standard IDs, AMP. Note that the IDs of the specified accessibility standards must also be specified by Configuration.DefaultStandardIds, i.e. in the set of IDs implied from the value of the 'getDefaultStandardIds' attribute defined in continuum.json, otherwise no accessibility concerns will be returned. Make sure to invoke one of the setUp methods before invoking this method. | |
| List< AccessibilityConcern > | TestForBestPractices (int[] bestPracticeIds) |
| Runs only the automatic Access Engine tests corresponding to the specified best practices against the current page, as defined by the web driver used previously to invoke SetUp and, for specific best practice IDs, AMP. Make sure to invoke one of the setUp methods before invoking this method. | |
| List< AccessibilityConcern > | TestForSeverity (int minSeverity) |
| Runs only the automatic Access Engine tests of or greater than the specified severity against the current page, as defined by the web driver used previously to invoke SetUp. Make sure to invoke one of the setUp methods before invoking this method. | |
| List< AccessibilityConcern > | TestForTractability (int minTractability) |
| Runs only the automatic Access Engine tests of or greater than the specified tractability against the current page, as defined by the web driver used previously to invoke SetUp. Make sure to invoke one of the setUp methods before invoking this method. | |
| List< AccessibilityConcern > | TestForNoticeability (int minNoticeability) |
| Runs only the automatic Access Engine tests of or greater than the specified noticeability against the current page, as defined by the web driver used previously to invoke SetUp. Make sure to invoke one of the setUp methods before invoking this method. | |
| List< AccessibilityConcern > | TestNodeForStandards (int[] standardIds, string selectorForNodeToTest) |
| Runs only the automatic Access Engine tests corresponding to the specified accessibility standards against the current page, as defined by the web driver used previously to invoke SetUp and, for specific accessibility standard IDs, AMP. Note that the IDs of the specified accessibility standards must also be specified by Configuration.DefaultStandardIds, i.e. in the set of IDs implied from the value of the 'getDefaultStandardIds' attribute defined in continuum.json, otherwise no accessibility concerns will be returned. Make sure to invoke one of the setUp methods before invoking this method. | |
| List< AccessibilityConcern > | TestNodeForBestPractices (int[] bestPracticeIds, string selectorForNodeToTest) |
| Runs only the automatic Access Engine tests corresponding to the specified best practices against the current page, as defined by the web driver used previously to invoke SetUp and, for specific best practice IDs, AMP. Make sure to invoke one of the setUp methods before invoking this method. | |
| List< AccessibilityConcern > | TestNodeForSeverity (int minSeverity, string selectorForNodeToTest) |
| Runs only the automatic Access Engine tests of or greater than the specified severity against the current page, as defined by the web driver used previously to invoke SetUp. Make sure to invoke one of the setUp methods before invoking this method. | |
| List< AccessibilityConcern > | TestNodeForTractability (int minTractability, string selectorForNodeToTest) |
| Runs only the automatic Access Engine tests of or greater than the specified tractability against the current page, as defined by the web driver used previously to invoke SetUp. Make sure to invoke one of the setUp methods before invoking this method. | |
| List< AccessibilityConcern > | TestNodeForNoticeability (int minNoticeability, string selectorForNodeToTest) |
| Runs only the automatic Access Engine tests of or greater than the specified noticeability against the current page, as defined by the web driver used previously to invoke SetUp. Make sure to invoke one of the setUp methods before invoking this method. | |
| string | GetAccessibilityConcernsPrettyPrinted () |
| Gets a pretty-printed String of accessibility concerns found by Access Engine during the last test execution. | |
| string | GetAssertionsPrettyPrinted () |
| Gets a pretty-printed String of assertions found by Access Engine during the last test execution. | |
| List< Assertion > | RunAllTestsForAssertions () |
| Runs all automatic Access Engine tests against the current page, as defined by the web driver used previously to invoke SetUp. Make sure to invoke one of the setUp methods before invoking this method. | |
| List< Assertion > | RunAllTestsForAssertions (bool includeIframeContentr) |
| Runs all automatic Access Engine tests against the current page, as defined by the web driver used previously to invoke SetUp. Make sure to invoke one of the setUp methods before invoking this method. | |
| List< Assertion > | RunAllTestsForAssertions (bool includeIframeContent, Filter filter) |
| Runs all automatic Access Engine tests against the current page, as defined by the web driver used previously to invoke SetUp. Make sure to invoke one of the setUp methods before invoking this method. | |
| bool | GetIncludePotentialAccessibilityConcerns () |
| Gets whether or not accessibility concerns that require manual review are included in any of Continuum's test results. If enabled, any accessibility concerns that require manual review will have AccessibilityConcern.NeedsReview return true. By default, this is specified by Configuration.AccessibilityConcernsConfiguration.IncludePotentialConcerns, i.e. the value for the 'includePotentialAccessibilityConcerns' attribute defined in continuum.json. This setting can be toggled programmatically using SetIncludePotentialAccessibilityConcerns, overriding the value specified in continuum.json. | |
| Configuration.Format | GetResultsFormat () |
| void | SetIncludePotentialAccessibilityConcerns (bool includePotentialAccessibilityConcerns) |
| Globally sets whether or not accessibility concerns that require manual review are included in any of Continuum's test results. If enabled, any accessibility concerns that require manual review will have AccessibilityConcern.NeedsReview return true. Using this method will override the value for the 'includePotentialAccessibilityConcerns' attribute defined in continuum.json, which is otherwise used by default. | |
| AMPReportingService | GetAMPReportingService () |
| Gets the instance of the AMP reporting service associated with this instance of Continuum. Please consult our support documentation for more information on how to report to AMP. | |
| LevelAccessPlatformReportingService | GetLevelAccessPlatformReportingService () |
| Dictionary< int, string > | GetSupportedTests () |
| Gets the list of supported tests. | |
| Dictionary< int, string > | GetSupportedBestPractices () |
| Gets the list of supported best practices. | |
| Dictionary< int, string > | GetSupportedStandards () |
| Gets the list of supported standards. | |
Properties | |
| List< AccessibilityConcern > | AccessibilityConcerns [get] |
| Gets the list of accessibility concerns found by Access Engine during the last test execution. | |
| List< Assertion > | Assertions [get] |
| Gets the list of assertions found by Access Engine during the last test execution. | |
This class encapsulates all of the helper functionality Access Continuum offers for running Access Engine to test web projects.
|
inline |
Initialize the Continuum SDK for accessibility testing.
| configurationPath | Relative or absolute path to a valid continuum.json file. |
|
inline |
Gets a pretty-printed String of accessibility concerns found by Access Engine during the last test execution.
|
inline |
|
inline |
Gets a pretty-printed String of assertions found by Access Engine during the last test execution.
|
inline |
Gets whether or not accessibility concerns that require manual review are included in any of Continuum's test results. If enabled, any accessibility concerns that require manual review will have AccessibilityConcern.NeedsReview return true. By default, this is specified by Configuration.AccessibilityConcernsConfiguration.IncludePotentialConcerns, i.e. the value for the 'includePotentialAccessibilityConcerns' attribute defined in continuum.json. This setting can be toggled programmatically using SetIncludePotentialAccessibilityConcerns, overriding the value specified in continuum.json.
|
inline |
Gets information about the current page on the WebDriver instance.
|
inline |
Gets the list of supported best practices.
|
inline |
Gets the list of supported standards.
|
inline |
Gets the list of supported tests.
|
inline |
Runs all automatic Access Engine tests against the current page, as defined by the web driver used previously to invoke SetUp. Make sure to invoke one of the setUp methods before invoking this method.
|
inline |
Runs all automatic Access Engine tests against the current page, as defined by the web driver used previously to invoke SetUp. Make sure to invoke one of the setUp methods before invoking this method.
| includeIframeContent |
|
inline |
Runs all automatic Access Engine tests against the current page, as defined by the web driver used previously to invoke SetUp. Make sure to invoke one of the setUp methods before invoking this method.
| includeIframeContent | |
| xpathExclusions | |
| filter |
|
inline |
Runs all automatic Access Engine tests against the current page, as defined by the web driver used previously to invoke SetUp. Make sure to invoke one of the setUp methods before invoking this method.
| xpathExclusions |
|
inline |
Runs all automatic Access Engine tests against the current page, as defined by the web driver used previously to invoke SetUp. Make sure to invoke one of the setUp methods before invoking this method.
|
inline |
Runs all automatic Access Engine tests against the current page, as defined by the web driver used previously to invoke SetUp. Make sure to invoke one of the setUp methods before invoking this method.
| includeIframeContent | |
| filter |
|
inline |
Runs all automatic Access Engine tests against the current page, as defined by the web driver used previously to invoke SetUp. Make sure to invoke one of the setUp methods before invoking this method.
| includeIframeContent |
|
inline |
Runs all automatic Access Engine tests against the current page for only the specified node and all its children, as defined by the web driver used previously to invoke SetUp and the specified CSS selector. Make sure to invoke one of the setUp methods before invoking this method.
| selectorForNodeToTest |
|
inline |
Runs all automatic Access Engine tests against the current page for only the specified node and all its children, as defined by the web driver used previously to invoke SetUp and the specified CSS selector. Make sure to invoke one of the setUp methods before invoking this method.
| selectorForNodeToTest | |
| includeIframeContent |
|
inline |
Runs all automatic Access Engine tests against the current page for only the specified node and all its children, as defined by the web driver used previously to invoke SetUp and the specified CSS selector. Make sure to invoke one of the setUp methods before invoking this method.
| selectorForNodeToTest | |
| includeIframeContent | |
| xpathExclusions | |
| filter |
|
inline |
Runs all automatic Access Engine tests against the current page for only the specified node and all its children, as defined by the web driver used previously to invoke SetUp and the specified CSS selector. Make sure to invoke one of the setUp methods before invoking this method.
| selectorForNodeToTest | |
| xpathExclusions |
|
inline |
Runs only the specified automatic Access Engine tests against the current page, as defined by the web driver used previously to invoke SetUp and, for specific test IDs, AMP. Make sure to invoke one of the setUp methods before invoking this method.
| engineTestIds | The IDs of the automatic Access Engine tests to test for (invoke GetSupportedTests for a list of these, or consult AMP) |
|
inline |
Globally sets whether or not accessibility concerns that require manual review are included in any of Continuum's test results. If enabled, any accessibility concerns that require manual review will have AccessibilityConcern.NeedsReview return true. Using this method will override the value for the 'includePotentialAccessibilityConcerns' attribute defined in continuum.json, which is otherwise used by default.
This method is only available in the Pro edition of Continuum.
| includePotentialAccessibilityConcerns | True if accessibility concerns that require manual review should be included in any of Continuum's test results, false if they should not |
|
inline |
Sets up Continuum for web testing.
| webDriver | |
| context |
|
inline |
Runs only the automatic Access Engine tests corresponding to the specified best practices against the current page, as defined by the web driver used previously to invoke SetUp and, for specific best practice IDs, AMP. Make sure to invoke one of the setUp methods before invoking this method.
| bestPracticeIds | The IDs of the best practices to test for (invoke GetSupportedBestPractices for a list of these, or consult AMP) |
|
inline |
Runs only the automatic Access Engine tests of or greater than the specified noticeability against the current page, as defined by the web driver used previously to invoke SetUp. Make sure to invoke one of the setUp methods before invoking this method.
| minNoticeability |
|
inline |
Runs only the automatic Access Engine tests of or greater than the specified severity against the current page, as defined by the web driver used previously to invoke SetUp. Make sure to invoke one of the setUp methods before invoking this method.
| minSeverity |
|
inline |
Runs only the automatic Access Engine tests corresponding to the specified accessibility standards against the current page, as defined by the web driver used previously to invoke SetUp and, for specific accessibility standard IDs, AMP. Note that the IDs of the specified accessibility standards must also be specified by Configuration.DefaultStandardIds, i.e. in the set of IDs implied from the value of the 'getDefaultStandardIds' attribute defined in continuum.json, otherwise no accessibility concerns will be returned. Make sure to invoke one of the setUp methods before invoking this method.
| standardIds | The IDs of the accessibility standards to test for (invoke GetSupportedStandards for a list of these, or consult AMP) |
|
inline |
Runs only the automatic Access Engine tests of or greater than the specified tractability against the current page, as defined by the web driver used previously to invoke SetUp. Make sure to invoke one of the setUp methods before invoking this method.
| minTractability | The inclusive minimum tractability of accessibility concerns to test for on a scale of 1 to 10, where 1 is the least tractable and 10 is the most tractable |
|
inline |
Runs only the automatic Access Engine tests corresponding to the specified best practices against the current page, as defined by the web driver used previously to invoke SetUp and, for specific best practice IDs, AMP. Make sure to invoke one of the setUp methods before invoking this method.
| bestPracticeIds | The IDs of the best practices to test for (invoke GetSupportedBestPractices for a list of these, or consult AMP) |
| selectorForNodeToTest | A CSS selector to restrict accessibility testing to |
|
inline |
Runs only the automatic Access Engine tests of or greater than the specified noticeability against the current page, as defined by the web driver used previously to invoke SetUp. Make sure to invoke one of the setUp methods before invoking this method.
| minNoticeability | |
| selectorForNodeToTest | A CSS selector to restrict accessibility testing to |
|
inline |
Runs only the automatic Access Engine tests of or greater than the specified severity against the current page, as defined by the web driver used previously to invoke SetUp. Make sure to invoke one of the setUp methods before invoking this method.
| minSeverity | |
| selectorForNodeToTest | A CSS selector to restrict accessibility testing to |
|
inline |
Runs only the automatic Access Engine tests corresponding to the specified accessibility standards against the current page, as defined by the web driver used previously to invoke SetUp and, for specific accessibility standard IDs, AMP. Note that the IDs of the specified accessibility standards must also be specified by Configuration.DefaultStandardIds, i.e. in the set of IDs implied from the value of the 'getDefaultStandardIds' attribute defined in continuum.json, otherwise no accessibility concerns will be returned. Make sure to invoke one of the setUp methods before invoking this method.
| standardIds | The IDs of the accessibility standards to test for (invoke GetSupportedStandards for a list of these, or consult AMP) |
| selectorForNodeToTest | A CSS selector to restrict accessibility testing to |
|
inline |
Runs only the automatic Access Engine tests of or greater than the specified tractability against the current page, as defined by the web driver used previously to invoke SetUp. Make sure to invoke one of the setUp methods before invoking this method.
| minTractability | The inclusive minimum tractability of accessibility concerns to test for on a scale of 1 to 10, where 1 is the least tractable and 10 is the most tractable |
| selectorForNodeToTest | A CSS selector to restrict accessibility testing to |