Appium

getAppiumContext

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.getAppiumContext()

Повертає

• <Context> context: рядок, що представляє поточний контекст, або null, що означає 'немає контексту'

---

switchAppiumContext

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.switchAppiumContext(name)

Параметри

Назва	Тип	Деталі
name	string	рядок, що представляє доступний контекст

---

getAppiumContexts

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.getAppiumContexts()

Повертає

• <Context[]> contexts: масив рядків, що представляють доступні контексти, наприклад 'WEBVIEW' або 'NATIVE'

---

shake

Виконати дію струшування на пристрої.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.shake()

Підтримка

---

lock

Заблокувати пристрій.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.lock(seconds)

Параметри

Назва	Тип	Деталі
seconds опціонально	number	на скільки часу заблокувати екран (тільки iOS)

Підтримка

---

unlock

Розблокувати пристрій.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.unlock()

Підтримка

---

isLocked

Перевірити, чи заблокований пристрій.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.isLocked()

Повертає

• <boolean> isLocked: True, якщо пристрій заблокований, false, якщо ні

Підтримка

---

startRecordingScreen

Почати запис екрану.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.startRecordingScreen(options)

Параметри

Назва	Тип	Деталі
options опціонально	object	параметри команди, які можуть містити ключі такі як: remotePath, username, password, method, forceRestart, timeLimit, videoType, videoQuality, videoFps, bitRate, videoSize, bugReport (докладніше в документації Appium)

Підтримка

---

stopRecordingScreen

Зупинити запис екрану

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

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

Параметри

Назва	Тип	Деталі
remotePath опціонально	string	Шлях до віддаленого розташування, куди повинно бути завантажено отримане відео. Підтримуються такі протоколи: http/https, ftp. Цей параметр впливає лише в тому випадку, якщо існує процес запису екрану і параметр forceRestart не встановлено в значення true. Значення null або порожній рядок (за замовчуванням) означає, що вміст отриманого файлу має бути закодований у форматі Base64.
username опціонально	string	Ім'я користувача для віддаленої автентифікації.
password опціонально	string	Пароль для віддаленої автентифікації.
method опціонально	string	Назва методу завантаження http multipart. За замовчуванням використовується 'PUT'.

Повертає

• <string> response: Рядок, закодований в Base64. Якщо встановлено remote_path, відповідь - порожній рядок

Підтримка

---

getPerformanceDataTypes

Повертає типи інформації про стан системи, які підтримуються для читання, такі як cpu, memory, network traffic і battery.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.getPerformanceDataTypes()

Повертає

• <string[]> performanceTypes: Доступні типи даних продуктивності (cpuinfo|batteryinfo|networkinfo|memoryinfo)

Підтримка

---

getPerformanceData

Повертає інформацію про стан системи, яка підтримується для читання, такі як cpu, memory, network traffic і battery.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.getPerformanceData(packageName, dataType, dataReadTimeout)

Параметри

Назва	Тип	Деталі
packageName	string	назва пакету додатку
dataType	string	тип стану системи, який потрібно прочитати. Повинен бути одним із підтримуваних типів даних продуктивності
dataReadTimeout опціонально	number	кількість спроб для зчитування

Повертає

• <string[]> performanceData: Тип інформації про стан системи, який підтримується для читання, такий як cpu, memory, network traffic і battery

Підтримка

---

pressKeyCode

Натиснути певну клавішу на пристрої.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.pressKeyCode(keycode, metastate, flags)

Параметри

Назва	Тип	Деталі
keycode	number	код клавіші для натискання
metastate опціонально	number	мета-стан для натискання коду клавіші
flags опціонально	number	прапорці для натискання клавіші

Підтримка

---

longPressKeyCode

Натиснути та утримувати певний код клавіші на пристрої.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.longPressKeyCode(keycode, metastate, flags)

Параметри

Назва	Тип	Деталі
keycode	number	код клавіші для натискання на пристрої
metastate опціонально	number	мета-стан для натискання клавіші
flags опціонально	number	прапорці для натискання клавіші

Підтримка

---

sendKeyEvent

Надіслати код клавіші на пристрій.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.sendKeyEvent(keycode, metastate)

