Executar uma Verificação
Pronto, preparado, escaneie
Quando você inicializar a biblioteca móvel Axe DevTools, você passa as configurações de configuração para o método axeStartSession. É aqui que você declara sua intenção de enviar resultados para o Axe Developer Hub ou apenas salvar os resultados localmente.
// Once per test run
await driver.execute('mobile: axeStartSession', {
apiKey: "<DEQUE_APIKEY>",
projectId: "<DEQUE_PROJECT_ID>",
axeUploadResults: true
// Note: Results are uploaded to Axe Developer Hub by default;
// you can omit this value or set to `false` to only save results locally
});Ative a verificação de acessibilidade em qualquer ponto de seus testes. Quando estiver pronto para iniciar uma verificação de acessibilidade, chame a API Execute Script, passando axeScan.
// Per screen
driver.execute('mobile: axeScan')Entrada
| Parâmetro | Tipo | Descrição |
|---|---|---|
| axeSettings | Object |
Inclui a autenticação e configuração para o Axe DevTools Mobile. (Veja Chaves de Autenticação nas Configurações para as chaves necessárias). |
Chaves de Autenticação em Configurações
Se você não inicializou uma sessão com o driver, será necessário fornecer um dos seguintes no objeto axeSettings para autenticar a varredura.
| Chave | Tipo | Descrição |
|---|---|---|
| apiKey | String |
Exigido pela Deque para fornecer acesso a usuários autorizados. Acesse sua chave de API do Axe DevTools Mobile no portal Axe Account. |
| licenseKey | String |
Exigido pela Deque para fornecer acesso a usuários autorizados para verificações offline. Por favor, entre em contato com seu representante da Deque ou contate o suporte para coordenar a entrega da sua chave de licença. |
Chaves de Configuração em Configurações
Se você deseja personalizar a configuração do seu teste, pode adicionar qualquer uma das chaves opcionais abaixo ao objeto axeSettings. Encontre mais detalhes sobre essas propriedades - incluindo descontinuações - em Personalize Sua Configuração.
| Chave | Tipo | Descrição |
|---|---|---|
| axeUploadResults | Boolean |
Defina como false para autenticar sem iniciar uma sessão no Axe Developer Hub, mantendo os resultados localmente. O padrão é true. |
| ignoreRules (obsoleto) | [String] |
Forneça um array de strings para aplicar uma lista de regras a serem ignoradas em todas as visualizações. Cada string no array deve ser um ruleId válido - por exemplo, ColorContrast. Encontre ruleIds dentro do objeto axeConf no resultado JSON de qualquer verificação. Passe este valor na chamada mobile: axeScan. |
| ignoreExperimental (obsoleto) | Boolean |
Quando este parâmetro é definido como true, regra(s) experimentais serão ignoradas. O valor padrão é false. Passe este valor na chamada mobile: axeScan. |
| uploadToDashboard (obsoleto) | Boolean |
Quando este parâmetro é definido como false, a verificação não será carregada. O valor padrão é true. Use axeUploadResults com mobile: axeStartSession em vez disso. |
Você pode considerar adicionar uma função utilitária ao seu script de teste como um ponto central para iniciar uma verificação de acessibilidade.