Appium

getAppiumContext

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.getAppiumContext()

Zwraca

• <Context> context: ciąg znaków reprezentujący bieżący kontekst lub null oznaczający 'brak kontekstu'

---

switchAppiumContext

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.switchAppiumContext(name)

Parametry

Nazwa	Typ	Szczegóły
name	string	ciąg znaków reprezentujący dostępny kontekst

---

getAppiumContexts

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.getAppiumContexts()

Zwraca

• <Context[]> contexts: tablica ciągów reprezentujących dostępne konteksty, np. 'WEBVIEW' lub 'NATIVE'

---

shake

Wykonanie akcji potrząśnięcia na urządzeniu.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.shake()

Wsparcie

---

lock

Zablokuj urządzenie.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.lock(seconds)

Parametry

Nazwa	Typ	Szczegóły
seconds opcjonalny	number	jak długo blokować ekran (tylko iOS)

Wsparcie

---

unlock

Odblokuj urządzenie.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.unlock()

Wsparcie

---

isLocked

Sprawdź, czy urządzenie jest zablokowane czy nie.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.isLocked()

Zwraca

• <boolean> isLocked: Prawda, jeśli urządzenie jest zablokowane, fałsz jeśli nie

Wsparcie

---

startRecordingScreen

Rozpocznij nagrywanie ekranu.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.startRecordingScreen(options)

Parametry

Nazwa	Typ	Szczegóły
options opcjonalny	object	parametry komendy, które mogą zawierać klucze jak: remotePath, username, password, method, forceRestart, timeLimit, videoType, videoQuality, videoFps, bitRate, videoSize, bugReport (więcej opisu w dokumentacji Appium)

Wsparcie

---

stopRecordingScreen

Zatrzymaj nagrywanie ekranu

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

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

Parametry

Nazwa	Typ	Szczegóły
remotePath opcjonalny	string	Ścieżka do zdalnej lokalizacji, gdzie utworzone wideo powinno zostać przesłane. Obsługiwane są następujące protokoły: http/https, ftp. Ta opcja ma efekt tylko wtedy, gdy istnieje proces nagrywania ekranu i parametr forceRestart nie jest ustawiony na true. Wartość null lub pusty ciąg (ustawienie domyślne) oznacza, że zawartość wynikowego pliku powinna być zakodowana jako Base64.
username opcjonalny	string	Nazwa użytkownika do uwierzytelnienia zdalnego.
password opcjonalny	string	Hasło do uwierzytelnienia zdalnego.
method opcjonalny	string	Nazwa metody przesyłania wieloczęściowego HTTP. Domyślnie używana jest metoda 'PUT'.

Zwraca

• <string> response: Ciąg zakodowany w Base64. Jeśli remote_path jest ustawiony, odpowiedź jest pustym ciągiem

Wsparcie

---

getPerformanceDataTypes

Zwraca typy informacji o stanie systemu, które są obsługiwane do odczytu, takie jak cpu, memory, network traffic i battery.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.getPerformanceDataTypes()

Zwraca

• <string[]> performanceTypes: Dostępne typy danych wydajnościowych (cpuinfo|batteryinfo|networkinfo|memoryinfo)

Wsparcie

---

getPerformanceData

Zwraca informacje o stanie systemu, które są obsługiwane do odczytu, takie jak cpu, memory, network traffic i battery.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.getPerformanceData(packageName, dataType, dataReadTimeout)

Parametry

Nazwa	Typ	Szczegóły
packageName	string	nazwa pakietu aplikacji
dataType	string	typ stanu systemu, który chcemy odczytać. Powinien to być jeden z obsługiwanych typów danych wydajnościowych
dataReadTimeout opcjonalny	number	liczba prób odczytu

Zwraca

• <string[]> performanceData: Typ informacji o stanie systemu, które są obsługiwane do odczytu, takie jak cpu, memory, network traffic i battery

Wsparcie

---

pressKeyCode

Naciśnij określony klawisz na urządzeniu.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.pressKeyCode(keycode, metastate, flags)

Parametry

