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 du nœud d'accessibilité. Faites référence aux classes et fonctions publiques de la bibliothèque ci-dessous lorsque vous créez vos tests.
Initialisation d'axe DevTools
Utilisez les API suivantes lors de l’initialisation de la bibliothèque AxeDevTools.
startSession(params)
Génère un jeton d'authentification et initialise une session de test. Incluez l'identifiant du projet pour publier les résultats sur axe Developer Hub.
Obligatoire param :
| Nom | Type | Description |
|---|---|---|
| Clé API | String |
Clé API Deque |
Facultatif param :
| Nom | Type | Description |
|---|---|---|
| ID du projet | String |
ID du projet axe Developer Hub |
| URL du serveur | String |
Définit l'URL du serveur auquel se connecter. |
loginWithUsername(params)
Génère un jeton d'authentification pour se connecter au tableau de bord. Cette API sera dépréciée en 2026. Utilisez startSession à la place.
Obligatoire params :
| Nom | Type | Description |
|---|---|---|
| Nom d'utilisateur | String |
Nom d'utilisateur Deque |
| Mot de passe | String |
Mot de passe Deque |
Facultatif param :
| Nom | Type | Description |
|---|---|---|
| Configuration du serveur | String |
Définit l'URL du serveur auquel se 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 startSession à la place.
Obligatoire param :
| Nom | Type | Description |
|---|---|---|
| Clé API | String |
Clé API Deque |
Facultatif param :
| Nom | Type | Description |
|---|---|---|
| URL du serveur | String |
Définit l'URL du serveur auquel se connecter. |
setInstrumentation(param)
Permet à la bibliothèque d'obtenir la hiérarchie des vues de l'application testée.
Obligatoire param :
| Nom | Type | Description |
|---|---|---|
| instrumentation | android.app.Instrumentation |
Objet de 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.
Renvoie :
| 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 l'établissement d'une nouvelle connexion.
Analyse
Une fois que vous avez importé et initialisé la bibliothèque, vous êtes prêt à analyser. AxeDevTools
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 permet d'obtenir des informations plus détaillées sur le résultat ou de mettre à jour ultérieurement le scan en fournissant un nom ou des étiquettes |
getResult(param)
Demande le résultat d'un scan en faisant correspondre 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 |
Gestion des résultats
Utilisez ces API avec l'objet ScanResultHandler renvoyé par une analyse.
uploadToDashboard()
Téléverser le résultat du scan d'accessibilité. 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()
Accédez au résultat de votre analyse pour l'utiliser dans le test.
Personnalisation de votre configuration
Nommez et étiquetez vos analyses, choisissez d'ignorer certaines règles ou créez vos propres règles personnalisées.
setScanName(param)
Veuillez définir un nom pour le scan avant de le téléverser.
Obligatoire param :
| Nom | Type | Description |
|---|---|---|
| nom | String |
Nom du scan |
addCustomRule(param)
Ajoutez une règle à exécuter sur votre application pendant les analyses.
Obligatoire param :
| Nom | Type | Description |
|---|---|---|
| Règle personnalisée | Class<AxeDevToolsRule> |
Règle à ajouter |
ignoreRules(param)
Ignore complètement l'exécution des règles sur n'importe quelle vue.
Obligatoire param :
| Nom | Type | Description |
|---|---|---|
| Règles à ignorer | List<String> |
Liste des règles à ignorer |
ignoreByViewIdResourceName(params)
Paramètres requis :
| Nom | Type | Description |
|---|---|---|
| viewIdResourceName | String |
Nom de l'ID de ressource pour la vue |
| ruleList | List<String> |
Liste des règles à ignorer |
ignoreExperimental()
Exclut les règles expérimentales. Les résultats des règles expérimentales auront le statut de AxeStatus.IGNORED.
resetIgnoredRules()
Effacer la liste des règles ignorées définie par les API de règles ignorées. Utile pour modifier la configuration des règles entre les tests automatisés.
tagScanAs(param)
Étiquette un scan avant de le téléverser.
Obligatoire param :
| Nom | Type | Description |
|---|---|---|
| balises | Set<String> |
Liste des balises à ajouter à l'analyse. |
tearDown()
Réinitialise les balises et efface l'état de test des tests précédents.
deleteResult(param)
Supprimez le résultat d'une analyse, correspondant à la clé de résultat fournie. Tableau de bord mobile uniquement
Obligatoire param :
| Nom | Type | Description |
|---|---|---|
| axeDevTools clé de résultat | AxeDevToolsResultKey |
L'identifiant du résultat auquel vous souhaitez accéder. |