Протокол WebDriver

newSession

Команда New Session створює нову сесію WebDriver з кінцевою точкою вузла. Якщо створення не вдалося, повертається помилка про те, що сесія не створена.

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

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

browser.newSession(capabilities)

Параметри

Назва	Тип	Деталі
capabilities	object	JSON-об'єкт, набір можливостей, які були об'єднані та співставлені в алгоритмі обробки можливостей

Повертає

• <Object> session: Об'єкт, що містить sessionId та можливості створеної сесії WebDriver.

---

deleteSession

Команда Delete Session закриває будь-які контексти верхнього рівня, пов'язані з поточною сесією, завершує з'єднання і, нарешті, закриває поточну сесію.

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

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

browser.deleteSession(deleteSessionOpts)

Параметри

Назва	Тип	Деталі
deleteSessionOpts опціонально	object	Об'єкт, що містить параметри для команди deleteSession, наприклад { shutdownDriver: boolean }

---

status

Команда Status повертає інформацію про те, чи знаходиться віддалений кінець у стані, в якому він може створювати нові сесії, і додатково може включати довільну метаінформацію, специфічну для реалізації.

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

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

browser.status()

Приклад

examples.js

loading...

View on GitHub

Повертає

• <Object> status: Об'єкт, що містить статус драйвера.

---

getTimeouts

Команда Get Timeouts отримує тривалість таймаутів, пов'язаних з поточною сесією.

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

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

browser.getTimeouts()

Приклад

examples.js

loading...

View on GitHub

Повертає

• <Object> timeouts: Об'єкт, що містить тривалість таймаутів для script, pageLoad та implicit.

---

setTimeouts

Команда Set Timeouts встановлює тривалість таймаутів, пов'язаних з поточною сесією. Таймаути, якими можна керувати, перелічені в таблиці таймаутів сесії нижче.

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

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

browser.setTimeouts(implicit, pageLoad, script)

Параметри

Назва	Тип	Деталі
implicit опціонально	number	ціле число в мс для неявного очікування сесії
pageLoad опціонально	number	ціле число в мс для таймауту завантаження сторінки сесії
script опціонально	number	ціле число в мс для таймауту скрипта сесії

Приклад

examples.js

loading...

View on GitHub

---

getUrl

Команда Get Current URL повертає URL поточного контексту перегляду верхнього рівня.

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

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

browser.getUrl()

Приклад

examples.js

loading...

View on GitHub

Повертає

• <string> url: URL документа активного документа поточного контексту перегляду верхнього рівня

---

navigateTo

Команда navigateTo (go) використовується для того, щоб примусити агент користувача перейти в поточному контексті перегляду верхнього рівня на нове місце.

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

інфо

Ця команда протоколу вбудована в наступний зручний метод: url. Рекомендується використовувати цю команду замість протоколу.

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

browser.navigateTo(url)

Параметри

Назва	Тип	Деталі
url	string	рядок, що представляє абсолютний URL (починається з http(s)), можливо, включаючи фрагмент (#...), також може бути локальна схема (about: тощо)

Приклад

examples.js

loading...

View on GitHub

---

back

Команда Back змушує браузер пройти один крок назад у об'єднаній історії сесії поточного контексту перегляду верхнього рівня. Це еквівалентно натисканню кнопки "назад" в інтерфейсі браузера або виклику window.history.back.

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

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

browser.back()

Приклад

examples.js

loading...

View on GitHub

---

forward

Команда Forward змушує браузер пройти один крок вперед у об'єднаній історії сесії поточного контексту перегляду верхнього рівня.

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

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

browser.forward()

Приклад

examples.js

loading...

View on GitHub

---

refresh

Команда Refresh змушує браузер перезавантажити сторінку в поточному контексті перегляду верхнього рівня.

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

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

browser.refresh()

Приклад

examples.js

loading...

View on GitHub

---

getTitle

Команда Get Title повертає заголовок документа поточного контексту перегляду верхнього рівня, еквівалентно виклику document.title.

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

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

browser.getTitle()

Приклад

examples.js

loading...

View on GitHub

Повертає

• <string> title: Повертає рядок, ідентичний document.title поточного контексту перегляду верхнього рівня.

---

getWindowHandle

Команда Get Window Handle повертає ідентифікатор вікна для поточного контексту перегляду верхнього рівня. Його можна використовувати як аргумент для Switch To Window.

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

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

browser.getWindowHandle()

Приклад

examples.js

loading...

View on GitHub

Повертає

• <string> handle: Повертає рядок, який є ідентифікатором вікна для поточного контексту перегляду верхнього рівня.

---

closeWindow

Команда Close Window закриває поточний контекст перегляду верхнього рівня. Після завершення, якщо більше немає відкритих контекстів перегляду верхнього рівня, сама сесія WebDriver закривається.

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

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

browser.closeWindow()

Приклад

examples.js

loading...

View on GitHub

---

switchToWindow

Команда Switch To Window використовується для вибору поточного контексту перегляду верхнього рівня для поточної сесії, тобто того, який буде використовуватися для обробки команд.

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

інфо

Ця команда протоколу вбудована в наступний зручний метод: switchWindow. Рекомендується використовувати цю команду замість протоколу.

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

browser.switchToWindow(handle)

Параметри

Назва	Тип	Деталі
handle	string	рядок, що представляє ідентифікатор вікна, повинен бути одним із рядків, що були повернуті при виклику getWindowHandles

Приклад

examples.js

loading...

View on GitHub

---

createWindow

Створює новий контекст перегляду верхнього рівня.

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

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

browser.createWindow(type)

Параметри

Назва	Тип	Деталі
type	string	Встановіть значення 'tab', якщо новостворене вікно ділить вікно на рівні ОС з поточним контекстом перегляду, або 'window' в іншому випадку.

Приклад

examples.js

loading...

View on GitHub

Повертає

• <Object> window: Об'єкт нового вікна, що містить 'handle' зі значенням ідентифікатора та 'type' зі значенням типу створеного вікна

---

getWindowHandles

Команда Get Window Handles повертає список ідентифікаторів вікон для кожного відкритого контексту перегляду верхнього рівня. Порядок, в якому повертаються ідентифікатори вікон, є довільним.

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

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

browser.getWindowHandles()

Приклад

examples.js

loading...

View on GitHub

Повертає

• <String[]> handles: Масив, який є списком ідентифікаторів вікон.

---

printPage

Команда Print Page рендерить документ у пагінований PDF-документ. Примітка: Chrome наразі підтримує це лише в режимі headless, див. crbug753118).

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

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

