Protocolo WebDriver

newSession

O comando New Session cria uma nova sessão WebDriver com o nó de endpoint. Se a criação falhar, um erro de sessão não criada é retornado.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.newSession(capabilities)

Parâmetros

Nome	Tipo	Detalhes
capabilities	object	um objeto JSON, o conjunto de capacidades que foi mesclado e correspondido no algoritmo de processamento de capacidades

Retorna

• <Object> session: Objeto contendo sessionId e capabilities da sessão WebDriver criada.

---

deleteSession

O comando Delete Session fecha quaisquer contextos de navegação de nível superior associados à sessão atual, encerra a conexão e finalmente fecha a sessão atual.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.deleteSession(deleteSessionOpts)

Parâmetros

Nome	Tipo	Detalhes
deleteSessionOpts opcional	object	Objeto contendo opções para o comando deleteSession, por exemplo { shutdownDriver: boolean }

---

status

O comando Status retorna informações sobre se um endpoint remoto está em um estado em que pode criar novas sessões e pode adicionalmente incluir meta informações arbitrárias específicas da implementação.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.status()

Exemplo

examples.js

loading...

View on GitHub

Retorna

• <Object> status: Objeto contendo o status do driver.

---

getTimeouts

O comando Get Timeouts obtém as durações de timeout associadas à sessão atual.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.getTimeouts()

Exemplo

examples.js

loading...

View on GitHub

Retorna

• <Object> timeouts: Objeto contendo durações de timeout para script, pageLoad e implicit.

---

setTimeouts

O comando Set Timeouts define as durações de timeout associadas à sessão atual. Os timeouts que podem ser controlados estão listados na tabela de timeouts de sessão abaixo.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.setTimeouts(implicit, pageLoad, script)

Parâmetros

Nome	Tipo	Detalhes
implicit opcional	number	inteiro em ms para o timeout de espera implícita da sessão
pageLoad opcional	number	inteiro em ms para o timeout de carregamento de página da sessão
script opcional	number	inteiro em ms para o timeout de script da sessão

Exemplo

examples.js

loading...

View on GitHub

---

getUrl

O comando Get Current URL retorna a URL do contexto de navegação de nível superior atual.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.getUrl()

Exemplo

examples.js

loading...

View on GitHub

Retorna

• <string> url: URL do documento ativo do contexto de navegação de nível superior atual

---

navigateTo

O comando navigateTo (go) é usado para fazer com que o agente do usuário navegue no contexto de navegação de nível superior atual para uma nova localização.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

informação

Este comando de protocolo está incorporado no seguinte método conveniente: url. É recomendado usar este comando em vez do protocolo.

Uso

browser.navigateTo(url)

Parâmetros

Nome	Tipo	Detalhes
url	string	string representando uma URL absoluta (começando com http(s)), possivelmente incluindo um fragmento (#...), também poderia ser um esquema local (about: etc)

Exemplo

examples.js

loading...

View on GitHub

---

back

O comando Back faz com que o navegador percorra um passo para trás no histórico de sessão conjunto do contexto de navegação de nível superior atual. Isso é equivalente a pressionar o botão voltar no chrome do navegador ou chamar window.history.back.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.back()

Exemplo

examples.js

loading...

View on GitHub

---

forward

O comando Forward faz com que o navegador percorra um passo à frente no histórico de sessão conjunto do contexto de navegação de nível superior atual.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.forward()

Exemplo

examples.js

loading...

View on GitHub

---

refresh

O comando Refresh faz com que o navegador recarregue a página no contexto de navegação de nível superior atual.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.refresh()

Exemplo

examples.js

loading...

View on GitHub

---

getTitle

O comando Get Title retorna o título do documento do contexto de navegação de nível superior atual, equivalente a chamar document.title.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.getTitle()

Exemplo

examples.js

loading...

View on GitHub

Retorna

• <string> title: Retorna uma string que é a mesma que document.title do contexto de navegação de nível superior atual.

---

getWindowHandle

O comando Get Window Handle retorna o identificador da janela para o contexto de navegação de nível superior atual. Pode ser usado como um argumento para Switch To Window.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.getWindowHandle()

Exemplo

examples.js

loading...

View on GitHub

Retorna

• <string> handle: Retorna uma string que é o identificador da janela para o contexto de navegação de nível superior atual.

---

closeWindow

O comando Close Window fecha o contexto de navegação de nível superior atual. Uma vez concluído, se não houver mais contextos de navegação de nível superior abertos, a sessão WebDriver em si é fechada.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.closeWindow()

Exemplo

examples.js

loading...

View on GitHub

---

switchToWindow

O comando Switch To Window é usado para selecionar o contexto de navegação de nível superior atual para a sessão atual, ou seja, aquele que será usado para processar comandos.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

informação

Este comando de protocolo está incorporado no seguinte método conveniente: switchWindow. É recomendado usar este comando em vez do protocolo.

Uso

browser.switchToWindow(handle)

Parâmetros

Nome	Tipo	Detalhes
handle	string	uma string representando um identificador de janela, deve ser uma das strings que foi retornada em uma chamada para getWindowHandles

Exemplo

examples.js

loading...

View on GitHub

---

createWindow

Cria um novo contexto de navegação de nível superior.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.createWindow(type)

Parâmetros

Nome	Tipo	Detalhes
type	string	Defina como 'tab' se a janela recém-criada compartilha uma janela em nível de SO com o contexto de navegação atual, ou 'window' caso contrário.

Exemplo

examples.js

loading...

View on GitHub

Retorna

• <Object> window: Novo objeto de janela contendo 'handle' com o valor do identificador e 'type' com o valor do tipo de janela criada

---

getWindowHandles

O comando Get Window Handles retorna uma lista de identificadores de janelas para cada contexto de navegação de nível superior aberto. A ordem em que os identificadores de janela são retornados é arbitrária.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.getWindowHandles()

Exemplo

examples.js

loading...

View on GitHub

Retorna

• <String[]> handles: Uma matriz que é uma lista de identificadores de janela.

---

printPage

O comando Print Page renderiza o documento para um documento PDF paginado. Nota: O Chrome atualmente só suporta isso no modo headless, veja crbug753118).

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

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

