Référence API
Informations sur les classes et fonctions publiques de la bibliothèque.
Lorsque vous configurez des tests automatisés, vous définissez le registre d'instrumentation, permettant à Axe DevTools pour Android de se connecter aux informations de noeud d'accessibilité. Consultez les classes et fonctions publiques de la bibliothèque ci-dessous pour construire vos tests.
Initialisation d'AxeDevTools
Utilisez les API suivantes lors de l'initialisation de la bibliothèque AxeDevTools.
startScanSession(params)
Authentifie une clé API et initialise une session de test. L'identifiant du projet est requis pour publier les résultats sur Axe Developer Hub.
Obligatoire param :
| Nom | Type | Description |
|---|---|---|
| apiKey | String |
clé API Deque |
Optionnel param :
| Nom | Type | Description |
|---|---|---|
| projectId | String |
ID de projet Axe Developer Hub |
| axeAccountUrl | String |
Définit l'URL du serveur à connecter |
startSession(params)
Génère un jeton d'authentification et initialise une session de test. Incluez l'ID du projet pour publier les résultats sur Axe Developer Hub. Cette API sera dépréciée en 2026. Utilisez startScanSession à la place.
Obligatoire param :
| Nom | Type | Description |
|---|---|---|
| apiKey | String |
clé API Deque |
Optionnel params :
| Nom | Type | Description |
|---|---|---|
| projectId | String |
ID de projet Axe Developer Hub |
| serverUrl | String |
Définit l'URL du serveur à connecter |
loginWithApiKey(param)
Génère un jeton d'authentification pour se connecter au tableau de bord. Cette API sera dépréciée en 2026. Utilisez startScanSession à la place.
Obligatoire param :
| Nom | Type | Description |
|---|---|---|
| apiKey | String |
clé API Deque |
Optionnel param :
| Nom | Type | Description |
|---|---|---|
| serverUrl | String |
Définit l'URL du serveur à connecter |
setInstrumentation(param)
Permet à la bibliothèque d'obtenir la hiérarchie de vue de l'application testée.
Obligatoire param :
| Nom | Type | Description |
|---|---|---|
| instrumentation | android.app.Instrumentation |
Objet du registre d'instrumentation fournissant le contexte de l'application et l'instrumentation. |
isUserAuthenticated()
Renvoie un booléen pour indiquer si l'utilisateur est authentifié et prêt à envoyer des analyses.
Retours :
| Type | Description |
|---|---|
| Booléen | Indique si un utilisateur est authentifié pour Axe DevTools Mobile |
disconnect()
Efface la session réseau actuelle d'Axe DevTools pour permettre une nouvelle connexion.
Scan
Une fois que vous avez importé et initialisé la bibliothèque AxeDevTools, vous êtes prêt à scanner.
scan()
Scanne les informations collectées par l'objet registre d'instrumentation passé dans setInstrumentation(param) à la recherche de problèmes et retourne un ScanResultHandler.
Retours :
| Nom | Type | Description |
|---|---|---|
| ScanResultHandler | Nullable | ScanResultHandler offre un moyen d'obtenir des informations plus détaillées sur le résultat ou de compléter le scan en fournissant un nom ou des tags |
getResult(param)
Demande le résultat d'un scan en faisant correspondre la clé de résultat fournie.
Obligatoire param :
| Nom | Type | Description |
|---|---|---|
| axeDevToolsResultKey | AxeDevToolsResultKey |
L'identifiant du résultat que vous souhaitez obtenir |
Retours :
| Type | Description |
|---|---|
| AxeDevToolsResult | Nullable AxeDevToolsResult permet d'accéder aux détails du résultat |
Gérer les résultats
generateHtmlReportAndSummary
Rassemblez tous les scans depuis le début d'une session et générez un rapport localement sur votre appareil.
Optionnel param :
| Nom | Type | Description |
|---|---|---|
| scanName | String |
Nom du scan optionnel. Le défaut est AxeAccessibilityReport. |
Remarque : Utilisez les API suivantes avec l'objet ScanResultHandler retourné par un scan.
uploadToDashboard()
Téléchargez le résultat du scan d'accessibilité.
Retours :
| Type | Description |
|---|---|
| AxeDevToolsResult | Nullable AxeDevToolsResult permet d'accéder aux détails du résultat |
saveResultToLocalStorage(param)
Enregistrez le résultat du scan d'accessibilité dans un fichier local sur votre appareil de test.
Obligatoire param :
| Nom | Type | Description |
|---|---|---|
| prefixFilename | String |
Début du nom de fichier pour enregistrer le résultat. |
getSerializedResult()
Accédez au résultat de votre scan pour l'utiliser dans le test.
Personnaliser votre configuration
Nommez et étiquetez vos scans, choisissez d'ignorer certaines règles ou créez vos propres règles personnalisées.
setScanName(param)
Définissez un nom pour le scan avant de le télécharger.
Obligatoire param :
| Nom | Type | Description |
|---|---|---|
| nom | String |
Nom pour le scan |
addCustomRule(param)
Ajoute une règle pour l’exécuter contre votre application lors des scans.
Obligatoire param :
| Nom | Type | Description |
|---|---|---|
| customRule | Class<AxeDevToolsRule> |
Règle à ajouter |
ignoreRules(param)
Ignore complètement les règles pour qu'elles ne soient pas exécutées contre n'importe quelle vue.
Obligatoire param :
| Nom | Type | Description |
|---|---|---|
| rulesToIgnore | List<String> |
Liste des règles à ignorer |
ignoreByViewIdResourceName(params)
Obligatoire params :
| Nom | Type | Description |
|---|---|---|
| viewIdResourceName | String |
Nom de l'ID de ressource pour la vue |
| ruleList | List<String> |
Liste des règles à ignorer |
ignoreExperimental()
Se désinscrit des règles expérimentales. Les résultats pour la ou les règles expérimentales auront le statut de AxeStatus.IGNORED.
resetIgnoredRules()
Efface la liste des règles ignorées définie par les APIs de règles ignorées. Utile pour changer la configuration des règles entre les tests automatisés.
tagScanAs(param)
Tague un scan avant de le télécharger.
Obligatoire param :
| Nom | Type | Description |
|---|---|---|
| tags | Set<String> |
Liste des tags à ajouter au scan. |
tearDown()
Réinitialise les tags et efface l'état du test précédent.
deleteResult(param)
Supprimer le résultat d'un scan, correspondant à la clé de résultat fournie. (Tableau de bord mobile uniquement)
Obligatoire param :
| Nom | Type | Description |
|---|---|---|
| axeDevToolsResultKey | AxeDevToolsResultKey |
L'identifiant du résultat que vous souhaitez accéder. |