Référence API
API utilisées pour analyser et gérer les résultats renvoyés par les analyses
Analyser et gérer les résultats
Utilisez les API suivantes pour analyser votre application et gérer les résultats. Vous pouvez trouver toutes les classes et fonctions publiques de la bibliothèque dans la Référence API complète.
scan()
Analyse les informations collectées par l'objet de registre d'instrumentation transmis à setInstrumentation(param) pour détecter les problèmes et renvoie un ScanResultHandler.
Renvoie :
| Nom | Type | Description |
|---|---|---|
| ScanResultHandler | Nullable | ScanResultHandler fournit un moyen d'obtenir des informations plus détaillées sur le résultat ou de mettre à jour davantage l'analyse en fournissant un nom ou des balises. |
getResult(param)
Demande le résultat d'une analyse à partir du tableau de bord correspondant à la clé de résultat fournie.
Obligatoire param :
| Nom | Type | Description |
|---|---|---|
| axeDevTools clé de résultat | AxeDevToolsResultKey |
L'identifiant du résultat que vous souhaitez récupérer. |
Renvoie :
| Type | Description |
|---|---|
| Résultat AxeDevTools | Nullable AxeDevToolsResult donne accès aux détails du résultat. |
deleteResult(param)
Supprime le résultat d'une analyse du tableau de bord correspondant à la clé de résultat fournie.
Obligatoire param :
| Nom | Type | Description |
|---|---|---|
| axeDevTools clé de résultat | AxeDevToolsResultKey |
L'identifiant du résultat que vous souhaitez récupérer. |
tearDown()
Réinitialise les balises et efface l'état de test des tests précédents.
ScanResultHandler
uploadToDashboard(param)
Téléchargez le résultat de l'analyse d'accessibilité sur le tableau de bord. Par défaut, l'objet résultat complet est renvoyé.
Facultatif param :
| Nom | Type | Description |
|---|---|---|
| Téléverser uniquement | Boolean |
Facultatif, la valeur par défaut est false. Lorsque la valeur est true, le résultat est téléversé sur le tableau de bord et la clé de résultat n'est disponible que dans l'objet AxeDevToolsResult . |
Renvoie :
| Type | Description |
|---|---|
| Résultat AxeDevTools | Nullable AxeDevToolsResult donne accès aux détails du résultat. |
saveResultToLocalStorage(param)
Enregistrez le résultat de l’analyse d’accessibilité dans un fichier local sur votre appareil de test.
Obligatoire param :
| Nom | Type | Description |
|---|---|---|
| préfixeDuNomDeFichier | String |
Début du nom du fichier sous lequel enregistrer le résultat. |
getSerializedResult()
Récupère le résultat de votre scan pour l'utiliser dans le test.