Параметри

Назва	Тип	Деталі
keycode	string	код клавіші для натискання
metastate опціонально	string	мета-стан для натискання коду клавіші

Підтримка

---

rotateDevice

Обертати пристрій у трьох вимірах.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.rotateDevice(x, y, z)

Параметри

Назва	Тип	Деталі
x	number	x-зміщення для використання як центру обертового жесту
y	number	y-зміщення для використання як центру обертового жесту
z	number	z-зміщення для використання як центру обертового жесту

Підтримка

---

getCurrentActivity

Отримати назву поточної активності Android.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.getCurrentActivity()

Повертає

• <string> activity: Назва поточної активності

Підтримка

---

getCurrentPackage

Отримати назву поточного пакету Android.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.getCurrentPackage()

Повертає

• <string> package: Назва поточного пакету

Підтримка

---

installApp

Встановити вказаний додаток на пристрій.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.installApp(appPath)

Параметри

Назва	Тип	Деталі
appPath	string	шлях до файлу додатку .apk

Підтримка

---

activateApp

Активувати вказаний додаток на пристрої

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.activateApp(appId)

Параметри

Назва	Тип	Деталі
appId	string	ID додатку (package ID для Android, bundle ID для iOS)

Підтримка

---

removeApp

Видалити додаток з пристрою.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.removeApp(appId)

Параметри

Назва	Тип	Деталі
appId	string	ID додатку (package ID для Android, bundle ID для iOS)

Підтримка

---

terminateApp

Завершити вказаний додаток на пристрої

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.terminateApp(appId, options)

Параметри

Назва	Тип	Деталі
appId	string	ID додатку (package ID для Android, bundle ID для iOS)
options опціонально	object	Параметри команди. Наприклад, "timeout": (Тільки Android) Час очікування для повторної спроби завершення додатку (детальніше в документації Appium)

Підтримка

---

isAppInstalled

Перевірити, чи встановлений вказаний додаток на пристрої.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.isAppInstalled(appId)

Параметри

Назва	Тип	Деталі
appId	string	ID додатку (package ID для Android, bundle ID для iOS)

Повертає

• <boolean> isAppInstalled: Повертає true, якщо встановлено, false, якщо ні

Підтримка

---

queryAppState

Отримати стан вказаного додатку на пристрої

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.queryAppState(appId)

Параметри

Назва	Тип	Деталі
appId	string	ID додатку (package ID для Android, bundle ID для iOS)

Повертає

• <number> appStatus: 0 - не встановлено. 1 - не запущено. 2 - працює у фоновому режимі або призупинено. 3 - працює у фоновому режимі. 4 - працює на передньому плані

Підтримка

---

hideKeyboard

Приховати екранну клавіатуру.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

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

Параметри

Назва	Тип	Деталі
strategy опціонально	string	стратегія приховування клавіатури (тільки UIAutomation), доступні стратегії - 'press', 'pressKey', 'swipeDown', 'tapOut', 'tapOutside', 'default'
key опціонально	string	значення клавіші, якщо стратегія 'pressKey'
keyCode опціонально	string	код клавіші, якщо стратегія 'pressKey'
keyName опціонально	string	назва клавіші, якщо стратегія 'pressKey'

Підтримка

---

isKeyboardShown

Перевірити, чи відображається екранна клавіатура.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.isKeyboardShown()

Повертає

• <boolean> isKeyboardShown: True, якщо клавіатура відображається

Підтримка

---

pushFile

Розмістити файл на пристрої у конкретному місці.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.pushFile(path, data)

Параметри

Назва	Тип	Деталі
path	string	шлях для розміщення даних
data	string	зміст файлу у форматі base64

Підтримка

---

pullFile

Отримати файл з файлової системи пристрою.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.pullFile(path)

Параметри

Назва	Тип	Деталі
path	string	шлях на пристрої, звідки потрібно отримати файл

Повертає

• <string> response: Зміст файлу у форматі base64

Підтримка

---

pullFolder

Отримати папку з файлової системи пристрою.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.pullFolder(path)

Параметри

Назва	Тип	Деталі
path	string	шлях до всієї папки на пристрої

