API-Referenz
Informationen zu den öffentlichen Klassen und Funktionen der Bibliothek.
Wenn Sie automatisierte Tests einrichten, setzen Sie das Instrumentierungs-Registry, sodass Axe DevTools für Android eine Verbindung zu den Informationen der Zugänglichkeitsknoten herstellen kann. Beziehen Sie sich auf die öffentlichen Klassen und Funktionen der Bibliothek unten, während Sie Ihre Tests erstellen.
Initialisierung von AxeDevTools
Verwenden Sie die folgenden APIs, wenn Sie die AxeDevTools-Bibliothek initialisieren.
startScanSession(params)
Authentifiziert einen API-Schlüssel und initialisiert eine Testsitzung. Die Projekt-ID ist erforderlich, um Ergebnisse im Axe Developer Hub zu veröffentlichen.
Erforderlich param:
| Name | Typ | Beschreibung |
|---|---|---|
| apiKey | String |
Deque-API-Schlüssel |
Optional param:
| Name | Typ | Beschreibung |
|---|---|---|
| projectId | String |
Axe Developer Hub Projekt-ID |
| axeAccountUrl | String |
Definiert die Server-URL, zu der verbunden werden soll |
startSession(params)
Erzeugt ein Authentifizierungs-Token und initialisiert eine Testsitzung. Geben Sie die Projekt-ID an, um Ergebnisse an den Axe Developer Hub zu senden. Diese API wird 2026 eingestellt. Verwenden Sie stattdessen startScanSession.
Erforderlich param:
| Name | Typ | Beschreibung |
|---|---|---|
| apiKey | String |
Deque-API-Schlüssel |
Optional params:
| Name | Typ | Beschreibung |
|---|---|---|
| projectId | String |
Axe Developer Hub Projekt-ID |
| serverUrl | String |
Definiert die Server-URL, zu der verbunden werden soll |
loginWithApiKey(param)
Erzeugt ein Authentifizierungs-Token für die Verbindung mit dem Dashboard. Diese API wird 2026 eingestellt. Verwenden Sie stattdessen startScanSession.
Erforderlich param:
| Name | Typ | Beschreibung |
|---|---|---|
| apiKey | String |
Deque-API-Schlüssel |
Optional param:
| Name | Typ | Beschreibung |
|---|---|---|
| serverUrl | String |
Definiert die Server-URL, zu der verbunden werden soll |
setInstrumentation(param)
Ermöglicht es der Bibliothek, die Ansichtsstruktur der zu testenden Anwendung zu erhalten.
Erforderlich param:
| Name | Typ | Beschreibung |
|---|---|---|
| instrumentation | android.app.Instrumentation |
Instrumentierungsregistrierungsobjekt, das den Anwendungskontext und die Instrumentierung bereitstellt. |
isUserAuthenticated()
Gibt einen booleschen Wert zurück, um anzuzeigen, ob der Benutzer authentifiziert ist und bereit ist, Scans zu senden.
Rückgabe:
| Typ | Beschreibung |
|---|---|
| Boolean | Gibt an, ob ein Benutzer für Axe DevTools Mobile authentifiziert ist |
disconnect()
Löscht die aktuelle Axe DevTools-Netzwerksitzung, um eine neue Verbindung zu ermöglichen.
Scannen
Sobald Sie die AxeDevTools-Bibliothek importiert und initialisiert haben, sind Sie bereit zum Scannen.
scan()
Scans die vom Instrumentierungs-Registry-Objekt an setInstrumentation(param) übermittelten Informationen auf Probleme und gibt ein ScanResultHandler zurück.
Rückgabe:
| Name | Typ | Beschreibung |
|---|---|---|
| ScanResultHandler | Nullable | ScanResultHandler bietet eine Möglichkeit, detailliertere Informationen zu dem Ergebnis zu erhalten oder den Scan weiter zu aktualisieren, indem ein Name oder Tags bereitgestellt werden |
getResult(param)
Fordert das Ergebnis eines Scans an, indem der bereitgestellte Ergebnisschlüssel abgeglichen wird.
Erforderlich param:
| Name | Typ | Beschreibung |
|---|---|---|
| axeDevToolsResultKey | AxeDevToolsResultKey |
Der Bezeichner des Ergebnisses, das Sie abrufen möchten |
Rückgabe:
| Typ | Beschreibung |
|---|---|
| AxeDevToolsResult | Nullable AxeDevToolsResult bietet Zugang zu den Details des Ergebnisses |
Umgang mit Ergebnissen
generateHtmlReportAndSummary
Sammeln Sie alle Scans seit Beginn einer Sitzung und erzeugen Sie einen Bericht direkt auf Ihrem Gerät.
Optional param:
| Name | Typ | Beschreibung |
|---|---|---|
| scanName | String |
Optionaler Scan-Name. Standard ist AxeAccessibilityReport. |
Hinweis: Verwenden Sie die folgenden APIs mit dem von einem Scan zurückgegebenen ScanResultHandler-Objekt.
uploadToDashboard()
Laden Sie das Ergebnis des Zugänglichkeits-Scans hoch.
Rückgabe:
| Typ | Beschreibung |
|---|---|
| AxeDevToolsResult | Nullable AxeDevToolsResult bietet Zugang zu den Details des Ergebnisses |
saveResultToLocalStorage(param)
Speichern Sie das Ergebnis des Barrierefreiheitsscans in einer lokalen Datei auf Ihrem Testgerät.
Erforderlich param:
| Name | Typ | Beschreibung |
|---|---|---|
| prefixFilename | String |
Anfang des Dateinamens, unter dem das Ergebnis gespeichert wird. |
getSerializedResult()
Greifen Sie auf das Ergebnis Ihres Scans zu, um es innerhalb des Tests zu verwenden.
Anpassen Ihrer Konfiguration
Benennen und markieren Sie Ihre Scans, entscheiden Sie sich dafür, bestimmte Regeln zu ignorieren, oder erstellen Sie Ihre eigenen benutzerdefinierten Regeln.
setScanName(param)
Geben Sie dem Scan einen Namen, bevor Sie ihn hochladen.
Erforderlich param:
| Name | Typ | Beschreibung |
|---|---|---|
| name | String |
Name für den Scan |
addCustomRule(param)
Fügen Sie eine Regel hinzu, die während der Scans gegen Ihre Anwendung ausgeführt wird.
Erforderlich param:
| Name | Typ | Beschreibung |
|---|---|---|
| customRule | Class<AxeDevToolsRule> |
Regel zum Hinzufügen |
ignoreRules(param)
Ignoriert Regeln vollständig und verhindert deren Ausführung gegen jede Ansicht.
Erforderlich param:
| Name | Typ | Beschreibung |
|---|---|---|
| rulesToIgnore | List<String> |
Liste der zu ignorierenden Regeln |
ignoreByViewIdResourceName(params)
Erforderlich params:
| Name | Typ | Beschreibung |
|---|---|---|
| viewIdResourceName | String |
Ressourcen-ID-Name für die Ansicht |
| ruleList | List<String> |
Liste der zu ignorierenden Regeln |
ignoreExperimental()
Verzichtet auf experimentelle Regeln. Ergebnisse für experimentelle Regel(n) werden den Status AxeStatus.IGNORED haben.
resetIgnoredRules()
Löscht die durch die ignorierten Regeln-APIs gesetzte Ignorierliste. Nützlich zur Änderung der Regelkonfiguration zwischen automatisierten Tests.
tagScanAs(param)
Kennzeichnet einen Scan, bevor er hochgeladen wird.
Erforderlich param:
| Name | Typ | Beschreibung |
|---|---|---|
| tags | Set<String> |
Liste von Tags, die dem Scan hinzugefügt werden sollen. |
tearDown()
Setzt Tags zurück und löscht den Testzustand von vorhergehenden Tests.
deleteResult(param)
Löschen Sie das Ergebnis eines Scans, das mit dem bereitgestellten Ergebnisschlüssel übereinstimmt. (Nur Mobile Dashboard)
Erforderlich param:
| Name | Typ | Beschreibung |
|---|---|---|
| axeDevToolsResultKey | AxeDevToolsResultKey |
Der Bezeichner des Ergebnisses, auf das Sie zugreifen möchten. |