Parâmetros

Nome	Tipo	Detalhes
orientation opcional	string	orientação da página. Padrão: portrait
scale opcional	number	escala da página. Padrão: 1
background opcional	boolean	fundo da página. Padrão: false
width opcional	number	largura da página em cm. Padrão: 21.59 da página
height opcional	number	altura da página em cm. Padrão: 27.94 da página
top opcional	number	margem da página em cm a partir da margem superior. Padrão: 1
bottom opcional	number	margem da página em cm a partir da margem inferior. Padrão: 1
left opcional	number	margem da página em cm a partir da margem esquerda. Padrão: 1
right opcional	number	margem da página em cm a partir da margem direita. Padrão: 1
shrinkToFit opcional	boolean	reduzir o pdf para caber na página. Padrão: true
pageRanges opcional	object[]	intervalos de páginas. Padrão []

Exemplo

examples.js

loading...

View on GitHub

Retorna

• <string> pdf: A representação PDF codificada em base64 do documento paginado.

---

switchToFrame

O comando Switch To Frame é usado para selecionar o contexto de navegação de nível superior atual ou um contexto de navegação filho do contexto de navegação atual para usar como o contexto de navegação atual para comandos subsequentes.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

cuidado

Este comando de protocolo está obsoleto
Este comando está obsoleto e incentivamos todos a usar switchFrame em vez disso para alternar para frames. Leia mais sobre este comando em https://webdriver.io/docs/api/browser/switchFrame.

Uso

browser.switchToFrame(id)

Parâmetros

Nome	Tipo	Detalhes
id	number, object, null	um de três tipos possíveis: null: isso representa o contexto de navegação de nível superior (ou seja, não um iframe), um Number, representando o índice do objeto de janela correspondente a um frame, um objeto Element recebido usando findElement.

Exemplo

examples.js

loading...

View on GitHub

---

switchToParentFrame

O comando Switch to Parent Frame define o contexto de navegação atual para comandos futuros para o pai do contexto de navegação atual.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.switchToParentFrame()

Exemplo

examples.js

loading...

View on GitHub

---

getWindowRect

O comando Get Window Rect retorna o tamanho e a posição na tela da janela do sistema operacional correspondente ao contexto de navegação de nível superior atual.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

informação

Este comando de protocolo está incorporado no seguinte método conveniente: getWindowSize. É recomendado usar este comando em vez do protocolo.

Uso

browser.getWindowRect()

Exemplo

examples.js

loading...

View on GitHub

Retorna

• <Object> windowRect: Uma representação JSON de um objeto "window rect". Isso tem 4 propriedades: x, y, width e height.

---

setWindowRect

O comando Set Window Rect altera o tamanho e a posição da janela do sistema operacional correspondente ao contexto de navegação de nível superior atual.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

informação

Este comando de protocolo está incorporado no seguinte método conveniente: setWindowSize. É recomendado usar este comando em vez do protocolo.

Uso

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

Parâmetros

Nome	Tipo	Detalhes
x	number, null	o atributo screenX do objeto window
y	number, null	o atributo screenY do objeto window
width	number, null	a largura das dimensões externas do contexto de navegação de nível superior, incluindo chrome do navegador etc...
height	number, null	a altura das dimensões externas do contexto de navegação de nível superior, incluindo chrome do navegador etc...

Exemplo

examples.js

loading...

View on GitHub

Retorna

• <Object> windowRect: Uma representação JSON de um objeto "window rect" baseado no novo estado da janela.

---

maximizeWindow

O comando Maximize Window invoca a operação específica do gerenciador de janelas "maximize", se houver, na janela que contém o contexto de navegação de nível superior atual. Isso normalmente aumenta a janela para o tamanho máximo disponível sem entrar em tela cheia.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.maximizeWindow()

Exemplo

examples.js

loading...

View on GitHub

Retorna

• <Object> windowRect: Uma representação JSON de um objeto "window rect" baseado no novo estado da janela.