browser.printPage(orientation, scale, background, width, height, top, bottom, left, right, shrinkToFit, pageRanges)

Параметри

Назва	Тип	Деталі
orientation опціонально	string	орієнтація сторінки. За замовчуванням: portrait
scale опціонально	number	масштаб сторінки. За замовчуванням: 1
background опціонально	boolean	фон сторінки. За замовчуванням: false
width опціонально	number	ширина сторінки в см. За замовчуванням: 21.59 для сторінки
height опціонально	number	висота сторінки в см. За замовчуванням: 27.94 для сторінки
top опціонально	number	поля сторінки в см від верхнього краю. За замовчуванням: 1
bottom опціонально	number	поля сторінки в см від нижнього краю. За замовчуванням: 1
left опціонально	number	поля сторінки в см від лівого краю. За замовчуванням: 1
right опціонально	number	поля сторінки в см від правого краю. За замовчуванням: 1
shrinkToFit опціонально	boolean	зменшення pdf для підгонки до сторінки. За замовчуванням: true
pageRanges опціонально	object[]	діапазони сторінок. За замовчуванням []

Приклад

examples.js

loading...

View on GitHub

Повертає

• <string> pdf: PDF-представлення пагінованого документа, закодоване в base64.

---

switchToFrame

Команда Switch To Frame використовується для вибору поточного контексту перегляду верхнього рівня або дочірнього контексту перегляду поточного контексту як поточного контексту перегляду для наступних команд.

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

обережно

Ця команда протоколу застаріла
Ця команда застаріла, і ми рекомендуємо усім використовувати switchFrame для перемикання у фрейми. Дізнайтеся більше про цю команду на https://webdriver.io/docs/api/browser/switchFrame.

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

browser.switchToFrame(id)

Параметри

Назва	Тип	Деталі
id	number, object, null	один з трьох можливих типів: null: представляє контекст перегляду верхнього рівня (тобто не iframe), число, що представляє індекс об'єкта вікна, відповідного фрейму, об'єкт Element, отриманий за допомогою findElement.

Приклад

examples.js

loading...

View on GitHub

---

switchToParentFrame

Команда Switch to Parent Frame встановлює поточний контекст перегляду для майбутніх команд на батьківський контекст поточного контексту перегляду.

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

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

browser.switchToParentFrame()

Приклад

examples.js

loading...

View on GitHub

---

getWindowRect

Команда Get Window Rect повертає розмір і позицію на екрані вікна операційної системи, що відповідає поточному контексту перегляду верхнього рівня.

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

інфо

Ця команда протоколу вбудована в наступний зручний метод: getWindowSize. Рекомендується використовувати цю команду замість протоколу.

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

browser.getWindowRect()

Приклад

examples.js

loading...

View on GitHub

Повертає

• <Object> windowRect: JSON-представлення об'єкта "вікно прямокутника". Це має 4 властивості: x, y, width та height.

---

setWindowRect

Команда Set Window Rect змінює розмір та положення вікна операційної системи, що відповідає поточному контексту перегляду верхнього рівня.

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

інфо

Ця команда протоколу вбудована в наступний зручний метод: setWindowSize. Рекомендується використовувати цю команду замість протоколу.

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

