Appium

getAppiumContext

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.getAppiumContext()

Retourne

• <Context> context: une chaîne de caractères représentant le contexte actuel ou null représentant 'pas de contexte'

---

switchAppiumContext

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.switchAppiumContext(name)

Paramètres

Name	Type	Details
name	string	une chaîne de caractères représentant un contexte disponible

---

getAppiumContexts

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.getAppiumContexts()

Retourne

• <Context[]> contexts: un tableau de chaînes de caractères représentant les contextes disponibles, par exemple 'WEBVIEW', ou 'NATIVE'

---

shake

Exécuter une action de secousse sur l'appareil.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.shake()

Support

---

lock

Verrouiller l'appareil.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.lock(seconds)

Paramètres

Name	Type	Details
seconds optional	number	combien de temps verrouiller l'écran (iOS uniquement)

Support

---

unlock

Déverrouiller l'appareil.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.unlock()

Support

---

isLocked

Vérifier si l'appareil est verrouillé ou non.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.isLocked()

Retourne

• <boolean> isLocked: True si l'appareil est verrouillé, false sinon

Support

---

startRecordingScreen

Commencer à enregistrer l'écran.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.startRecordingScreen(options)

Paramètres

Name	Type	Details
options optional	object	paramètres de commande qui peuvent contenir des clés comme: remotePath, username, password, method, forceRestart, timeLimit, videoType, videoQuality, videoFps, bitRate, videoSize, bugReport (voir plus de description dans la documentation Appium)

Support

---

stopRecordingScreen

Arrêter l'enregistrement de l'écran

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.stopRecordingScreen(remotePath, username, password, method)

Paramètres

Name	Type	Details
remotePath optional	string	Le chemin vers l'emplacement distant, où la vidéo résultante doit être téléchargée. Les protocoles suivants sont pris en charge http/https, ftp. Cette option n'a d'effet que s'il y a un processus d'enregistrement d'écran en cours et que le paramètre forceRestart n'est pas défini sur true. La valeur de chaîne nulle ou vide (le paramètre par défaut) signifie que le contenu du fichier résultant doit être encodé en Base64.
username optional	string	Le nom d'utilisateur pour l'authentification à distance.
password optional	string	Le mot de passe pour l'authentification à distance.
method optional	string	Le nom de la méthode de téléchargement HTTP multipart. Le 'PUT' est utilisé par défaut.

Retourne

• <string> response: Chaîne encodée en Base64. Si remote_path est défini, la réponse est une chaîne vide

Support

---

getPerformanceDataTypes

Renvoie les types d'informations sur l'état du système qui peuvent être lus comme le CPU, la mémoire, le trafic réseau et la batterie.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.getPerformanceDataTypes()

Retourne

• <string[]> performanceTypes: Les types de données de performance disponibles (cpuinfo|batteryinfo|networkinfo|memoryinfo)

Support

---

getPerformanceData

Renvoie les informations sur l'état du système qui peuvent être lues comme le CPU, la mémoire, le trafic réseau et la batterie.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.getPerformanceData(packageName, dataType, dataReadTimeout)

Paramètres

Name	Type	Details
packageName	string	le nom du package de l'application
dataType	string	le type d'état système que l'on souhaite lire. Il doit être l'un des types de données de performance pris en charge
dataReadTimeout optional	number	le nombre de tentatives de lecture

Retourne

• <string[]> performanceData: Le type d'information de l'état du système qui est pris en charge pour la lecture comme le CPU, la mémoire, le trafic réseau et la batterie

Support

---

pressKeyCode

Appuyer sur une touche particulière sur l'appareil.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.pressKeyCode(keycode, metastate, flags)

Paramètres

Name	Type	Details
keycode	number	code de touche à appuyer
metastate optional	number	état méta pour appuyer sur le code de touche
flags optional	number	drapeaux pour l'appui sur la touche

Support

---

longPressKeyCode

Appuyer et maintenir un code de touche particulier sur l'appareil.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.longPressKeyCode(keycode, metastate, flags)

Paramètres

Name	Type	Details
keycode	number	code de touche à appuyer sur l'appareil
metastate optional	number	métaétat pour l'appui sur la touche
flags optional	number	drapeaux pour l'appui sur la touche

Support

---

sendKeyEvent

