Zum Hauptinhalt springen

Appium

getAppiumContext

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.getAppiumContext()
Gibt zurück
  • <Context> context: ein String, der den aktuellen Kontext darstellt, oder null, was 'kein Kontext' bedeutet

switchAppiumContext

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.switchAppiumContext(name)
Parameter
NameTypDetails
namestringein String, der einen verfügbaren Kontext darstellt

getAppiumContexts

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.getAppiumContexts()
Gibt zurück
  • <Context[]> contexts: ein Array von Strings, die verfügbare Kontexte darstellen, z.B. 'WEBVIEW' oder 'NATIVE'

shake

Führt eine Schüttelaktion auf dem Gerät aus.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.shake()
Unterstützung

Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3)


lock

Sperrt das Gerät.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.lock(seconds)
Parameter
NameTypDetails
seconds
optional
numberwie lange der Bildschirm gesperrt werden soll (nur iOS)
Unterstützung

Support for UIAutomation (8.0 to 9.3) Support for UiAutomator (4.2+) Support for Windows (10+)


unlock

Entsperrt das Gerät.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.unlock()
Unterstützung

Support for UiAutomator (4.2+) Support for Windows (10+)


isLocked

Prüft, ob das Gerät gesperrt ist oder nicht.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.isLocked()
Gibt zurück
  • <boolean> isLocked: True, wenn das Gerät gesperrt ist, false wenn nicht
Unterstützung

Support for UiAutomator (4.2+) Support for Windows (10+)


startRecordingScreen

Startet die Bildschirmaufnahme.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.startRecordingScreen(options)
Parameter
NameTypDetails
options
optional
objectBefehlsparameter, die Schlüssel wie remotePath, username, password, method, forceRestart, timeLimit, videoType, videoQuality, videoFps, bitRate, videoSize, bugReport enthalten können (weitere Beschreibungen in der Appium-Dokumentation)
Unterstützung

Support for XCUITest (9.3+) Support for UiAutomator (4.2+) Support for Windows (10+)


stopRecordingScreen

Stoppt die Bildschirmaufnahme

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.stopRecordingScreen(remotePath, username, password, method)
Parameter
NameTypDetails
remotePath
optional
stringDer Pfad zum entfernten Speicherort, wohin das resultierende Video hochgeladen werden soll. Die folgenden Protokolle werden unterstützt: http/https, ftp. Diese Option hat nur einen Effekt, wenn ein Bildschirmaufnahmeprozess im Gange ist und der forceRestart-Parameter nicht auf true gesetzt ist. Null oder ein leerer String (die Standardeinstellung) bedeutet, dass der Inhalt der resultierenden Datei als Base64 codiert werden soll.
username
optional
stringDer Benutzername für die Remote-Authentifizierung.
password
optional
stringDas Passwort für die Remote-Authentifizierung.
method
optional
stringDer Name der HTTP-Multipart-Upload-Methode. Die 'PUT'-Methode wird standardmäßig verwendet.
Gibt zurück
  • <string> response: Base64-codierter String. Wenn remote_path gesetzt ist, ist die Antwort ein leerer String
Unterstützung

Support for XCUITest (9.3+) Support for UiAutomator (4.2+) Support for Windows (10+)


getPerformanceDataTypes

Gibt die Informationstypen des Systemzustands zurück, deren Lesen unterstützt wird, wie CPU, Speicher, Netzwerkverkehr und Batterie.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.getPerformanceDataTypes()
Gibt zurück
  • <string[]> performanceTypes: Die verfügbaren Leistungsdatentypen (cpuinfo|batteryinfo|networkinfo|memoryinfo)
Unterstützung

Support for UiAutomator (4.2+)


getPerformanceData

Gibt die Informationen des Systemzustands zurück, deren Lesen unterstützt wird, wie CPU, Speicher, Netzwerkverkehr und Batterie.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.getPerformanceData(packageName, dataType, dataReadTimeout)
Parameter
NameTypDetails
packageNamestringder Packagename der Anwendung
dataTypestringder Typ des Systemzustands, der gelesen werden soll. Er sollte einer der unterstützten Leistungsdatentypen sein
dataReadTimeout
optional
numberdie Anzahl der Leseversuche
Gibt zurück
  • <string[]> performanceData: Der Informationstyp des Systemzustands, dessen Lesen unterstützt wird, wie CPU, Speicher, Netzwerkverkehr und Batterie
Unterstützung

Support for UiAutomator (4.2+)


pressKeyCode

Drückt eine bestimmte Taste auf dem Gerät.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.pressKeyCode(keycode, metastate, flags)
Parameter
NameTypDetails
keycodenumberzu drückender Keycode
metastate
optional
numberMeta-Zustand, mit dem der Keycode gedrückt werden soll
flags
optional
numberFlags für den Tastendruck
Unterstützung