Підтримка

---

toggleAirplaneMode

Переключити режим польоту на пристрої.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.toggleAirplaneMode()

Підтримка

---

toggleData

Перемкнути стан сервісу передачі даних.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.toggleData()

Підтримка

---

toggleWiFi

Перемкнути стан сервісу Wi-Fi.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.toggleWiFi()

Підтримка

---

toggleLocationServices

Перемкнути стан сервісу геолокації.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.toggleLocationServices()

Підтримка

---

toggleNetworkSpeed

Встановити швидкість мережі (тільки для емулятора)

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.toggleNetworkSpeed(netspeed)

Параметри

Назва	Тип	Деталі
netspeed	string	Тип мережі - 'full','gsm', 'edge', 'hscsd', 'gprs', 'umts', 'hsdpa', 'lte', 'evdo'

Підтримка

---

openNotifications

Відкрити сповіщення Android (тільки для емулятора).

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.openNotifications()

Підтримка

---

startActivity

Запустити активність Android, вказавши назву пакету та назву активності.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

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

Параметри

Назва	Тип	Деталі
appPackage	string	назва додатку
appActivity	string	назва активності
appWaitPackage опціонально	string	назва додатку для очікування
appWaitActivity опціонально	string	назва активності для очікування
intentAction=android.intent.action.MAIN опціонально	string	дія наміру, яка буде використана для запуску активності
intentCategory=android.intent.category.LAUNCHER опціонально	string	категорія наміру, яка буде використана для запуску активності
intentFlags=0x10200000 опціонально	string	прапорці, які будуть використовуватися для запуску активності
optionalIntentArguments опціонально	string	додаткові аргументи наміру, які будуть використані для запуску активності
dontStopAppOnReset опціонально	string	не зупиняє процес додатку під тестом перед запуском додатку за допомогою adb

Підтримка

---

getSystemBars

Отримати інформацію про видимість та межі рядка стану та панелі навігації.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.getSystemBars()

Повертає

• <object[]> systemBars: Інформація про видимість та межі рядка стану та панелі навігації

Підтримка

---

getDeviceTime

Отримати час на пристрої.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.getDeviceTime()

Повертає

• <string> time: Час на пристрої

Підтримка

---

getDisplayDensity

Отримати щільність дисплея з пристрою.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.getDisplayDensity()

Повертає

• <*>

Підтримка

---

touchId

Симулювати подію touch id (тільки для симулятора iOS). Щоб увімкнути цю функцію, бажана можливість allowTouchIdEnroll повинна бути встановлена на true, і симулятор повинен бути зареєстрований. Коли ви встановлюєте allowTouchIdEnroll на true, це за замовчуванням налаштує симулятор як зареєстрований. Стан реєстрації можна перемикати. Цей виклик працюватиме, тільки якщо процес Appium або його батьківський додаток (наприклад, Terminal.app або Appium.app) має доступ до доступності Mac OS у System Preferences > Security & Privacy > Privacy > Accessibility list.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.touchId(match)

Параметри

Назва	Тип	Деталі
match	boolean	ми симулюємо успішний дотик (true) чи невдалий дотик (false)

Підтримка

---

toggleEnrollTouchId

Перемкнути реєстрацію симулятора для прийняття touchId (тільки для симулятора iOS). Щоб увімкнути цю функцію, бажана можливість allowTouchIdEnroll повинна бути встановлена на true. Коли allowTouchIdEnroll встановлено на true, симулятор буде зареєстрований за замовчуванням, і 'Toggle Touch ID Enrollment' змінює стан реєстрації. Цей виклик працюватиме, тільки якщо процес Appium або його батьківський додаток (наприклад, Terminal.app або Appium.app) має доступ до доступності Mac OS у System Preferences > Security & Privacy > Privacy > Accessibility list.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.toggleEnrollTouchId(enabled)

Параметри

Назва	Тип	Деталі
enabled=true опціонально	boolean	дорівнює true, якщо реєстрація TouchID повинна бути увімкнена

Підтримка

---

launchApp

Запустити додаток на пристрої.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

застереження

