Riferimento API

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

Informazioni sulle classi e le funzioni pubbliche della libreria.

Not for use with personal data

AxeDevTools

Quando si imposta un test automatizzato, si imposta il registro di strumentazione, consentendo ad axe DevTools per Android di connettersi alle informazioni del nodo di accessibilità. Durante la creazione dei test, fare riferimento alle classi e alle funzioni pubbliche della libreria riportate di seguito.

Inizializzazione di AxeDevTools

Utilizzare le seguenti API durante l'inizializzazione della libreria AxeDevTools.

loginWithUsername(params)

Genera un token di autenticazione per connettersi alla dashboard.

Obbligatorio params:

Nome Tipo Descrizione
Nome utente String Deque nome utente
password String Deque password

Facoltativo param:

Nome Tipo Descrizione
Configurazione del server String Definisce l'URL del server a cui connettersi.

loginWithApiKey(param)

Genera un token di autenticazione per connettersi alla dashboard.

Obbligatorio param:

Nome Tipo Descrizione
apiKey String Chiave API di Deque

Facoltativo param:

Nome Tipo Descrizione
URL del server String Definisce l'URL del server a cui connettersi.

setInstrumentation(param)

Consente alla libreria di ottenere la gerarchia di visualizzazione dell'applicazione sottoposta a test.

Obbligatorio param:

Nome Tipo Descrizione
strumentazione android.app.Instrumentation Oggetto del registro di strumentazione che fornisce contesto applicativo e strumentazione.

isUserAuthenticated()

Restituisce un valore booleano per indicare se l'utente è autenticato e pronto a inviare scansioni.

Restituisce:

Tipo Descrizione
Booleano Indica se un utente è autenticato per axe DevTools Mobile.

disconnect()

Cancella la sessione di rete corrente di axe DevTools per consentire una nuova connessione.

Scansione

Dopo aver importato e inizializzato la libreria, sei pronto per la scansione. AxeDevTools

scan()

Esegue la scansione delle informazioni raccolte dall'oggetto del registro di strumentazione passato in setInstrumentation(param) per individuare eventuali problemi e restituisce un ScanResultHandler.

Restituisce:

Nome Tipo Descrizione
Gestore dei risultati di scansione Annullabile ScanResultHandler fornisce un modo per ottenere informazioni più dettagliate sul risultato o per aggiornare ulteriormente la scansione specificando un nome o dei tag.

getResult(param)

Richiede il risultato di una scansione dalla dashboard corrispondente alla chiave di risultato fornita.

Obbligatorio param:

Nome Tipo Descrizione
chiaveRisultatoAxeDevTools AxeDevToolsResultKey L'identificatore del risultato che desideri acquisire.

Restituisce:

Tipo Descrizione
Risultato di AxeDevTools Nullable AxeDevToolsResult fornisce l'accesso ai dettagli del risultato.

Gestione dei risultati

Utilizzare queste API ScanResultHandler con l'oggetto restituito da una scansione.

uploadToDashboard()

Carica il risultato della scansione di accessibilità sulla dashboard. Restituisce:

Tipo Descrizione
Risultato di AxeDevTools Nullable AxeDevToolsResult fornisce l'accesso ai dettagli del risultato.

saveResultToLocalStorage(param)

Salva il risultato della scansione di accessibilità in un file locale sul dispositivo di prova.

Obbligatorio param:

Nome Tipo Descrizione
prefissoDelNomeFile String Inizio del nome del file con cui salvare il risultato.

getSerializedResult()

Acquisisce il risultato della scansione da utilizzare nel test.

Personalizzazione della configurazione

Assegna un nome e un'etichetta alle tue scansioni, scegli di ignorare determinate regole o crea le tue regole personalizzate.

setScanName(param)

Assegna un nome alla scansione prima di caricarla sulla dashboard.

Obbligatorio param:

Nome Tipo Descrizione
nome String Nome per la scansione.

addCustomRule(param)

Aggiungi una regola da eseguire sulla tua applicazione durante le scansioni.

Obbligatorio param:

Nome Tipo Descrizione
customRule Class<AxeDevToolsRule> Regola da aggiungere

ignoreRules(param)

Ignora completamente le regole, impedendone l'esecuzione in qualsiasi vista.

Obbligatorio param:

Nome Tipo Descrizione
regole da ignorare List<String> Elenco delle regole da ignorare.

ignoreByViewIdResourceName(params)

Parametri obbligatori:

Nome Tipo Descrizione
viewIdResourceName String Nome ID risorsa per la vista
Lista delle regole List<String> Elenco delle regole da ignorare

ignoreExperimental()

Rinuncia alle regole sperimentali. I risultati per le regole sperimentali avranno lo stato di AxeStatus.IGNORED.

resetIgnoredRules()

Cancella l'elenco delle regole ignorate impostato dalle API delle regole ignorate. Utile per modificare la configurazione delle regole tra i test automatizzati.

tagScanAs(param)

Tagga una scansione prima di caricarla sulla dashboard.

Obbligatorio param:

Nome Tipo Descrizione
tag Set<String> Elenco dei tag da aggiungere alla scansione.

tearDown()

Reimposta i tag e cancella lo stato del test precedente.

deleteResult(param)

Elimina dalla dashboard il risultato di una scansione corrispondente alla chiave di risultato fornita.

Obbligatorio param:

Nome Tipo Descrizione
axeDevToolsResultKey AxeDevToolsResultKey L'identificatore del risultato che desideri acquisire.

Is this page helpful?

Help us improve this page

Still need help?