API-Referenz

This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard

Informationen zu den öffentlichen Klassen und Funktionen der Bibliothek.

Not for use with personal data

Wenn Sie automatisierte Tests einrichten, legen Sie das Instrumentierungsregister fest, sodass axe DevTools für Android eine Verbindung mit den Zugänglichkeitsknoteninformationen herstellen kann. Verweisen Sie beim Erstellen Ihrer Tests auf die unten aufgeführten öffentlichen Klassen und Funktionen der Bibliothek.

axe DevTools initialisieren

Verwenden Sie beim Initialisieren der AxeDevTools-Bibliothek die folgenden APIs.

startSession(params)

Generiert ein Authentifizierungstoken und initialisiert eine Testsitzung. Fügen Sie die Projekt-ID hinzu, um Ergebnisse im axe Developer Hub zu veröffentlichen.

Erforderlich param:

Name Art Beschreibung
apiKey String Deque API-Schlüssel

Optional param:

Name Art Beschreibung
Projekt-ID String axe Developer Hub Projekt-ID
Server-URL String Definiert die Server-URL, zu der eine Verbindung hergestellt werden soll.

loginWithUsername(params)

Generiert ein Authentifizierungstoken zur Verbindung mit dem Dashboard. Diese API wird im Jahr 2026 abgekündigt. Verwenden Sie stattdessen startSession.

Erforderlich params:

Name Art Beschreibung
Benutzername String Deque-Benutzername
Passwort String Deque-Passwort

Optional param:

Name Art Beschreibung
Serverkonfiguration String Definiert die Server-URL, zu der eine Verbindung hergestellt werden soll.

loginWithApiKey(param)

Generiert ein Authentifizierungstoken zur Verbindung mit dem Dashboard. Diese API wird im Jahr 2026 abgekündigt. Verwenden Sie stattdessen startSession.

Erforderlich param:

Name Art Beschreibung
apiKey String Deque API-Schlüssel

Optional param:

Name Art Beschreibung
Server-URL String Definiert die Server-URL, zu der eine Verbindung hergestellt werden soll.

setInstrumentation(param)

Ermöglicht der Bibliothek, die Ansichtshierarchie der zu testenden Anwendung abzurufen.

Erforderlich param:

Name Art Beschreibung
Instrumentalisierung android.app.Instrumentation Instrumentalisierungs-Registrierungsobjekt, das Anwendungskontext und Instrumentalisierung bereitstellt.

isUserAuthenticated()

Gibt einen Booleschen Wert zurück, um anzugeben, ob der Benutzer authentifiziert und zum Senden von Scans bereit ist.

Gibt zurück:

Art Beschreibung
Boolescher Wert Gibt an, ob ein Benutzer für axe DevTools Mobile authentifiziert ist.

disconnect()

Löscht die aktuelle axe DevTools-Netzwerksitzung, um eine neue Verbindung herzustellen.

Scannen

Nachdem Sie die AxeDevTools Bibliothek importiert und initialisiert haben, können Sie mit dem Scannen beginnen.

scan()

Durchsucht die vom Instrumentierungsregistrierungsobjekt gesammelten Informationen nach Problemen setInstrumentation(param) und gibt ein ScanResultHandler zurück.

Gibt zurück:

Name Art Beschreibung
ScanResultHandler Nullable ScanResultHandler ermöglicht es, detailliertere Informationen zum Ergebnis zu erhalten oder den Scan durch Angabe eines Namens oder von Tags weiter zu bearbeiten.

getResult(param)

Fordert das Ergebnis eines Scans an, indem der bereitgestellte Ergebnisschlüssel abgeglichen wird.

Erforderlich param:

Name Art Beschreibung
axeDevToolsResultKey AxeDevToolsResultKey Die Kennung des Ergebnisses, das Sie abrufen möchten

Gibt zurück:

Art Beschreibung
AxeDevToolsResult Nullable AxeDevToolsResult bietet Zugriff auf Details des Ergebnisses

Handhabung der Ergebnisse

Verwenden Sie diese APIs mit dem von einem Scan zurückgegebenen ScanResultHandler Objekt.

uploadToDashboard()

Laden Sie das Ergebnis des Barrierefreiheitsscans hoch. 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()

Greifen Sie auf das Scan-Ergebnis zu, um es im Test zu verwenden.

Anpassen Ihrer Konfiguration

Benennen und kennzeichnen Sie Ihre Scans, ignorieren Sie bestimmte Regeln oder erstellen Sie Ihre eigenen benutzerdefinierten Regeln.

setScanName(param)

Benennen Sie den Scan vor dem Hochladen.

Erforderlich param:

Name Art Beschreibung
Name String Name für den Scan

addCustomRule(param)

Fügen Sie eine Regel hinzu, die während Scans für Ihre Anwendung ausgeführt wird.

Erforderlich param:

Name Art Beschreibung
customRule Class<AxeDevToolsRule> Hinzuzufügende Regel

ignoreRules(param)

Ignoriert Regeln vollständig, sodass sie gegen keine Ansicht ausgeführt werden.

Erforderlich param:

Name Art Beschreibung
rulesToIgnore List<String> Liste der zu ignorierenden Regeln

ignoreByViewIdResourceName(params)

Erforderliche Parameter:

Name Art Beschreibung
viewIdResourceName String Ressourcen-ID-Name für die Ansicht
Regelliste List<String> Liste der zu ignorierenden Regeln

ignoreExperimental()

Deaktiviert experimentelle Regeln. Ergebnisse für experimentelle Regeln haben den Status AxeStatus.IGNORED.

resetIgnoredRules()

Löschen Sie die Liste der ignorierten Regeln, die von den APIs für ignorierte Regeln festgelegt wurde. Hilfreich zum Ändern der Regelkonfiguration zwischen automatisierten Tests.

tagScanAs(param)

Markieren Sie einen Scan, bevor Sie ihn hochladen.

Erforderlich param:

Name Art Beschreibung
Tags Set<String> Liste der Tags, die dem Scan hinzugefügt werden sollen.

tearDown()

Setzt Tags zurück und löscht den Teststatus aus vorherigen Tests.

deleteResult(param)

Das Ergebnis eines Scans löschen, das dem angegebenen Ergebnisschlüssel entspricht. (Nur im Mobile Dashboard)

Erforderlich param:

Name Art Beschreibung
axeDevToolsResultKey AxeDevToolsResultKey Die Kennung des Ergebnisses, auf das Sie zugreifen möchten.

Is this page helpful?

Help us improve this page

Still need help?