Nazwa	Typ	Szczegóły
keycode	number	kod klawisza do naciśnięcia
metastate opcjonalny	number	stan meta do naciśnięcia z kodem klawisza
flags opcjonalny	number	flagi dla naciśnięcia klawisza

Wsparcie

---

longPressKeyCode

Naciśnij i przytrzymaj określony kod klawisza na urządzeniu.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.longPressKeyCode(keycode, metastate, flags)

Parametry

Nazwa	Typ	Szczegóły
keycode	number	kod klawisza do naciśnięcia na urządzeniu
metastate opcjonalny	number	stan meta dla naciśnięcia klawisza
flags opcjonalny	number	flagi dla naciśnięcia klawisza

Wsparcie

---

sendKeyEvent

Wyślij kod klawisza do urządzenia.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.sendKeyEvent(keycode, metastate)

Parametry

Nazwa	Typ	Szczegóły
keycode	string	kod klawisza do naciśnięcia
metastate opcjonalny	string	stan meta do naciśnięcia z kodem klawisza

Wsparcie

---

rotateDevice

Obróć urządzenie w trzech wymiarach.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.rotateDevice(x, y, z)

Parametry

Nazwa	Typ	Szczegóły
x	number	przesunięcie x do użycia dla środka gestu obrotu
y	number	przesunięcie y do użycia dla środka gestu obrotu
z	number	przesunięcie z do użycia dla środka gestu obrotu

Wsparcie

---

getCurrentActivity

Pobierz nazwę bieżącej aktywności Androida.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.getCurrentActivity()

Zwraca

• <string> activity: Nazwa bieżącej aktywności

Wsparcie

---

getCurrentPackage

Pobierz nazwę bieżącego pakietu Androida.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.getCurrentPackage()

Zwraca

• <string> package: Nazwa bieżącego pakietu

Wsparcie

---

installApp

Zainstaluj daną aplikację na urządzeniu.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.installApp(appPath)

Parametry

Nazwa	Typ	Szczegóły
appPath	string	ścieżka do pliku aplikacji .apk

Wsparcie

---

activateApp

Aktywuj daną aplikację na urządzeniu

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.activateApp(appId)

Parametry

Nazwa	Typ	Szczegóły
appId	string	ID aplikacji (ID pakietu dla Androida, ID pakietu dla iOS)

Wsparcie

---

removeApp

Usuń aplikację z urządzenia.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.removeApp(appId)

Parametry

Nazwa	Typ	Szczegóły
appId	string	ID aplikacji (ID pakietu dla Androida, ID pakietu dla iOS)

Wsparcie

---

terminateApp

Zakończ daną aplikację na urządzeniu

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.terminateApp(appId, options)

Parametry

Nazwa	Typ	Szczegóły
appId	string	ID aplikacji (ID pakietu dla Androida, ID pakietu dla iOS)
options opcjonalny	object	Opcje komendy. Np. "timeout": (Tylko Android) Limit czasu na ponowne zakończenie aplikacji (więcej w dokumentacji Appium)

Wsparcie

---

isAppInstalled

Sprawdź, czy określona aplikacja jest zainstalowana na urządzeniu.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.isAppInstalled(appId)

Parametry

Nazwa	Typ	Szczegóły
appId	string	ID aplikacji (ID pakietu dla Androida, ID pakietu dla iOS)

Zwraca

• <boolean> isAppInstalled: Zwraca true jeśli zainstalowane, false jeśli nie

Wsparcie

---

queryAppState

Pobierz status danej aplikacji na urządzeniu

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.queryAppState(appId)

Parametry

Nazwa	Typ	Szczegóły
appId	string	ID aplikacji (ID pakietu dla Androida, ID pakietu dla iOS)

Zwraca

• <number> appStatus: 0 oznacza niezainstalowaną. 1 oznacza nie uruchomioną. 2 oznacza uruchomioną w tle lub zawieszoną. 3 oznacza uruchomioną w tle. 4 oznacza uruchomioną na pierwszym planie

Wsparcie

---

hideKeyboard

Ukryj klawiaturę ekranową.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

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

Parametry