Envoyer un code de touche à l'appareil.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.sendKeyEvent(keycode, metastate)

Paramètres

Name	Type	Details
keycode	string	code de touche à appuyer
metastate optional	string	état méta pour appuyer sur le code de touche

Support

---

rotateDevice

Faire pivoter l'appareil en trois dimensions.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.rotateDevice(x, y, z)

Paramètres

Name	Type	Details
x	number	décalage x à utiliser pour le centre du geste de rotation
y	number	décalage y à utiliser pour le centre du geste de rotation
z	number	décalage z à utiliser pour le centre du geste de rotation

Support

---

getCurrentActivity

Obtenir le nom de l'activité Android actuelle.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.getCurrentActivity()

Retourne

• <string> activity: Nom de l'activité actuelle

Support

---

getCurrentPackage

Obtenir le nom du package Android actuel.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.getCurrentPackage()

Retourne

• <string> package: Nom du package actuel

Support

---

installApp

Installer l'application donnée sur l'appareil.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.installApp(appPath)

Paramètres

Name	Type	Details
appPath	string	chemin vers le fichier .apk de l'application

Support

---

activateApp

Activer l'application donnée sur l'appareil

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.activateApp(appId)

Paramètres

Name	Type	Details
appId	string	ID de l'application (ID du package pour Android, ID du bundle pour iOS)

Support

---

removeApp

Supprimer une application de l'appareil.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.removeApp(appId)

Paramètres

Name	Type	Details
appId	string	ID de l'application (ID du package pour Android, ID du bundle pour iOS)

Support

---

terminateApp

Terminer l'application donnée sur l'appareil

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.terminateApp(appId, options)

Paramètres

Name	Type	Details
appId	string	ID de l'application (ID du package pour Android, ID du bundle pour iOS)
options optional	object	Options de commande. Ex. "timeout": (Android uniquement) Délai pour réessayer de terminer l'application (voir plus dans la documentation Appium)

Support

---

isAppInstalled

Vérifier si l'application spécifiée est installée sur l'appareil.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.isAppInstalled(appId)

Paramètres

Name	Type	Details
appId	string	ID de l'application (ID du package pour Android, ID du bundle pour iOS)

Retourne

• <boolean> isAppInstalled: Retourne true si installée, false sinon

Support

---

queryAppState

Obtenir l'état de l'application donnée sur l'appareil

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.queryAppState(appId)

Paramètres

Name	Type	Details
appId	string	ID de l'application (ID du package pour Android, ID du bundle pour iOS)

Retourne

• <number> appStatus: 0 n'est pas installé. 1 n'est pas en cours d'exécution. 2 s'exécute en arrière-plan ou est suspendu. 3 s'exécute en arrière-plan. 4 s'exécute au premier plan

Support

---

hideKeyboard

Masquer le clavier virtuel.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.hideKeyboard(strategy, key, keyCode, keyName)

Paramètres

Name	Type	Details
strategy optional	string	stratégie de masquage du clavier (UIAutomation uniquement), stratégies disponibles - 'press', 'pressKey', 'swipeDown', 'tapOut', 'tapOutside', 'default'
key optional	string	valeur de la touche si la stratégie est 'pressKey'
keyCode optional	string	code de la touche si la stratégie est 'pressKey'
keyName optional	string	nom de la touche si la stratégie est 'pressKey'

Support

---

isKeyboardShown

Si le clavier virtuel est affiché ou non.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.isKeyboardShown()

Retourne

• <boolean> isKeyboardShown: True si le clavier est affiché

Support

---

pushFile

Placer un fichier sur l'appareil à un endroit particulier.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.pushFile(path, data)

Paramètres

Name	Type	Details
path	string	chemin pour installer les données
data	string	contenu du fichier en base64

Support

---

pullFile

Récupérer un fichier du système de fichiers de l'appareil.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.pullFile(path)

Paramètres

Name	Type	Details
path	string	chemin sur l'appareil pour extraire le fichier

Retourne

• <string> response: Contenu du fichier en base64

Support

---

pullFolder

Récupérer un dossier du système de fichiers de l'appareil.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.pullFolder(path)

Paramètres

Name	Type	Details
path	string	chemin vers un dossier entier sur l'appareil

Support

---

toggleAirplaneMode

Activer/désactiver le mode avion sur l'appareil.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.toggleAirplaneMode()