Ця команда протоколу застаріла
Для iOS використовуйте driver.execute('mobile: launchApp', { ... }), а для Android використовуйте driver.execute('mobile: activateApp', { ... }).

Використання

driver.launchApp()

Підтримка

---

closeApp

Закрити додаток на пристрої.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

застереження

Ця команда протоколу застаріла
Використовуйте driver.execute('mobile: terminateApp', { ... }) натомість

Використання

driver.closeApp()

Підтримка

---

background

Відправити поточний запущений додаток для цієї сесії у фоновий режим.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

застереження

Ця команда протоколу застаріла
Використовуйте driver.execute('mobile: backgroundApp', { ... }) натомість

Використання

driver.background(seconds)

Параметри

Назва	Тип	Деталі
seconds=null	number, null	час очікування для відновлення додатку, якщо 'null', додаток не буде відновлено

Підтримка

---

endCoverage

Отримати дані про покриття тестами.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.endCoverage(intent, path)

Параметри

Назва	Тип	Деталі
intent	string	намір для трансляції
path	string	шлях до файлу .ec

Підтримка

---

getStrings

Отримати рядки додатку.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.getStrings(language, stringFile)

Параметри

Назва	Тип	Деталі
language опціонально	string	код мови
stringFile опціонально	string	шлях до файлу рядків

Повертає

• <object> appStrings: всі визначені рядки з додатку для вказаної мови та назви файлу рядків

Підтримка

---

setValueImmediate

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.setValueImmediate(elementId, text)

Параметри

Назва	Тип	Деталі
elementId	String	ідентифікатор елемента, повернений у попередньому виклику Find Element(s)
text	string	текст для встановлення для елемента

Підтримка

---

replaceValue

Замінити значення елемента безпосередньо.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.replaceValue(elementId, value)

Параметри

Назва	Тип	Деталі
elementId	String	ідентифікатор елемента, повернений у попередньому виклику Find Element(s)
value	string	значення для заміни на елементі

Підтримка

---

getSettings

Отримати поточні налаштування на пристрої.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.getSettings()

Повертає

• <object> settings: JSON хеш всіх поточно вказаних налаштувань, див. API налаштувань

Підтримка

---

updateSettings

Оновити поточні налаштування на пристрої.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.updateSettings(settings)

Параметри

Назва	Тип	Деталі
settings	object	об'єкт з парами ключ/значення налаштувань для оновлення

Підтримка

---

receiveAsyncResponse

URL для зворотного виклику для асинхронного виконання JavaScript.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.receiveAsyncResponse(response)

Параметри

Назва	Тип	Деталі
response	object	відповідь для отримання на пристрої

Підтримка

---

gsmCall

Зробити GSM-дзвінок (тільки для емулятора).

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.gsmCall(phoneNumber, action)

Параметри

Назва	Тип	Деталі
phoneNumber	string	номер телефону для дзвінка
action	string	Дія - 'call', 'accept', 'cancel', 'hold'

Підтримка

---

gsmSignal

Встановити силу сигналу GSM (тільки для емулятора).

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.gsmSignal(signalStrength, signalStrengh)

Параметри