Nazwa	Typ	Szczegóły
strategy opcjonalny	string	strategia ukrywania klawiatury (tylko UIAutomation), dostępne strategie - 'press', 'pressKey', 'swipeDown', 'tapOut', 'tapOutside', 'default'
key opcjonalny	string	wartość klawisza jeśli strategia to 'pressKey'
keyCode opcjonalny	string	kod klawisza jeśli strategia to 'pressKey'
keyName opcjonalny	string	nazwa klawisza jeśli strategia to 'pressKey'

Wsparcie

---

isKeyboardShown

Czy klawiatura ekranowa jest wyświetlana.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.isKeyboardShown()

Zwraca

• <boolean> isKeyboardShown: Prawda, jeśli klawiatura jest wyświetlana

Wsparcie

---

pushFile

Umieść plik na urządzeniu w określonym miejscu.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.pushFile(path, data)

Parametry

Nazwa	Typ	Szczegóły
path	string	ścieżka do zainstalowania danych
data	string	zawartość pliku w base64

Wsparcie

---

pullFile

Pobierz plik z systemu plików urządzenia.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.pullFile(path)

Parametry

Nazwa	Typ	Szczegóły
path	string	ścieżka na urządzeniu, z której pobrać plik

Zwraca

• <string> response: Zawartość pliku w base64

Wsparcie

---

pullFolder

Pobierz folder z systemu plików urządzenia.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.pullFolder(path)

Parametry

Nazwa	Typ	Szczegóły
path	string	ścieżka do całego folderu na urządzeniu

Wsparcie

---

toggleAirplaneMode

Przełącz tryb samolotowy na urządzeniu.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.toggleAirplaneMode()

Wsparcie

---

toggleData

Przełącz stan usługi danych.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.toggleData()

Wsparcie

---

toggleWiFi

Przełącz stan usługi wifi.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.toggleWiFi()

Wsparcie

---

toggleLocationServices

Przełącz stan usługi lokalizacji.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.toggleLocationServices()

Wsparcie

---

toggleNetworkSpeed

Ustaw prędkość sieci (tylko Emulator)

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.toggleNetworkSpeed(netspeed)

Parametry

Nazwa	Typ	Szczegóły
netspeed	string	Typ sieci - 'full','gsm', 'edge', 'hscsd', 'gprs', 'umts', 'hsdpa', 'lte', 'evdo'

Wsparcie

---

openNotifications

Otwórz powiadomienia Androida (tylko Emulator).

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.openNotifications()

Wsparcie

---

startActivity

Uruchom aktywność Androida podając nazwę pakietu i nazwę aktywności.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

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

Parametry

Nazwa	Typ	Szczegóły
appPackage	string	nazwa aplikacji
appActivity	string	nazwa aktywności
appWaitPackage opcjonalny	string	nazwa aplikacji, na którą należy czekać
appWaitActivity opcjonalny	string	nazwa aktywności, na którą należy czekać
intentAction=android.intent.action.MAIN opcjonalny	string	akcja intencji, która zostanie użyta do uruchomienia aktywności
intentCategory=android.intent.category.LAUNCHER opcjonalny	string	kategoria intencji, która zostanie użyta do uruchomienia aktywności
intentFlags=0x10200000 opcjonalny	string	flagi, które będą używane do uruchomienia aktywności
optionalIntentArguments opcjonalny	string	dodatkowe argumenty intencji, które będą używane do uruchomienia aktywności
dontStopAppOnReset opcjonalny	string	nie zatrzymuje procesu testowanej aplikacji przed uruchomieniem aplikacji za pomocą adb

Wsparcie

---

getSystemBars

Pobierz informacje o widoczności i granicach pasków stanu i nawigacji.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.getSystemBars()

Zwraca

• <object[]> systemBars: Informacje o widoczności i granicach paska stanu i nawigacji

Wsparcie

---

getDeviceTime

Pobierz czas z urządzenia.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.getDeviceTime()

Zwraca

• <string> time: Czas na urządzeniu

Wsparcie

---

getDisplayDensity

Pobierz gęstość wyświetlacza z urządzenia.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.getDisplayDensity()

Zwraca

• <*>

Wsparcie

---

touchId

