Referência da API
Informações sobre as classes e funções públicas da biblioteca.
Ao configurar testes automatizados, você define o registro de instrumentação, permitindo que o axe DevTools para Android se conecte às informações dos nós de acessibilidade. Consulte as classes e funções públicas da biblioteca abaixo enquanto constrói seus testes.
Iniciando o AxeDevTools
Use as seguintes APIs ao inicializar a biblioteca AxeDevTools.
startSession(params)
Gera um token de autenticação e inicia uma sessão de testes. Inclua o ID do projeto para postar resultados no axe Developer Hub.
Obrigatório param:
| Nome | Tipo | Descrição |
|---|---|---|
| apiKey | String |
Chave da API Deque |
Opcional param:
| Nome | Tipo | Descrição |
|---|---|---|
| projectId | String |
ID do Projeto no axe Developer Hub |
| serverUrl | String |
Define a URL do servidor para conectar |
loginWithUsername(params)
Gera um token de autenticação para conectar ao painel. Esta API será descontinuada em 2026. Use startSession em vez disso.
Obrigatório params:
| Nome | Tipo | Descrição |
|---|---|---|
| username | String |
Nome de usuário Deque |
| password | String |
Senha Deque |
Opcional param:
| Nome | Tipo | Descrição |
|---|---|---|
| serverConfig | String |
Define a URL do servidor para conectar |
loginWithApiKey(param)
Gera um token de autenticação para conectar ao painel. Esta API será descontinuada em 2026. Use startSession em vez disso.
Obrigatório param:
| Nome | Tipo | Descrição |
|---|---|---|
| apiKey | String |
Chave API Deque |
Opcional param:
| Nome | Tipo | Descrição |
|---|---|---|
| serverUrl | String |
Define a URL do servidor para conectar |
setInstrumentation(param)
Permite que a biblioteca obtenha a hierarquia de visualização da aplicação em teste.
Obrigatório param:
| Nome | Tipo | Descrição |
|---|---|---|
| instrumentation | android.app.Instrumentation |
Objeto Instrumentation Registry que fornece contexto de aplicação e instrumentação. |
isUserAuthenticated()
Retorna um booleano para indicar se o usuário está autenticado e pronto para enviar varreduras.
Retorna:
| Tipo | Descrição |
|---|---|
| Booleano | Indica se um usuário está autenticado para o axe DevTools Mobile |
disconnect()
Limpa a sessão atual de rede do axe DevTools para permitir uma nova conexão.
Escaneamento
Depois de ter importado e inicializado a AxeDevTools biblioteca, você está pronto para escanear.
scan()
Escaneia as informações coletadas pelo objeto registry de instrumentação passado em setInstrumentation(param) em busca de problemas e retorna um ScanResultHandler.
Retorna:
| Nome | Tipo | Descrição |
|---|---|---|
| ScanResultHandler | Nullable | ScanResultHandler fornece uma maneira de obter informações mais detalhadas sobre o resultado ou atualizar ainda mais o escaneamento fornecendo um nome ou etiquetas |
getResult(param)
Solicita o resultado de uma varredura correspondendo a chave de resultado fornecida.
Obrigatório param:
| Nome | Tipo | Descrição |
|---|---|---|
| axeDevToolsResultKey | AxeDevToolsResultKey |
O identificador do resultado que você deseja obter |
Retornos:
| Tipo | Descrição |
|---|---|
| AxeDevToolsResult | Nulo AxeDevToolsResult fornece acesso aos detalhes do resultado |
Gerenciamento dos Resultados
Use estas APIs com o ScanResultHandler objeto retornado de uma varredura.
uploadParaDashboard()
Carregue o resultado da varredura de acessibilidade. Retornos:
| Tipo | Descrição |
|---|---|
| AxeDevToolsResult | Nulo AxeDevToolsResult fornece acesso aos detalhes do resultado |
salvarResultadoParaArmazenamentoLocal(param)
Salve o resultado da varredura de acessibilidade em um arquivo local no seu dispositivo de teste.
Obrigatório param:
| Nome | Tipo | Descrição |
|---|---|---|
| prefixoNomeArquivo | String |
Início do nome do arquivo para salvar o resultado. |
obterResultadoSerializado()
Acesse o resultado da sua varredura para usar dentro do teste.
Personalizando Sua Configuração
Nomeie e marque suas varreduras, opte por ignorar certas regras ou crie suas próprias regras personalizadas.
definirNomeDaVarredura(param)
Defina um nome para a varredura antes de enviá-la.
Obrigatório param:
| Nome | Tipo | Descrição |
|---|---|---|
| nome | String |
Nome para a varredura |
adicionarRegraPersonalizada(param)
Adicione uma regra para executar contra sua aplicação durante as varreduras.
Obrigatório param:
| Nome | Tipo | Descrição |
|---|---|---|
| regraPersonalizada | Class<AxeDevToolsRule> |
Regra para adicionar |
ignorarRegras(param)
Ignora completamente as regras de serem executadas contra qualquer visualização.
Obrigatório param:
| Nome | Tipo | Descrição |
|---|---|---|
| regrasParaIgnorar | List<String> |
Lista de regras para ignorar |
ignorarPorNomeDeRecursoViewId(params)
Parâmetros obrigatórios:
| Nome | Tipo | Descrição |
|---|---|---|
| nomeRecursoViewId | String |
Nome do ID do recurso para a visualização |
| listaDeRegras | List<String> |
Lista de regras para ignorar |
ignorarExperimental()
Desativa as regras experimentais. Os resultados das regra(s) experimentais terão o status de AxeStatus.IGNORED.
resetarRegrasIgnoradas()
Limpa a lista de regras ignoradas configurada pelas APIs de regras ignoradas. Útil para alterar a configuração de regras entre testes automatizados.
etiquetarVarreduraComo(param)
Etiqueta uma varredura antes de enviá-la.
Obrigatório param:
| Nome | Tipo | Descrição |
|---|---|---|
| etiquetas | Set<String> |
Lista de etiquetas a serem adicionadas à varredura. |
desmontar()
Reseta as etiquetas e limpa o estado do teste de testes anteriores.
deletarResultado(param)
Deleta o resultado de uma varredura, correspondendo à chave de resultado fornecida. (Apenas no Painel Móvel)
Obrigatório param:
| Nome | Tipo | Descrição |
|---|---|---|
| chaveDeResultadoAxeDevTools | AxeDevToolsResultKey |
O identificador do resultado que você deseja acessar. |