---

minimizeWindow

O comando Minimize Window invoca a operação específica do gerenciador de janelas "minimize", se houver, na janela que contém o contexto de navegação de nível superior atual. Isso normalmente oculta a janela na bandeja do sistema.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.minimizeWindow()

Retorna

• <Object> windowRect: Uma representação JSON de um objeto "window rect" do (novo) contexto de navegação de nível superior atual.

---

fullscreenWindow

O comando Fullscreen Window invoca a operação específica do gerenciador de janelas "full screen", se houver, na janela que contém o contexto de navegação de nível superior atual. Isso normalmente aumenta a janela para o tamanho da tela física e pode ocultar elementos do chrome do navegador, como barras de ferramentas.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.fullscreenWindow()

Retorna

• <Object> windowRect: Uma representação JSON de um objeto "window rect" do (novo) contexto de navegação de nível superior atual.

---

findElement

O comando Find Element é usado para encontrar um elemento no contexto de navegação atual que pode ser usado para comandos futuros. Este comando retorna a representação JSON do elemento que pode ser passada para o comando $ para transformar a referência em um elemento WebdriverIO estendido.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

informação

Este comando de protocolo está incorporado no seguinte método conveniente: $. É recomendado usar este comando em vez do protocolo.

Uso

browser.findElement(using, value)

Parâmetros

Nome	Tipo	Detalhes
using	string	uma estratégia de localização de elemento válida
value	string	o seletor real que será usado para encontrar um elemento

Exemplo

examples.js

loading...

View on GitHub

Retorna

• <object> element: Uma representação JSON de um objeto de elemento, por exemplo { 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }.

---

findElementFromShadowRoot

O comando Find Element From Shadow Root é usado para encontrar um elemento dentro da raiz da sombra de um elemento que pode ser usado para comandos futuros. Este comando retorna a representação JSON do elemento que pode ser passada para o comando $ para transformar a referência em um elemento WebdriverIO estendido.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

informação

Este comando de protocolo está incorporado no seguinte método conveniente: shadow$. É recomendado usar este comando em vez do protocolo.

Uso

browser.findElementFromShadowRoot(shadowId, using, value)

Parâmetros

Nome	Tipo	Detalhes
shadowId	String	ID do elemento de um elemento raiz de sombra
using	string	uma estratégia de localização de elemento válida
value	string	o seletor real que será usado para encontrar um elemento

Exemplo

examples.js

loading...

View on GitHub

Retorna

• <object> element: Uma representação JSON de um objeto de sombra de elemento, por exemplo { 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }.

---

findElements

O comando Find Elements é usado para encontrar elementos no contexto de navegação atual que podem ser usados para comandos futuros. Este comando retorna uma matriz de representação JSON dos elementos que pode ser passada para o comando $ para transformar a referência em um elemento WebdriverIO estendido (Veja findElement).

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

informação

Este comando de protocolo está incorporado no seguinte método conveniente: $$. É recomendado usar este comando em vez do protocolo.

Uso

browser.findElements(using, value)

Parâmetros

Nome	Tipo	Detalhes
using	string	uma estratégia de localização de elemento válida
value	string	o seletor real que será usado para encontrar um elemento

Exemplo

examples.js

loading...

View on GitHub

Retorna

• <object[]> elements: Uma lista JSON (possivelmente vazia) de representações de um objeto de elemento, por exemplo [{ 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }].

---

findElementsFromShadowRoot

O comando Find Elements é usado para encontrar elementos dentro da raiz da sombra de um elemento que podem ser usados para comandos futuros. Este comando retorna uma matriz de representação JSON dos elementos que pode ser passada para o comando $ para transformar a referência em um elemento WebdriverIO estendido (Veja findElement).

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

informação

Este comando de protocolo está incorporado no seguinte método conveniente: shadow$$. É recomendado usar este comando em vez do protocolo.

Uso

browser.findElementsFromShadowRoot(shadowId, using, value)

Parâmetros

Nome	Tipo	Detalhes
shadowId	String	ID do elemento de um elemento raiz de sombra
using	string	uma estratégia de localização de elemento válida
value	string	o seletor real que será usado para encontrar um elemento

Exemplo

examples.js

loading...

View on GitHub

Retorna

• <object[]> elements: Uma lista JSON (possivelmente vazia) de representações de um objeto de elemento, por exemplo { 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }.

---

findElementFromElement

O comando Find Element From Element é usado para encontrar um elemento a partir de um elemento web no contexto de navegação atual que pode ser usado para comandos futuros. Este comando retorna a representação JSON do elemento que pode ser passada para o comando $ para transformar a referência em um elemento WebdriverIO estendido (Veja findElement).

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

informação

Este comando de protocolo está incorporado no seguinte método conveniente: $. É recomendado usar este comando em vez do protocolo.

Uso

browser.findElementFromElement(elementId, using, value)

Parâmetros

Nome	Tipo	Detalhes
elementId	String	o id de um elemento retornado em uma chamada anterior para Find Element(s)
using	string	uma estratégia de localização de elemento válida
value	string	o seletor real que será usado para encontrar um elemento

