Riferimento API
Informazioni sulle classi e funzioni pubbliche della libreria.
Quando si imposta il test automatizzato, si configura il registro dell'strumentazione, permettendo ad Axe DevTools per Android di connettersi alle informazioni sul nodo di accessibilità. Fai riferimento alle classi e alle funzioni pubbliche della libreria qui sotto mentre crei i tuoi test.
Inizializzazione di AxeDevTools
Utilizza le seguenti API quando inizializzi la libreria AxeDevTools.
startScanSession(params)
Autentica una chiave API e inizializza una sessione di test. L'ID del progetto è richiesto per pubblicare i risultati su Axe Developer Hub.
Richiesto param:
| Nome | Tipo | Descrizione |
|---|---|---|
| apiKey | String |
Chiave API Deque |
Opzionale param:
| Nome | Tipo | Descrizione |
|---|---|---|
| projectId | String |
ID progetto Axe Developer Hub |
| axeAccountUrl | String |
Definisce l'URL del server a cui connettersi |
startSession(params)
Genera un token di autenticazione e avvia una sessione di test. Includi l'ID del progetto per inviare i risultati a Axe Developer Hub. Questa API verrà deprecata nel 2026. Usa startScanSession invece.
Richiesto param:
| Nome | Tipo | Descrizione |
|---|---|---|
| apiKey | String |
Chiave API Deque |
Opzionale params:
| Nome | Tipo | Descrizione |
|---|---|---|
| projectId | String |
ID progetto Axe Developer Hub |
| serverUrl | String |
Definisce l'URL del server a cui connettersi |
loginWithApiKey(param)
Genera un token di autenticazione per connettersi al dashboard. Questa API verrà deprecata nel 2026. Usa startScanSession invece.
Richiesto param:
| Nome | Tipo | Descrizione |
|---|---|---|
| apiKey | String |
Chiave API Deque |
Opzionale param:
| Nome | Tipo | Descrizione |
|---|---|---|
| serverUrl | String |
Definisce l'URL del server a cui connettersi |
setInstrumentation(param)
Permette alla libreria di ottenere la gerarchia delle viste dell'applicazione da testare.
Richiesto param:
| Nome | Tipo | Descrizione |
|---|---|---|
| strumentazione | android.app.Instrumentation |
Oggetto Registry di Strumentazione che fornisce il contesto dell'applicazione e la strumentazione. |
isUserAuthenticated()
Restituisce un booleano per indicare se l'utente è autenticato e pronto per inviare scansioni.
Restituisce:
| Tipo | Descrizione |
|---|---|
| Booleano | Indica se un utente è autenticato per Axe DevTools Mobile |
disconnect()
Svuota la sessione di rete corrente di Axe DevTools per permettere una nuova connessione.
Scansione
Una volta importata e inizializzata la libreria AxeDevTools, sei pronto per la scansione.
scansione()
Scansiona le informazioni raccolte dall'oggetto del registro dell'strumentazione passato a setInstrumentation(param) per individuare problemi e restituisce un ScanResultHandler.
Restituisce:
| Nome | Tipo | Descrizione |
|---|---|---|
| ScanResultHandler | Nullable | ScanResultHandler fornisce un modo per ottenere informazioni più dettagliate sul risultato o aggiornare ulteriormente la scansione fornendo un nome o tag |
getResult(param)
Richiede il risultato di una scansione abbinando la chiave del risultato fornita.
Richiesto param:
| Nome | Tipo | Descrizione |
|---|---|---|
| axeDevToolsResultKey | AxeDevToolsResultKey |
L'identificatore del risultato che si desidera ottenere |
Restituisce:
| Tipo | Descrizione |
|---|---|
| AxeDevToolsResult | Nullable AxeDevToolsResult fornisce accesso ai dettagli del risultato |
Gestione dei Risultati
generateHtmlReportAndSummary
Raccogli tutte le scansioni dall'inizio di una sessione e genera un report localmente sul tuo dispositivo.
Opzionale param:
| Nome | Tipo | Descrizione |
|---|---|---|
| scanName | String |
Nome opzionale della scansione. Il predefinito è AxeAccessibilityReport. |
Nota: Usa le seguenti API con l'oggetto ScanResultHandler restituito da una scansione.
uploadToDashboard()
Carica il risultato della scansione di accessibilità.
Restituisce:
| Tipo | Descrizione |
|---|---|
| AxeDevToolsResult | Nullable AxeDevToolsResult fornisce accesso ai dettagli del risultato |
saveResultToLocalStorage(param)
Salva il risultato della scansione dell'accessibilità in un file locale sul dispositivo di test.
Richiesto param:
| Nome | Tipo | Descrizione |
|---|---|---|
| prefixFilename | String |
Inizio del nome del file da salvare. |
getSerializedResult()
Accedi al risultato della tua scansione per utilizzarlo nel test.
Personalizzazione della Configurazione
Nomina e contrassegna le tue scansioni, scegli di ignorare determinate regole o crea le tue regole personalizzate.
setScanName(param)
Imposta un nome alla scansione prima di caricarla.
Richiesto param:
| Nome | Tipo | Descrizione |
|---|---|---|
| nome | String |
Nome per la scansione |
addCustomRule(param)
Aggiungi una regola da eseguire sulla tua applicazione durante le scansioni.
Richiesto param:
| Nome | Tipo | Descrizione |
|---|---|---|
| regolaPersonalizzata | Class<AxeDevToolsRule> |
Regola da aggiungere |
ignoreRules(param)
Ignora completamente le regole dall'essere eseguite su qualsiasi vista.
Richiesto param:
| Nome | Tipo | Descrizione |
|---|---|---|
| regoleDaIgnorare | List<String> |
Elenco delle regole da ignorare |
ignoreByViewIdResourceName(params)
Richiesto params:
| Nome | Tipo | Descrizione |
|---|---|---|
| nomeRisorsaViewId | String |
Nome ID risorsa per la vista |
| elencoRegole | List<String> |
Elenco delle regole da ignorare |
ignoreExperimental()
Esclude le regole sperimentali. I risultati per le regole sperimentali avranno lo stato di AxeStatus.IGNORED.
resetIgnoredRules()
Pulisce l'elenco delle regole ignorate impostato dalle API delle regole ignorate. Utile per modificare la configurazione delle regole tra i test automatizzati.
tagScanAs(param)
Etichetta una scansione prima di caricarla.
Richiesto param:
| Nome | Tipo | Descrizione |
|---|---|---|
| etichette | Set<String> |
Elenco delle etichette da aggiungere alla scansione. |
tearDown()
Ripristina le etichette e cancella lo stato del test dai test precedenti.
eliminaRisultato(param)
Elimina il risultato di una scansione corrispondente alla chiave del risultato fornita. (Solo Dashboard Mobile)
Richiesto param:
| Nome | Tipo | Descrizione |
|---|---|---|
| axeDevToolsResultKey | AxeDevToolsResultKey |
L'identificatore del risultato a cui vuoi accedere. |