browser.setWindowRect(x, y, width, height)

Параметри

Назва	Тип	Деталі
x	number, null	атрибут screenX об'єкта вікна
y	number, null	атрибут screenY об'єкта вікна
width	number, null	ширина зовнішніх розмірів контексту перегляду верхнього рівня, включаючи елементи інтерфейсу браузера тощо...
height	number, null	висота зовнішніх розмірів контексту перегляду верхнього рівня, включаючи елементи інтерфейсу браузера тощо...

Приклад

examples.js

loading...

View on GitHub

Повертає

• <Object> windowRect: JSON-представлення об'єкта "вікно прямокутника" на основі нового стану вікна.

---

maximizeWindow

Команда Maximize Window викликає специфічну для віконного менеджера операцію "максимізації", якщо така є, у вікні, що містить поточний контекст перегляду верхнього рівня. Зазвичай це збільшує вікно до максимально доступного розміру без переходу в повноекранний режим.

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

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

browser.maximizeWindow()

Приклад

examples.js

loading...

View on GitHub

Повертає

• <Object> windowRect: JSON-представлення об'єкта "вікно прямокутника" на основі нового стану вікна.

---

minimizeWindow

Команда Minimize Window викликає специфічну для віконного менеджера операцію "мінімізації", якщо така є, у вікні, що містить поточний контекст перегляду верхнього рівня. Зазвичай це приховує вікно в системному треї.

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

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

browser.minimizeWindow()

Повертає

• <Object> windowRect: JSON-представлення об'єкта "вікно прямокутника" (нового) поточного контексту перегляду верхнього рівня.

---

fullscreenWindow

Команда Fullscreen Window викликає специфічну для віконного менеджера операцію "повного екрана", якщо така є, у вікні, що містить поточний контекст перегляду верхнього рівня. Зазвичай це збільшує вікно до розміру фізичного дисплея і може приховувати елементи інтерфейсу браузера, такі як панелі інструментів.

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

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

browser.fullscreenWindow()

Повертає

• <Object> windowRect: JSON-представлення об'єкта "вікно прямокутника" (нового) поточного контексту перегляду верхнього рівня.

---

findElement

Команда Find Element використовується для пошуку елемента в поточному контексті перегляду, який можна використовувати для майбутніх команд. Ця команда повертає JSON-представлення елемента, яке можна передати до команди $ для перетворення посилання на розширений елемент WebdriverIO.

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

інфо

Ця команда протоколу вбудована в наступний зручний метод: $. Рекомендується використовувати цю команду замість протоколу.

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

browser.findElement(using, value)

Параметри

Назва	Тип	Деталі
using	string	дійсна стратегія розташування елемента
value	string	фактичний селектор, який буде використовуватися для пошуку елемента

Приклад

examples.js

loading...

View on GitHub

Повертає

• <object> element: JSON-представлення об'єкта елемента, наприклад, { 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }.

---

findElementFromShadowRoot

Команда Find Element From Shadow Root використовується для пошуку елемента всередині тіньового кореня елемента, який можна використовувати для майбутніх команд. Ця команда повертає JSON-представлення елемента, яке можна передати до команди $ для перетворення посилання на розширений елемент WebdriverIO.

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

інфо

Ця команда протоколу вбудована в наступний зручний метод: shadow$. Рекомендується використовувати цю команду замість протоколу.

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

browser.findElementFromShadowRoot(shadowId, using, value)

Параметри

Назва	Тип	Деталі
shadowId	String	ідентифікатор елемента тіньового кореня
using	string	дійсна стратегія розташування елемента
value	string	фактичний селектор, який буде використовуватися для пошуку елемента

Приклад

examples.js

loading...

View on GitHub

Повертає

• <object> element: JSON-представлення об'єкта тіньового елемента, наприклад, { 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }.

---

findElements

Команда Find Elements використовується для пошуку елементів у поточному контексті перегляду, які можна використовувати для майбутніх команд. Ця команда повертає масив JSON-представлень елементів, які можна передати команді $ для перетворення посилання на розширений елемент WebdriverIO (див. findElement).

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

інфо

Ця команда протоколу вбудована в наступний зручний метод: $$. Рекомендується використовувати цю команду замість протоколу.

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

browser.findElements(using, value)

Параметри

Назва	Тип	Деталі
using	string	дійсна стратегія розташування елемента
value	string	фактичний селектор, який буде використовуватися для пошуку елемента

Приклад

examples.js

loading...

View on GitHub

Повертає

• <object[]> elements: (Можливо пустий) JSON-список представлень об'єкта елемента, наприклад, [{ 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }].

---

findElementsFromShadowRoot

Команда Find Elements використовується для пошуку елементів всередині тіньового кореня елемента, які можна використовувати для майбутніх команд. Ця команда повертає масив JSON-представлень елементів, які можна передати команді $ для перетворення посилання на розширений елемент WebdriverIO (див. findElement).

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

інфо

