API-referentie
Informatie over de openbare klassen en functies van de bibliotheek.
Wanneer je geautomatiseerde tests opzet, stel je het instrumentatieregister in, zodat axe DevTools voor Android verbinding kan maken met de informatieknooppunt voor toegankelijkheid. Raadpleeg de openbare klassen en functies van de bibliotheek hieronder terwijl je je tests bouwt.
AxeDevTools Initialiseren
Gebruik de volgende API's bij het initialiseren van de AxeDevTools-bibliotheek.
startSession(params)
Genereert een auth-token en initialiseert een testsessie. Voeg de project-ID toe om resultaten naar axe Developer Hub te posten.
Verplicht param:
| Naam | Type | Beschrijving |
|---|---|---|
| apiKey | String |
Deque API-sleutel |
Optioneel param:
| Naam | Type | Beschrijving |
|---|---|---|
| projectId | String |
axe Developer Hub Project-ID |
| serverUrl | String |
Bepaalt de server-URL waarmee verbinding moet worden gemaakt |
loginWithUsername(params)
Genereert een auth-token om verbinding te maken met het dashboard. Deze API wordt afgeschaft in 2026. Gebruik startSession in plaats daarvan.
Verplicht params:
| Naam | Type | Beschrijving |
|---|---|---|
| gebruikersnaam | String |
Deque gebruikersnaam |
| wachtwoord | String |
Deque wachtwoord |
Optioneel param:
| Naam | Type | Beschrijving |
|---|---|---|
| serverConfig | String |
Bepaalt de server-URL waarmee verbinding moet worden gemaakt |
loginWithApiKey(param)
Genereert een auth-token om verbinding te maken met het dashboard. Deze API wordt afgeschaft in 2026. Gebruik startSession in plaats daarvan.
Verplicht param:
| Naam | Type | Beschrijving |
|---|---|---|
| apiSleutel | String |
Deque API-sleutel |
Optioneel param:
| Naam | Type | Beschrijving |
|---|---|---|
| serverUrl | String |
Definieert de server-URL om mee te verbinden |
stelInstrumentatieIn(param)
Stelt de bibliotheek in staat om de weergavehiërarchie van de applicatie onder test te verkrijgen.
Vereist param:
| Naam | Type | Beschrijving |
|---|---|---|
| instrumentatie | android.app.Instrumentation |
Instrumentatie Register Object dat de applicatiecontext en instrumentatie biedt. |
isGebruikerGeverifieerd()
Geeft een boolean terug die aangeeft of de gebruiker geverifieerd is en klaar is om scans te verzenden.
Geeft terug:
| Type | Beschrijving |
|---|---|
| Boolean | Geeft aan of een gebruiker geverifieerd is voor axe DevTools Mobile |
verbreekVerbinding()
Verwijdert de huidige axe DevTools-netwerksessie om een nieuwe verbinding mogelijk te maken.
Scannen
Zodra je de AxeDevTools library hebt geïmporteerd en geïnitialiseerd, ben je klaar om te scannen.
scan()
Scant de informatie die is verzameld door het instrumentatieregistratieobject dat is meegegeven aan setInstrumentation(param) op problemen en retourneert een ScanResultHandler.
Geeft terug:
| Naam | Type | Beschrijving |
|---|---|---|
| ScanResultHandler | Nullable | ScanResultHandler biedt een manier om meer gedetailleerde informatie over het resultaat te verkrijgen of de scan verder bij te werken door een naam of tags op te geven |
getResultaat(param)
Vraagt het resultaat van een scan op door de opgegeven resultaat sleutel te matchen.
Vereist param:
| Naam | Type | Beschrijving |
|---|---|---|
| axeDevToolsResultSleutel | AxeDevToolsResultKey |
De identificatie van het resultaat dat je wilt ophalen |
Retourneert:
| Type | Beschrijving |
|---|---|
| AxeDevToolsResult | Nullable AxeDevToolsResult biedt toegang tot details van het resultaat |
Resultaten Behandelen
Gebruik deze API's met het ScanResultHandler object dat wordt geretourneerd door een scan.
uploadToDashboard()
Upload het resultaat van de toegankelijkheidsscan. Retourneert:
| Type | Beschrijving |
|---|---|
| AxeDevToolsResult | Nullable AxeDevToolsResult biedt toegang tot details van het resultaat |
saveResultToLocalStorage(param)
Sla het resultaat van de toegankelijkheidsscan op als een lokaal bestand op uw testapparaat.
Vereist param:
| Naam | Type | Beschrijving |
|---|---|---|
| prefixFilename | String |
Begin van de bestandsnaam om het resultaat als op te slaan. |
getSerializedResult()
Toegang tot het resultaat van uw scan om binnen de test te gebruiken.
Uw Configuratie Aanpassen
Geef uw scans een naam en label, kies ervoor om bepaalde regels te negeren, of maak uw eigen aangepaste regels.
setScanName(param)
Geef een naam aan de scan voordat u deze uploadt.
Vereist param:
| Naam | Type | Beschrijving |
|---|---|---|
| naam | String |
Naam voor de scan |
addCustomRule(param)
Voeg een regel toe om te draaien tegen uw applicatie tijdens scans.
Vereist param:
| Naam | Type | Beschrijving |
|---|---|---|
| customRule | Class<AxeDevToolsRule> |
Regel om toe te voegen |
ignoreRules(param)
Negeert regels volledig van het draaien tegen elke weergave.
Vereist param:
| Naam | Type | Beschrijving |
|---|---|---|
| rulesToIgnore | List<String> |
Lijst van regels om te negeren |
ignoreByViewIdResourceName(params)
Vereiste parameters:
| Naam | Type | Beschrijving |
|---|---|---|
| viewIdResourceName | String |
Resource ID naam voor de view |
| ruleList | List<String> |
Lijst van regels om te negeren |
ignoreExperimental()
Wijst experimentele regels af. Resultaten voor experimentele regel(s) zullen de status hebben van AxeStatus.IGNORED.
resetIgnoredRules()
Leeg de lijst van genegeerde regels die door de genegeerde regels API’s is ingesteld. Handig voor het wijzigen van regelconfiguraties tussen geautomatiseerde tests.
tagScanAs(param)
Tag een scan voordat deze wordt geüpload.
Vereist param:
| Naam | Type | Beschrijving |
|---|---|---|
| tags | Set<String> |
Lijst van tags om aan de scan toe te voegen. |
tearDown()
Reset tags en wist de teststatus van eerder testen.
deleteResult(param)
Verwijder het resultaat van een scan, passend bij de verstrekte resultaatsleutel. (Alleen mobiele dashboard)
Vereist param:
| Naam | Type | Beschrijving |
|---|---|---|
| axeDevToolsResultKey | AxeDevToolsResultKey |
De identificatie van het resultaat dat je wilt openen. |