Symuluj zdarzenie touch id (tylko Symulator iOS). Aby włączyć tę funkcję, opcja allowTouchIdEnroll musi być ustawiona na true, a Symulator musi być zarejestrowany. Gdy ustawisz allowTouchIdEnroll na true, Symulator będzie domyślnie zarejestrowany. Stan rejestracji można przełączać. To wywołanie będzie działać tylko wtedy, gdy proces Appium lub jego aplikacja nadrzędna (np. Terminal.app lub Appium.app) ma dostęp do dostępności systemu Mac OS w Preferencje systemowe > Bezpieczeństwo i prywatność > Prywatność > Dostępność.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.touchId(match)

Parametry

Nazwa	Typ	Szczegóły
match	boolean	czy symulujemy udane dotknięcie (true) czy nieudane dotknięcie (false)

Wsparcie

---

toggleEnrollTouchId

Przełączanie rejestracji symulatora do akceptowania touchId (tylko Symulator iOS). Aby włączyć tę funkcję, opcja allowTouchIdEnroll musi być ustawiona na true. Gdy allowTouchIdEnroll jest ustawiona na true, Symulator będzie zarejestrowany domyślnie, a 'Toggle Touch ID Enrollment' zmienia stan rejestracji. To wywołanie będzie działać tylko wtedy, gdy proces Appium lub jego aplikacja nadrzędna (np. Terminal.app lub Appium.app) ma dostęp do dostępności systemu Mac OS w Preferencje systemowe > Bezpieczeństwo i prywatność > Prywatność > Dostępność.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.toggleEnrollTouchId(enabled)

Parametry

Nazwa	Typ	Szczegóły
enabled=true opcjonalny	boolean	równa się true, jeśli rejestracja TouchID powinna być włączona

Wsparcie

---

launchApp

Uruchom aplikację na urządzeniu.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

ostrożnie

Ta komenda protokołu jest przestarzała
Dla iOS, użyj driver.execute('mobile: launchApp', { ... }), a dla Androida, użyj driver.execute('mobile: activateApp', { ... }).

Użycie

driver.launchApp()

Wsparcie

---

closeApp

Zamknij aplikację na urządzeniu.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

ostrożnie

Ta komenda protokołu jest przestarzała
Użyj driver.execute('mobile: terminateApp', { ... }) zamiast tego

Użycie

driver.closeApp()

Wsparcie

---

background

Wyślij aktualnie uruchomioną aplikację dla tej sesji w tło.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

ostrożnie

Ta komenda protokołu jest przestarzała
Użyj driver.execute('mobile: backgroundApp', { ... }) zamiast tego

Użycie

driver.background(seconds)

Parametry

Nazwa	Typ	Szczegóły
seconds=null	number, null	limit czasu na przywrócenie aplikacji, jeśli 'null', aplikacja nie zostanie przywrócona

Wsparcie

---

endCoverage

Pobierz dane pokrycia testowego.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.endCoverage(intent, path)

Parametry

Nazwa	Typ	Szczegóły
intent	string	intencja do rozgłoszenia
path	string	ścieżka do pliku .ec

Wsparcie

---

getStrings

Pobierz ciągi aplikacji.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.getStrings(language, stringFile)

Parametry

Nazwa	Typ	Szczegóły
language opcjonalny	string	kod języka
stringFile opcjonalny	string	ścieżka do pliku ciągów

Zwraca

• <object> appStrings: wszystkie zdefiniowane ciągi z aplikacji dla określonego języka i nazwy pliku ciągów

Wsparcie

---

setValueImmediate

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.setValueImmediate(elementId, text)

Parametry

Nazwa	Typ	Szczegóły
elementId	String	identyfikator elementu zwrócony w poprzednim wywołaniu Find Element(s)
text	string	tekst do ustawienia w elemencie

Wsparcie

---

replaceValue

Zastąp wartość elementu bezpośrednio.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.replaceValue(elementId, value)

Parametry

Nazwa	Typ	Szczegóły
elementId	String	identyfikator elementu zwrócony w poprzednim wywołaniu Find Element(s)
value	string	wartość do zastąpienia w elemencie

Wsparcie

---

getSettings

