API-referentie
API's gebruikt om te scannen en resultaten van scans te verwerken
Scannen en Resultaten Verwerken
Gebruik de volgende API's om je app te scannen en de resultaten te verwerken. Je kunt alle openbare klassen en functies van de bibliotheek vinden in de volledige API-referentie.
scan()
Scant de informatie verzameld door het doorgegeven instrumentatieregistratie-object voor problemen en retourneert een setInstrumentation(param) . ScanResultHandler
Retourneert:
| Naam | Type | Omschrijving |
|---|---|---|
| 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. |
getResult(param)
Vraagt het resultaat van een scan op bij het dashboard dat overeenkomt met de verstrekte resultatensleutel.
Vereist param:
| Naam | Type | Omschrijving |
|---|---|---|
| axeDevToolsResultKey | AxeDevToolsResultKey |
De identificatie van het resultaat dat je wilt verkrijgen. |
Retourneert:
| Type | Omschrijving |
|---|---|
| AxeDevToolsResult | Nullable AxeDevToolsResult biedt toegang tot details van het resultaat. |
deleteResult(param)
Verwijder het resultaat van een scan van het dashboard dat overeenkomt met de verstrekte resultatensleutel.
Vereist param:
| Naam | Type | Omschrijving |
|---|---|---|
| axeDevToolsResultKey | AxeDevToolsResultKey |
De identificatie van het resultaat dat je wilt verkrijgen. |
tearDown()
Reset tags en wist de teststatus van eerdere tests.
ScanResultHandler
uploadToDashboard(param)
Upload het resultaat van de toegankelijkheidsscan naar het dashboard. Standaard wordt het volledige resultaatobject geretourneerd.
Optioneel param:
| Naam | Type | Beschrijving |
|---|---|---|
| uploadOnly | Boolean |
Optioneel, standaard is false. Wanneer ingesteld op true, wordt het resultaat geüpload naar het dashboard en is de resultaatsleutel alleen beschikbaar binnen het AxeDevToolsResult object. |
Retourneert:
| Type | Beschrijving |
|---|---|
| AxeDevToolsResult | Nullable AxeDevToolsResult biedt toegang tot details van het resultaat. |
saveResultToLocalStorage(param)
Sla het resultaat van de toegankelijkheidsscan op in een lokaal bestand op uw testapparaat.
Verplicht param:
| Naam | Type | Beschrijving |
|---|---|---|
| prefixFilename | String |
Begin van de bestandsnaam om het resultaat als op te slaan. |
getSerializedResult()
Haalt het resultaat van uw scan op om binnen de test te gebruiken.