Support for UiAutomator (4.2+)


longPressKeyCode

Drückt und hält einen bestimmten Keycode auf dem Gerät.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.longPressKeyCode(keycode, metastate, flags)
Parameter
NameTypDetails
keycodenumberauf dem Gerät zu drückender Keycode
metastate
optional
numberMeta-Zustand für den Tastendruck
flags
optional
numberFlags für den Tastendruck
Unterstützung

Support for UiAutomator (4.2+)


sendKeyEvent

Sendet einen Keycode an das Gerät.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.sendKeyEvent(keycode, metastate)
Parameter
NameTypDetails
keycodestringzu drückender Keycode
metastate
optional
stringMeta-Zustand, mit dem der Keycode gedrückt werden soll
Unterstützung

Support for UiAutomator (4.2+)


rotateDevice

Dreht das Gerät in drei Dimensionen.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.rotateDevice(x, y, z)
Parameter
NameTypDetails
xnumberx-Offset, der für den Mittelpunkt der Drehgeste verwendet werden soll
ynumbery-Offset, der für den Mittelpunkt der Drehgeste verwendet werden soll
znumberz-Offset, der für den Mittelpunkt der Drehgeste verwendet werden soll
Unterstützung

Support for UIAutomation (8.0 to 9.3) Support for UiAutomator (4.2+)


getCurrentActivity

Holt den Namen der aktuellen Android-Aktivität.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.getCurrentActivity()
Gibt zurück
  • <string> activity: Name der aktuellen Aktivität
Unterstützung

Support for UiAutomator (4.2+)


getCurrentPackage

Holt den Namen des aktuellen Android-Pakets.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.getCurrentPackage()
Gibt zurück
  • <string> package: Name des aktuellen Pakets
Unterstützung

Support for UiAutomator (4.2+)


installApp

Installiert die angegebene App auf dem Gerät.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.installApp(appPath)
Parameter
NameTypDetails
appPathstringPfad zur .apk-Anwendungsdatei
Unterstützung

Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3) Support for UiAutomator (4.2+)


activateApp

Aktiviert die angegebene App auf dem Gerät

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.activateApp(appId)
Parameter
NameTypDetails
appIdstringApp-ID (Package-ID für Android, Bundle-ID für iOS)
Unterstützung

Support for XCUITest (9.3+) Support for UiAutomator (4.2+)


removeApp

Entfernt eine App vom Gerät.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.removeApp(appId)
Parameter
NameTypDetails
appIdstringApp-ID (Package-ID für Android, Bundle-ID für iOS)
Unterstützung

Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3) Support for UiAutomator (4.2+)


terminateApp

Beendet die angegebene App auf dem Gerät

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.terminateApp(appId, options)
Parameter
NameTypDetails
appIdstringApp-ID (Package-ID für Android, Bundle-ID für iOS)
options
optional
objectBefehlsoptionen. Z.B. "timeout": (Nur Android) Timeout für erneuten Versuch die App zu beenden (siehe mehr in der Appium-Dokumentation)
Unterstützung

Support for XCUITest (9.3+) Support for UiAutomator (4.2+)


isAppInstalled

Prüft, ob die angegebene App auf dem Gerät installiert ist.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.isAppInstalled(appId)
Parameter
NameTypDetails
appIdstringApp-ID (Package-ID für Android, Bundle-ID für iOS)
Gibt zurück
  • <boolean> isAppInstalled: Gibt true zurück, wenn installiert, false wenn nicht
Unterstützung

Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3) Support for UiAutomator (4.2+)


queryAppState

Ermittelt den Status der angegebenen App auf dem Gerät

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.queryAppState(appId)
Parameter
NameTypDetails
appIdstringApp-ID (Package-ID für Android, Bundle-ID für iOS)
Gibt zurück
  • <number> appStatus: 0 ist nicht installiert. 1 ist nicht ausgeführt. 2 wird im Hintergrund oder suspendiert ausgeführt. 3 wird im Hintergrund ausgeführt. 4 wird im Vordergrund ausgeführt
Unterstützung

Support for XCUITest (9.3+) Support for UiAutomator (4.2+)


hideKeyboard

Verbirgt die Bildschirmtastatur.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.hideKeyboard(strategy, key, keyCode, keyName)
Parameter
NameTypDetails
strategy
optional
stringStrategie zum Verbergen der Tastatur (nur UIAutomation), verfügbare Strategien - 'press', 'pressKey', 'swipeDown', 'tapOut', 'tapOutside', 'default'
key
optional
stringTastenwert, wenn die Strategie 'pressKey' ist
keyCode
optional
stringTastencode, wenn die Strategie 'pressKey' ist
keyName
optional
stringTastenname, wenn die Strategie 'pressKey' ist
Unterstützung

Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3) Support for UiAutomator (4.2+) Support for Windows (10+)


