Referência da API
Informações sobre as classes e funções públicas da biblioteca.
Quando você configura testes automatizados, define o registro de instrumentação, permitindo que o Axe DevTools para Android se conecte às informações do nó de acessibilidade. Consulte as classes públicas e funções da biblioteca abaixo enquanto constrói seus testes.
Iniciando o AxeDevTools
Use as seguintes APIs ao inicializar a biblioteca AxeDevTools.
iniciarSessaoDeDigitalizacao(params)
Autentica uma chave de API e inicializa uma sessão de teste. O ID do projeto é necessário para postar resultados no Axe Developer Hub.
Obrigatório param:
| Nome | Tipo | Descrição |
|---|---|---|
| apiKey | String |
Chave API Deque |
Opcional param:
| Nome | Tipo | Descrição |
|---|---|---|
| projectId | String |
ID do Projeto no Axe Developer Hub |
| axeAccountUrl | String |
Define a URL do servidor para conectar |
startSession(params)
Gera um token de autenticação e inicializa uma sessão de teste. Inclua o ID do projeto para postar resultados no Axe Developer Hub. Esta API será descontinuada em 2026. Use startScanSession em vez disso.
Obrigatório param:
| Nome | Tipo | Descrição |
|---|---|---|
| apiKey | String |
Chave API Deque |
Opcional params:
| Nome | Tipo | Descrição |
|---|---|---|
| projectId | String |
ID do Projeto no Axe Developer Hub |
| serverUrl | String |
Define a URL do servidor para conectar |
loginWithApiKey(param)
Gera um token de autenticação para conectar-se ao painel. Esta API será descontinuada em 2026. Use startScanSession 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.
Retornos:
| Tipo | Descrição |
|---|---|
| Booleano | Indica se um usuário está autenticado para o Axe DevTools Mobile |
disconnect()
Limpa a sessão de rede atual do Axe DevTools para permitir uma nova conexão.
Escaneamento
Uma vez que você tenha importado e inicializado a biblioteca AxeDevTools, estará pronto para escanear.
scan()
Escaneia as informações coletadas pelo objeto de registro de instrumentação passado em setInstrumentation(param) para problemas e retorna um ScanResultHandler.
Retornos:
| Nome | Tipo | Descrição |
|---|---|---|
| ScanResultHandler | Nulo | ScanResultHandler fornece uma forma de obter informações mais detalhadas sobre o resultado ou atualizar ainda mais o escaneamento fornecendo um nome ou tags |
getResult(param)
Solicita o resultado de uma varredura correspondendo a chave de resultado fornecida.
Obrigatório param:
| Nome | Tipo | Descrição |
|---|---|---|
| chaveDeResultadoAxeDevTools | 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
generateHtmlReportAndSummary
Reúna todos os escaneamentos desde o início de uma sessão e gere um relatório localmente no seu dispositivo.
Opcional param:
| Nome | Tipo | Descrição |
|---|---|---|
| scanName | String |
Nome do escaneamento opcional. O padrão é AxeAccessibilityReport. |
Nota: Use as seguintes APIs com o objeto ScanResultHandler retornado de um escaneamento.
uploadParaDashboard()
Carregue o resultado do escaneamento 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 |
As APIs ignore agora estão obsoletas. Qualquer substituição ou remoção será anunciada nas notas de lançamento de outubro de 2026.
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)
Obrigatório params:
| Nome | Tipo | Descrição |
|---|---|---|
| nomeRecursoViewId | String |
Nome do ID do recurso para a visualização |
| listaDeRegras | List<String> |
Lista de regras para ignorar |
ignorarExperimental()
Exclui-se das regras experimentais. Os resultados para regra(s) experimental(is) 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.
As tags agora estão obsoletas e serão totalmente removidas no lançamento de outubro de 2026. Qualquer substituição ou remoção será anunciada nas notas de lançamento.
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. |