Referencia de la API
APIs utilizadas para escanear y gestionar los resultados devueltos de los escaneos
Escanear y gestionar resultados
Utilice las siguientes API para escanear su aplicación y gestionar los resultados. Puede encontrar todas las clases y funciones públicas de la biblioteca en la Referencia de API completa.
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 Proporciona una manera 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 del panel que coincida con la clave de resultado proporcionada.
Obligatorio param
| Nombre | Tipo | Descripción |
|---|---|---|
| claveResultadoAxeDevTools | AxeDevToolsResultKey |
El identificador del resultado que desea obtener. |
Retorna:
| Tipo | Descripción |
|---|---|
| Resultado de AxeDevTools | Nullable AxeDevToolsResult proporciona acceso a los detalles del resultado. |
deleteResult(param)
Eliminar el resultado de un escaneo del panel que coincida con la clave de resultado proporcionada.
Obligatorio param
| Nombre | Tipo | Descripción |
|---|---|---|
| claveResultadoAxeDevTools | AxeDevToolsResultKey |
El identificador del resultado que desea obtener. |
tearDown()
Restablece las etiquetas y borra el estado de prueba de pruebas anteriores.
Manejador de resultados de escaneo
uploadToDashboard(param)
Sube el resultado del análisis de accesibilidad al panel de control. De forma predeterminada, se devuelve el objeto de resultado completo.
Opcional param:
| Nombre | Tipo | Descripción |
|---|---|---|
| SubirSolo | Boolean |
Opcional, el valor predeterminado es falso. Cuando se configura en verdadero, el resultado se sube al panel y la clave del resultado solo está disponible dentro del objeto AxeDevToolsResult . |
Retorna:
| Tipo | Descripción |
|---|---|
| AxeDevToolsResult | Nullable AxeDevToolsResult proporciona acceso 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()
Obtiene el resultado de su escaneo para usarlo en la prueba.