Een scan uitvoeren
Klaar voor de start, scan
Wanneer je de Axe DevTools bibliotheek voor mobiele apparaten initialiseren, geef je configuratie-instellingen door aan de axeStartSession-methode. Dit is waar je aangeeft of je de intentie hebt om resultaten naar Axe Developer Hub te uploaden of alleen lokaal op te slaan.
// Once per test run
await driver.execute('mobile: axeStartSession', {
apiKey: "<DEQUE_APIKEY>",
projectId: "<DEQUE_PROJECT_ID>",
axeUploadResults: true
// Note: Results are uploaded to Axe Developer Hub by default;
// you can omit this value or set to `false` to only save results locally
});Activeer de toegankelijkheidsscan op elk moment tijdens je tests. Wanneer je klaar bent om een toegankelijkheidsscan te starten, roep de Execute Script API aan, met axeScan als parameter.
// Per screen
driver.execute('mobile: axeScan')Invoer
| Parameter | Type | Beschrijving |
|---|---|---|
| axeInstellingen | Object |
Bevat de authenticatie en configuratie voor Axe DevTools Mobile. (Zie Authenticatiesleutels in Instellingen voor vereiste sleutels). |
Authenticatiesleutels in Instellingen
Als je niet sessie met de driver hebt geïnitialiseerd hebt, moet je een van de volgende opties in het axeSettings-object opgeven om de scan te authenticeren.
| Sleutel | Type | Beschrijving |
|---|---|---|
| apiKey | String |
Vereist door Deque om toegang te bieden aan geautoriseerde gebruikers. Raadpleeg je Axe DevTools Mobile API-sleutel in het Axe Account portaal. |
| licenseKey | String |
Vereist door Deque om toegang te bieden aan geautoriseerde gebruikers voor offline scans. Neem contact op met je Deque-vertegenwoordiger of neem contact op met de ondersteuning om de levering van je licentiesleutel te coördineren. |
Configuratiesleutels in Instellingen
Als je je testconfiguratie wilt aanpassen, kun je een van de onderstaande optionele sleutels toevoegen aan het axeSettings-object. Vind meer details over deze eigenschappen - inclusief deprecaties - in Pas je configuratie aan.
| Sleutel | Type | Beschrijving |
|---|---|---|
| axeUploadResultaten | Boolean |
Stel in op false om te authenticeren zonder een Axe Developer Hub-sessie te starten, zodat resultaten lokaal blijven. Standaard ingesteld op true. |
| negeerRegels (verouderd) | [String] |
Voorzie een lijst van strings om een lijst met te negeren regels op alle weergaven toe te passen. Elke string in de lijst moet een geldige ruleId zijn - bijvoorbeeld, ColorContrast. Vind ruleIds binnen het axeConf-object in het JSON-resultaat voor elke scan. Geef deze waarde door aan mobile: axeScan-aanroep. |
| negeerExperimenteel (verouderd) | Boolean |
Wanneer deze parameter op true is ingesteld, worden experimentele regels genegeerd. De standaardwaarde is false. Geef deze waarde door aan de mobile: axeScan-aanroep. |
| uploadNaarDashboard (verouderd) | Boolean |
Wanneer deze parameter op false is ingesteld, wordt de scan niet geüpload. De standaardwaarde is true. Gebruik axeUploadResults met mobile: axeStartSession in plaats daarvan. |
U kunt overwegen een hulpfunctie aan uw testscript toe te voegen als een centrale plek om een toegankelijkheidsscan te starten.