Exemplo

examples.js

loading...

View on GitHub

Retorna

• <object> element: Uma representação JSON de um objeto de elemento, por exemplo { 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }.

---

findElementsFromElement

O comando Find Elements From Element é usado para encontrar elementos a partir de um elemento web no contexto de navegação atual que podem ser usados para comandos futuros. Este comando retorna uma matriz de representação JSON dos elementos que pode ser passada para o comando $ para transformar a referência em um elemento WebdriverIO estendido (Veja findElement).

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

informação

Este comando de protocolo está incorporado no seguinte método conveniente: $$. É recomendado usar este comando em vez do protocolo.

Uso

browser.findElementsFromElement(elementId, using, value)

Parâmetros

Nome	Tipo	Detalhes
elementId	String	o id de um elemento retornado em uma chamada anterior para Find Element(s)
using	string	uma estratégia de localização de elemento válida
value	string	o seletor real que será usado para encontrar um elemento

Exemplo

examples.js

loading...

View on GitHub

Retorna

• <object[]> elements: Uma lista JSON (possivelmente vazia) de representações de um objeto de elemento, por exemplo [{ 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }].

---

getElementShadowRoot

Obtém o objeto de raiz de sombra de um elemento. O objeto de resultado pode ser usado para buscar elementos dentro desta raiz de sombra usando, por exemplo, findElementFromShadowRoots ou findElementsFromShadowRoots.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

informação

Este comando de protocolo está incorporado no seguinte método conveniente: shadow$. É recomendado usar este comando em vez do protocolo.

Uso

browser.getElementShadowRoot(elementId)

Parâmetros

Nome	Tipo	Detalhes
elementId	String	o id de um elemento retornado em uma chamada anterior para Find Element(s)

Exemplo

examples.js

loading...

View on GitHub

Retorna