Support

---

toggleData

Changer l'état du service de données.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.toggleData()

Support

---

toggleWiFi

Changer l'état du service WiFi.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.toggleWiFi()

Support

---

toggleLocationServices

Changer l'état du service de localisation.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.toggleLocationServices()

Support

---

toggleNetworkSpeed

Définir la vitesse du réseau (Émulateur uniquement)

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.toggleNetworkSpeed(netspeed)

Paramètres

Name	Type	Details
netspeed	string	Type de réseau - 'full','gsm', 'edge', 'hscsd', 'gprs', 'umts', 'hsdpa', 'lte', 'evdo'

Support

---

openNotifications

Ouvrir les notifications Android (Émulateur uniquement).

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.openNotifications()

Support

---

startActivity

Démarrer une activité Android en fournissant le nom du package et le nom de l'activité.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.startActivity(appPackage, appActivity, appWaitPackage, appWaitActivity, intentAction, intentCategory, intentFlags, optionalIntentArguments, dontStopAppOnReset)

Paramètres

Name	Type	Details
appPackage	string	nom de l'application
appActivity	string	nom de l'activité
appWaitPackage optional	string	nom de l'application à attendre
appWaitActivity optional	string	nom de l'activité à attendre
intentAction=android.intent.action.MAIN optional	string	action d'intention qui sera utilisée pour démarrer l'activité
intentCategory=android.intent.category.LAUNCHER optional	string	catégorie d'intention qui sera utilisée pour démarrer l'activité
intentFlags=0x10200000 optional	string	drapeaux qui seront utilisés pour démarrer l'activité
optionalIntentArguments optional	string	arguments d'intention supplémentaires qui seront utilisés pour démarrer l'activité
dontStopAppOnReset optional	string	n'arrête pas le processus de l'application en test, avant de démarrer l'application à l'aide d'adb

Support

---

getSystemBars

Récupérer les informations de visibilité et de limites des barres d'état et de navigation.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.getSystemBars()

Retourne

• <object[]> systemBars: Informations sur la visibilité et les limites de la barre d'état et de navigation

Support

---

getDeviceTime

Obtenir l'heure sur l'appareil.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.getDeviceTime()

Retourne

• <string> time: Heure sur l'appareil

Support

---

getDisplayDensity

Obtenir la densité d'affichage de l'appareil.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.getDisplayDensity()

Retourne

• <*>

Support

---

touchId

Simuler un événement touch id (iOS Simulator uniquement). Pour activer cette fonctionnalité, la capacité désirée allowTouchIdEnroll doit être définie sur true et le Simulator doit être enregistré. Lorsque vous définissez allowTouchIdEnroll sur true, cela configurera par défaut le Simulator pour être enregistré. L'état d'enregistrement peut être basculé. Cet appel ne fonctionnera que si le processus Appium ou son application parent (par exemple Terminal.app ou Appium.app) a accès à l'accessibilité de Mac OS dans Préférences Système > Sécurité et confidentialité > Confidentialité > Accessibilité.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.touchId(match)

Paramètres

Name	Type	Details
match	boolean	simulons-nous un toucher réussi (true) ou un toucher échoué (false)

Support

---

toggleEnrollTouchId

Basculer le simulateur enregistré pour accepter touchId (iOS Simulator uniquement). Pour activer cette fonctionnalité, la capacité désirée allowTouchIdEnroll doit être définie sur true. Lorsque allowTouchIdEnroll est défini sur true, le Simulator sera enregistré par défaut, et le 'Toggle Touch ID Enrollment' change l'état d'enregistrement. Cet appel ne fonctionnera que si le processus Appium ou son application parent (par exemple, Terminal.app ou Appium.app) a accès à l'accessibilité de Mac OS dans Préférences Système > Sécurité et confidentialité > Confidentialité > Accessibilité.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.toggleEnrollTouchId(enabled)

Paramètres

Name	Type	Details
enabled=true optional	boolean	égal à true si l'inscription TouchID doit être activée

Support

---

launchApp

Lancer une application sur l'appareil.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

attention

Cette commande de protocole est dépréciée
Pour iOS, utilisez driver.execute('mobile: launchApp', { ... }), et pour Android, utilisez driver.execute('mobile: activateApp', { ... }).

Utilisation

driver.launchApp()

Support

---