Назва	Тип	Деталі
signalStrength	string	сила сигналу в діапазоні [0, 4]
signalStrengh опціонально	string	сила сигналу в діапазоні [0, 4]. Будь ласка, також встановіть цей параметр з тим самим значенням, якщо ви використовуєте Appium v1.11.0 або нижче (див. https://github.com/appium/appium/issues/12234).

Підтримка

---

powerCapacity

Встановити відсоток заряду батареї (тільки для емулятора).

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.powerCapacity(percent)

Параметри

Назва	Тип	Деталі
percent	number	значення відсотка в діапазоні [0, 100]

Підтримка

---

powerAC

Встановити стан зарядного пристрою батареї на підключений або ні (тільки для емулятора).

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.powerAC(state)

Параметри

Назва	Тип	Деталі
state	string	встановити стан. on або off

Підтримка

---

gsmVoice

Встановити стан голосового зв'язку GSM (тільки для емулятора).

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.gsmVoice(state)

Параметри

Назва	Тип	Деталі
state	string	стан голосового зв'язку GSM - 'unregistered', 'home', 'roaming', 'searching', 'denied', 'off', 'on'

Підтримка

---

sendSms

Симулювати SMS-повідомлення (тільки для емулятора).

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.sendSms(phoneNumber, message)

Параметри

Назва	Тип	Деталі
phoneNumber	string	номер телефону, на який слід надіслати SMS
message	string	SMS-повідомлення

Підтримка

---

fingerPrint

Автентифікувати користувачів за допомогою сканування відбитків пальців на підтримуваних емуляторах.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.fingerPrint(fingerprintId)

Параметри

Назва	Тип	Деталі
fingerprintId	number	відбитки пальців, що зберігаються в системі ключів Android (від 1 до 10)

Підтримка

---

setClipboard

Встановити вміст системного буфера обміну

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.setClipboard(content, contentType, label)

Параметри

Назва	Тип	Деталі
content	string	Фактичний вміст буфера обміну, кодований у base64
contentType опціонально	string	Тип вмісту для отримання. Plaintext, Image, URL. Android підтримує лише plaintext
label опціонально	string	Мітка даних буфера обміну для Android

Повертає

• <string> response: Відповідь від сервера Appium

Підтримка

---

getClipboard

Отримати вміст системного буфера обміну

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.getClipboard(contentType)

Параметри

Назва	Тип	Деталі
contentType опціонально	string	Тип вмісту для отримання. Plaintext, Image, URL. Android підтримує лише plaintext

Повертає

• <string> response: Вміст буфера обміну як рядок, кодований у base64, або порожній рядок, якщо буфер обміну порожній

Підтримка

---

touchPerform

Ця функціональність доступна лише в нативному контексті. 'Touch Perform' працює подібно до інших сингулярних взаємодій дотику, за винятком того, що це дозволяє об'єднати разом більше ніж одну дотикову дію як одну команду. Це корисно, оскільки команди Appium надсилаються через мережу і між командами є затримка. Ця затримка може зробити певні дотикові взаємодії неможливими, оскільки деякі взаємодії повинні виконуватися в одній послідовності. Вертикальний рух, наприклад, вимагає натискання, переміщення до іншої координати y, а потім відпускання. Щоб це працювало, не може бути затримки між взаємодіями.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.touchPerform(actions)

Параметри

Назва	Тип	Деталі
actions	object[]	Тип дії для виконання (наприклад, moveTo, release, press, tap, wait)

Приклад

// do a horizontal swipe by percentage
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: {},
  },
]);

Підтримка

---

multiTouchPerform

Ця функціональність доступна лише в нативному контексті. Виконати послідовність дій мультидотику.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.multiTouchPerform(actions)

Параметри

Назва	Тип	Деталі
actions	object[]	Тип дії для виконання (наприклад, moveTo, release, press, tap, wait)

Підтримка

---

executeDriverScript

Ця команда дозволяє вам вказати скрипт WebdriverIO як рядок і передати його на сервер Appium для локального виконання на самому сервері. Цей підхід допомагає мінімізувати потенційну затримку, пов'язану з кожною командою. Щоб використовувати цю команду з Appium 2.0, ви повинні мати встановлений плагін execute-driver-plugin.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.executeDriverScript(script, type, timeout)

Параметри

Назва	Тип	Деталі
script	string	Скрипт для виконання. Він має доступ до об'єкта 'driver', який представляє сесію WebdriverIO, приєднану до поточного сервера.
type опціонально	string	Мова/фреймворк, використаний у скрипті. В даний час підтримується лише 'webdriverio', який є за замовчуванням.
timeout опціонально	number	Кількість мілісекунд, протягом яких скрипт повинен бути дозволений запуститися, перш ніж буде вбитий сервером Appium. За замовчуванням це еквівалентно 1 годині.

Повертає

• <object> result: Об'єкт, що містить два поля: 'result', який є поверненим значенням самого скрипту, і 'logs', який містить 3 внутрішніх поля, 'log', 'warn' і 'error', які містять масив рядків, зареєстрованих console.log, console.warn і console.error при виконанні скрипту.

---

getEvents

Отримати події, збережені на сервері appium.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.getEvents(type)

Параметри