• <string> shadowRoot: Uma representação JSON de uma raiz de sombra de elemento, por exemplo { 'shadow-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }.

---

getActiveElement

Get Active Element retorna o elemento ativo do elemento de documento do contexto de navegação atual. Este comando retorna a representação JSON do elemento que pode ser passada para o comando $ para transformar a referência em um elemento WebdriverIO estendido (Veja findElement).

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.getActiveElement()

Exemplo

examples.js

loading...

View on GitHub

Retorna

• <string> element: Uma representação JSON de um objeto de elemento, por exemplo { 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }.

---

isElementSelected

Is Element Selected determina se o elemento referenciado está selecionado ou não. Esta operação só faz sentido em elementos de entrada dos estados de Checkbox e Radio Button, ou elementos de opção.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

informação

Este comando de protocolo está incorporado no seguinte método conveniente: isSelected. É recomendado usar este comando em vez do protocolo.

Uso

browser.isElementSelected(elementId)

Parâmetros

Nome	Tipo	Detalhes
elementId	String	o id de um elemento retornado em uma chamada anterior para Find Element(s)

Exemplo

examples.js

loading...

View on GitHub

Retorna

• <Boolean> isSelected: true ou false com base no estado selecionado.

---

isElementDisplayed

Is Element Displayed determina a visibilidade de um elemento, guiada pelo que é perceptualmente visível para o olho humano. Neste contexto, a exibição de um elemento não está relacionada às propriedades de estilo visibility ou display.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

informação

Este comando de protocolo está incorporado no seguinte método conveniente: isDisplayed. É recomendado usar este comando em vez do protocolo.

Uso

browser.isElementDisplayed(elementId)

Parâmetros

Nome	Tipo	Detalhes
elementId	String	o id de um elemento retornado em uma chamada anterior para Find Element(s)

Exemplo

examples.js

loading...

View on GitHub

Retorna

• <Boolean> isDisplayed: true ou false com base no estado visível.

---

getElementAttribute

O comando Get Element Attribute retornará o atributo de um elemento web.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

informação

Este comando de protocolo está incorporado no seguinte método conveniente: getAttribute. É recomendado usar este comando em vez do protocolo.

Uso

browser.getElementAttribute(elementId, name)

Parâmetros

Nome	Tipo	Detalhes
elementId	String	o id de um elemento retornado em uma chamada anterior para Find Element(s)
name	String	nome do valor do atributo a ser recuperado

Exemplo

examples.js

loading...

View on GitHub

Retorna

• <string> attribute: O atributo nomeado do elemento.

---

getElementProperty

O comando Get Element Property retornará o resultado da obtenção de uma propriedade de um elemento.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

informação

Este comando de protocolo está incorporado no seguinte método conveniente: getProperty. É recomendado usar este comando em vez do protocolo.

Uso

browser.getElementProperty(elementId, name)

Parâmetros

Nome	Tipo	Detalhes
elementId	String	o id de um elemento retornado em uma chamada anterior para Find Element(s)
name	String	nome da propriedade do atributo a ser recuperada

Exemplo

examples.js

loading...

View on GitHub

Retorna

• <string> property: A propriedade nomeada do elemento, acessada chamando GetOwnProperty no objeto do elemento.

---

getElementCSSValue

O comando Get Element CSS Value recupera o valor computado da propriedade CSS fornecida do elemento web fornecido.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

informação

Este comando de protocolo está incorporado no seguinte método conveniente: getCSSProperty. É recomendado usar este comando em vez do protocolo.

Uso

browser.getElementCSSValue(elementId, propertyName)

Parâmetros

Nome	Tipo	Detalhes
elementId	String	o id de um elemento retornado em uma chamada anterior para Find Element(s)
propertyName	String	nome da propriedade CSS a ser recuperada

Exemplo

examples.js

loading...

View on GitHub

Retorna

• <string> cssValue: O valor computado do parâmetro correspondente ao nome da propriedade das declarações de estilo do elemento (a menos que o tipo de documento seja xml, caso em que o valor de retorno é simplesmente a string vazia).

---

getElementText

O comando Get Element Text pretende retornar o texto "como renderizado" de um elemento. O texto renderizado de um elemento também é usado para localizar elementos pelo texto do link e texto parcial do link.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.getElementText(elementId)

Parâmetros

Nome	Tipo	Detalhes
elementId	String	o id de um elemento retornado em uma chamada anterior para Find Element(s)

Exemplo

examples.js

loading...

View on GitHub

Retorna

• <string> text: O texto visível do elemento (incluindo elementos filhos), seguindo o algoritmo definido nos Selenium Atoms para bot.dom.getVisibleText.

---

getElementTagName

O comando Get Element Tag Name retorna o nome do elemento qualificado do elemento web fornecido.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

informação

Este comando de protocolo está incorporado no seguinte método conveniente: getTagName. É recomendado usar este comando em vez do protocolo.

Uso

browser.getElementTagName(elementId)

Parâmetros

Nome	Tipo	Detalhes
elementId	String	o id de um elemento retornado em uma chamada anterior para Find Element(s)

Exemplo

examples.js

loading...

View on GitHub

Retorna

• <string> text: O atributo tagName do elemento.

---

getElementRect

O comando Get Element Rect retorna as dimensões e coordenadas do elemento web fornecido.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

informação

Este comando de protocolo está incorporado nos seguintes métodos convenientes: getSize, getLocation. É recomendado usar estes comandos em vez do protocolo.

Uso

browser.getElementRect(elementId)

Parâmetros

Nome	Tipo	Detalhes
elementId	String	o id de um elemento retornado em uma chamada anterior para Find Element(s)

Exemplo

examples.js

loading...

View on GitHub

Retorna

• <Object> elementRect: Um objeto JSON representando a posição e o retângulo delimitador do elemento.

---

isElementEnabled

Is Element Enabled determina se o elemento referenciado está habilitado ou não. Esta operação só faz sentido em controles de formulário.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

informação

Este comando de protocolo está incorporado no seguinte método conveniente: isEnabled. É recomendado usar este comando em vez do protocolo.

Uso

browser.isElementEnabled(elementId)

Parâmetros

Nome	Tipo	Detalhes
elementId	String	o id de um elemento retornado em uma chamada anterior para Find Element(s)

Exemplo

examples.js

loading...

View on GitHub

Retorna

• <Boolean> isEnabled: Se o elemento estiver em um documento xml, ou for um controle de formulário desativado: false, caso contrário, true.

---

elementClick

O comando Element Click rola para a exibição do elemento se ele ainda não estiver interagível por ponteiro, e clica em seu ponto central visível. Se o ponto central do elemento estiver obscurecido por outro elemento, um erro de clique de elemento interceptado é retornado. Se o elemento estiver fora da viewport, um erro de elemento não interagível é retornado.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

informação

Este comando de protocolo está incorporado no seguinte método conveniente: click. É recomendado usar este comando em vez do protocolo.

Uso

browser.elementClick(elementId)

Parâmetros

Nome	Tipo	Detalhes
elementId	String	o id de um elemento retornado em uma chamada anterior para Find Element(s)

Exemplo

examples.js

loading...

View on GitHub

---

elementClear

O comando Element Clear rola para a exibição de um elemento editável ou resetável e então tenta limpar seus arquivos selecionados ou conteúdo de texto.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

informação

Este comando de protocolo está incorporado no seguinte método conveniente: clearValue. É recomendado usar este comando em vez do protocolo.

Uso

browser.elementClear(elementId)

Parâmetros

Nome	Tipo	Detalhes
elementId	String	o id de um elemento retornado em uma chamada anterior para Find Element(s)

Exemplo

examples.js

loading...

View on GitHub

---

elementSendKeys

O comando Element Send Keys rola para a exibição do elemento de controle de formulário e então envia as teclas fornecidas para o elemento. No caso de o elemento não ser interagível por teclado, um erro de elemento não interagível é retornado.

O estado de entrada de tecla usado para a entrada pode ser limpo no meio da "digitação" enviando a tecla nula, que é U+E000 (NULL).

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

informação

Este comando de protocolo está incorporado nos seguintes métodos convenientes: addValue, setValue. É recomendado usar estes comandos em vez do protocolo.

Uso

browser.elementSendKeys(elementId, text)

Parâmetros

Nome	Tipo	Detalhes
elementId	String	o id de um elemento retornado em uma chamada anterior para Find Element(s)
text	string	string para enviar como toques de tecla para o elemento

Exemplo

examples.js

loading...

View on GitHub

---

getPageSource

O comando Get Page Source retorna uma serialização em string do DOM do documento ativo do contexto de navegação atual.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.getPageSource()

Exemplo

examples.js

loading...

View on GitHub

Retorna

• <string> pageSource: o DOM do documento ativo do contexto de navegação atual

---

executeScript

O comando Execute Script executa uma função JavaScript no contexto do contexto de navegação atual e retorna o valor de retorno da função.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

informação

Este comando de protocolo está incorporado no seguinte método conveniente: execute. É recomendado usar este comando em vez do protocolo.

Uso

browser.executeScript(script, args)

Parâmetros

Nome	Tipo	Detalhes
script	string	uma string, o corpo da função Javascript que você deseja executar
args	string, object, number, boolean, null, undefined[]	um array de valores JSON que serão desserializados e passados como argumentos para sua função

Exemplo

examples.js

loading...

View on GitHub

Retorna

• <*> result: Ou o valor de retorno do seu script, o cumprimento da Promessa retornada pelo seu script, ou o erro que foi o motivo da rejeição da Promessa retornada pelo seu script.

---

executeAsyncScript

O comando Execute Async Script faz com que o JavaScript seja executado como uma função anônima. Ao contrário do comando Execute Script, o resultado da função é ignorado. Em vez disso, um argumento adicional é fornecido como o argumento final para a função. Esta é uma função que, quando chamada, retorna seu primeiro argumento como a resposta.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

informação

Este comando de protocolo está incorporado no seguinte método conveniente: executeAsync. É recomendado usar este comando em vez do protocolo.

Uso

browser.executeAsyncScript(script, args)

Parâmetros

Nome	Tipo	Detalhes
script	string	uma string, o corpo da função Javascript que você deseja executar
args	string, object, number, boolean, null, undefined[]	um array de valores JSON que serão desserializados e passados como argumentos para sua função

Exemplo

examples.js

loading...

View on GitHub

Retorna

• <*> result: Ou o valor de retorno do seu script, o cumprimento da Promessa retornada pelo seu script, ou o erro que foi o motivo da rejeição da Promessa retornada pelo seu script.

---

getAllCookies

O comando Get All Cookies retorna todos os cookies associados ao endereço do documento ativo do contexto de navegação atual.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.getAllCookies()

Exemplo

examples.js

loading...

View on GitHub

Retorna

• <Object[]> cookies: Uma lista de cookies serializados. Cada cookie serializado tem vários campos opcionais que podem ou não ser retornados além de name e value.

---

addCookie

O comando Add Cookie adiciona um único cookie ao armazenamento de cookies associado ao endereço do documento ativo.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.addCookie(cookie)

Parâmetros

Nome	Tipo	Detalhes
cookie	object	Um objeto JSON representando um cookie. Deve ter pelo menos os campos name e value e pode ter mais, incluindo expiry-time e assim por diante

Exemplo

examples.js

loading...

View on GitHub

---

deleteAllCookies

O comando Delete All Cookies permite a exclusão de todos os cookies associados ao endereço do documento ativo.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.deleteAllCookies()

Exemplo

examples.js

loading...

View on GitHub

---

getNamedCookie

O comando Get Named Cookie retorna o cookie com o nome solicitado dos cookies associados no armazenamento de cookies do documento ativo do contexto de navegação atual. Se nenhum cookie for encontrado, um erro de cookie inexistente é retornado.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.getNamedCookie(name)

Parâmetros

Nome	Tipo	Detalhes
name	String	nome do cookie a ser recuperado

Exemplo

examples.js

loading...

View on GitHub

Retorna

• <Object> cookie: Um cookie serializado, com campos name e value. Há vários campos opcionais como path, domain e expiry-time que também podem estar presentes.

---

deleteCookie

O comando Delete Cookie permite que você exclua um único cookie pelo nome do parâmetro, ou todos os cookies associados ao endereço do documento ativo se o nome não for definido.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.deleteCookie(name)

Parâmetros

Nome	Tipo	Detalhes
name	String	nome do cookie a ser excluído

Exemplo

examples.js

loading...

View on GitHub

---

performActions

O comando Perform Actions é usado para executar ações complexas do usuário. Veja spec para mais detalhes.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.performActions(actions)

Parâmetros

Nome	Tipo	Detalhes
actions	object[]	uma lista de objetos, cada um dos quais representa uma fonte de entrada e suas ações associadas

---

releaseActions

O comando Release Actions é usado para liberar todas as teclas e botões do ponteiro que estão atualmente pressionados. Isso faz com que eventos sejam disparados como se o estado fosse liberado por uma série explícita de ações. Também limpa todo o estado interno dos dispositivos virtuais.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.releaseActions()

---

dismissAlert

O comando Dismiss Alert descarta uma caixa de diálogo simples se presente, caso contrário, erro. Uma solicitação para descartar um prompt de usuário, que pode não necessariamente ter um botão de descarte, tem o mesmo efeito que aceitá-lo.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.dismissAlert()

Exemplo

examples.js

loading...

View on GitHub

---

acceptAlert

O comando Accept Alert aceita uma caixa de diálogo simples se presente, caso contrário, erro.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.acceptAlert()

---

getAlertText

O comando Get Alert Text retorna a mensagem do prompt de usuário atual. Se não houver prompt de usuário atual, ele retorna um erro.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.getAlertText()

Exemplo

examples.js

loading...

View on GitHub

Retorna

• <string> alertText: A mensagem do prompt de usuário.

---

sendAlertText

O comando Send Alert Text define o campo de texto de um prompt de usuário window.prompt para o valor fornecido.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.sendAlertText(text)

Parâmetros

Nome	Tipo	Detalhes
text	string	string para definir o prompt

---

takeScreenshot

O comando Take Screenshot tira uma captura de tela da viewport do contexto de navegação de nível superior.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.takeScreenshot()

Retorna

• <string> screenshot: Os dados de imagem PNG codificados em base64 que compõem a captura de tela da viewport inicial.

---

takeElementScreenshot

O comando Take Element Screenshot tira uma captura de tela da região visível abrangida pelo retângulo delimitador de um elemento.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.takeElementScreenshot(elementId, scroll)

Parâmetros

Nome	Tipo	Detalhes
elementId	String	o id de um elemento retornado em uma chamada anterior para Find Element(s)
scroll opcional	boolean	rolar para visualizar o elemento. Padrão: true

Retorna

• <string> screenshot: Os dados de imagem PNG codificados em base64 que compõem a captura de tela da região visível do retângulo delimitador de um elemento após ele ter sido rolado para a visualização.

---

getElementComputedRole

Obter o papel WAI-ARIA computado de um elemento.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.getElementComputedRole(elementId)

Parâmetros

Nome	Tipo	Detalhes
elementId	String	o id de um elemento retornado em uma chamada anterior para Find Element(s)

Retorna

• <string> role: O resultado do cálculo do papel WAI-ARIA do elemento.

---

getElementComputedLabel

Obter o nome acessível do elemento.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.getElementComputedLabel(elementId)

Parâmetros

Nome	Tipo	Detalhes
elementId	String	o id de um elemento retornado em uma chamada anterior para Find Element(s)

Retorna

• <string> label: O resultado de um Cálculo de Nome e Descrição Acessível para o Nome Acessível do elemento.

---

setPermissions

Simula a modificação pelo usuário do estado de permissão de um PermissionDescriptor. Nota: esse recurso ainda não foi implementado em todos os navegadores.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.setPermissions(descriptor, state, oneRealm)

Parâmetros

Nome	Tipo	Detalhes
descriptor	object	Cada recurso poderoso tem um ou mais aspectos que os sites podem solicitar permissão para acessar. Para descrever esses aspectos, cada recurso define um subtipo de PermissionDescriptor para ser seu tipo de descritor de permissão. Nota: esse recurso ainda não foi implementado em todos os navegadores.
state	string	Determina se a permissão é concedida, negada ou solicitada.
oneRealm opcional	boolean	Se deve ou não aplicar permissões a todos os contextos de execução.

Exemplos

// definir permissões de midi
browser.setPermissions(
  { name: 'midi', sysex: true },
  'granted' // pode ser também "denied" ou "prompt"
);

// definir permissões de clipboard
browser.setPermissions({ name: 'clipboard-read' }, 'granted');
// agora você pode ler a área de transferência via, por exemplo
const clipboardText = await browser.execute(() => navigator.clipboard.readText());

---

generateTestReport

Gera um relatório para testes. Extensão para Reporting API. Nota: esse recurso ainda não foi implementado em todos os navegadores.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.generateTestReport(message, group)

Parâmetros

Nome	Tipo	Detalhes
message	string	Mensagem a ser exibida no relatório.
group opcional	string	Especifica o grupo de endpoint para entregar o relatório.

---

createMockSensor

Cria um sensor simulado para emular sensores como o Sensor de Luz Ambiente. Nota: esse recurso ainda não foi implementado em todos os navegadores.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.createMockSensor(mockSensorType, maxSamplingFrequency, minSamplingFrequency)

Parâmetros

Nome	Tipo	Detalhes
mockSensorType	string	Tipo de API de sensor para simular, por exemplo 'ambient-light'
maxSamplingFrequency opcional	number	Um double representando a frequência em Hz que é usado para definir a frequência máxima de amostragem suportada para o sensor simulado associado.
minSamplingFrequency opcional	number	Um double representando a frequência em Hz que é usado para definir a frequência mínima de amostragem suportada para o sensor simulado associado.

---

getMockSensor

Recupera informações sobre um determinado tipo de sensor simulado. Nota: esse recurso ainda não foi implementado em todos os navegadores.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.getMockSensor(type)

Parâmetros

Nome	Tipo	Detalhes
type	String	Tipo de sensor simulado para recuperar informações.

Retorna

• <object> sensorReading: Valores da leitura do sensor simulado.

---

updateMockSensor

Atualiza o tipo de sensor simulado. Nota: esse recurso ainda não foi implementado em todos os navegadores.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

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

Parâmetros

Nome	Tipo	Detalhes
type	String	Tipo de sensor simulado para atualizar informações.
mockSensorType	string	Tipo de API de sensor para simular, por exemplo 'ambient-light'
maxSamplingFrequency opcional	number	Um double representando a frequência em Hz que é usado para definir a frequência máxima de amostragem suportada para o sensor simulado associado.
minSamplingFrequency opcional	number	Um double representando a frequência em Hz que é usado para definir a frequência mínima de amostragem suportada para o sensor simulado associado.

---

deleteMockSensor

O comando Delete Session fecha quaisquer contextos de navegação de nível superior associados à sessão atual, encerra a conexão e finalmente fecha a sessão atual. Nota: esse recurso ainda não foi implementado em todos os navegadores.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.deleteMockSensor(type)

Parâmetros

Nome	Tipo	Detalhes
type	String	Tipo de sensor simulado para excluir.

---

setTimeZone

Simula a mudança de um fuso horário para fins de teste. Nota: esse recurso ainda não foi implementado em todos os navegadores.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.setTimeZone(time_zone)

Parâmetros

Nome	Tipo	Detalhes
time_zone	string	Nome do fuso horário, por exemplo Asia/Tokyo

---

addVirtualAuthenticator

Cria um Autenticador Virtual de software.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

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

Parâmetros

Nome	Tipo	Detalhes
protocol opcional	string	Valores válidos: 'ctap1/u2f', 'ctap2', 'ctap2_1'.
transport opcional	string	Valores válidos: 'usb', 'nfc', 'ble' ou 'internal'.
hasResidentKey opcional	boolean	Valores válidos: true, false.
hasUserVerification opcional	boolean	Valores válidos: true, false.
isUserConsenting opcional	boolean	Valores válidos: true, false.
isUserVerified opcional	boolean	Valores válidos: Um array contendo identificadores de extensão.
extensions opcional	string[]	Valores válidos: Até 3 entradas de Método de Verificação de Usuário.
uvm opcional	object[]

Retorna

• <string> authenticatorId: Retorna o ID de string do autenticador.

---

removeVirtualAuthenticator

Remove um Autenticador Virtual criado anteriormente.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.removeVirtualAuthenticator(authenticatorId)

Parâmetros

Nome	Tipo	Detalhes
authenticatorId	String	id do autenticador

---

addCredential

Injeta uma Fonte de Credencial de Chave Pública em um Autenticador Virtual existente.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

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

Parâmetros

Nome	Tipo	Detalhes
authenticatorId	String	ID do autenticador
credentialId	string	O ID da Credencial codificado usando Codificação Base64url.
isResidentCredential	boolean	Se definido como true, uma credencial detectável do lado do cliente é criada. Se definido como false, uma credencial do lado do servidor é criada em vez disso.
rpId	string	O ID da Parte Confiável ao qual a credencial está limitada.
privateKey	string	Um pacote de chave assimétrica contendo uma única chave privada por [RFC5958], codificado usando Codificação Base64url.
userHandle	string	O userHandle associado à credencial codificado usando Codificação Base64url. Esta propriedade pode não estar definida.
signCount	number	O valor inicial para um contador de assinatura associado à fonte de credencial de chave pública.
largeBlob opcional	string	O blob grande, por credencial, associado à fonte de credencial de chave pública, codificado usando Codificação Base64url. Esta propriedade pode não estar definida.

---

getCredentials

Retorna um objeto de Parâmetros de Credencial para cada Fonte de Credencial de Chave Pública armazenada em um Autenticador Virtual, independentemente de terem sido armazenadas usando Add Credential ou navigator.credentials.create().

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.getCredentials(authenticatorId)

Parâmetros

Nome	Tipo	Detalhes
authenticatorId	String	id do autenticador

Retorna

• <object[]> credentials: Retorna uma matriz de credenciais.

---

removeAllCredentials

Remove todas as Fontes de Credencial de Chave Pública armazenadas em um Autenticador Virtual.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.removeAllCredentials(authenticatorId)

Parâmetros

Nome	Tipo	Detalhes
authenticatorId	String	id do autenticador

---

removeCredential

Remove uma Fonte de Credencial de Chave Pública armazenada em um Autenticador Virtual.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.removeCredential(authenticatorId, credentialId)

Parâmetros

Nome	Tipo	Detalhes
authenticatorId	String	id do autenticador
credentialId	String	id da credencial

---

setUserVerified

O comando de extensão Set User Verified define a propriedade isUserVerified no Autenticador Virtual.

Comando do Protocolo WebDriver. Mais detalhes podem ser encontrados na documentação oficial do protocolo.

Uso

browser.setUserVerified(authenticatorId)

Parâmetros

Nome	Tipo	Detalhes
authenticatorId	String	id do autenticador