closeApp

Fermer une application sur l'appareil.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

attention

Cette commande de protocole est dépréciée
Utilisez driver.execute('mobile: terminateApp', { ... }) à la place

Utilisation

driver.closeApp()

Support

---

background

Envoyer l'application en cours d'exécution pour cette session en arrière-plan.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

attention

Cette commande de protocole est dépréciée
Utilisez driver.execute('mobile: backgroundApp', { ... }) à la place

Utilisation

driver.background(seconds)

Paramètres

Name	Type	Details
seconds=null	number, null	délai pour restaurer l'application, si 'null' l'application ne sera pas restaurée

Support

---

endCoverage

Obtenir les données de couverture de test.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.endCoverage(intent, path)

Paramètres

Name	Type	Details
intent	string	intention à diffuser
path	string	chemin vers le fichier .ec

Support

---

getStrings

Obtenir les chaînes de l'application.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.getStrings(language, stringFile)

Paramètres

Name	Type	Details
language optional	string	code de langue
stringFile optional	string	chemin vers le fichier de chaînes

Retourne

• <object> appStrings: toutes les chaînes définies d'une application pour la langue et le nom de fichier de chaînes spécifiés

Support

---

setValueImmediate

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.setValueImmediate(elementId, text)

Paramètres

Name	Type	Details
elementId	String	l'identifiant d'un élément retourné dans un appel précédent à Find Element(s)
text	string	texte à définir pour un élément

Support

---

replaceValue

Remplacer directement la valeur d'un élément.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.replaceValue(elementId, value)

Paramètres

Name	Type	Details
elementId	String	l'identifiant d'un élément retourné dans un appel précédent à Find Element(s)
value	string	valeur à remplacer sur l'élément

Support

---

getSettings

Récupérer les paramètres actuels sur l'appareil.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.getSettings()

Retourne

• <object> settings: Hachage JSON de tous les paramètres actuellement spécifiés, voir API des paramètres

Support

---

updateSettings

Mettre à jour le paramètre actuel sur l'appareil.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.updateSettings(settings)

Paramètres

Name	Type	Details
settings	object	objet clé/valeur avec les paramètres à mettre à jour

Support

---

receiveAsyncResponse

URL de rappel pour l'exécution asynchrone de JavaScript.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.receiveAsyncResponse(response)

Paramètres

Name	Type	Details
response	object	réponse à recevoir sur l'appareil

Support

---

gsmCall

Effectuer un appel GSM (Émulateur uniquement).

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.gsmCall(phoneNumber, action)

Paramètres

Name	Type	Details
phoneNumber	string	le numéro de téléphone à appeler
action	string	L'action - 'call', 'accept', 'cancel', 'hold'

Support

---

gsmSignal

Définir la force du signal GSM (Émulateur uniquement).

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.gsmSignal(signalStrength, signalStrengh)

Paramètres