isKeyboardShown

Überprüft, ob die Bildschirmtastatur angezeigt wird.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.isKeyboardShown()
Gibt zurück
  • <boolean> isKeyboardShown: True, wenn die Tastatur angezeigt wird
Unterstützung

Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3) Support for UiAutomator (4.2+) Support for Windows (10+)


pushFile

Platziert eine Datei an einem bestimmten Ort auf dem Gerät.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.pushFile(path, data)
Parameter
NameTypDetails
pathstringPfad, in den die Daten installiert werden sollen
datastringInhalt der Datei in Base64
Unterstützung

Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3) Support for UiAutomator (4.2+) Support for Windows (10+)


pullFile

Ruft eine Datei vom Dateisystem des Geräts ab.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.pullFile(path)
Parameter
NameTypDetails
pathstringPfad auf dem Gerät, von dem die Datei abgerufen werden soll
Gibt zurück
  • <string> response: Inhalt der Datei in Base64
Unterstützung

Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3) Support for UiAutomator (4.2+) Support for Windows (10+)


pullFolder

Ruft einen Ordner vom Dateisystem des Geräts ab.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.pullFolder(path)
Parameter
NameTypDetails
pathstringPfad zu einem gesamten Ordner auf dem Gerät
Unterstützung

Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3) Support for UiAutomator (4.2+) Support for Windows (10+)


toggleAirplaneMode

Schaltet den Flugmodus auf dem Gerät um.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.toggleAirplaneMode()
Unterstützung

Support for UiAutomator (4.2+)


toggleData

Schaltet den Zustand des Datendienstes um.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.toggleData()
Unterstützung

Support for UiAutomator (4.2+)


toggleWiFi

Schaltet den Zustand des WLAN-Dienstes um.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.toggleWiFi()
Unterstützung

Support for UiAutomator (4.2+)


toggleLocationServices

Schaltet den Zustand des Standortdienstes um.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.toggleLocationServices()
Unterstützung

Support for UiAutomator (4.2+)


toggleNetworkSpeed

Stellt die Netzwerkgeschwindigkeit ein (nur Emulator)

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.toggleNetworkSpeed(netspeed)
Parameter
NameTypDetails
netspeedstringNetzwerktyp - 'full', 'gsm', 'edge', 'hscsd', 'gprs', 'umts', 'hsdpa', 'lte', 'evdo'
Unterstützung

Support for UiAutomator (4.2+)


openNotifications

Öffnet Android-Benachrichtigungen (nur Emulator).

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.openNotifications()
Unterstützung

Support for UiAutomator (4.2+)


startActivity

Startet eine Android-Aktivität durch Angabe des Paketnamen und des Aktivitätsnamen.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.startActivity(appPackage, appActivity, appWaitPackage, appWaitActivity, intentAction, intentCategory, intentFlags, optionalIntentArguments, dontStopAppOnReset)
Parameter
NameTypDetails
appPackagestringName der App
appActivitystringName der Aktivität
appWaitPackage
optional
stringName der App, auf die gewartet werden soll
appWaitActivity
optional
stringName der Aktivität, auf die gewartet werden soll
intentAction=android.intent.action.MAIN
optional
stringIntent-Aktion, die zum Starten der Aktivität verwendet wird
intentCategory=android.intent.category.LAUNCHER
optional
stringIntent-Kategorie, die zum Starten der Aktivität verwendet wird
intentFlags=0x10200000
optional
stringFlags, die zum Starten der Aktivität verwendet werden
optionalIntentArguments
optional
stringZusätzliche Intent-Argumente, die zum Starten der Aktivität verwendet werden
dontStopAppOnReset
optional
stringStoppt den Prozess der zu testenden App nicht, bevor die App mit adb gestartet wird
Unterstützung

Support for UiAutomator (4.2+)


getSystemBars

Ruft Sichtbarkeits- und Begrenzungsinformationen der Status- und Navigationsleisten ab.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.getSystemBars()
Gibt zurück
  • <object[]> systemBars: Informationen über Sichtbarkeit und Grenzen von Status- und Navigationsleiste
Unterstützung

Support for UiAutomator (4.2+)


getDeviceTime

Holt die Zeit auf dem Gerät.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.getDeviceTime()
Gibt zurück
  • <string> time: Zeit auf dem Gerät
Unterstützung

Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3) Support for UiAutomator (4.2+)


getDisplayDensity

Holt die Anzeigedichte vom Gerät.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.getDisplayDensity()
Gibt zurück
  • <*>
Unterstützung