Назва	Тип	Деталі
type	string[]	Отримати події, які фільтруються за типом, якщо тип вказано.

Повертає

• <object> result: JSON-хеш подій, наприклад {'commands' => [{'cmd' => 123455, ....}], 'startTime' => 1572954894127, }.

Підтримка

---

logEvent

Зберегти користувацьку подію.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.logEvent(vendor, event)

Параметри

Назва	Тип	Деталі
vendor	string	Назва постачальника. Це буде vendor у vendor:event.
event	string	Назва події. Це буде event у vendor:event.

Підтримка

---

compareImages

Ця функція проводить порівняння зображень, використовуючи можливості фреймворку OpenCV. Зверніть увагу, що для роботи цієї функції як фреймворк OpenCV, так і модуль opencv4nodejs повинні бути встановлені на машині, де працює сервер Appium. Крім того, вам потрібно мати встановлений плагін images-plugin, щоб використовувати цю функцію з Appium 2.0.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

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

Параметри

Назва	Тип	Деталі
mode=matchFeatures	string	Один з можливих режимів порівняння: 'matchFeatures', 'getSimilarity', 'matchTemplate'. За замовчуванням - 'matchFeatures'.
firstImage	string	Дані зображення. Підтримуються всі формати зображень, які приймає сама бібліотека OpenCV.
secondImage	string	Дані зображення. Підтримуються всі формати зображень, які приймає сама бібліотека OpenCV.
options=[object Object]	object	Вміст цього словника залежить від фактичного значення mode. Див. документацію на модуль appium-support для отримання більш детальної інформації.

Повертає

• <object> result: Вміст результуючого словника залежить від фактичних значень mode та options. Див. документацію на модуль appium-support для отримання більш детальної інформації.

---

implicitWait

Встановити кількість часу, який драйвер повинен чекати при пошуку елементів. При пошуку одного елемента драйвер повинен опитувати сторінку, доки елемент не буде знайдений або не закінчиться час очікування, залежно від того, що настане раніше. При пошуку кількох елементів драйвер повинен опитувати сторінку, доки не буде знайдено хоча б один елемент або не закінчиться час очікування, після чого він повинен повернути порожній список. Якщо ця команда ніколи не відправляється, драйвер повинен за замовчуванням використовувати неявне очікування 0 мс.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.implicitWait(ms)

Параметри

Назва	Тип	Деталі
ms	number	Кількість часу в мілісекундах для очікування елемента.

Підтримка

---

getLocationInView

Визначити розташування елемента на екрані після його прокрутки в зону видимості.

Примітка: Це вважається внутрішньою командою і повинно використовуватися лише для визначення розташування елемента для правильного генерування нативних подій.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.getLocationInView(elementId)

Параметри

Назва	Тип	Деталі
elementId	String	ID елемента для маршрутизації команди

Повертає

• <Object> location: Координати X та Y для елемента на сторінці.

Підтримка

---

sendKeys

Надіслати послідовність натискань клавіш на активний елемент

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.sendKeys(value)

Параметри

Назва	Тип	Деталі
value	string[]	Послідовність клавіш для вводу. Повинен бути наданий масив.

Підтримка

---

availableIMEEngines

Перелічити всі доступні движки на машині. Щоб використовувати движок, він повинен бути присутній у цьому списку.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.availableIMEEngines()

Повертає

• <String[]> engines: Список доступних движків

Підтримка

---

getActiveIMEEngine

Отримати назву активного IME движка. Рядок назви залежить від платформи.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.getActiveIMEEngine()

Повертає

• <String> engine: Назва активного IME движка

Підтримка

---

isIMEActivated

Вказує, чи активне введення IME на даний момент

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.isIMEActivated()

Повертає

• <Boolean> isActive: true, якщо введення IME доступне та активне на даний момент, false в іншому випадку

Підтримка

---

deactivateIMEEngine

Деактивує поточно активний IME движок.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.deactivateIMEEngine()

Підтримка

---

activateIMEEngine

Зробити движок доступним

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.activateIMEEngine(engine)

Параметри

Назва	Тип	Деталі
engine	string	назва движка для активації

Підтримка

---

