Протокол WebDriver

newSession

Команда New Session создает новую сессию WebDriver с конечной точкой узла. Если создание не удается, возвращается ошибка создания сессии.

Команда протокола WebDriver. Более подробную информацию можно найти в официальной документации протокола.

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

browser.newSession(capabilities)

Параметры

Имя	Тип	Детали
capabilities	object	объект JSON, набор возможностей, которые были в конечном итоге объединены и соответствовали в алгоритме обработки возможностей

Возвращает

• <Object> session: Объект, содержащий sessionId и capabilities созданной сессии WebDriver.

---

deleteSession

Команда Delete Session закрывает любые контексты верхнего уровня просмотра, связанные с текущей сессией, завершает соединение и, наконец, закрывает текущую сессию.

Команда протокола WebDriver. Более подробную информацию можно найти в официальной документации протокола.

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

browser.deleteSession(deleteSessionOpts)

Параметры

Имя	Тип	Детали
deleteSessionOpts optional	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 optional	number	целое число в мс для неявного ожидания сессии
pageLoad optional	number	целое число в мс для таймаута загрузки страницы сессии
script optional	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 заставляет браузер перейти на один шаг назад в объединенной истории сессии текущего контекста просмотра верхнего уровня. Это эквивалентно нажатию кнопки "назад" в chrome браузера или вызову 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 в настоящее время поддерживает это только в безголовом режиме, см. crbug753118).

Команда протокола WebDriver. Более подробную информацию можно найти в официальной документации протокола.

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

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

Параметры

Имя	Тип	Детали
orientation optional	string	ориентация страницы. По умолчанию: portrait
scale optional	number	масштаб страницы. По умолчанию: 1
background optional	boolean	фон страницы. По умолчанию: false
width optional	number	ширина страницы в см. По умолчанию: 21.59 от страницы
height optional	number	высота страницы в см. По умолчанию: 27.94 от страницы
top optional	number	поле страницы в см от верхнего края. По умолчанию: 1
bottom optional	number	поле страницы в см от нижнего края. По умолчанию: 1
left optional	number	поле страницы в см от левого края. По умолчанию: 1
right optional	number	поле страницы в см от правого края. По умолчанию: 1
shrinkToFit optional	boolean	уменьшить pdf, чтобы он поместился на странице. По умолчанию: true
pageRanges optional	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), Number, представляющий индекс объекта окна, соответствующего фрейму, объект 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-представление объекта "window rect". Он имеет 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	ширина внешних размеров контекста просмотра верхнего уровня, включая chrome браузера и т.д...
height	number, null	высота внешних размеров контекста просмотра верхнего уровня, включая chrome браузера и т.д...

Пример

examples.js

loading...

View on GitHub

Возвращает

• <Object> windowRect: JSON-представление объекта "window rect" на основе нового состояния окна.

---

maximizeWindow

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

Команда протокола WebDriver. Более подробную информацию можно найти в официальной документации протокола.

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

browser.maximizeWindow()

Пример

examples.js

loading...

View on GitHub

Возвращает

• <Object> windowRect: JSON-представление объекта "window rect" на основе нового состояния окна.

---

minimizeWindow

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

Команда протокола WebDriver. Более подробную информацию можно найти в официальной документации протокола.

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

browser.minimizeWindow()

Возвращает

• <Object> windowRect: JSON-представление объекта "window rect" (нового) текущего контекста просмотра верхнего уровня.

---

fullscreenWindow

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

Команда протокола WebDriver. Более подробную информацию можно найти в официальной документации протокола.

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

browser.fullscreenWindow()

Возвращает

• <Object> windowRect: JSON-представление объекта "window rect" (нового) текущего контекста просмотра верхнего уровня.

---

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 используется для поиска элемента в пределах shadow root элемента, который может быть использован для будущих команд. Эта команда возвращает JSON-представление элемента, которое может быть передано команде $ для преобразования ссылки в расширенный элемент WebdriverIO.

Команда протокола WebDriver. Более подробную информацию можно найти в официальной документации протокола.

информация

Эта команда протокола встроена в следующий удобный метод: shadow$. Рекомендуется использовать эту команду вместо протокольной.

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

browser.findElementFromShadowRoot(shadowId, using, value)

Параметры

Имя	Тип	Детали
shadowId	String	идентификатор элемента shadow root
using	string	действительная стратегия определения местоположения элемента
value	string	фактический селектор, который будет использоваться для поиска элемента

Пример

examples.js

loading...

View on GitHub

Возвращает

