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
Name | Typ | Details |
---|---|---|
name | string | ein 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
lock
Sperrt das Gerät.
Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.
Verwendung
driver.lock(seconds)
Parameter
Name | Typ | Details |
---|---|---|
seconds optional | number | wie lange der Bildschirm gesperrt werden soll (nur iOS) |
Unterstützung
unlock
Entsperrt das Gerät.
Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.
Verwendung
driver.unlock()
Unterstützung
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
startRecordingScreen
Startet die Bildschirmaufnahme.
Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.
Verwendung
driver.startRecordingScreen(options)
Parameter
Name | Typ | Details |
---|---|---|
options optional | object | Befehlsparameter, 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
stopRecordingScreen
Stoppt die Bildschirmaufnahme
Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.
Verwendung
driver.stopRecordingScreen(remotePath, username, password, method)
Parameter
Name | Typ | Details |
---|---|---|
remotePath optional | string | Der 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 | string | Der Benutzername für die Remote-Authentifizierung. |
password optional | string | Das Passwort für die Remote-Authentifizierung. |
method optional | string | Der 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
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
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
Name | Typ | Details |
---|---|---|
packageName | string | der Packagename der Anwendung |
dataType | string | der Typ des Systemzustands, der gelesen werden soll. Er sollte einer der unterstützten Leistungsdatentypen sein |
dataReadTimeout optional | number | die 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
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
Name | Typ | Details |
---|---|---|
keycode | number | zu drückender Keycode |
metastate optional | number | Meta-Zustand, mit dem der Keycode gedrückt werden soll |
flags optional | number | Flags für den Tastendruck |
Unterstützung
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
Name | Typ | Details |
---|---|---|
keycode | number | auf dem Gerät zu drückender Keycode |
metastate optional | number | Meta-Zustand für den Tastendruck |
flags optional | number | Flags für den Tastendruck |
Unterstützung
sendKeyEvent
Sendet einen Keycode an das Gerät.
Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.
Verwendung
driver.sendKeyEvent(keycode, metastate)
Parameter
Name | Typ | Details |
---|---|---|
keycode | string | zu drückender Keycode |
metastate optional | string | Meta-Zustand, mit dem der Keycode gedrückt werden soll |
Unterstützung
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
Name | Typ | Details |
---|---|---|
x | number | x-Offset, der für den Mittelpunkt der Drehgeste verwendet werden soll |
y | number | y-Offset, der für den Mittelpunkt der Drehgeste verwendet werden soll |
z | number | z-Offset, der für den Mittelpunkt der Drehgeste verwendet werden soll |
Unterstützung
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
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
installApp
Installiert die angegebene App auf dem Gerät.
Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.
Verwendung
driver.installApp(appPath)
Parameter
Name | Typ | Details |
---|---|---|
appPath | string | Pfad zur .apk-Anwendungsdatei |
Unterstützung
activateApp
Aktiviert die angegebene App auf dem Gerät
Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.
Verwendung
driver.activateApp(appId)
Parameter
Name | Typ | Details |
---|---|---|
appId | string | App-ID (Package-ID für Android, Bundle-ID für iOS) |
Unterstützung
removeApp
Entfernt eine App vom Gerät.
Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.
Verwendung
driver.removeApp(appId)
Parameter
Name | Typ | Details |
---|---|---|
appId | string | App-ID (Package-ID für Android, Bundle-ID für iOS) |
Unterstützung
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
Name | Typ | Details |
---|---|---|
appId | string | App-ID (Package-ID für Android, Bundle-ID für iOS) |
options optional | object | Befehlsoptionen. Z.B. "timeout": (Nur Android) Timeout für erneuten Versuch die App zu beenden (siehe mehr in der Appium-Dokumentation) |
Unterstützung
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
Name | Typ | Details |
---|---|---|
appId | string | App-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
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
Name | Typ | Details |
---|---|---|
appId | string | App-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
hideKeyboard
Verbirgt die Bildschirmtastatur.
Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.
Verwendung
driver.hideKeyboard(strategy, key, keyCode, keyName)
Parameter
Name | Typ | Details |
---|---|---|
strategy optional | string | Strategie zum Verbergen der Tastatur (nur UIAutomation), verfügbare Strategien - 'press', 'pressKey', 'swipeDown', 'tapOut', 'tapOutside', 'default' |
key optional | string | Tastenwert, wenn die Strategie 'pressKey' ist |
keyCode optional | string | Tastencode, wenn die Strategie 'pressKey' ist |
keyName optional | string | Tastenname, wenn die Strategie 'pressKey' ist |
Unterstützung
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
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
Name | Typ | Details |
---|---|---|
path | string | Pfad, in den die Daten installiert werden sollen |
data | string | Inhalt der Datei in Base64 |
Unterstützung
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
Name | Typ | Details |
---|---|---|
path | string | Pfad auf dem Gerät, von dem die Datei abgerufen werden soll |
Gibt zurück
- <string>
response
: Inhalt der Datei in Base64
Unterstützung
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
Name | Typ | Details |
---|---|---|
path | string | Pfad zu einem gesamten Ordner auf dem Gerät |
Unterstützung
toggleAirplaneMode
Schaltet den Flugmodus auf dem Gerät um.
Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.
Verwendung
driver.toggleAirplaneMode()
Unterstützung
toggleData
Schaltet den Zustand des Datendienstes um.
Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.
Verwendung
driver.toggleData()
Unterstützung
toggleWiFi
Schaltet den Zustand des WLAN-Dienstes um.
Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.
Verwendung
driver.toggleWiFi()
Unterstützung
toggleLocationServices
Schaltet den Zustand des Standortdienstes um.
Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.
Verwendung
driver.toggleLocationServices()
Unterstützung
toggleNetworkSpeed
Stellt die Netzwerkgeschwindigkeit ein (nur Emulator)
Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.
Verwendung
driver.toggleNetworkSpeed(netspeed)
Parameter
Name | Typ | Details |
---|---|---|
netspeed | string | Netzwerktyp - 'full', 'gsm', 'edge', 'hscsd', 'gprs', 'umts', 'hsdpa', 'lte', 'evdo' |
Unterstützung
openNotifications
Öffnet Android-Benachrichtigungen (nur Emulator).
Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.
Verwendung
driver.openNotifications()
Unterstützung
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
Name | Typ | Details |
---|---|---|
appPackage | string | Name der App |
appActivity | string | Name der Aktivität |
appWaitPackage optional | string | Name der App, auf die gewartet werden soll |
appWaitActivity optional | string | Name der Aktivität, auf die gewartet werden soll |
intentAction=android.intent.action.MAIN optional | string | Intent-Aktion, die zum Starten der Aktivität verwendet wird |
intentCategory=android.intent.category.LAUNCHER optional | string | Intent-Kategorie, die zum Starten der Aktivität verwendet wird |
intentFlags=0x10200000 optional | string | Flags, die zum Starten der Aktivität verwendet werden |
optionalIntentArguments optional | string | Zusätzliche Intent-Argumente, die zum Starten der Aktivität verwendet werden |
dontStopAppOnReset optional | string | Stoppt den Prozess der zu testenden App nicht, bevor die App mit adb gestartet wird |
Unterstützung
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
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
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
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
Name | Typ | Details |
---|---|---|
match | boolean | Simulieren wir eine erfolgreiche Berührung (true) oder eine fehlgeschlagene Berührung (false) |
Unterstützung
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
Name | Typ | Details |
---|---|---|
enabled=true optional | boolean | entspricht true, wenn die TouchID-Registrierung aktiviert werden soll |
Unterstützung
launchApp
Startet eine App auf dem Gerät.
Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.
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
closeApp
Schließt eine App auf dem Gerät.
Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.
Dieser Protokollbefehl ist veraltet
Verwenden Sie stattdessen driver.execute('mobile: terminateApp', { ... })
Verwendung
driver.closeApp()
Unterstützung
background
Sendet die derzeit laufende App für diese Sitzung in den Hintergrund.
Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.
Dieser Protokollbefehl ist veraltet
Verwenden Sie stattdessen driver.execute('mobile: backgroundApp', { ... })
Verwendung
driver.background(seconds)
Parameter
Name | Typ | Details |
---|---|---|
seconds=null | number, null | Timeout zur Wiederherstellung der App, bei 'null' wird die App nicht wiederhergestellt |
Unterstützung
endCoverage
Ruft Testabdeckungsdaten ab.
Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.
Verwendung
driver.endCoverage(intent, path)
Parameter
Name | Typ | Details |
---|---|---|
intent | string | zu sendender Intent |
path | string | Pfad zur .ec-Datei |
Unterstützung
getStrings
Holt App-Strings.
Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.
Verwendung
driver.getStrings(language, stringFile)
Parameter
Name | Typ | Details |
---|---|---|
language optional | string | Sprachcode |
stringFile optional | string | Pfad 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
setValueImmediate
Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.
Verwendung
driver.setValueImmediate(elementId, text)
Parameter
Name | Typ | Details |
---|---|---|
elementId | String | die ID eines Elements, die in einem vorherigen Aufruf von Find Element(s) zurückgegeben wurde |
text | string | Text, der für ein Element gesetzt werden soll |
Unterstützung
replaceValue
Ersetzt den Wert eines Elements direkt.
Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.
Verwendung
driver.replaceValue(elementId, value)
Parameter
Name | Typ | Details |
---|---|---|
elementId | String | die ID eines Elements, die in einem vorherigen Aufruf von Find Element(s) zurückgegeben wurde |
value | string | Wert, der im Element ersetzt werden soll |
Unterstützung
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
updateSettings
Aktualisiert die aktuelle Einstellung auf dem Gerät.
Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.
Verwendung
driver.updateSettings(settings)
Parameter
Name | Typ | Details |
---|---|---|
settings | object | Schlüssel/Wert-Objekt mit zu aktualisierenden Einstellungen |
Unterstützung
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
Name | Typ | Details |
---|---|---|
response | object | auf dem Gerät zu empfangende Antwort |
Unterstützung
gsmCall
Tätigt einen GSM-Anruf (nur Emulator).
Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.
Verwendung
driver.gsmCall(phoneNumber, action)
Parameter
Name | Typ | Details |
---|---|---|
phoneNumber | string | die Telefonnummer, die angerufen werden soll |
action | string | Die Aktion - 'call', 'accept', 'cancel', 'hold' |
Unterstützung
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
Name | Typ | Details |
---|---|---|
signalStrength | string | Signalstärke im Bereich [0, 4] |
signalStrengh optional | string | Signalstä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
powerCapacity
Stellt den Batteriestand ein (nur Emulator).
Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.
Verwendung
driver.powerCapacity(percent)
Parameter
Name | Typ | Details |
---|---|---|
percent | number | Prozentwert im Bereich [0, 100] |
Unterstützung
powerAC
Stellt den Zustand des Batterieladegeräts auf verbunden oder nicht ein (nur Emulator).
Appium-Befehl. Weitere Details finden Sie in der offiziellen Protokolldokumentation.