asyncScriptTimeout

Встановити кількість часу в мілісекундах, протягом якого асинхронні скрипти, виконані за допомогою /session/:sessionId/execute_async, можуть виконуватися до того, як вони будуть перервані і клієнту буде повернена помилка Timeout.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.asyncScriptTimeout(ms)

Параметри

Назва	Тип	Деталі
ms	number	Кількість часу в мілісекундах, протягом якого команди з обмеженням часу можуть виконуватися

Підтримка

---

submit

Відправити елемент форми.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.submit(elementId)

Параметри

Назва	Тип	Деталі
elementId	String	ID елемента форми для відправки

Підтримка

---

getElementSize

Визначити розмір елемента в пікселях. Розмір буде повернутий як JSON-об'єкт з властивостями width і height.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.getElementSize(elementId)

Параметри

Назва	Тип	Деталі
elementId	String	ID елемента для маршрутизації команди

Повертає

• <Object> size: Ширина та висота елемента в пікселях.

Підтримка

---

getElementLocation

Визначити розташування елемента на сторінці. Точка (0, 0) відноситься до верхнього лівого кута сторінки. Координати елемента повертаються як JSON-об'єкт з властивостями x і y.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.getElementLocation(elementId)

Параметри

Назва	Тип	Деталі
elementId	String	ID елемента для маршрутизації команди

Повертає

• <Object> location: Координати X та Y для елемента на сторінці.

Підтримка

---

touchClick

Одинарне натискання на сенсорному пристрої.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.touchClick(element)

Параметри

Назва	Тип	Деталі
element	string	ID елемента для одинарного натискання.

Підтримка

---

touchDown

Палець вниз на екрані.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.touchDown(x, y)

Параметри

Назва	Тип	Деталі
x	number	x-координата на екрані
y	number	y-координата на екрані

Підтримка

---

touchUp

Палець вгору на екрані.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.touchUp(x, y)

Параметри

Назва	Тип	Деталі
x	number	x-координата на екрані
y	number	y-координата на екрані

Підтримка

---

touchMove

Рух пальця по екрану.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.touchMove(x, y)

Параметри

Назва	Тип	Деталі
x	number	x-координата на екрані
y	number	y-координата на екрані

Підтримка

---

touchLongClick

Довге натискання на сенсорному екрані за допомогою подій руху пальця.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.touchLongClick(element)

Параметри

Назва	Тип	Деталі
element	string	ID елемента для довгого натискання

Підтримка

---

touchFlick

Швидке проведення на сенсорному екрані за допомогою подій руху пальця. Ця команда швидкого проведення починається в певному місці екрану.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

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

Параметри

Назва	Тип	Деталі
xoffset опціонально	number	зміщення x в пікселях для швидкого проведення
yoffset опціонально	number	зміщення y в пікселях для швидкого проведення
element опціонально	string	ID елемента, де починається швидке проведення
speed опціонально	number	швидкість у пікселях за секунду
xspeed опціонально	number	швидкість x у пікселях за секунду
yspeed опціонально	number	швидкість y у пікселях за секунду

Підтримка

---

getOrientation

Отримати поточну орієнтацію пристрою.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.getOrientation()

Повертає

• <String> orientation: Поточна орієнтація, що відповідає значенню, визначеному в ScreenOrientation: LANDSCAPE|PORTRAIT.

Підтримка

---

setOrientation

Встановити орієнтацію пристрою

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.setOrientation(orientation)

Параметри

Назва	Тип	Деталі
orientation	string	нова орієнтація браузера, як визначено в ScreenOrientation: LANDSCAPE|PORTRAIT

Підтримка

---

getLogs

Отримати журнал для заданого типу журналу. Буфер журналу скидається після кожного запиту.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.getLogs(type)

Параметри

Назва	Тип	Деталі
type	string	тип журналу

Повертає

• <Object[]> logs: Список записів журналу.

Підтримка

---

getLogTypes

Отримати доступні типи журналів.

Команда Appium. Більше деталей можна знайти в офіційній документації протоколу.

Використання

driver.getLogTypes()

Повертає

• <String[]> logTypes: Список доступних типів журналів.

Підтримка