• <object> element: JSON-представление объекта shadow элемента, например { '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 используется для поиска элементов в пределах shadow root элемента, которые могут быть использованы для будущих команд. Эта команда возвращает массив JSON-представлений элементов, которые могут быть переданы команде $ для преобразования ссылки в расширенный элемент WebdriverIO (См. findElement).

Команда протокола WebDriver. Более подробную информацию можно найти в официальной документации протокола.

информация

Эта команда протокола встроена в следующий удобный метод: shadow$$. Рекомендуется использовать эту команду вместо протокольной.

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

browser.findElementsFromShadowRoot(shadowId, using, value)

Параметры

Имя	Тип	Детали
shadowId	String	идентификатор элемента shadow root
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

Получение объекта shadow root элемента. Результирующий объект может быть использован для извлечения элементов в этом shadow root с помощью, например, findElementFromShadowRoots или findElementsFromShadowRoots.

Команда протокола WebDriver. Более подробную информацию можно найти в официальной документации протокола.

информация

Эта команда протокола встроена в следующий удобный метод: shadow$. Рекомендуется использовать эту команду вместо протокольной.

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

browser.getElementShadowRoot(elementId)

Параметры

Имя	Тип	Детали
elementId	String	идентификатор элемента, возвращенный в предыдущем вызове Find Element(s)

Пример

examples.js

loading...

View on GitHub

Возвращает

• <string> shadowRoot: JSON-представление shadow root элемента, например { '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 или элементов option.

Команда протокола 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 прокручивает элемент в видимую область, если он еще не доступен для взаимодействия с указателем, и щелкает его видимую центральную точку. Если центральная точка элемента закрыта другим элементом, возвращается ошибка перехвата щелчка элемента. Если элемент находится вне области просмотра, возвращается ошибка элемента, не доступного для взаимодействия.

Команда протокола 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 прокручивает в область видимости элемент управления формой, а затем отправляет предоставленные ключи элементу. В случае, если элемент не доступен для взаимодействия с клавиатурой, возвращается ошибка элемента, не доступного для взаимодействия.

Состояние ввода ключа, используемое для ввода, может быть очищено в середине "набора текста" путем отправки нулевого ключа, который является 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 и может иметь больше, включая время истечения срока действия и так далее

Пример

examples.js

loading...

View on GitHub

---

deleteAllCookies

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

Команда протокола WebDriver. Более подробную информацию можно найти в официальной документации протокола.

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

browser.deleteAllCookies()

Пример

examples.js

loading...

View on GitHub

---

getNamedCookie

Команда Get Named Cookie возвращает кук с запрошенным именем из связанных куков в хранилище куков активного документа текущего контекста просмотра. Если кук не найден, возвращается ошибка "такого кука нет".

Команда протокола WebDriver. Более подробную информацию можно найти в официальной документации протокола.

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

browser.getNamedCookie(name)

Параметры

Имя	Тип	Детали
name	String	имя кука для получения

Пример

examples.js

loading...

View on GitHub

Возвращает

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

---

deleteCookie

Команда Delete Cookie позволяет удалить либо один кук по имени параметра, либо все куки, связанные с адресом активного документа, если имя не определено.

Команда протокола 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 optional	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 optional	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 optional	string	Определяет группу конечных точек для доставки отчета.

---

createMockSensor

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

Команда протокола WebDriver. Более подробную информацию можно найти в официальной документации протокола.

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

browser.createMockSensor(mockSensorType, maxSamplingFrequency, minSamplingFrequency)

Параметры

Имя	Тип	Детали
mockSensorType	string	Тип API датчика для имитации, например 'ambient-light'
maxSamplingFrequency optional	number	Двойное число, представляющее частоту в Гц, которое используется для установки максимальной поддерживаемой частоты дискретизации для связанного имитационного датчика.
minSamplingFrequency optional	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 optional	number	Двойное число, представляющее частоту в Гц, которое используется для установки максимальной поддерживаемой частоты дискретизации для связанного имитационного датчика.
minSamplingFrequency optional	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 optional	string	Допустимые значения: 'ctap1/u2f', 'ctap2', 'ctap2_1'.
transport optional	string	Допустимые значения: 'usb', 'nfc', 'ble' или 'internal'.
hasResidentKey optional	boolean	Допустимые значения: true, false.
hasUserVerification optional	boolean	Допустимые значения: true, false.
isUserConsenting optional	boolean	Допустимые значения: true, false.
isUserVerified optional	boolean	Допустимые значения: Массив, содержащий идентификаторы расширений.
extensions optional	string[]	Допустимые значения: До 3 записей Метода Проверки Пользователя.
uvm optional	object[]

Возвращает

• <string> authenticatorId: Возвращает строковый идентификатор аутентификатора.

---

removeVirtualAuthenticator

Удаляет ранее созданный Виртуальный Аутентификатор.

Команда протокола WebDriver. Более подробную информацию можно найти в официальной документации протокола.

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

browser.removeVirtualAuthenticator(authenticatorId)

Параметры

Имя	Тип	Детали
authenticatorId	String	идентификатор аутентификатора

---

addCredential

Внедряет Источник Учетных Данных Открытого Ключа в существующий Виртуальный Аутентификатор.

Команда протокола WebDriver. Более подробную информацию можно найти в официальной документации протокола.

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

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

Параметры

Имя	Тип	Детали
authenticatorId	String	ID аутентификатора
credentialId	string	ID учетных данных, закодированный с использованием Base64url Encoding.
isResidentCredential	boolean	Если установлено в true, создаются учетные данные, обнаруживаемые на стороне клиента. Если установлено в false, вместо этого создаются учетные данные на стороне сервера.
rpId	string	ID доверяющей стороны, к которому привязаны учетные данные.
privateKey	string	Пакет асимметричного ключа, содержащий один приватный ключ согласно [RFC5958], закодированный с использованием Base64url Encoding.
userHandle	string	userHandle, связанный с учетными данными, закодированный с использованием Base64url Encoding. Это свойство может быть не определено.
signCount	number	Начальное значение счетчика подписи, связанного с источником учетных данных открытого ключа.
largeBlob optional	string	Большой blob, связанный с источником учетных данных открытого ключа, закодированный с использованием Base64url Encoding. Это свойство может быть не определено.

---

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	идентификатор аутентификатора