Riferimento API
API utilizzate per scansionare e gestire i risultati restituiti dalle scansioni
Scansiona e gestisci i risultati
Utilizza le seguenti API per eseguire la scansione della tua app e gestire i risultati. È possibile trovare tutte le classi e le funzioni pubbliche della libreria nel Riferimento API completo.
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. |
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. |
tearDown()
Reimposta i tag e cancella lo stato del test precedente.
Gestore dei risultati di scansione
uploadToDashboard(param)
Carica il risultato della scansione di accessibilità sulla dashboard. Per impostazione predefinita, viene restituito l'oggetto risultato completo.
Facoltativo param:
| Nome | Tipo | Descrizione |
|---|---|---|
| caricare solo | Boolean |
Facoltativo, il valore predefinito è no. Se impostato su true, il risultato viene caricato nella dashboard e la chiave del risultato è disponibile solo all'interno dell' AxeDevToolsResult oggetto. |
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.