Support for UiAutomator (4.2+)


touchId

Simuliert ein Touch-ID-Ereignis (nur iOS-Simulator). Um diese Funktion zu aktivieren, muss die gewünschte Capability allowTouchIdEnroll auf true gesetzt sein und der Simulator muss registriert sein. Wenn Sie allowTouchIdEnroll auf true setzen, wird der Simulator standardmäßig registriert. Der Registrierungsstatus kann umgeschaltet werden. Dieser Aufruf funktioniert nur, wenn der Appium-Prozess oder seine übergeordnete Anwendung (z.B. Terminal.app oder Appium.app) Zugriff auf die Mac OS-Bedienungshilfen in Systemeinstellungen > Sicherheit & Datenschutz > Datenschutz > Bedienungshilfen hat.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.touchId(match)
Parameter
NameTypDetails
matchbooleanSimulieren wir eine erfolgreiche Berührung (true) oder eine fehlgeschlagene Berührung (false)
Unterstützung

Support for XCUITest (9.3+)


toggleEnrollTouchId

Schaltet die Registrierung des Simulators zur Akzeptanz von TouchID um (nur iOS-Simulator). Um diese Funktion zu aktivieren, muss die gewünschte Capability allowTouchIdEnroll auf true gesetzt sein. Wenn allowTouchIdEnroll auf true gesetzt ist, wird der Simulator standardmäßig registriert, und 'Toggle Touch ID Enrollment' ändert den Registrierungsstatus. Dieser Aufruf funktioniert nur, wenn der Appium-Prozess oder seine übergeordnete Anwendung (z.B. Terminal.app oder Appium.app) Zugriff auf die Mac OS-Bedienungshilfen in Systemeinstellungen > Sicherheit & Datenschutz > Datenschutz > Bedienungshilfen hat.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.toggleEnrollTouchId(enabled)
Parameter
NameTypDetails
enabled=true
optional
booleanentspricht true, wenn die TouchID-Registrierung aktiviert werden soll
Unterstützung

Support for XCUITest (9.3+)


launchApp

Startet eine App auf dem Gerät.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Achtung

Dieser Protokollbefehl ist veraltet
Verwenden Sie für iOS driver.execute('mobile: launchApp', { ... }) und für Android driver.execute('mobile: activateApp', { ... }).

Verwendung
driver.launchApp()
Unterstützung

Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3) Support for UiAutomator (4.2+)


closeApp

Schließt eine App auf dem Gerät.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Achtung

Dieser Protokollbefehl ist veraltet
Verwenden Sie stattdessen driver.execute('mobile: terminateApp', { ... })

Verwendung
driver.closeApp()
Unterstützung

Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3) Support for UiAutomator (4.2+)


background

Sendet die derzeit laufende App für diese Sitzung in den Hintergrund.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Achtung

Dieser Protokollbefehl ist veraltet
Verwenden Sie stattdessen driver.execute('mobile: backgroundApp', { ... })

Verwendung
driver.background(seconds)
Parameter
NameTypDetails
seconds=nullnumber, nullTimeout zur Wiederherstellung der App, bei 'null' wird die App nicht wiederhergestellt
Unterstützung

Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3) Support for UiAutomator (4.2+)


endCoverage

Ruft Testabdeckungsdaten ab.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.endCoverage(intent, path)
Parameter
NameTypDetails
intentstringzu sendender Intent
pathstringPfad zur .ec-Datei
Unterstützung

Support for UiAutomator (4.2+)


getStrings

Holt App-Strings.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.getStrings(language, stringFile)
Parameter
NameTypDetails
language
optional
stringSprachcode
stringFile
optional
stringPfad zur String-Datei
Gibt zurück
  • <object> appStrings: alle definierten Strings aus einer App für die angegebene Sprache und den Dateinamen der Strings
Unterstützung

Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3) Support for UiAutomator (4.2+)


setValueImmediate

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.setValueImmediate(elementId, text)
Parameter
NameTypDetails
elementIdStringdie ID eines Elements, die in einem vorherigen Aufruf von Find Element(s) zurückgegeben wurde
textstringText, der für ein Element gesetzt werden soll
Unterstützung

Support for XCUITest (9.3+) Support for UiAutomator (4.2+)


replaceValue

Ersetzt den Wert eines Elements direkt.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.replaceValue(elementId, value)
Parameter
NameTypDetails
elementIdStringdie ID eines Elements, die in einem vorherigen Aufruf von Find Element(s) zurückgegeben wurde
valuestringWert, der im Element ersetzt werden soll
Unterstützung

Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3) Support for UiAutomator (4.2+)


getSettings

Ruft die aktuellen Einstellungen auf dem Gerät ab.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.getSettings()
Gibt zurück
  • <object> settings: JSON-Hash aller aktuell angegebenen Einstellungen, siehe Settings API
