Referência da API
APIs usadas para escanear e manipular os resultados retornados das verificações
Escanear e Manipular Resultados
Use as seguintes APIs para escanear seu aplicativo e lidar com os resultados. Você pode encontrar todas as classes e funções públicas da biblioteca na referência completa da API.
scan()
Analisa as informações coletadas pelo objeto de registro de instrumentação passado para setInstrumentation(param) em busca de problemas e retorna um ScanResultHandler.
Retorna:
| Nome | Tipo | Descrição |
|---|---|---|
| ScanResultHandler | Nulável | ScanResultHandler fornece uma maneira de obter informações mais detalhadas sobre o resultado ou atualizar ainda mais a verificação, fornecendo um nome ou tags. |
getResult(param)
Solicita o resultado de um escaneamento no painel que corresponda à chave de resultado fornecida.
param obrigatória:
| Nome | Tipo | Descrição |
|---|---|---|
| axeDevToolsResultKey | AxeDevToolsResultKey |
O identificador do resultado que você gostaria de obter. |
Retorna:
| Tipo | Descrição |
|---|---|
| AxeDevToolsResult | AxeDevToolsResult anulável fornece acesso aos detalhes do resultado. |
deleteResult(param)
Exclui o resultado de um escaneamento no painel que corresponda à chave de resultado fornecida.
param obrigatória:
| Nome | Tipo | Descrição |
|---|---|---|
| axeDevToolsResultKey | AxeDevToolsResultKey |
O identificador do resultado que você gostaria de obter. |
tearDown()
Redefine tags e limpa o estado de teste de testes anteriores.
ScanResultHandler
uploadToDashboard(param)
Carrega o resultado do escaneamento de acessibilidade para o painel. Por padrão, o objeto de resultado completo é retornado.
param opcional:
| Nome | Tipo | Descrição |
|---|---|---|
| apenasUpload | Boolean |
Opcional, o padrão é falso. Quando configurado como verdadeiro, o resultado é enviado para o painel e a chave do resultado está disponível apenas dentro do objeto AxeDevToolsResult. |
Retorna:
| Tipo | Descrição |
|---|---|
| AxeDevToolsResult | AxeDevToolsResult anulável fornece acesso aos detalhes do resultado. |
saveResultToLocalStorage(param)
Salva o resultado da varredura de acessibilidade em um arquivo local no seu dispositivo de teste.
param obrigatória:
| Nome | Tipo | Descrição |
|---|---|---|
| prefixoNomeArquivo | String |
Início do nome do arquivo para salvar o resultado. |
getSerializedResult()
Obtém o resultado da sua varredura para usar no teste.