Name	Type	Details
signalStrength	string	force du signal dans la plage [0, 4]
signalStrengh optional	string	force du signal dans la plage [0, 4]. Veuillez également définir ce paramètre avec la même valeur si vous utilisez Appium v1.11.0 ou inférieur (voir https://github.com/appium/appium/issues/12234).

Support

---

powerCapacity

Définir le pourcentage de batterie (Émulateur uniquement).

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.powerCapacity(percent)

Paramètres

Name	Type	Details
percent	number	valeur en pourcentage dans la plage [0, 100]

Support

---

powerAC

Définir l'état du chargeur de batterie comme connecté ou non (Émulateur uniquement).

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.powerAC(state)

Paramètres

Name	Type	Details
state	string	définir l'état. on ou off

Support

---

gsmVoice

Définir l'état de la voix GSM (Émulateur uniquement).

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.gsmVoice(state)

Paramètres

Name	Type	Details
state	string	état de la voix GSM - 'unregistered', 'home', 'roaming', 'searching', 'denied', 'off', 'on'

Support

---

sendSms

Simuler un message SMS (Émulateur uniquement).

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.sendSms(phoneNumber, message)

Paramètres

Name	Type	Details
phoneNumber	string	le numéro de téléphone pour envoyer le SMS
message	string	le message SMS

Support

---

fingerPrint

Authentifier les utilisateurs en utilisant leurs empreintes digitales sur les émulateurs pris en charge.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.fingerPrint(fingerprintId)

Paramètres

Name	Type	Details
fingerprintId	number	empreintes digitales stockées dans le système Android Keystore (de 1 à 10)

Support

---

setClipboard

Définir le contenu du presse-papiers système

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.setClipboard(content, contentType, label)

Paramètres

Name	Type	Details
content	string	Le contenu réel du presse-papiers encodé en base64
contentType optional	string	Le type de contenu à obtenir. Plaintext, Image, URL. Android ne prend en charge que plaintext
label optional	string	Étiquette des données du presse-papiers pour Android

Retourne

• <string> response: Réponse du serveur Appium

Support

---

getClipboard

Obtenir le contenu du presse-papiers système

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.getClipboard(contentType)

Paramètres

Name	Type	Details
contentType optional	string	Le type de contenu à obtenir. Plaintext, Image, URL. Android ne prend en charge que plaintext

Retourne

• <string> response: Contenu du presse-papiers sous forme de chaîne encodée en base64 ou une chaîne vide si le presse-papiers est vide

Support

---

touchPerform

Cette fonctionnalité n'est disponible que dans un contexte natif. 'Touch Perform' fonctionne de manière similaire aux autres interactions tactiles singulières, sauf que cela vous permet d'enchaîner plus d'une action tactile en une seule commande. Ceci est utile car les commandes Appium sont envoyées via le réseau et il y a une latence entre les commandes. Cette latence peut rendre certaines interactions tactiles impossibles car certaines interactions doivent être effectuées en une seule séquence. Le glissement vertical, par exemple, nécessite d'appuyer, de se déplacer vers une coordonnée y différente, puis de relâcher. Pour que cela fonctionne, il ne peut pas y avoir de délai entre les interactions.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.touchPerform(actions)

Paramètres

Name	Type	Details
actions	object[]	Le type d'action à effectuer (par exemple moveTo, release, press, tap, wait)

Exemple

// faire un glissement horizontal par pourcentage
const startPercentage = 10;
const endPercentage = 90;
const anchorPercentage = 50;

const { width, height } = driver.getWindowSize();
const anchor = height * anchorPercentage / 100;
const startPoint = width * startPercentage / 100;
const endPoint = width * endPercentage / 100;
driver.touchPerform([
  {
    action: 'press',
    options: {
      x: startPoint,
      y: anchor,
    },
  },
  {
    action: 'wait',
    options: {
      ms: 100,
    },
  },
  {
    action: 'moveTo',
    options: {
      x: endPoint,
      y: anchor,
    },
  },
  {
    action: 'release',
    options: {},
  },
]);

Support

---

multiTouchPerform

Cette fonctionnalité n'est disponible que dans un contexte natif. Effectuer une séquence d'actions tactiles multiples.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.multiTouchPerform(actions)

Paramètres

Name	Type	Details
actions	object[]	Le type d'action à effectuer (par exemple moveTo, release, press, tap, wait)

Support

---

executeDriverScript

Cette commande vous permet de spécifier un script WebdriverIO sous forme de chaîne et de le transmettre au serveur Appium pour une exécution locale sur le serveur lui-même. Cette approche aide à minimiser la latence potentielle associée à chaque commande. Pour utiliser cette commande avec Appium 2.0, vous devez avoir le plugin execute-driver-plugin installé.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.executeDriverScript(script, type, timeout)

Paramètres

Name	Type	Details
script	string	Le script à exécuter. Il a accès à un objet 'driver' qui représente une session WebdriverIO attachée au serveur actuel.
type optional	string	Le langage/framework utilisé dans le script. Actuellement, seul 'webdriverio' est pris en charge et est la valeur par défaut.
timeout optional	number	Le nombre de millisecondes pendant lesquelles le script devrait être autorisé à s'exécuter avant d'être tué par le serveur Appium. Par défaut, équivalent à 1 heure.

Retourne

• <object> result: Un objet contenant deux champs: 'result', qui est la valeur de retour du script lui-même, et 'logs', qui contient 3 champs internes, 'log', 'warn', et 'error', qui contiennent un tableau de chaînes enregistrées par console.log, console.warn, et console.error dans l'exécution du script.

---

getEvents

Obtenir les événements stockés dans le serveur appium.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.getEvents(type)

Paramètres

Name	Type	Details
type	string[]	Obtenir les événements filtrés avec le type si le type est fourni.

Retourne

• <object> result: Un hachage JSON d'événements comme {'commands' => [{'cmd' => 123455, ....}], 'startTime' => 1572954894127, }.

Support

---

logEvent

Stocker un événement personnalisé.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.logEvent(vendor, event)

Paramètres

Name	Type	Details
vendor	string	Le nom du fournisseur. Ce sera vendor dans vendor:event.
event	string	Le nom de l'événement. Ce sera event dans vendor:event.

Support

---

compareImages

Cette fonctionnalité effectue des comparaisons d'images en utilisant les capacités du framework OpenCV. Veuillez noter que pour que cette fonctionnalité fonctionne, le framework OpenCV et le module opencv4nodejs doivent être installés sur la machine où le serveur Appium est opérationnel. De plus, vous devrez avoir le plugin images-plugin installé pour utiliser cette fonctionnalité avec Appium 2.0.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.compareImages(mode, firstImage, secondImage, options)

Paramètres

Name	Type	Details
mode=matchFeatures	string	Un des modes de comparaison possibles: 'matchFeatures', 'getSimilarity', 'matchTemplate'. 'matchFeatures' est par défaut.
firstImage	string	Données d'image. Tous les formats d'image que la bibliothèque OpenCV accepte elle-même sont pris en charge.
secondImage	string	Données d'image. Tous les formats d'image que la bibliothèque OpenCV accepte elle-même sont pris en charge.
options=[object Object]	object	Le contenu de ce dictionnaire dépend de la valeur réelle de mode. Voir la documentation sur le module appium-support pour plus de détails.

Retourne

• <object> result: Le contenu du dictionnaire résultant dépend des valeurs réelles de mode et options. Voir la documentation sur le module appium-support pour plus de détails.

---

implicitWait

Définir le temps que le pilote doit attendre lors de la recherche d'éléments. Lors de la recherche d'un seul élément, le pilote doit interroger la page jusqu'à ce qu'un élément soit trouvé ou que le délai expire, selon la première éventualité. Lors de la recherche de plusieurs éléments, le pilote doit interroger la page jusqu'à ce qu'au moins un élément soit trouvé ou que le délai expire, auquel cas il doit renvoyer une liste vide. Si cette commande n'est jamais envoyée, le pilote doit par défaut avoir une attente implicite de 0ms.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.implicitWait(ms)

Paramètres

Name	Type	Details
ms	number	La quantité de temps, en millisecondes, à attendre sur un élément.

Support

---

getLocationInView

Déterminer l'emplacement d'un élément sur l'écran une fois qu'il a été défilé en vue.

Remarque: Ceci est considéré comme une commande interne et ne doit être utilisé que pour déterminer l'emplacement d'un élément pour générer correctement des événements natifs.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.getLocationInView(elementId)

Paramètres

Name	Type	Details
elementId	String	ID de l'élément vers lequel router la commande

Retourne

• <Object> location: Les coordonnées X et Y de l'élément sur la page.

Support

---

sendKeys

Envoyer une séquence de frappes à l'élément actif

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.sendKeys(value)

Paramètres

Name	Type	Details
value	string[]	La séquence de touches à taper. Un tableau doit être fourni.

Support

---

availableIMEEngines

Lister tous les moteurs disponibles sur la machine. Pour utiliser un moteur, il doit être présent dans cette liste.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.availableIMEEngines()

Retourne

• <String[]> engines: Une liste des moteurs disponibles

Support

---

getActiveIMEEngine

Obtenir le nom du moteur IME actif. La chaîne de nom est spécifique à la plateforme.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.getActiveIMEEngine()

Retourne

• <String> engine: Le nom du moteur IME actif

Support

---

isIMEActivated

Indique si l'entrée IME est active pour le moment

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.isIMEActivated()

Retourne

• <Boolean> isActive: true si l'entrée IME est disponible et actuellement active, false sinon

Support

---

deactivateIMEEngine

Désactive le moteur IME actuellement actif.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.deactivateIMEEngine()

Support

---

activateIMEEngine

Rendre un moteur disponible

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.activateIMEEngine(engine)

Paramètres

Name	Type	Details
engine	string	nom du moteur à activer

Support

---

asyncScriptTimeout

Définir la quantité de temps, en millisecondes, pendant laquelle les scripts asynchrones exécutés par /session/:sessionId/execute_async sont autorisés à s'exécuter avant d'être abandonnés et qu'une erreur Timeout est renvoyée au client.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.asyncScriptTimeout(ms)

Paramètres

Name	Type	Details
ms	number	La quantité de temps, en millisecondes, pendant laquelle les commandes limitées dans le temps sont autorisées à s'exécuter

Support

---

submit

Soumettre un élément de formulaire.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.submit(elementId)

Paramètres

Name	Type	Details
elementId	String	ID de l'élément de formulaire à soumettre

Support

---

getElementSize

Déterminer la taille d'un élément en pixels. La taille sera retournée sous forme d'objet JSON avec les propriétés width et height.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.getElementSize(elementId)

Paramètres

Name	Type	Details
elementId	String	ID de l'élément vers lequel router la commande

Retourne

• <Object> size: La largeur et la hauteur de l'élément, en pixels.

Support

---

getElementLocation

Déterminer l'emplacement d'un élément sur la page. Le point (0, 0) fait référence au coin supérieur gauche de la page. Les coordonnées de l'élément sont retournées sous forme d'objet JSON avec les propriétés x et y.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.getElementLocation(elementId)

Paramètres

Name	Type	Details
elementId	String	ID de l'élément vers lequel router la commande

Retourne

• <Object> location: Les coordonnées X et Y de l'élément sur la page.

Support

---

touchClick

Tapotement unique sur l'appareil tactile.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.touchClick(element)

Paramètres

Name	Type	Details
element	string	ID de l'élément sur lequel effectuer un tapotement simple.

Support

---

touchDown

Doigt posé sur l'écran.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.touchDown(x, y)

Paramètres

Name	Type	Details
x	number	coordonnée x sur l'écran
y	number	coordonnée y sur l'écran

Support

---

touchUp

Doigt levé de l'écran.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.touchUp(x, y)

Paramètres

Name	Type	Details
x	number	coordonnée x sur l'écran
y	number	coordonnée y sur l'écran

Support

---

touchMove

Mouvement du doigt sur l'écran.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.touchMove(x, y)

Paramètres

Name	Type	Details
x	number	coordonnée x sur l'écran
y	number	coordonnée y sur l'écran

Support

---

touchLongClick

Appui long sur l'écran tactile en utilisant des événements de mouvement du doigt.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.touchLongClick(element)

Paramètres

Name	Type	Details
element	string	ID de l'élément sur lequel faire un appui long

Support

---

touchFlick

Effectuer un mouvement rapide sur l'écran tactile en utilisant des événements de mouvement du doigt. Cette commande de mouvement rapide commence à un emplacement particulier de l'écran.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.touchFlick(xoffset, yoffset, element, speed, xspeed, yspeed)

Paramètres

Name	Type	Details
xoffset optional	number	le décalage x en pixels pour le mouvement rapide
yoffset optional	number	le décalage y en pixels pour le mouvement rapide
element optional	string	ID de l'élément où commence le mouvement rapide
speed optional	number	la vitesse en pixels par seconde
xspeed optional	number	la vitesse x en pixels par seconde
yspeed optional	number	la vitesse y en pixels par seconde

Support

---

getOrientation

Obtenir l'orientation actuelle de l'appareil.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.getOrientation()

Retourne

• <String> orientation: L'orientation actuelle correspondant à une valeur définie dans ScreenOrientation: LANDSCAPE|PORTRAIT.

Support

---

setOrientation

Définir l'orientation de l'appareil

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.setOrientation(orientation)

Paramètres

Name	Type	Details
orientation	string	la nouvelle orientation du navigateur telle que définie dans ScreenOrientation: LANDSCAPE|PORTRAIT

Support

---

getLogs

Obtenir le journal pour un type de journal donné. Le tampon de journalisation est réinitialisé après chaque demande.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.getLogs(type)

Paramètres

Name	Type	Details
type	string	le type de journal

Retourne

• <Object[]> logs: La liste des entrées du journal.

Support

---

getLogTypes

Obtenir les types de journaux disponibles.

Commande Appium. Plus de détails peuvent être trouvés dans la documentation officielle du protocole.

Utilisation

driver.getLogTypes()

Retourne

• <String[]> logTypes: La liste des types de journaux disponibles.

Support