Unterstützung

Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3) Support for UiAutomator (4.2+) Support for Windows (10+)


updateSettings

Aktualisiert die aktuelle Einstellung auf dem Gerät.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.updateSettings(settings)
Parameter
NameTypDetails
settingsobjectSchlüssel/Wert-Objekt mit zu aktualisierenden Einstellungen
Unterstützung

Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3) Support for UiAutomator (4.2+) Support for Windows (10+)


receiveAsyncResponse

Callback-URL für asynchrone Ausführung von JavaScript.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.receiveAsyncResponse(response)
Parameter
NameTypDetails
responseobjectauf dem Gerät zu empfangende Antwort
Unterstützung

Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3)


gsmCall

Tätigt einen GSM-Anruf (nur Emulator).

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.gsmCall(phoneNumber, action)
Parameter
NameTypDetails
phoneNumberstringdie Telefonnummer, die angerufen werden soll
actionstringDie Aktion - 'call', 'accept', 'cancel', 'hold'
Unterstützung

Support for UiAutomator (4.2+)


gsmSignal

Stellt die GSM-Signalstärke ein (nur Emulator).

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.gsmSignal(signalStrength, signalStrengh)
Parameter
NameTypDetails
signalStrengthstringSignalstärke im Bereich [0, 4]
signalStrengh
optional
stringSignalstärke im Bereich [0, 4]. Bitte setzen Sie diesen Parameter auch mit dem gleichen Wert, wenn Sie Appium v1.11.0 oder niedriger verwenden (siehe https://github.com/appium/appium/issues/12234).
Unterstützung

Support for UiAutomator (4.2+)


powerCapacity

Stellt den Batteriestand ein (nur Emulator).

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.powerCapacity(percent)
Parameter
NameTypDetails
percentnumberProzentwert im Bereich [0, 100]
Unterstützung

Support for UiAutomator (4.2+)


powerAC

Stellt den Zustand des Batterieladegeräts auf verbunden oder nicht ein (nur Emulator).

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.powerAC(state)
Parameter
NameTypDetails
statestringstellt den Zustand ein. on oder off
Unterstützung

Support for UiAutomator (4.2+)


gsmVoice

Stellt den GSM-Sprachzustand ein (nur Emulator).

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.gsmVoice(state)
Parameter
NameTypDetails
statestringZustand der GSM-Sprache - 'unregistered', 'home', 'roaming', 'searching', 'denied', 'off', 'on'
Unterstützung

Support for UiAutomator (4.2+)


sendSms

Simuliert eine SMS-Nachricht (nur Emulator).

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.sendSms(phoneNumber, message)
Parameter
NameTypDetails
phoneNumberstringdie Telefonnummer, an die die SMS gesendet werden soll
messagestringdie SMS-Nachricht
Unterstützung

Support for UiAutomator (4.2+)


fingerPrint

Authentifiziert Benutzer über ihre Fingerabdruckscans auf unterstützten Emulatoren.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.fingerPrint(fingerprintId)
Parameter
NameTypDetails
fingerprintIdnumberim Android Keystore-System gespeicherte Fingerabdrücke (von 1 bis 10)
Unterstützung

Support for UiAutomator (4.2+)


setClipboard

Setzt den Inhalt der Zwischenablage des Systems

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.setClipboard(content, contentType, label)
Parameter
NameTypDetails
contentstringDer eigentliche Base64-codierte Inhalt der Zwischenablage
contentType
optional
stringDer Typ des zu bekommenden Inhalts. Plaintext, Image, URL. Android unterstützt nur Plaintext
label
optional
stringBeschriftung der Zwischenablagedaten für Android
Gibt zurück
  • <string> response: Antwort vom Appium-Server
Unterstützung

Support for XCUITest (9.3+) Support for UiAutomator (4.2+)


getClipboard

Holt den Inhalt der Zwischenablage des Systems

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.getClipboard(contentType)
Parameter
NameTypDetails
contentType
optional
stringDer Typ des zu bekommenden Inhalts. Plaintext, Image, URL. Android unterstützt nur Plaintext
Gibt zurück
  • <string> response: Inhalt der Zwischenablage als Base64-codierter String oder ein leerer String, wenn die Zwischenablage leer ist
Unterstützung

Support for XCUITest (9.3+) Support for UiAutomator (4.2+)


touchPerform

Diese Funktionalität ist nur innerhalb eines nativen Kontexts verfügbar. 'Touch Perform' funktioniert ähnlich wie die anderen einzelnen Touch-Interaktionen, außer dass Sie damit mehr als eine Touch-Aktion als einen Befehl verketten können. Dies ist nützlich, da Appium-Befehle über das Netzwerk gesendet werden und es Latenz zwischen Befehlen gibt. Diese Latenz kann bestimmte Touch-Interaktionen unmöglich machen, da einige Interaktionen in einer Sequenz ausgeführt werden müssen. Vertical erfordert beispielsweise das Drücken, Bewegen zu einer anderen y-Koordinate und dann Loslassen. Damit es funktioniert, darf es keine Verzögerung zwischen den Interaktionen geben.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.touchPerform(actions)
Parameter
NameTypDetails
actionsobject[]Die Art der auszuführenden Aktion (z.B. moveTo, release, press, tap, wait)
Beispiel
// horizontales Wischen nach Prozent durchführen
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: {},
},
]);
Unterstützung