Ця команда протоколу вбудована в наступний зручний метод: shadow$$. Рекомендується використовувати цю команду замість протоколу.

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

browser.findElementsFromShadowRoot(shadowId, using, value)

Параметри

Назва	Тип	Деталі
shadowId	String	ідентифікатор елемента тіньового кореня
using	string	дійсна стратегія розташування елемента
value	string	фактичний селектор, який буде використовуватися для пошуку елемента

Приклад

examples.js

loading...

View on GitHub

Повертає

• <object[]> elements: (Можливо пустий) JSON-список представлень об'єкта елемента, наприклад, { 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }.

---

findElementFromElement

Команда Find Element From Element використовується для пошуку елемента з веб-елемента в поточному контексті перегляду, який можна використовувати для майбутніх команд. Ця команда повертає JSON-представлення елемента, яке можна передати команді $ для перетворення посилання на розширений елемент WebdriverIO (див. findElement).

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

інфо

Ця команда протоколу вбудована в наступний зручний метод: $. Рекомендується використовувати цю команду замість протоколу.

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

browser.findElementFromElement(elementId, using, value)

Параметри

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

Приклад

examples.js

loading...

View on GitHub

Повертає

• <object> element: JSON-представлення об'єкта елемента, наприклад, { 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }.

---

findElementsFromElement

Команда Find Elements From Element використовується для пошуку елементів з веб-елемента в поточному контексті перегляду, які можна використовувати для майбутніх команд. Ця команда повертає масив JSON-представлень елементів, які можна передати команді $ для перетворення посилання на розширений елемент WebdriverIO (див. findElement).

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

інфо

Ця команда протоколу вбудована в наступний зручний метод: $$. Рекомендується використовувати цю команду замість протоколу.

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

browser.findElementsFromElement(elementId, using, value)

Параметри

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

Приклад

examples.js

loading...

View on GitHub

Повертає

• <object[]> elements: (Можливо пустий) JSON-список представлень об'єкта елемента, наприклад, [{ 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }].

---

getElementShadowRoot

Отримати об'єкт тіньового кореня елемента. Результуючий об'єкт можна використовувати для отримання елементів у цьому тіньовому корені за допомогою, наприклад, findElementFromShadowRoots або findElementsFromShadowRoots.

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

інфо

Ця команда протоколу вбудована в наступний зручний метод: shadow$. Рекомендується використовувати цю команду замість протоколу.

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

browser.getElementShadowRoot(elementId)

Параметри

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

Приклад

examples.js

loading...

View on GitHub

Повертає

