Riferimento API
API utilizzate per eseguire scansioni e gestire i risultati restituiti dalle scansioni
Scansione e Gestione dei Risultati
Utilizza le seguenti API per scansionare la tua app e gestire i risultati. Puoi trovare tutte le classi e le funzioni pubbliche della libreria nel riferimento API completo.
scan()
Scansiona le informazioni raccolte dall'oggetto registry di strumentazione passato in setInstrumentation(param) per rilevare 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 dal dashboard il risultato di una scansione corrispondente alla chiave di risultato fornita.
Richiesto param:
| Nome | Tipo | Descrizione |
|---|---|---|
| axeDevToolsResultKey | AxeDevToolsResultKey |
L'identificatore del risultato che desideri ottenere. |
Restituisce:
| Tipo | Descrizione |
|---|---|
| AxeDevToolsResult | Nullable AxeDevToolsResult fornisce accesso ai dettagli del risultato. |
deleteResult(param)
Elimina un risultato della scansione dal dashboard corrispondente alla chiave di risultato fornita.
Richiesto param:
| Nome | Tipo | Descrizione |
|---|---|---|
| axeDevToolsResultKey | AxeDevToolsResultKey |
L'identificatore del risultato che desideri ottenere. |
tearDown()
Reimposta i tag e cancella lo stato del test dai test precedenti.
ScanResultHandler
uploadToDashboard(param)
Carica il risultato della scansione dell'accessibilità sul dashboard. Per impostazione predefinita, viene restituito l'oggetto risultato completo.
Opzionale param:
| Nome | Tipo | Descrizione |
|---|---|---|
| uploadOnly | Boolean |
Opzionale, il valore predefinito è false. Se impostato su true, il risultato è caricato sul dashboard e la chiave di risultato è disponibile solo all'interno dell'oggetto AxeDevToolsResult. |
Restituisce:
| Tipo | Descrizione |
|---|---|
| AxeDevToolsResult | Nullable AxeDevToolsResult fornisce l'accesso ai dettagli del risultato. |
saveResultToLocalStorage(param)
Salva il risultato della scansione dell'accessibilità in un file locale sul dispositivo di test.
Obbligatorio param:
| Nome | Tipo | Descrizione |
|---|---|---|
| prefissoNomeFile | String |
Inizio del nome del file in cui salvare il risultato. |
getSerializedResult()
Acquisisce il risultato della tua scansione da utilizzare nel test.