Support for UiAutomator (4.2+) Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3) Support for Windows (10+)


multiTouchPerform

Diese Funktionalität ist nur innerhalb eines nativen Kontexts verfügbar. Führt eine Multi-Touch-Aktionssequenz aus.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.multiTouchPerform(actions)
Parameter
NameTypDetails
actionsobject[]Die Art der auszuführenden Aktion (z.B. moveTo, release, press, tap, wait)
Unterstützung

Support for UiAutomator (4.2+) Support for XCUITest (9.3+), UIAutomation (8.0 to 9.3) Support for Windows (10+)


executeDriverScript

Mit diesem Befehl können Sie ein WebdriverIO-Skript als String angeben und an den Appium-Server zur lokalen Ausführung auf dem Server selbst übertragen. Dieser Ansatz hilft, potenzielle Latenz im Zusammenhang mit jedem Befehl zu minimieren. Um diesen Befehl mit Appium 2.0 zu nutzen, müssen Sie das execute-driver-plugin Plugin installiert haben.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.executeDriverScript(script, type, timeout)
Parameter
NameTypDetails
scriptstringDas auszuführende Skript. Es hat Zugriff auf ein 'driver'-Objekt, das eine WebdriverIO-Sitzung darstellt, die mit dem aktuellen Server verbunden ist.
type
optional
stringDie im Skript verwendete Sprache/Framework. Derzeit wird nur 'webdriverio' unterstützt und ist die Standardeinstellung.
timeout
optional
numberDie Anzahl der Millisekunden, für die das Skript ausgeführt werden darf, bevor es vom Appium-Server beendet wird. Standardmäßig entspricht dies 1 Stunde.
Gibt zurück
  • <object> result: Ein Objekt, das zwei Felder enthält: 'result', das der Rückgabewert des Skripts selbst ist, und 'logs', das 3 innere Felder enthält, 'log', 'warn' und 'error', die ein Array von Strings enthalten, die während der Ausführung des Skripts durch console.log, console.warn und console.error protokolliert wurden.

getEvents

Ruft im Appium-Server gespeicherte Ereignisse ab.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.getEvents(type)
Parameter
NameTypDetails
typestring[]Ereignisse abrufen, die mit dem Typ gefiltert sind, wenn der Typ angegeben wird.
Gibt zurück
  • <object> result: Ein JSON-Hash von Ereignissen wie {'commands' => [{'cmd' => 123455, ....}], 'startTime' => 1572954894127, }.
Unterstützung

Support for UiAutomator (4.2+) Support for XCUITest (9.3+)


logEvent

Speichert ein benutzerdefiniertes Ereignis.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.logEvent(vendor, event)
Parameter
NameTypDetails
vendorstringDer Name des Anbieters. Es wird 'vendor' in 'vendor:event' sein.
eventstringDer Name des Ereignisses. Es wird 'event' in 'vendor:event' sein.
Unterstützung

Support for UiAutomator (4.2+) Support for XCUITest (9.3+)


compareImages

Diese Funktion führt Bildvergleiche unter Verwendung der Fähigkeiten des OpenCV-Frameworks durch. Bitte beachten Sie, dass für diese Funktionalität sowohl das OpenCV-Framework als auch das opencv4nodejs-Modul auf dem Computer installiert sein müssen, auf dem der Appium-Server läuft. Außerdem müssen Sie das images-plugin Plugin installiert haben, um diese Funktion mit Appium 2.0 zu nutzen.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.compareImages(mode, firstImage, secondImage, options)
Parameter
NameTypDetails
mode=matchFeaturesstringEiner der möglichen Vergleichsmodi: 'matchFeatures', 'getSimilarity', 'matchTemplate'. 'matchFeatures' ist standardmäßig eingestellt.
firstImagestringBilddaten. Alle Bildformate, die die OpenCV-Bibliothek selbst akzeptiert, werden unterstützt.
secondImagestringBilddaten. Alle Bildformate, die die OpenCV-Bibliothek selbst akzeptiert, werden unterstützt.
options=[object Object]objectDer Inhalt dieses Wörterbuchs hängt vom tatsächlichen mode-Wert ab. Weitere Details finden Sie in der Dokumentation zum appium-support-Modul.
Gibt zurück
  • <object> result: Der Inhalt des resultierenden Wörterbuchs hängt von den tatsächlichen mode- und options-Werten ab. Weitere Details finden Sie in der Dokumentation zum appium-support-Modul.