• <string> shadowRoot: JSON-представлення тіньового кореня елемента, наприклад, { 'shadow-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }.

---

getActiveElement

Get Active Element повертає активний елемент елемента документа поточного контексту перегляду. Ця команда повертає JSON-представлення елемента, яке можна передати команді $ для перетворення посилання на розширений елемент WebdriverIO (див. findElement).

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

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

browser.getActiveElement()

Приклад

examples.js

loading...

View on GitHub

Повертає

• <string> element: JSON-представлення об'єкта елемента, наприклад, { 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }.

---

isElementSelected

Is Element Selected визначає, чи вибраний вказаний елемент чи ні. Ця операція має сенс лише для елементів вводу типу прапорець (Checkbox) і перемикач (Radio Button) або елементів опцій.

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

інфо

Ця команда протоколу вбудована в наступний зручний метод: isSelected. Рекомендується використовувати цю команду замість протоколу.

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

browser.isElementSelected(elementId)

Параметри

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

Приклад

examples.js

loading...

View on GitHub

Повертає

• <Boolean> isSelected: true або false на основі стану вибору.

---

isElementDisplayed

Is Element Displayed визначає видимість елемента, яка керується тим, що сприймається людським оком. У цьому контексті відображення елемента не пов'язане з властивостями стилю visibility або display.

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

інфо

Ця команда протоколу вбудована в наступний зручний метод: isDisplayed. Рекомендується використовувати цю команду замість протоколу.

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

browser.isElementDisplayed(elementId)

Параметри

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

Приклад

examples.js

loading...

View on GitHub

Повертає

• <Boolean> isDisplayed: true або false на основі стану видимості.

---

getElementAttribute

Команда Get Element Attribute поверне атрибут веб-елемента.

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

інфо

Ця команда протоколу вбудована в наступний зручний метод: getAttribute. Рекомендується використовувати цю команду замість протоколу.

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

browser.getElementAttribute(elementId, name)

Параметри

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

Приклад

examples.js

loading...

View on GitHub

Повертає

• <string> attribute: Названий атрибут елемента.

---

getElementProperty

Команда Get Element Property поверне результат отримання властивості елемента.

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

інфо

Ця команда протоколу вбудована в наступний зручний метод: getProperty. Рекомендується використовувати цю команду замість протоколу.

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

browser.getElementProperty(elementId, name)

Параметри

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

Приклад

examples.js

loading...

View on GitHub

Повертає

• <string> property: Названа властивість елемента, доступна шляхом виклику GetOwnProperty на об'єкті елемента.

---

getElementCSSValue

Команда Get Element CSS Value отримує обчислене значення заданої властивості CSS для даного веб-елемента.

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

інфо

Ця команда протоколу вбудована в наступний зручний метод: getCSSProperty. Рекомендується використовувати цю команду замість протоколу.

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

browser.getElementCSSValue(elementId, propertyName)

Параметри

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

Приклад

examples.js

loading...

View on GitHub

Повертає

• <string> cssValue: Обчислене значення параметра, відповідного імені властивості з декларацій стилю елемента (якщо тип документа не xml, в цьому випадку повертається просто порожній рядок).

---

getElementText

Команда Get Element Text призначена для повернення тексту елемента "як відображається". Відображений текст елемента також використовується для пошуку елементів за текстом посилання та частковим текстом посилання.

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

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

browser.getElementText(elementId)

Параметри

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

Приклад

examples.js

loading...

View on GitHub

Повертає

• <string> text: Видимий текст елемента (включаючи дочірні елементи), відповідно до алгоритму, визначеного в Selenium Atoms для bot.dom.getVisibleText.

---

getElementTagName

Команда Get Element Tag Name повертає кваліфіковану назву елемента даного веб-елемента.

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

інфо

Ця команда протоколу вбудована в наступний зручний метод: getTagName. Рекомендується використовувати цю команду замість протоколу.

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

browser.getElementTagName(elementId)

Параметри

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

Приклад

examples.js

loading...

View on GitHub

Повертає

• <string> text: Атрибут tagName елемента.

---

getElementRect

Команда Get Element Rect повертає розміри та координати даного веб-елемента.

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

інфо

Ця команда протоколу вбудована в наступні зручні методи: getSize, getLocation. Рекомендується використовувати ці команди замість протоколу.

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

browser.getElementRect(elementId)

Параметри

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

Приклад

examples.js

loading...

View on GitHub

Повертає

• <Object> elementRect: JSON-об'єкт, що представляє позицію та обмежуючий прямокутник елемента.

---

isElementEnabled

Is Element Enabled визначає, чи увімкнений вказаний елемент чи ні. Ця операція має сенс лише для елементів управління формою.

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

інфо

Ця команда протоколу вбудована в наступний зручний метод: isEnabled. Рекомендується використовувати цю команду замість протоколу.

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

browser.isElementEnabled(elementId)

Параметри

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

Приклад

examples.js

loading...

View on GitHub

Повертає

• <Boolean> isEnabled: Якщо елемент знаходиться в xml-документі або є вимкненим елементом управління формою: false, в іншому випадку, true.

---

elementClick

Команда Element Click прокручує елемент у видиму область, якщо він ще не є доступним для вказівника, і клацає по його видимій центральній точці. Якщо центральна точка елемента закрита іншим елементом, повертається помилка "element click intercepted". Якщо елемент знаходиться за межами області перегляду, повертається помилка "element not interactable".

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

інфо

Ця команда протоколу вбудована в наступний зручний метод: click. Рекомендується використовувати цю команду замість протоколу.

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

browser.elementClick(elementId)

Параметри

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

Приклад

examples.js

loading...

View on GitHub

---

elementClear

Команда Element Clear прокручує у видиму область елемент, який можна редагувати або скидати, і потім намагається очистити його вибрані файли або текстовий вміст.

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

інфо

Ця команда протоколу вбудована в наступний зручний метод: clearValue. Рекомендується використовувати цю команду замість протоколу.

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

browser.elementClear(elementId)

Параметри

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

Приклад

examples.js

loading...

View on GitHub

---

elementSendKeys

Команда Element Send Keys прокручує у видиму область елемент форми, а потім відправляє надані клавіші до елемента. У випадку, якщо елемент не доступний для клавіатури, повертається помилка "element not interactable".

Стан введення клавіш може бути очищений у процесі "набору" шляхом відправки нульового ключа, який є U+E000 (NULL).

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

інфо

Ця команда протоколу вбудована в наступні зручні методи: addValue, setValue. Рекомендується використовувати ці команди замість протоколу.

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

browser.elementSendKeys(elementId, text)

Параметри

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

Приклад

examples.js

loading...

View on GitHub

---

getPageSource

Команда Get Page Source повертає рядкову серіалізацію DOM активного документа поточного контексту перегляду.

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

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

browser.getPageSource()

Приклад

examples.js

loading...

View on GitHub

Повертає

• <string> pageSource: DOM активного документа поточного контексту перегляду

---

executeScript

Команда Execute Script виконує функцію JavaScript у контексті поточного контексту перегляду та повертає значення, що повертається функцією.

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

інфо

Ця команда протоколу вбудована в наступний зручний метод: execute. Рекомендується використовувати цю команду замість протоколу.

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

browser.executeScript(script, args)

Параметри

Назва	Тип	Деталі
script	string	рядок, тіло функції Javascript, яку ви хочете виконати
args	string, object, number, boolean, null, undefined[]	масив значень JSON, які будуть десеріалізовані та передані як аргументи до вашої функції

Приклад

examples.js

loading...

View on GitHub

Повертає

• <*> result: Або значення, що повертається вашим скриптом, або виконання Promise, поверненого вашим скриптом, або помилка, яка була причиною відхилення Promise, поверненого вашим скриптом.

---

executeAsyncScript

Команда Execute Async Script змушує JavaScript виконуватися як анонімна функція. На відміну від команди Execute Script, результат функції ігнорується. Замість цього додатковий аргумент надається як останній аргумент функції. Це функція, яка при виклику повертає свій перший аргумент як відповідь.

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

інфо

Ця команда протоколу вбудована в наступний зручний метод: executeAsync. Рекомендується використовувати цю команду замість протоколу.

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

browser.executeAsyncScript(script, args)

Параметри

Назва	Тип	Деталі
script	string	рядок, тіло функції Javascript, яку ви хочете виконати
args	string, object, number, boolean, null, undefined[]	масив значень JSON, які будуть десеріалізовані та передані як аргументи до вашої функції

Приклад

examples.js

loading...

View on GitHub

Повертає

• <*> result: Або значення, що повертається вашим скриптом, або виконання Promise, поверненого вашим скриптом, або помилка, яка була причиною відхилення Promise, поверненого вашим скриптом.

---

getAllCookies

Команда Get All Cookies повертає всі куки, пов'язані з адресою активного документа поточного контексту перегляду.

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

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

browser.getAllCookies()

Приклад

examples.js

loading...

View on GitHub

Повертає

• <Object[]> cookies: Список серіалізованих кук. Кожна серіалізована кука має кілька необов'язкових полів, які можуть повертатися або не повертатися на додаток до name та value.

---

addCookie

Команда Add Cookie додає одну куку до сховища кук, пов'язаного з адресою активного документа.

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

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

browser.addCookie(cookie)

Параметри

Назва	Тип	Деталі
cookie	object	JSON-об'єкт, що представляє куку. Він повинен мати принаймні поля name і value, та може мати більше, включаючи expiry-time тощо

Приклад

examples.js

loading...

View on GitHub

---

deleteAllCookies

Команда Delete All Cookies дозволяє видалити всі куки, пов'язані з адресою активного документа.

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

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

browser.deleteAllCookies()

Приклад

examples.js

loading...

View on GitHub

---

getNamedCookie

Команда Get Named Cookie повертає куку з вказаним ім'ям із пов'язаних кук у сховищі кук активного документа поточного контексту перегляду. Якщо кука не знайдена, повертається помилка "no such cookie".

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

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

browser.getNamedCookie(name)

Параметри

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

Приклад

examples.js

loading...

View on GitHub

Повертає

• <Object> cookie: Серіалізована кука з полями name та value. Є ряд додаткових полів, таких як path, domain та expiry-time, які також можуть бути присутніми.

---

deleteCookie

Команда Delete Cookie дозволяє видалити або одну куку за параметром name, або всі куки, пов'язані з адресою активного документа, якщо name не визначено.

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

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

browser.deleteCookie(name)

Параметри

Назва	Тип	Деталі
name	String	назва куки для видалення

Приклад

examples.js

loading...

View on GitHub

---

performActions

Команда Perform Actions використовується для виконання складних дій користувача. Детальніше дивіться спецификацію.

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

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

browser.performActions(actions)

Параметри

Назва	Тип	Деталі
actions	object[]	список об'єктів, кожен з яких представляє джерело введення та пов'язані з ним дії

---

releaseActions

Команда Release Actions використовується для звільнення всіх клавіш та кнопок вказівника, які в даний момент натиснуті. Це призводить до виникнення подій, як якщо б стан був звільнений явною серією дій. Вона також очищає весь внутрішній стан віртуальних пристроїв.

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

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

browser.releaseActions()

---

dismissAlert

Команда Dismiss Alert закриває простий діалог, якщо він є, в іншому випадку - помилка. Запит на відхилення сповіщення користувача, яке може не мати кнопки відхилення, має такий же ефект, як і прийняття його.

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

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

browser.dismissAlert()

Приклад

examples.js

loading...

View on GitHub

---

acceptAlert

Команда Accept Alert приймає простий діалог, якщо він є, в іншому випадку - помилка.

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

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

browser.acceptAlert()

---

getAlertText

Команда Get Alert Text повертає повідомлення поточного користувацького запиту. Якщо немає поточного запиту користувача, вона повертає помилку.

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

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

browser.getAlertText()

Приклад

examples.js

loading...

View on GitHub

Повертає

• <string> alertText: Повідомлення запиту користувача.

---

sendAlertText

Команда Send Alert Text встановлює текстове поле запиту користувача window.prompt на вказане значення.

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

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

browser.sendAlertText(text)

Параметри

Назва	Тип	Деталі
text	string	рядок для встановлення в запиті

---

takeScreenshot

Команда Take Screenshot робить знімок екрана області перегляду контексту перегляду верхнього рівня.

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

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

browser.takeScreenshot()

Повертає

• <string> screenshot: Дані зображення PNG у форматі base64, що складають знімок екрана початкової області перегляду.

---

takeElementScreenshot

Команда Take Element Screenshot робить знімок видимої області, охопленої обмежуючим прямокутником елемента.

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

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

browser.takeElementScreenshot(elementId, scroll)

Параметри

Назва	Тип	Деталі
elementId	String	ідентифікатор елемента, повернений у попередньому виклику Find Element(s)
scroll опціонально	boolean	прокрутити до елемента. За замовчуванням: true

Повертає

• <string> screenshot: Дані зображення PNG у форматі base64, що складають знімок екрана видимої області обмежуючого прямокутника елемента після його прокрутки у видиму область.

---

getElementComputedRole

Отримати обчислену роль WAI-ARIA елемента.

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

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

browser.getElementComputedRole(elementId)

Параметри

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

Повертає

• <string> role: Результат обчислення ролі WAI-ARIA елемента.

---

getElementComputedLabel

Отримати доступне ім'я елемента.

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

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

browser.getElementComputedLabel(elementId)

Параметри

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

Повертає

• <string> label: Результат обчислення доступного імені та опису для доступного імені елемента.

---

setPermissions

Симулює модифікацію користувачем стану дозволу PermissionDescriptor. Примітка: ця функція ще не впроваджена у всіх браузерах.

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

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

browser.setPermissions(descriptor, state, oneRealm)

Параметри

Назва	Тип	Деталі
descriptor	object	Кожна потужна функція має один або більше аспектів, для доступу до яких веб-сайти можуть запитувати дозвіл. Для опису цих аспектів кожна функція визначає підтип PermissionDescriptor як свій тип дескриптора дозволу. Примітка: ця функція ще не впроваджена у всіх браузерах.
state	string	Визначає, чи дозвіл надано, відхилено або запитано.
oneRealm опціонально	boolean	Чи застосовувати дозволи до всіх контекстів виконання.

Приклади

// встановити дозволи midi
browser.setPermissions(
  { name: 'midi', sysex: true },
  'granted' // може бути також "denied" або "prompt"
);

// встановити дозволи буфера обміну
browser.setPermissions({ name: 'clipboard-read' }, 'granted');
// тепер ви можете читати буфер обміну через, наприклад
const clipboardText = await browser.execute(() => navigator.clipboard.readText());

---

generateTestReport

Генерує звіт для тестування. Розширення для Reporting API. Примітка: ця функція ще не впроваджена у всіх браузерах.

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

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

browser.generateTestReport(message, group)

Параметри

Назва	Тип	Деталі
message	string	Повідомлення, яке буде відображатися у звіті.
group опціонально	string	Визначає групу кінцевих точок для доставки звіту.

---

createMockSensor

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

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

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

browser.createMockSensor(mockSensorType, maxSamplingFrequency, minSamplingFrequency)

Параметри

Назва	Тип	Деталі
mockSensorType	string	Тип API сенсора для фіктивної емуляції, наприклад, 'ambient-light'
maxSamplingFrequency опціонально	number	Подвійне число, що представляє частоту в Гц, яке використовується для встановлення максимальної підтримуваної частоти вибірки для пов'язаного фіктивного сенсора.
minSamplingFrequency опціонально	number	Подвійне число, що представляє частоту в Гц, яке використовується для встановлення мінімальної підтримуваної частоти вибірки для пов'язаного фіктивного сенсора.

---

getMockSensor

Отримує інформацію про даний тип фіктивного сенсора. Примітка: ця функція ще не впроваджена у всіх браузерах.

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

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

browser.getMockSensor(type)

Параметри

Назва	Тип	Деталі
type	String	Тип фіктивного сенсора для отримання інформації.

Повертає

• <object> sensorReading: Значення показів фіктивного сенсора.

---

updateMockSensor

Оновлює тип фіктивного сенсора. Примітка: ця функція ще не впроваджена у всіх браузерах.

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

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

browser.updateMockSensor(type, mockSensorType, maxSamplingFrequency, minSamplingFrequency)

Параметри

Назва	Тип	Деталі
type	String	Тип фіктивного сенсора для оновлення інформації.
mockSensorType	string	Тип API сенсора для фіктивної емуляції, наприклад, 'ambient-light'
maxSamplingFrequency опціонально	number	Подвійне число, що представляє частоту в Гц, яке використовується для встановлення максимальної підтримуваної частоти вибірки для пов'язаного фіктивного сенсора.
minSamplingFrequency опціонально	number	Подвійне число, що представляє частоту в Гц, яке використовується для встановлення мінімальної підтримуваної частоти вибірки для пов'язаного фіктивного сенсора.

---

deleteMockSensor

Команда Delete Session закриває будь-які контексти перегляду верхнього рівня, пов'язані з поточною сесією, завершує з'єднання і, нарешті, закриває поточну сесію. Примітка: ця функція ще не впроваджена у всіх браузерах.

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

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

browser.deleteMockSensor(type)

Параметри

Назва	Тип	Деталі
type	String	Тип фіктивного сенсора для видалення.

---

setTimeZone

Симулює зміну часового поясу для цілей тестування. Примітка: ця функція ще не впроваджена у всіх браузерах.

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

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

browser.setTimeZone(time_zone)

Параметри

Назва	Тип	Деталі
time_zone	string	Назва часового поясу, наприклад, Asia/Tokyo

---

addVirtualAuthenticator

Створює програмний Віртуальний Аутентифікатор.

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

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

browser.addVirtualAuthenticator(protocol, transport, hasResidentKey, hasUserVerification, isUserConsenting, isUserVerified, extensions, uvm)

Параметри

Назва	Тип	Деталі
protocol опціонально	string	Допустимі значення: 'ctap1/u2f', 'ctap2', 'ctap2_1'.
transport опціонально	string	Допустимі значення: 'usb', 'nfc', 'ble' або 'internal'.
hasResidentKey опціонально	boolean	Допустимі значення: true, false.
hasUserVerification опціонально	boolean	Допустимі значення: true, false.
isUserConsenting опціонально	boolean	Допустимі значення: true, false.
isUserVerified опціонально	boolean	Допустимі значення: масив, що містить ідентифікатори розширень.
extensions опціонально	string[]	Допустимі значення: До 3 записів методу перевірки користувача.
uvm опціонально	object[]

Повертає

• <string> authenticatorId: Повертає рядковий ідентифікатор автентифікатора.

---

removeVirtualAuthenticator

Видаляє попередньо створений віртуальний аутентифікатор.

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

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

browser.removeVirtualAuthenticator(authenticatorId)

Параметри

Назва	Тип	Деталі
authenticatorId	String	ідентифікатор автентифікатора

---

addCredential

Впроваджує джерело публічного ключа облікових даних в існуючий віртуальний аутентифікатор.

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

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

browser.addCredential(authenticatorId, credentialId, isResidentCredential, rpId, privateKey, userHandle, signCount, largeBlob)

Параметри

Назва	Тип	Деталі
authenticatorId	String	Ідентифікатор автентифікатора
credentialId	string	Ідентифікатор облікових даних, закодований за допомогою кодування Base64url.
isResidentCredential	boolean	Якщо встановлено значення true, створюється облікові дані, які можна виявити на стороні клієнта. Якщо встановлено значення false, замість цього створюються облікові дані на стороні сервера.
rpId	string	Ідентифікатор довіряючої сторони, до якої обмежені облікові дані.
privateKey	string	Пакет асиметричного ключа, що містить один приватний ключ відповідно до [RFC5958], закодований з використанням кодування Base64url.
userHandle	string	Ідентифікатор користувача, пов'язаний з обліковими даними, закодований за допомогою кодування Base64url. Ця властивість може бути не визначена.
signCount	number	Початкове значення лічильника підписів, пов'язаного з джерелом публічного ключа облікових даних.
largeBlob опціонально	string	Великий BLOB, пов'язаний з джерелом публічного ключа облікових даних, закодований за допомогою кодування Base64url. Ця властивість може бути не визначена.

---

getCredentials

Повертає один об'єкт параметрів облікових даних для кожного джерела публічного ключа облікових даних, збереженого у віртуальному аутентифікаторі, незалежно від того, чи вони були збережені за допомогою Add Credential або navigator.credentials.create().

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

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

browser.getCredentials(authenticatorId)

Параметри

Назва	Тип	Деталі
authenticatorId	String	ідентифікатор автентифікатора

Повертає

• <object[]> credentials: Повертає масив облікових даних.

---

removeAllCredentials

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

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

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

browser.removeAllCredentials(authenticatorId)

Параметри

Назва	Тип	Деталі
authenticatorId	String	ідентифікатор автентифікатора

---

removeCredential

Видаляє джерело публічного ключа облікових даних, збережене у віртуальному аутентифікаторі.

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

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

browser.removeCredential(authenticatorId, credentialId)

Параметри

Назва	Тип	Деталі
authenticatorId	String	ідентифікатор автентифікатора
credentialId	String	ідентифікатор облікових даних

---

setUserVerified

Команда розширення Set User Verified встановлює властивість isUserVerified на віртуальному аутентифікаторі.

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

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

browser.setUserVerified(authenticatorId)

Параметри

Назва	Тип	Деталі
authenticatorId	String	ідентифікатор автентифікатора