Pobierz bieżące ustawienia z urządzenia.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.getSettings()

Zwraca

• <object> settings: Tablica JSON ze wszystkimi aktualnie określonymi ustawieniami, patrz API Ustawień

Wsparcie

---

updateSettings

Zaktualizuj bieżące ustawienie na urządzeniu.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.updateSettings(settings)

Parametry

Nazwa	Typ	Szczegóły
settings	object	obiekt klucz/wartość z ustawieniami do aktualizacji

Wsparcie

---

receiveAsyncResponse

Adres URL wywołania zwrotnego dla asynchronicznego wykonania JavaScript.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.receiveAsyncResponse(response)

Parametry

Nazwa	Typ	Szczegóły
response	object	odpowiedź do odebrania na urządzeniu

Wsparcie

---

gsmCall

Wykonaj połączenie GSM (tylko Emulator).

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.gsmCall(phoneNumber, action)

Parametry

Nazwa	Typ	Szczegóły
phoneNumber	string	numer telefonu do zadzwonienia
action	string	Akcja - 'call', 'accept', 'cancel', 'hold'

Wsparcie

---

gsmSignal

Ustaw siłę sygnału GSM (tylko Emulator).

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.gsmSignal(signalStrength, signalStrengh)

Parametry

Nazwa	Typ	Szczegóły
signalStrength	string	siła sygnału w zakresie [0, 4]
signalStrengh opcjonalny	string	siła sygnału w zakresie [0, 4]. Ustaw również ten parametr z tą samą wartością, jeśli używasz Appium w wersji 1.11.0 lub niższej (patrz https://github.com/appium/appium/issues/12234).

Wsparcie

---

powerCapacity

Ustaw procent baterii (tylko Emulator).

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.powerCapacity(percent)

Parametry

Nazwa	Typ	Szczegóły
percent	number	wartość procentowa w zakresie [0, 100]

Wsparcie

---

powerAC

Ustaw stan ładowarki baterii na podłączony lub nie (tylko Emulator).

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.powerAC(state)

Parametry

Nazwa	Typ	Szczegóły
state	string	ustaw stan. on lub off

Wsparcie

---

gsmVoice

Ustaw stan głosu GSM (tylko Emulator).

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.gsmVoice(state)

Parametry

Nazwa	Typ	Szczegóły
state	string	stan głosu GSM - 'unregistered', 'home', 'roaming', 'searching', 'denied', 'off', 'on'

Wsparcie

---

sendSms

Symuluj wiadomość SMS (tylko Emulator).

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.sendSms(phoneNumber, message)

Parametry

Nazwa	Typ	Szczegóły
phoneNumber	string	numer telefonu, na który ma zostać wysłana wiadomość SMS
message	string	wiadomość SMS

Wsparcie

---

fingerPrint

Uwierzytelniaj użytkowników za pomocą skanów odcisków palców na obsługiwanych emulatorach.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.fingerPrint(fingerprintId)

Parametry

Nazwa	Typ	Szczegóły
fingerprintId	number	odciski palców przechowywane w systemie Android Keystore (od 1 do 10)

Wsparcie

---

setClipboard

Ustaw zawartość schowka systemowego

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.setClipboard(content, contentType, label)

Parametry

Nazwa	Typ	Szczegóły
content	string	Rzeczywista zawartość schowka zakodowana w base64
contentType opcjonalny	string	Typ zawartości do pobrania. Plaintext, Image, URL. Android obsługuje tylko plaintext
label opcjonalny	string	Etykieta danych schowka dla Androida

Zwraca

• <string> response: Odpowiedź z serwera Appium

Wsparcie

---

getClipboard

Pobierz zawartość schowka systemowego

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.getClipboard(contentType)

Parametry

Nazwa	Typ	Szczegóły
contentType opcjonalny	string	Typ zawartości do pobrania. Plaintext, Image, URL. Android obsługuje tylko plaintext

Zwraca

• <string> response: Zawartość schowka jako ciąg zakodowany w base64 lub pusty ciąg, jeśli schowek jest pusty

Wsparcie

---

touchPerform

Ta funkcjonalność jest dostępna tylko w kontekście natywnym. 'Touch Perform' działa podobnie do innych pojedynczych interakcji dotykowych, z wyjątkiem tego, że pozwala łączyć więcej niż jedną akcję dotykową jako jedną komendę. Jest to przydatne, ponieważ komendy Appium są wysyłane przez sieć i występuje opóźnienie między komendami. To opóźnienie może uniemożliwić niektóre interakcje dotykowe, ponieważ niektóre interakcje muszą być wykonywane w jednej sekwencji. Vertical, na przykład, wymaga naciśnięcia, przesunięcia do innej współrzędnej y, a następnie zwolnienia. Aby to zadziałało, nie może być opóźnienia między interakcjami.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.touchPerform(actions)

Parametry

Nazwa	Typ	Szczegóły
actions	object[]	Typ akcji do wykonania (np. moveTo, release, press, tap, wait)

Przykład

// wykonaj poziome przesunięcie procentowo
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: {},
  },
]);