implicitWait

Stellt die Zeit ein, die der Treiber beim Suchen nach Elementen warten soll. Bei der Suche nach einem einzelnen Element sollte der Treiber die Seite abfragen, bis ein Element gefunden wird oder die Zeitüberschreitung eintritt, je nachdem, was zuerst eintritt. Bei der Suche nach mehreren Elementen sollte der Treiber die Seite abfragen, bis mindestens ein Element gefunden wird oder die Zeitüberschreitung eintritt, woraufhin er eine leere Liste zurückgeben sollte. Wenn dieser Befehl nie gesendet wird, sollte der Treiber standardmäßig eine implizite Wartezeit von 0ms haben.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.implicitWait(ms)
Parameter
NameTypDetails
msnumberDie Zeit in Millisekunden, die auf ein Element gewartet werden soll.
Unterstützung

Support for UiAutomator (4.2+) Support for XCUITest (9.3+)


getLocationInView

Bestimmt die Position eines Elements auf dem Bildschirm, nachdem es in die Ansicht gescrollt wurde.

Hinweis: Dies wird als interner Befehl betrachtet und sollte nur verwendet werden, um die Position eines Elements zur korrekten Generierung nativer Ereignisse zu bestimmen.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.getLocationInView(elementId)
Parameter
NameTypDetails
elementIdStringID des Elements, an das der Befehl weitergeleitet werden soll
Gibt zurück
  • <Object> location: Die X- und Y-Koordinaten für das Element auf der Seite.
Unterstützung

Support for UiAutomator (4.2+) Support for XCUITest (9.3+)


sendKeys

Sendet eine Folge von Tastenanschlägen an das aktive Element

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.sendKeys(value)
Parameter
NameTypDetails
valuestring[]Die Folge der zu tippenden Tasten. Ein Array muss bereitgestellt werden.
Unterstützung

Support for UiAutomator (4.2+) Support for XCUITest (9.3+)


availableIMEEngines

Listet alle verfügbaren Engines auf dem Computer auf. Um eine Engine zu verwenden, muss sie in dieser Liste vorhanden sein.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.availableIMEEngines()
Gibt zurück
  • <String[]> engines: Eine Liste verfügbarer Engines
Unterstützung

Support for UiAutomator (4.2+)


getActiveIMEEngine

Holt den Namen der aktiven IME-Engine. Die Namenszeichenfolge ist plattformspezifisch.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.getActiveIMEEngine()
Gibt zurück
  • <String> engine: Der Name der aktiven IME-Engine
Unterstützung

Support for UiAutomator (4.2+)


isIMEActivated

Zeigt an, ob die IME-Eingabe im Moment aktiv ist

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.isIMEActivated()
Gibt zurück
  • <Boolean> isActive: true, wenn die IME-Eingabe verfügbar und derzeit aktiv ist, sonst false
Unterstützung

Support for UiAutomator (4.2+)


deactivateIMEEngine

Deaktiviert die derzeit aktive IME-Engine.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.deactivateIMEEngine()
Unterstützung

Support for UiAutomator (4.2+)


activateIMEEngine

Aktiviert eine verfügbare Engine

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.activateIMEEngine(engine)
Parameter
NameTypDetails
enginestringName der zu aktivierenden Engine
Unterstützung

Support for UiAutomator (4.2+)


asyncScriptTimeout

Stellt die Zeit in Millisekunden ein, die asynchrone Skripte, die von /session/:sessionId/execute_async ausgeführt werden, laufen dürfen, bevor sie abgebrochen werden und ein Timeout-Fehler an den Client zurückgegeben wird.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.asyncScriptTimeout(ms)
Parameter
NameTypDetails
msnumberDie Zeit in Millisekunden, für die zeitbegrenzte Befehle ausgeführt werden dürfen
Unterstützung

Support for XCUITest (9.3+)


submit

Sendet ein Formularelement ab.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.submit(elementId)
Parameter
NameTypDetails
elementIdStringID des Formularelements, das abgesendet werden soll
Unterstützung

Support for XCUITest (9.3+)


getElementSize

