Referencia de la API
APIs utilizadas para escanear y manejar los resultados devueltos por los escaneos
Escanear y Manejar Resultados
Utilice las siguientes APIs para escanear su aplicación y manejar los resultados. Puede encontrar todas las clases y funciones públicas de la biblioteca en la referencia completa de la API.
scan()
Escanea la información recopilada por el objeto del registro de instrumentación pasado en setInstrumentation(param) para detectar problemas y devuelve un ScanResultHandler.
Devuelve:
| Nombre | Tipo | Descripción |
|---|---|---|
| ScanResultHandler | Nullable | ScanResultHandler proporciona una forma de obtener más información 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 desde el panel de control que coincide con la clave de resultado proporcionada.
Requerido param:
| Nombre | Tipo | Descripción |
|---|---|---|
| axeDevToolsResultKey | AxeDevToolsResultKey |
El identificador del resultado que desea obtener. |
Devuelve:
| Tipo | Descripción |
|---|---|
| AxeDevToolsResult | Nullable AxeDevToolsResult proporciona acceso a los detalles del resultado. |
deleteResult(param)
Elimina el resultado de un escaneo del panel de control que coincide con la clave de resultado proporcionada.
Requerido param:
| Nombre | Tipo | Descripción |
|---|---|---|
| axeDevToolsResultKey | AxeDevToolsResultKey |
El identificador del resultado que desea obtener. |
tearDown()
Restablece las etiquetas y borra el estado de la prueba de pruebas anteriores.
ScanResultHandler
uploadToDashboard(param)
Carga el resultado del escaneo de accesibilidad en el panel de control. Por defecto, se devuelve el objeto completo del resultado.
Opcional param:
| Nombre | Tipo | Descripción |
|---|---|---|
| uploadOnly | Boolean |
Opcional, por defecto es false. Cuando está configurado en true, el resultado se carga en el panel de control y la clave del resultado solo está disponible dentro del objeto AxeDevToolsResult. |
Devuelve:
| Tipo | Descripción |
|---|---|
| AxeDevToolsResult | Nullable AxeDevToolsResult proporciona acceso a los detalles del resultado. |
saveResultToLocalStorage(param)
Guarda el resultado del análisis de accesibilidad en un archivo local en tu dispositivo de prueba.
Requerido param:
| Nombre | Tipo | Descripción |
|---|---|---|
| prefijoNombreDeArchivo | String |
Inicio del nombre de archivo para guardar el resultado. |
getSerializedResult()
Obtiene el resultado de tu análisis para usar dentro de la prueba.