API-Referenz
Informationen zu den öffentlichen Klassen und Funktionen der Bibliothek.
AxeDevTools
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.
loginWithUsername(params)
Generiert ein Authentifizierungstoken zur Verbindung mit dem Dashboard.
Erforderlich params
:
Name | Art | Beschreibung |
---|---|---|
Benutzername | String |
Deque-Benutzername |
Passwort | String |
Deque-Passwort |
Optional param
:
Name | Art | Beschreibung |
---|---|---|
serverConfig | String |
Definiert die Server-URL, mit der eine Verbindung hergestellt werden soll. |
loginWithApiKey(param)
Generiert ein Authentifizierungstoken zur Verbindung mit dem Dashboard.
Erforderlich param
:
Name | Art | Beschreibung |
---|---|---|
apiKey | String |
Deque API-Schlüssel |
Optional param
:
Name | Art | Beschreibung |
---|---|---|
Server-URL | String |
Definiert die Server-URL, mit 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 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 |
---|---|
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 auf das Dashboard 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()
Erfasst das Ergebnis Ihres Scans zur Verwendung im Test.
Anpassen Ihrer Konfiguration
Benennen und kennzeichnen Sie Ihre Scans, ignorieren Sie bestimmte Regeln oder erstellen Sie Ihre eigenen benutzerdefinierten Regeln.
setScanName(param)
Geben Sie dem Scan einen Namen, bevor Sie ihn in das Dashboard 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)
Taggt einen Scan, bevor er in das Dashboard hochgeladen wird.
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)
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. |