Wsparcie

---

multiTouchPerform

Ta funkcjonalność jest dostępna tylko w kontekście natywnym. Wykonaj sekwencję akcji multi-touch.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.multiTouchPerform(actions)

Parametry

Nazwa	Typ	Szczegóły
actions	object[]	Typ akcji do wykonania (np. moveTo, release, press, tap, wait)

Wsparcie

---

executeDriverScript

Ta komenda umożliwia określenie skryptu WebdriverIO jako ciągu znaków i przesłanie go do serwera Appium w celu lokalnego wykonania na samym serwerze. To podejście pomaga zminimalizować potencjalne opóźnienia związane z każdą komendą. Aby korzystać z tej komendy z Appium 2.0, musisz mieć zainstalowany plugin execute-driver-plugin.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.executeDriverScript(script, type, timeout)

Parametry

Nazwa	Typ	Szczegóły
script	string	Skrypt do wykonania. Ma dostęp do obiektu 'driver', który reprezentuje sesję WebdriverIO dołączoną do bieżącego serwera.
type opcjonalny	string	Język/framework użyty w skrypcie. Obecnie obsługiwany jest tylko 'webdriverio' i jest to domyślna wartość.
timeout opcjonalny	number	Liczba milisekund, przez które skrypt powinien móc działać przed zabiciem przez serwer Appium. Domyślnie równowartość 1 godziny.

Zwraca

• <object> result: Obiekt zawierający dwa pola: 'result', który jest wartością zwracaną samego skryptu, oraz 'logs', który zawiera 3 wewnętrzne pola, 'log', 'warn' i 'error', które zawierają tablicę ciągów znaków zarejestrowanych przez console.log, console.warn i console.error podczas wykonywania skryptu.

---

getEvents

Pobierz zdarzenia przechowywane na serwerze appium.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.getEvents(type)

Parametry

Nazwa	Typ	Szczegóły
type	string[]	Pobierz zdarzenia, które są filtrowane według typu, jeśli typ jest podany.

Zwraca

• <object> result: Tablica JSON ze zdarzeniami, jak {'commands' => [{'cmd' => 123455, ....}], 'startTime' => 1572954894127, }.

Wsparcie

---

logEvent

Zapisz niestandardowe zdarzenie.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.logEvent(vendor, event)

Parametry

Nazwa	Typ	Szczegóły
vendor	string	Nazwa dostawcy. Będzie to vendor w vendor:event.
event	string	Nazwa zdarzenia. Będzie to event w vendor:event.

Wsparcie

---

compareImages

Ta funkcja przeprowadza porównania obrazów wykorzystując możliwości frameworku OpenCV. Należy pamiętać, że do działania tej funkcji zarówno framework OpenCV, jak i moduł opencv4nodejs muszą być zainstalowane na maszynie, na której działa serwer Appium. Ponadto, musisz mieć zainstalowany plugin images-plugin, aby korzystać z tej funkcji z Appium 2.0.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

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

Parametry