Bestimmt die Größe eines Elements in Pixeln. Die Größe wird als JSON-Objekt mit den Eigenschaften width und height zurückgegeben.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.getElementSize(elementId)
Parameter
NameTypDetails
elementIdStringID des Elements, an das der Befehl weitergeleitet werden soll
Gibt zurück
  • <Object> size: Die Breite und Höhe des Elements in Pixeln.
Unterstützung

Support for UiAutomator (4.2+) Support for XCUITest (9.3+)


getElementLocation

Bestimmt die Position eines Elements auf der Seite. Der Punkt (0, 0) bezieht sich auf die obere linke Ecke der Seite. Die Koordinaten des Elements werden als JSON-Objekt mit den Eigenschaften x und y zurückgegeben.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.getElementLocation(elementId)
Parameter
NameTypDetails
elementIdStringID des Elements, an das der Befehl weitergeleitet werden soll
Gibt zurück
  • <Object> location: Die X- und Y-Koordinaten für das Element auf der Seite.
Unterstützung

Support for UiAutomator (4.2+) Support for XCUITest (9.3+)


touchClick

Einzelner Tipp auf dem berührungsempfindlichen Gerät.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.touchClick(element)
Parameter
NameTypDetails
elementstringID des Elements, auf das einmal getippt werden soll.
Unterstützung

Support for UiAutomator (4.2+) Support for XCUITest (9.3+)


touchDown

Finger auf dem Bildschirm nach unten.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.touchDown(x, y)
Parameter
NameTypDetails
xnumberx-Koordinate auf dem Bildschirm
ynumbery-Koordinate auf dem Bildschirm
Unterstützung

Support for UiAutomator (4.2+)


touchUp

Finger auf dem Bildschirm nach oben.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.touchUp(x, y)
Parameter
NameTypDetails
xnumberx-Koordinate auf dem Bildschirm
ynumbery-Koordinate auf dem Bildschirm
Unterstützung

Support for UiAutomator (4.2+)


touchMove

Finger auf dem Bildschirm bewegen.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.touchMove(x, y)
Parameter
NameTypDetails
xnumberx-Koordinate auf dem Bildschirm
ynumbery-Koordinate auf dem Bildschirm
Unterstützung

Support for UiAutomator (4.2+)


touchLongClick

Langes Drücken auf dem Touchscreen mit Fingerbewegungsereignissen.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.touchLongClick(element)
Parameter
NameTypDetails
elementstringID des Elements, auf das lange gedrückt werden soll
Unterstützung

Support for UiAutomator (4.2+)


touchFlick

Wischen auf dem Touchscreen mit Fingerbewegungsereignissen. Dieser Wischbefehl beginnt an einer bestimmten Bildschirmposition.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.touchFlick(xoffset, yoffset, element, speed, xspeed, yspeed)
Parameter
NameTypDetails
xoffset
optional
numberder x-Offset in Pixeln, um den gewischt werden soll
yoffset
optional
numberder y-Offset in Pixeln, um den gewischt werden soll
element
optional
stringID des Elements, wo der Wisch beginnt
speed
optional
numberdie Geschwindigkeit in Pixeln pro Sekunde
xspeed
optional
numberdie x-Geschwindigkeit in Pixeln pro Sekunde
yspeed
optional
numberdie y-Geschwindigkeit in Pixeln pro Sekunde
Unterstützung

Support for UiAutomator (4.2+)


getOrientation

Holt die aktuelle Geräteausrichtung.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.getOrientation()
Gibt zurück
  • <String> orientation: Die aktuelle Ausrichtung entsprechend einem in ScreenOrientation definierten Wert: LANDSCAPE|PORTRAIT.
Unterstützung

Support for UiAutomator (4.2+) Support for XCUITest (9.3+)


setOrientation

Stellt die Geräteausrichtung ein

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.setOrientation(orientation)
Parameter
NameTypDetails
orientationstringdie neue Browser-Ausrichtung, wie in ScreenOrientation definiert: LANDSCAPE|PORTRAIT
Unterstützung

Support for UiAutomator (4.2+) Support for XCUITest (9.3+)


getLogs

Ruft das Protokoll für einen gegebenen Protokolltyp ab. Der Protokollpuffer wird nach jeder Anfrage zurückgesetzt.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.getLogs(type)
Parameter
NameTypDetails
typestringder Protokolltyp
Gibt zurück
  • <Object[]> logs: Die Liste der Protokolleinträge.
Unterstützung

Support for UiAutomator (4.2+) Support for XCUITest (9.3+)


getLogTypes

Ruft verfügbare Protokolltypen ab.

Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.

Verwendung
driver.getLogTypes()
Gibt zurück
  • <String[]> logTypes: Die Liste der verfügbaren Protokolltypen.
Unterstützung

Support for UiAutomator (4.2+) Support for XCUITest (9.3+)

Welcome! How can I help?

WebdriverIO AI Copilot