Referencia de API
Información sobre las clases y funciones públicas de la biblioteca.
Cuando configuras pruebas automatizadas, estableces el registro de instrumentalización, permitiendo que Axe DevTools para Android se conecte a la información del nodo de accesibilidad. Consulta las clases públicas y funciones de la biblioteca a continuación mientras construyes tus pruebas.
Inicializando AxeDevTools
Usa las siguientes APIs al inicializar la biblioteca AxeDevTools.
startScanSession(params)
Autentica una clave de API e inicializa una sesión de prueba. El ID del proyecto es necesario para publicar resultados en Axe Developer Hub.
Requerido param:
| Nombre | Tipo | Descripción |
|---|---|---|
| apiKey | String |
clave API de Deque |
Opcional param:
| Nombre | Tipo | Descripción |
|---|---|---|
| projectId | String |
ID del Proyecto en Axe Developer Hub |
| axeAccountUrl | String |
Define la URL del servidor a la que conectar |
startSession(params)
Genera un token de autenticación e inicializa una sesión de pruebas. Incluye el ID del proyecto para enviar resultados a Axe Developer Hub. Esta API se desaprobará en 2026. Usa startScanSession en su lugar.
Requerido param:
| Nombre | Tipo | Descripción |
|---|---|---|
| apiKey | String |
clave API de Deque |
Opcional params:
| Nombre | Tipo | Descripción |
|---|---|---|
| projectId | String |
ID del Proyecto en Axe Developer Hub |
| serverUrl | String |
Define la URL del servidor a la que conectar |
loginWithApiKey(param)
Genera un token de autenticación para conectarse al panel. Esta API se desaprobará en 2026. Usa startScanSession en su lugar.
Requerido param:
| Nombre | Tipo | Descripción |
|---|---|---|
| apiKey | String |
clave API de Deque |
Opcional param:
| Nombre | Tipo | Descripción |
|---|---|---|
| serverUrl | String |
Define la URL del servidor a la que conectar |
setInstrumentation(param)
Permite a la biblioteca obtener la jerarquía de vistas de la aplicación en prueba.
Requerido param:
| Nombre | Tipo | Descripción |
|---|---|---|
| instrumentation | android.app.Instrumentation |
Objeto de Registro de Instrumentación que proporciona el contexto de la aplicación e instrumentación. |
isUserAuthenticated()
Devuelve un booleano para indicar si el usuario está autenticado y listo para enviar escaneos.
Devuelve:
| Tipo | Descripción |
|---|---|
| Booleano | Indica si un usuario está autenticado para Axe DevTools Mobile |
disconnect()
Limpia la sesión de red actual de Axe DevTools para permitir una nueva conexión.
Escaneo
Una vez que hayas importado e inicializado la biblioteca AxeDevTools, estarás listo para escanear.
scan()
Escanea la información recopilada por el objeto del registro de instrumentalización pasado en setInstrumentation(param) en busca de problemas y devuelve un ScanResultHandler.
Devuelve:
| Nombre | Tipo | Descripción |
|---|---|---|
| ManejadorDeResultadosDeEscaneo | Nulo | ScanResultHandler proporciona una forma de obtener información más detallada sobre el resultado o actualizar aún más el escaneo proporcionando un nombre o etiquetas |
getResult(param)
Solicita el resultado de un escaneo al hacer coincidir la clave de resultado proporcionada.
Requerido param:
| Nombre | Tipo | Descripción |
|---|---|---|
| axeDevToolsResultKey | AxeDevToolsResultKey |
El identificador del resultado que deseas obtener |
Devuelve:
| Tipo | Descripción |
|---|---|
| ResultadoAxeDevTools | Nullable AxeDevToolsResult proporciona acceso a los detalles del resultado |
Manejo de Resultados
generateHtmlReportAndSummary
Recopila todos los escaneos desde el inicio de una sesión y genera un informe localmente en tu dispositivo.
Opcional param:
| Nombre | Tipo | Descripción |
|---|---|---|
| scanName | String |
Nombre del escaneo opcional. El valor predeterminado es AxeAccessibilityReport. |
Nota: Usa las siguientes APIs con el objeto ScanResultHandler retornado de un escaneo.
uploadToDashboard()
Sube el resultado del escaneo de accesibilidad.
Devuelve:
| Tipo | Descripción |
|---|---|
| ResultadoAxeDevTools | Nullable AxeDevToolsResult proporciona acceso a los detalles del resultado |
saveResultToLocalStorage(param)
Guarda el resultado del escaneo de accesibilidad en un archivo local en tu dispositivo de prueba.
Requerido param:
| Nombre | Tipo | Descripción |
|---|---|---|
| prefijoNombreArchivo | String |
Inicio del nombre de archivo para guardar el resultado. |
getSerializedResult()
Accede al resultado de tu escaneo para usarlo dentro de la prueba.
Personalización de tu configuración
Nombra y etiqueta tus escaneos, opta por ignorar ciertas reglas o crea tus propias reglas personalizadas.
setScanName(param)
Asigna un nombre al escaneo antes de cargarlo.
Requerido param:
| Nombre | Tipo | Descripción |
|---|---|---|
| nombre | String |
Nombre para el escaneo |
addCustomRule(param)
Añadir una regla para ejecutar en su aplicación durante los escaneos.
Requerido param:
| Nombre | Tipo | Descripción |
|---|---|---|
| reglaPersonalizada | Class<AxeDevToolsRule> |
Regla para añadir |
ignoreRules(param)
Ignora las reglas completamente de ser ejecutadas en cualquier vista.
Requerido param:
| Nombre | Tipo | Descripción |
|---|---|---|
| reglasAExcluir | List<String> |
Lista de reglas a ignorar |
ignoreByViewIdResourceName(params)
Requerido params:
| Nombre | Tipo | Descripción |
|---|---|---|
| nombreIdRecursoVista | String |
Nombre de ID del recurso para la vista |
| listaDeReglas | List<String> |
Lista de reglas a ignorar |
ignoreExperimental()
Opta por no usar reglas experimentales. Los resultados para la(s) regla(s) experimental(es) tendrán el estado de AxeStatus.IGNORED.
resetIgnoredRules()
Borrar la lista de reglas ignoradas establecida por las APIs de reglas ignoradas. Útil para cambiar la configuración de reglas entre pruebas automatizadas.
tagScanAs(param)
Etiqueta un escaneo antes de subirlo.
Requerido param:
| Nombre | Tipo | Descripción |
|---|---|---|
| etiquetas | Set<String> |
Lista de etiquetas para añadir al escaneo. |
tearDown()
Restablece etiquetas y limpia el estado de prueba de pruebas anteriores.
eliminarResultado(param)
Eliminar el resultado de un escaneo, coincidiendo con la clave de resultado proporcionada. (Solo Dashboard Móvil)
Requerido param:
| Nombre | Tipo | Descripción |
|---|---|---|
| axeDevToolsResultKey | AxeDevToolsResultKey |
El identificador del resultado al que desea acceder. |