Referencia de API
Información sobre las clases y funciones públicas de la biblioteca.
Cuando configura pruebas automatizadas, configura el registro de instrumentación, lo que permite que axe DevTools para Android se conecte a la información del nodo de accesibilidad. Haga referencia a las clases y funciones públicas de la biblioteca a continuación mientras crea sus pruebas.
Inicializando axe DevTools
Utilice las siguientes API al inicializar la biblioteca AxeDevTools.
startSession(params)
Genera un token de autorización e inicializa una sesión de prueba. Incluya el ID del proyecto para publicar los resultados en axe Developer Hub.
Obligatorio param
| Nombre | Tipo | Descripción |
|---|---|---|
| apiKey | String |
Clave API de Deque |
Opcional param:
| Nombre | Tipo | Descripción |
|---|---|---|
| ID del proyecto | String |
ID del proyecto de axe Developer Hub |
| URL del servidor | String |
Define la URL del servidor a la que conectarse |
loginWithUsername(params)
Genera un token de autenticación para conectarse al panel de control. Esta API será obsoleta en 2026. Use startSession en su lugar.
Obligatorio params:
| Nombre | Tipo | Descripción |
|---|---|---|
| Nombre de usuario | String |
Nombre de usuario de Deque |
| contraseña | String |
Contraseña de Deque |
Opcional param:
| Nombre | Tipo | Descripción |
|---|---|---|
| Configuración del servidor | String |
Define la URL del servidor a la que conectarse |
loginWithApiKey(param)
Genera un token de autenticación para conectarse al panel de control. Esta API será obsoleta en 2026. Use startSession en su lugar.
Obligatorio param
| Nombre | Tipo | Descripción |
|---|---|---|
| apiKey | String |
Clave API de Deque |
Opcional param:
| Nombre | Tipo | Descripción |
|---|---|---|
| URL del servidor | String |
Define la URL del servidor a la que conectarse |
setInstrumentation(param)
Permite que la biblioteca obtenga la jerarquía de vistas de la aplicación bajo prueba.
Obligatorio param
| Nombre | Tipo | Descripción |
|---|---|---|
| instrumentación | android.app.Instrumentation |
Objeto de registro de instrumentación que proporciona el contexto de la aplicación y la instrumentación. |
isUserAuthenticated()
Devuelve un valor booleano para indicar si el usuario está autenticado y listo para enviar escaneos.
Retorna:
| Tipo | Descripción |
|---|---|
| Booleano | Indica si un usuario está autenticado para axe DevTools Mobile |
disconnect()
Borra la sesión de red actual de axe DevTools para permitir que se realice una nueva conexión.
Exploración
Una vez que haya importado e inicializado la biblioteca, estará listo para escanear. AxeDevTools
scan()
Analiza la información recopilada por el objeto de registro de instrumentación pasado a setInstrumentation(param) en busca de problemas y devuelve un ScanResultHandler.
Retorna:
| Nombre | Tipo | Descripción |
|---|---|---|
| Manejador de resultados de escaneo | Anulable | ScanResultHandler permite obtener información más detallada sobre el resultado o actualizar el escaneo proporcionando un nombre o etiquetas |
getResult(param)
Solicita el resultado de un escaneo mediante la coincidencia de la clave de resultado proporcionada.
Obligatorio param
| Nombre | Tipo | Descripción |
|---|---|---|
| claveResultadoAxeDevTools | AxeDevToolsResultKey |
El identificador del resultado que desea obtener |
Retorna:
| Tipo | Descripción |
|---|---|
| AxeDevToolsResult | Nullable AxeDevToolsResult permite acceder a los detalles del resultado |
Manejo de resultados
Utilice estas APIs ScanResultHandler con el objeto devuelto desde un escaneo.
uploadToDashboard()
Subir el resultado del escaneo de accesibilidad. Retorna:
| Tipo | Descripción |
|---|---|
| AxeDevToolsResult | Nullable AxeDevToolsResult permite acceder a los detalles del resultado |
saveResultToLocalStorage(param)
Guarde el resultado del análisis de accesibilidad en un archivo local en su dispositivo de prueba.
Obligatorio param
| Nombre | Tipo | Descripción |
|---|---|---|
| prefixFilename | String |
Inicio del nombre del archivo con el que se guardará el resultado. |
getSerializedResult()
Acceda al resultado de su 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)
Asigne un nombre al escaneo antes de subirlo.
Obligatorio param
| Nombre | Tipo | Descripción |
|---|---|---|
| nombre | String |
Nombre del escaneo |
addCustomRule(param)
Agregue una regla para ejecutar en su aplicación durante los análisis.
Obligatorio param
| Nombre | Tipo | Descripción |
|---|---|---|
| customRule | Class<AxeDevToolsRule> |
Regla para agregar |
ignoreRules(param)
Ignora las reglas por completo para que no se ejecuten en ninguna vista.
Obligatorio param
| Nombre | Tipo | Descripción |
|---|---|---|
| reglasParaIgnorar | List<String> |
Lista de reglas a ignorar |
ignoreByViewIdResourceName(params)
Parámetros requeridos:
| Nombre | Tipo | Descripción |
|---|---|---|
| viewIdResourceName | String |
Nombre de identificación del recurso para la vista |
| Lista de reglas | List<String> |
Lista de reglas a ignorar |
ignoreExperimental()
Opta por no aplicar reglas experimentales. Los resultados de las reglas experimentales tendrán el estado de AxeStatus.IGNORED.
resetIgnoredRules()
Limpie la lista de reglas ignoradas establecida por las API de reglas ignoradas. Útil para cambiar la configuración de reglas entre pruebas automatizadas.
tagScanAs(param)
Etiqueta un escaneo antes de cargarlo.
Obligatorio param
| Nombre | Tipo | Descripción |
|---|---|---|
| etiquetas | Set<String> |
Lista de etiquetas para agregar al escaneo. |
tearDown()
Restablece las etiquetas y borra el estado de prueba de pruebas anteriores.
deleteResult(param)
Eliminar el resultado de un escaneo que coincida con la clave de resultado proporcionada. (Solo disponible en Mobile Dashboard)
Obligatorio param
| Nombre | Tipo | Descripción |
|---|---|---|
| claveResultadoAxeDevTools | AxeDevToolsResultKey |
El identificador del resultado al que desea acceder. |