API-referentie
Informatie over de openbare klassen en functies van de bibliotheek.
Wanneer u geautomatiseerd testen instelt, stelt u het instrumentatieregister in, waardoor Axe DevTools voor Android verbinding kan maken met de toegankelijkheidsnode-informatie. Raadpleeg de openbare klassen en functies van de bibliotheek hieronder terwijl u uw tests bouwt.
AxeDevTools Initialiseren
Gebruik de volgende API's bij het initialiseren van de AxeDevTools-bibliotheek.
startScanSession(params)
Verifieert een API-sleutel en start een testsessie. Het project-ID is vereist om resultaten naar Axe Developer Hub te sturen.
Vereist param:
| Naam | Type | Beschrijving |
|---|---|---|
| apiSleutel | String |
Deque API-sleutel |
Optioneel param:
| Naam | Type | Beschrijving |
|---|---|---|
| projectId | String |
Axe Developer Hub Project-ID |
| axeAccountUrl | String |
Definieert de server-URL om mee te verbinden |
startSession(params)
Genereert een auth-token en start een testsessie. Voeg het project-ID toe om resultaten te posten naar Axe Developer Hub. Deze API wordt in 2026 afgeschaft. Gebruik startScanSession in plaats daarvan.
Vereist param:
| Naam | Type | Beschrijving |
|---|---|---|
| apiSleutel | String |
Deque API-sleutel |
Optioneel params:
| Naam | Type | Beschrijving |
|---|---|---|
| projectId | String |
Axe Developer Hub Project-ID |
| serverUrl | String |
Definieert de server-URL om mee te verbinden |
loginWithApiKey(param)
Genereert een auth-token om verbinding te maken met het dashboard. Deze API wordt in 2026 afgeschaft. Gebruik startScanSession in plaats daarvan.
Vereist 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.
Retourneert:
| Type | Beschrijving |
|---|---|
| Boolean | Geeft aan of een gebruiker geauthenticeerd is voor Axe DevTools Mobile |
verbreekVerbinding()
Leegt de huidige Axe DevTools-netwerksessie om een nieuwe verbinding mogelijk te maken.
Scannen
Zodra u de AxeDevTools-bibliotheek hebt geïmporteerd en geïnitialiseerd, bent u klaar om te scannen.
scan()
Scant de informatie die is verzameld door het instrumentatieregisterobject dat is doorgegeven aan setInstrumentation(param) op problemen en retourneert een ScanResultHandler.
Retourneert:
| Naam | Type | Beschrijving |
|---|---|---|
| ScanResultHandler | Nullable | ScanResultHandler biedt een manier om meer gedetailleerde informatie over het resultaat te verkrijgen of de scan verder te updaten door een naam of tags te verstrekken |
getResultaat(param)
Vraagt het resultaat van een scan op door de opgegeven resultaat sleutel te matchen.
Vereist param:
| Naam | Type | Beschrijving |
|---|---|---|
| axeDevToolsResultKey | 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
generateHtmlReportAndSummary
Verzamel alle scans sinds het begin van een sessie en genereer een rapport lokaal op uw apparaat.
Optioneel param:
| Naam | Type | Beschrijving |
|---|---|---|
| scanName | String |
Optionele scannaam. Standaard is AxeAccessibilityReport. |
Opmerking: Gebruik de volgende API's met het ScanResultHandler-object dat is geretourneerd van 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)
Vereist params:
| Naam | Type | Beschrijving |
|---|---|---|
| viewIdResourceName | String |
Resource ID naam voor de view |
| ruleList | List<String> |
Lijst van regels om te negeren |
ignoreExperimental()
Meldt zich af voor experimentele regels. Resultaten voor experimentele regel(s) krijgen de status 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. |