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 приложения (ID пакета для Android, ID бандла для iOS)

Поддержка

---

removeApp

Удалить приложение с устройства.

Команда Appium. Подробнее в официальной документации по протоколу.

Использование

driver.removeApp(appId)

Параметры

Имя	Тип	Детали
appId	string	ID приложения (ID пакета для Android, ID бандла для iOS)

Поддержка

---

terminateApp

Завершить данное приложение на устройстве

Команда Appium. Подробнее в официальной документации по протоколу.

Использование

driver.terminateApp(appId, options)

Параметры

Имя	Тип	Детали
appId	string	ID приложения (ID пакета для Android, ID бандла для iOS)
options необязательно	object	Опции команды. Например, "timeout": (Только для Android) Таймаут для повторной попытки завершения приложения (подробнее в документации Appium)

Поддержка

---

isAppInstalled

Проверить, установлено ли указанное приложение на устройстве.

Команда Appium. Подробнее в официальной документации по протоколу.

Использование

driver.isAppInstalled(appId)

Параметры

Имя	Тип	Детали
appId	string	ID приложения (ID пакета для Android, ID бандла для iOS)

Возвращает

• <boolean> isAppInstalled: Возвращает true, если установлено, false, если нет

Поддержка

---

queryAppState

Получить состояние данного приложения на устройстве

Команда Appium. Подробнее в официальной документации по протоколу.

Использование

driver.queryAppState(appId)

Параметры

Имя	Тип	Детали
appId	string	ID приложения (ID пакета для Android, 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

Переключить состояние службы WiFi.

Команда 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 Simulator). Для включения этой функции, опция allowTouchIdEnroll должна быть установлена в true, а симулятор должен быть зарегистрирован. Когда вы устанавливаете allowTouchIdEnroll в true, симулятор будет зарегистрирован по умолчанию. Состояние регистрации можно переключать. Этот вызов будет работать только если процесс Appium или его родительское приложение (например, Terminal.app или Appium.app) имеет доступ к Mac OS accessibility в System Preferences > Security & Privacy > Privacy > Accessibility list.

Команда Appium. Подробнее в официальной документации по протоколу.

Использование

driver.touchId(match)

Параметры

Имя	Тип	Детали
match	boolean	симулируем ли успешное касание (true) или неудачное касание (false)

Поддержка

---

toggleEnrollTouchId

Переключить регистрацию симулятора для приема touchId (только для iOS Simulator). Для включения этой функции опция allowTouchIdEnroll должна быть установлена в true. Когда allowTouchIdEnroll установлен в true, симулятор будет зарегистрирован по умолчанию, и команда 'Toggle Touch ID Enrollment' изменяет состояние регистрации. Этот вызов будет работать только если процесс Appium или его родительское приложение (например, Terminal.app или Appium.app) имеет доступ к Mac OS accessibility в 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	id элемента, возвращенный в предыдущем вызове Find Element(s)
text	string	текст для установки в элемент

Поддержка

---

replaceValue

Заменить значение элемента напрямую.

Команда Appium. Подробнее в официальной документации по протоколу.

Использование

driver.replaceValue(elementId, value)

Параметры

Имя	Тип	Детали
elementId	String	id элемента, возвращенный в предыдущем вызове 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 Keystore (от 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: Список доступных типов логов.

Поддержка