Nazwa	Typ	Szczegóły
mode=matchFeatures	string	Jeden z możliwych trybów porównania: 'matchFeatures', 'getSimilarity', 'matchTemplate'. Domyślnie 'matchFeatures'.
firstImage	string	Dane obrazu. Wszystkie formaty obrazów, które sama biblioteka OpenCV akceptuje, są obsługiwane.
secondImage	string	Dane obrazu. Wszystkie formaty obrazów, które sama biblioteka OpenCV akceptuje, są obsługiwane.
options=[object Object]	object	Zawartość tego słownika zależy od rzeczywistej wartości mode. Zobacz dokumentację modułu appium-support, aby uzyskać więcej szczegółów.

Zwraca

• <object> result: Zawartość wynikowego słownika zależy od rzeczywistych wartości mode i options. Zobacz dokumentację modułu appium-support, aby uzyskać więcej szczegółów.

---

implicitWait

Ustaw ilość czasu, przez który sterownik powinien czekać podczas wyszukiwania elementów. Podczas wyszukiwania pojedynczego elementu sterownik powinien odpytywać stronę, aż zostanie znaleziony element lub upłynie limit czasu, w zależności od tego, co nastąpi wcześniej. Podczas wyszukiwania wielu elementów sterownik powinien odpytywać stronę, aż znajdzie co najmniej jeden element lub upłynie limit czasu, w którym to momencie powinien zwrócić pustą listę. Jeśli ta komenda nigdy nie zostanie wysłana, sterownik powinien domyślnie ustawić niejawne oczekiwanie na 0 ms.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.implicitWait(ms)

Parametry

Nazwa	Typ	Szczegóły
ms	number	Ilość czasu w milisekundach, przez którą należy czekać na element.

Wsparcie

---

getLocationInView

Określ lokalizację elementu na ekranie po przewinięciu go do widoku.

Uwaga: Jest to uznawane za komendę wewnętrzną i powinno być używane tylko do określania lokalizacji elementu w celu poprawnego generowania zdarzeń natywnych.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.getLocationInView(elementId)

Parametry

Nazwa	Typ	Szczegóły
elementId	String	ID elementu, do którego kierowana jest komenda

Zwraca

• <Object> location: Współrzędne X i Y elementu na stronie.

Wsparcie

---

sendKeys

Wyślij sekwencję naciśnięć klawiszy do aktywnego elementu

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.sendKeys(value)

Parametry

Nazwa	Typ	Szczegóły
value	string[]	Sekwencja klawiszy do wprowadzenia. Musi być podana tablica.

Wsparcie

---

availableIMEEngines

Wylistuj wszystkie dostępne silniki na maszynie. Aby użyć silnika, musi być on obecny na tej liście.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.availableIMEEngines()

Zwraca

• <String[]> engines: Lista dostępnych silników

Wsparcie

---

getActiveIMEEngine

Pobierz nazwę aktywnego silnika IME. Ciąg nazwy jest specyficzny dla platformy.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.getActiveIMEEngine()

Zwraca

• <String> engine: Nazwa aktywnego silnika IME

Wsparcie

---

isIMEActivated

Wskazuje, czy wprowadzanie IME jest aktywne w danym momencie

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.isIMEActivated()

Zwraca

• <Boolean> isActive: Prawda, jeśli wprowadzanie IME jest dostępne i aktualnie aktywne, fałsz w przeciwnym razie

Wsparcie

---

deactivateIMEEngine

Dezaktywuje aktualnie aktywny silnik IME.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.deactivateIMEEngine()

Wsparcie

---

activateIMEEngine

Aktywuj silnik, który jest dostępny

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.activateIMEEngine(engine)

Parametry

Nazwa	Typ	Szczegóły
engine	string	nazwa silnika do aktywacji

Wsparcie

---

asyncScriptTimeout

Ustaw ilość czasu w milisekundach, przez którą asynchroniczne skrypty wykonywane przez /session/:sessionId/execute_async mogą działać przed przerwaniem i zwróceniem błędu Timeout do klienta.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.asyncScriptTimeout(ms)

Parametry

Nazwa	Typ	Szczegóły
ms	number	Ilość czasu w milisekundach, przez którą polecenia z ograniczeniem czasowym mogą działać

Wsparcie

---

submit

Prześlij element formularza.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.submit(elementId)

Parametry

