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 die is verzameld door het instrumentatie-registerobject dat wordt 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 krijgen 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.
Vereiste param:
| Naam | Type | Beschrijving |
|---|---|---|
| axeDevToolsResultKey | AxeDevToolsResultKey |
De identificatie van het resultaat dat je wilt verkrijgen. |
Retourneert:
| Type | Beschrijving |
|---|---|
| AxeDevToolsResult | Nullable AxeDevToolsResult biedt toegang tot de details van het resultaat. |
deleteResult(param)
Verwijder het resultaat van een scan van het dashboard dat overeenkomt met de verstrekte resultatensleutel.
Vereiste param:
| Naam | Type | Beschrijving |
|---|---|---|
| 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.
Optionele 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 resultaten sleutel alleen beschikbaar binnen het AxeDevToolsResult-object. |
Retourneert:
| Type | Beschrijving |
|---|---|
| AxeDevToolsResult | Nullable AxeDevToolsResult biedt toegang tot de details van het resultaat. |
saveResultToLocalStorage(param)
Sla het resultaat van de toegankelijkheidsscan op in een lokaal bestand op uw testapparaat.
Vereiste 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.