API-Referenz
APIs zum Scannen und Verarbeiten der von Scans zurückgegebenen Ergebnisse
Ergebnisse scannen und verarbeiten
Verwenden Sie die folgenden APIs, um Ihre App zu scannen und die Ergebnisse zu verarbeiten. Alle öffentlichen Klassen und Funktionen der Bibliothek finden Sie in der vollständigen API-Referenz.
scan()
Durchsucht die vom übergebenen Instrumentierungsregistrierungsobjekt gesammelten Informationen setInstrumentation(param) nach Problemen und gibt einen ScanResultHandler zurück.
Gibt zurück:
| Name | Art | Beschreibung |
|---|---|---|
| ScanResultHandler | Nullable | ScanResultHandler bietet eine Möglichkeit, detailliertere Informationen zum Ergebnis zu erhalten oder den Scan durch Angabe eines Namens oder von Tags weiter zu aktualisieren. |
getResult(param)
Fordert ein Scan-Ergebnis vom Dashboard an, das dem bereitgestellten Ergebnisschlüssel entspricht.
Erforderlich param:
| Name | Art | Beschreibung |
|---|---|---|
| axeDevToolsResultKey | AxeDevToolsResultKey |
Die Kennung des Ergebnisses, das Sie abrufen möchten. |
Gibt zurück:
| Art | Beschreibung |
|---|---|
| AxeDevToolsErgebnis | Nullable AxeDevToolsResult bietet Zugriff auf Details des Ergebnisses. |
deleteResult(param)
Löschen Sie ein Scan-Ergebnis aus dem Dashboard, das dem angegebenen Ergebnisschlüssel entspricht.
Erforderlich param:
| Name | Art | Beschreibung |
|---|---|---|
| axeDevToolsResultKey | AxeDevToolsResultKey |
Die Kennung des Ergebnisses, das Sie abrufen möchten. |
tearDown()
Setzt Tags zurück und löscht den Teststatus aus vorherigen Tests.
ScanResultHandler
uploadToDashboard(param)
Laden Sie das Ergebnis des Barrierefreiheitsscans auf das Dashboard hoch. Standardmäßig wird das vollständige Ergebnisobjekt zurückgegeben.
Optional param:
| Name | Art | Beschreibung |
|---|---|---|
| uploadOnly | Boolean |
Optional, Standard ist „false“. Wenn der Wert auf „True“ gesetzt ist, wird das Ergebnis in das Dashboard hochgeladen und der Ergebnisschlüssel ist nur innerhalb des AxeDevToolsResult Objekts verfügbar. |
Gibt zurück:
| Art | Beschreibung |
|---|---|
| AxeDevToolsResult | Nullable AxeDevToolsResult bietet Zugriff auf Details des Ergebnisses. |
saveResultToLocalStorage(param)
Speichern Sie das Ergebnis des Barrierefreiheitsscans in einer lokalen Datei auf Ihrem Testgerät.
Erforderlich param:
| Name | Art | Beschreibung |
|---|---|---|
| prefixFilename | String |
Anfang des Dateinamens, unter dem das Ergebnis gespeichert werden soll. |
getSerializedResult()
Erfasst das Ergebnis Ihres Scans zur Verwendung im Test.