Nazwa	Typ	Szczegóły
elementId	String	ID elementu formularza do przesłania

Wsparcie

---

getElementSize

Określ rozmiar elementu w pikselach. Rozmiar zostanie zwrócony jako obiekt JSON z właściwościami width i height.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.getElementSize(elementId)

Parametry

Nazwa	Typ	Szczegóły
elementId	String	ID elementu, do którego kierowana jest komenda

Zwraca

• <Object> size: Szerokość i wysokość elementu w pikselach.

Wsparcie

---

getElementLocation

Określ lokalizację elementu na stronie. Punkt (0, 0) odnosi się do lewego górnego rogu strony. Współrzędne elementu są zwracane jako obiekt JSON z właściwościami x i y.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.getElementLocation(elementId)

Parametry

Nazwa	Typ	Szczegóły
elementId	String	ID elementu, do którego kierowana jest komenda

Zwraca

• <Object> location: Współrzędne X i Y elementu na stronie.

Wsparcie

---

touchClick

Pojedyncze dotknięcie na urządzeniu z obsługą dotyku.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.touchClick(element)

Parametry

Nazwa	Typ	Szczegóły
element	string	ID elementu do pojedynczego dotknięcia.

Wsparcie

---

touchDown

Palec w dół na ekranie.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.touchDown(x, y)

Parametry

Nazwa	Typ	Szczegóły
x	number	współrzędna x na ekranie
y	number	współrzędna y na ekranie

Wsparcie

---

touchUp

Palec w górę na ekranie.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.touchUp(x, y)

Parametry

Nazwa	Typ	Szczegóły
x	number	współrzędna x na ekranie
y	number	współrzędna y na ekranie

Wsparcie

---

touchMove

Ruch palcem na ekranie.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.touchMove(x, y)

Parametry

Nazwa	Typ	Szczegóły
x	number	współrzędna x na ekranie
y	number	współrzędna y na ekranie

Wsparcie

---

touchLongClick

Długie naciśnięcie na ekranie dotykowym za pomocą zdarzeń ruchu palców.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.touchLongClick(element)

Parametry

Nazwa	Typ	Szczegóły
element	string	ID elementu do długiego naciśnięcia

Wsparcie

---

touchFlick

Szybki ruch na ekranie dotykowym za pomocą zdarzeń ruchu palców. Ta komenda flick rozpoczyna się w określonym miejscu na ekranie.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

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

Parametry

Nazwa	Typ	Szczegóły
xoffset opcjonalny	number	przesunięcie x w pikselach, o które należy wykonać flick
yoffset opcjonalny	number	przesunięcie y w pikselach, o które należy wykonać flick
element opcjonalny	string	ID elementu, gdzie rozpoczyna się flick
speed opcjonalny	number	prędkość w pikselach na sekundę
xspeed opcjonalny	number	prędkość x w pikselach na sekundę
yspeed opcjonalny	number	prędkość y w pikselach na sekundę

Wsparcie

---

getOrientation

Pobierz bieżącą orientację urządzenia.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.getOrientation()

Zwraca

• <String> orientation: Bieżąca orientacja odpowiadająca wartości zdefiniowanej w ScreenOrientation: LANDSCAPE|PORTRAIT.

Wsparcie

---

setOrientation

Ustaw orientację urządzenia

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.setOrientation(orientation)

Parametry

Nazwa	Typ	Szczegóły
orientation	string	nowa orientacja przeglądarki zgodnie z definicją w ScreenOrientation: LANDSCAPE|PORTRAIT

Wsparcie

---

getLogs

Pobierz dziennik dla danego typu dziennika. Bufor dziennika jest resetowany po każdym żądaniu.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.getLogs(type)

Parametry

Nazwa	Typ	Szczegóły
type	string	typ dziennika

Zwraca

• <Object[]> logs: Lista wpisów dziennika.

Wsparcie

---

getLogTypes

Pobierz dostępne typy dzienników.

Komenda Appium. Więcej szczegółów można znaleźć w oficjalnej dokumentacji protokołu.

Użycie

driver.getLogTypes()

Zwraca

• <String[]> logTypes: Lista dostępnych typów dzienników.

Wsparcie