Pular para o conteúdo principal
Acessar Studio
Módulos

Browser

Browser

O módulo Browser é responsável por realizar todas as ações dentro de um navegador. Seus métodos podem ser acessados conforme o exemplo abaixo:

js
const navegador = await Browser.open["v1_0_0"]({
    url: `https://www.google.com.br/`,
    browser: `chrome`,
  })

Métodos​

apiRequest​

Método responsável por realizar requisições a uma determinada API através de sua url.

js
const response = await Browser.apiRequest["v1_0_0"]({
    browser: navegador,
    url: `https://api.com.br/api/v1/cars/${carsID}}/`,
    requestConfig: {
      method: 'GET',
    }
})

Parâmetros obrigatórios​

  • browser: Browser - espera uma instância do tipo Browser obtida através do método open.
  • url: String - URL da API.

Parâmetros opcionais​

  • requestConfig: Object - espera um objeto com as configurações da requisição. As opções são todas aquelas propriedades que estão disponíveis na classe da API Request que podem ser encontradas clicando aqui.

Retorno​

A constante ou variável criada, como a response do exemplo mostrado anteriormente, receberá o retorno da requisição.

checkBox​

Método responsável por marcar ou desmarcr um elemento do navegador.

js
await Browser.checkBox["v1_0_0"]({
    browser: navegador,
    selector: `#btn-checkBox`,
  })

Parâmetros obrigatórios​

  • browser: Browser - espera uma instância do tipo Browser obtida através do método open. Esse parâmetro não deve ser preenchido se o parâmetro element for passado.
  • selector: String - espera uma string para indicar o elemento que será clicado.
  • element: Element<SVGElement|HTMLElement> - espera um valor do tipo Element<SVGElement|HTMLElement> obtido através do método getElement. Esse valor é opcional se o parâmetro selector e browser for preenchido.

Parâmetros opcionais​

  • option: Boolean - espera um valor booleano que representará se será marcada ou desmarcada.
  • timeout: Number - espera um valor em milissegundos para indicar o tempo máximo de espera para que o elemento seja reconhecido. Caso não seja passado, o valor padrão é 30000 milissegundos.
  • state: String - espera uma string para indicar o estado do elemento que será clicado. Caso não seja passado, o valor padrão é visible. Os tipos de estados são:
    • visible - Elemento visível;
    • hidden: Elemento oculto;
    • attached: Elemento presente na estrutura do DOM (HTML da página);
    • detached: Elemento não presente na estrutura do DOM.

click​

Método responsável por clicar em um elemento do navegador.

js
await Browser.click["v1_0_0"]({
    browser: navegador,
    selector: `#btn-click`,
  })

Parâmetros obrigatórios​

  • browser: Browser - espera uma instância do tipo Browser obtida através do método open. Esse parâmetro não deve ser preenchido se o parâmetro element for passado.
  • selector: String - espera uma string para indicar o elemento que será clicado.
  • element: Element<SVGElement|HTMLElement> - espera um valor do tipo Element<SVGElement|HTMLElement> obtido através do método getElement. Esse valor é opcional se o parâmetro selector e browser for preenchido.

Parâmetros opcionais​

  • button: String - espera uma string para indicar o botão do mouse que será utilizado para clicar no elemento. Caso não seja passado, o valor padrão é left. Os tipos de botões são:
    • left - Botão esquerdo do mouse;
    • middle: Botão do meio do mouse;
    • right: Botão direito do mouse.
  • delay: Number - espera um valor em milissegundos para indicar o tempo de espera entre o pressionar e o soltar do botão do mouse. Caso não seja passado, o valor padrão é 0.
  • timeout: Number - espera um valor em milissegundos para indicar o tempo máximo de espera para que o elemento seja reconhecido. Caso não seja passado, o valor padrão é 30000 milissegundos.
  • state: String - espera uma string para indicar o estado do elemento que será clicado. Caso não seja passado, o valor padrão é visible. Os tipos de estados são:
    • visible - Elemento visível;
    • hidden: Elemento oculto;
    • attached: Elemento presente na estrutura do DOM (HTML da página);
    • detached: Elemento não presente na estrutura do DOM.
  • force: Boolean - espera um valor booleano para indicar se o clique será realizado ignorando os estados dos elementos. Caso não seja passado, o valor padrão é false.

clickLocator​

Ação responsável por clicar em um elemento a partir do seu XPath de uma determinada página já aberta em um navegador.

js
await Browser.clickLocator["v1_0_0"]({
    browser: navegador,
    xPath: `/html/body/div/div[1]/main/div[3]/div[2]/div/div/div/a/button`,
  })

Parâmetros obrigatórios​

  • browser: Browser - espera uma instância do tipo Browser obtida através do método open. Esse parâmetro não deve ser preenchido se o parâmetro element for passado.
  • xPath: String - espera uma string para indicar o elemento que será clicado.

clickText​

Ação responsável por realizar um clique em um elemento com um texto informado de uma determinada página já aberta. O clique pode ser no primeiro elemento com o texto informado que for encontrado, em todos ou com um índice indicado.

js
await Browser.clickText["v1_0_0"]({
    browser: navegador,
    text: `Clique aqui`,
    indice: 1
  })

Parâmetros obrigatórios​

  • browser: Browser - espera uma instância do tipo Browser obtida através do método open. Esse parâmetro não deve ser preenchido se o parâmetro element for passado.
  • text: String - espera uma string com o texto do elemento

Parâmetros opcionais​

  • indice: Number - espera um number com o indice do elemento.

close​

Método responsável por fechar um navegador.

js
await Browser.close["v1_0_0"]({
    browser: navegador,
  })

Parâmetros obrigatórios​

  • browser: Browser - espera uma instância do tipo Browser obtida através do método open.

downloadFile​

Método responsável por realizar o download de um arquivo através de um elemento ou seletor que possui o evento de download ou fazer o download através de uma URL.

js
await Browser.downloadFile["v2_0_0"]({
    browser: browser,
    selector: '#hl > a',
    downloadPath: 'C:/Users/Roberty/Downloads',
    filename: 'documento.pdf',
  })

Parâmetros obrigatórios​

  • browser: Browser - espera uma instância do tipo Browser obtida através do método open.
  • selector: String - espera uma string para indicar o elemento que possui o evento de download.
  • element: Element<SVGElement|HTMLElement> - espera um valor do tipo Element<SVGElement|HTMLElement> obtido através do método getElement. Esse valor é opcional se o parâmetro selector e browser for preenchido.
  • url: String - espera uma string para indicar a URL que será utilizada para fazer o download. Esse valor é opcional se o parâmetro selector e browser for preenchido.
  • downloadPath: String - espera uma string para indicar o caminho onde o arquivo será salvo.

Parâmetros opcionais​

  • filename: String - espera uma string para indicar o nome do arquivo que será salvo. Esse valor é opcional, caso não seja passado, o nome do arquivo será gerado aleatoriamente.

existElement​

Método responsável por verificar se um elemento existe na página.

js
const flagElement = await Browser.existElement["v1_0_0"]({
    browser: browser,
    selector: '#input-id',
  })

Parámetros obrigatórios​

  • browser: Browser - espera uma instância do tipo Browser obtida através do método open.
  • selector: String - espera uma string para indicar o elemento que será verificado.

Parâmetros opcionais​

  • timeout: Number - espera um valor em milissegundos para indicar o tempo máximo de espera para que o elemento seja reconhecido. Caso não seja passado, o valor padrão é 30000 milissegundos.
    • state: String - espera uma string para indicar o estado do elemento que será clicado. Caso não seja passado, o valor padrão é visible. Os tipos de estados são:
      • visible - Elemento visível;
      • hidden: Elemento oculto;
      • attached: Elemento presente na estrutura do DOM (HTML da página);
      • detached: Elemento não presente na estrutura do DOM.

Retorno​

A constante ou variável criada, como a flagElement mostrada no exemplo anterior, receberá true se o elemento existir na página e false caso contrário.

fillField​

Ação responsável por preencher elemento de uma determinada página já aberta em um navegador. Esse elemento podemos preencher a partir de sua label ou placeholder.

js
const fillField = await Browser.fillField["v1_0_0"]({
    browser: browser,
    text: string
    fillText: string
    option?: `placeholder` | `label` 
  })

Parámetros obrigatórios​

  • browser: Browser - espera uma instância do tipo Browser obtida através do método open.
  • text: String - espera uma string para indicar o elemento que será preenchido.
  • fillText: String - espera uma string com o texto que deseja preencher.

Parâmetros opcionais​

  • option: String - espera uma string para indicar a partir de qual texto irá preencher. Os tipos são:
    • placeholder - Placeholder;
    • label: Label.

Retorno​

A constante ou variável criada, como a flagElement mostrada no exemplo anterior, receberá true se o elemento existir na página e false caso contrário.

focus​

Método responsável por focar em um elemento do navegador.

js
const focusedElement = await Browser.focus["v1_0_0"]({
    browser: navegador,
    selector: `#input`,
  })

Parâmetros obrigatórios​

  • browser: Browser - espera uma instância do tipo Browser obtida através do método open. Esse valor é opcional se o parâmetro element for preenchido.
  • selector: String - espera uma string para indicar o elemento que será focado. Esse valor é opcional se o parâmetro element for preenchido.
  • element: Element<SVGElement|HTMLElement> - espera um valor do tipo Element<SVGElement|HTMLElement> obtido através do método getElement. Esse valor é opcional se o parâmetro selector e browser for preenchido.

Retorno​

A constante ou variável criada para receber o retorno do método, como a constante focusedELementmostrada no exemplo anterior, receberá um valor do tipo Element<SVGElement|HTMLElement>, ou seja, o elemento que foi focado.

getElement​

Método responsável por obter um elemento do navegador ou de um elemento já obtido por outro método getElement.

js
const elemento = await Browser.getElement["v1_0_0"]({
    browser: navegador,
    selector: `#btn-click`,
  })

Parâmetros obrigatórios​

  • browser: Browser - espera uma instância do tipo Browser obtida através do método open. Esse parâmetro não deve ser preenchido se o parâmetro element for passado.
  • selector: String - espera uma string para indicar o elemento que será obtido.
  • element: Element<SVGElement|HTMLElement> - espera um valor do tipo Element<SVGElement|HTMLElement> obtido através do método getElement. Esse valor é opcional se o parâmetro selector e browser for preenchido.

Parâmetros opcionais​

  • timeout: Number - espera um valor em milissegundos para indicar o tempo máximo de espera para que o elemento seja reconhecido. Caso não seja passado, o valor padrão é 30000 milissegundos.
  • state: String - espera uma string para indicar o estado do elemento que será obtido. Caso não seja passado, o valor padrão é visible. Os tipos de estados são:
    • visible - Elemento visível;
    • hidden: Elemento oculto;
    • attached: Elemento presente na estrutura do DOM;
    • detached: Elemento não presente na estrutura do DOM.

Retorno​

Na constante elemento mostrado no exemplo anterior, será retornado um valor do tipo Element<SVGElement|HTMLElement>, sendo assim, será possível utilizar todos os métodos pertencentes ao tipo Element<SVGElement|HTMLElement>. O usuário pode encontrar todos esses métodos clicando aqui.

getElementAttributeHtml​

Método responsável por obter o valor de um atributo html de um elemento.

js
const atributo = await Browser.getElementAttributeHtml["v1_0_0"]({
    browser: navegador,
    selector: `#btn-click`,
    attribute: `id`,
  })

Parâmetros obrigatórios​

  • browser: Browser - espera uma instância do tipo Browser obtida através do método open. Esse parâmetro não deve ser preenchido se o parâmetro element for passado.
  • selector: String - espera uma string para indicar de qual elemento será obtido o valor do atributo html.
  • element: Element<SVGElement|HTMLElement> - espera um valor do tipo Element<SVGElement|HTMLElement> obtido através do método getElement. Esse valor é opcional se o parâmetro selector e browser for preenchido.
  • attribute: String - espera uma string para indicar o atributo html que será obtido.

Retorno​

Na constante atributo mostrado no exemplo anterior, será retornada uma String com o valor presente no atributo html passado.

getElementHtml​

Método responsável por obter o valor de um elemento html.

js
const atributo = await Browser.getElementHtml["v1_0_0"]({
    browser: navegador,
    selector: `#btn-click`,
  })

Parâmetros obrigatórios​

  • browser: Browser - espera uma instância do tipo Browser obtida através do método open. Esse parâmetro não deve ser preenchido se o parâmetro element for passado.
  • selector: String - espera uma string para indicar de qual elemento será obtido o html.
  • element: Element<SVGElement|HTMLElement> - espera um valor do tipo Element<SVGElement|HTMLElement> obtido através do método getElement. Esse valor é opcional se o parâmetro selector e browser for preenchido.

Retorno​

Retorna uma String com o valor presente no elemento.

getElementText​

Método responsável por obter o valor de um elemento texto.

js
const atributo = await Browser.getElementText["v1_0_0"]({
    browser: navegador,
    selector: `#btn-click`,
  })

Parâmetros obrigatórios​

  • browser: Browser - espera uma instância do tipo Browser obtida através do método open. Esse parâmetro não deve ser preenchido se o parâmetro element for passado.
  • selector: String - espera uma string para indicar de qual elemento será obtido o texto.
  • element: Element<SVGElement|HTMLElement> - espera um valor do tipo Element<SVGElement|HTMLElement> obtido através do método getElement. Esse valor é opcional se o parâmetro selector e browser for preenchido.

Retorno​

Retorna uma String com o valor presente no elemento.

getElements​

Método responsável por obter vários elementos e armazená-los em um array.

js
const elementos = await Browser.getElements["v1_0_0"]({
    browser: navegador,
    selector: `#btn-click`,
  })

Parâmetros obrigatórios​

  • browser: Browser - espera uma instância do tipo Browser obtida através do método open. Esse parâmetro não deve ser preenchido se o parâmetro element for passado.
  • selector: String - espera uma string para indicar o elemento que será obtido.
  • element: Element<SVGElement|HTMLElement> - espera um valor do tipo Element<SVGElement|HTMLElement> obtido através do método getElement. Esse valor é opcional se o parâmetro selector e browser for preenchido.

Parâmetros opcionais​

  • timeout: Number - espera um valor em milissegundos para indicar o tempo máximo de espera para que o elemento seja reconhecido. Caso não seja passado, o valor padrão é 30000 milissegundos.
  • state: String - espera uma string para indicar o estado do elemento que será obtido. Caso não seja passado, o valor padrão é visible. Os tipos de estados são:
    • visible - Elemento visível;
    • hidden: Elemento oculto;
    • attached: Elemento presente na estrutura do DOM;
    • detached: Elemento não presente na estrutura do DOM.

Retorno​

Na constante elementos mostrado no exemplo anterior, será retornado um valor do tipo Element<SVGElement|HTMLElement>[], ou seja, um vetor de elementos do tipo Element<SVGElement|HTMLElement>. Assim o usuário poderá utilizar qualquer método ou propriedade de vetor para manipular os elementos presente nele. Clique aqui para ver todos os métodos e propriedades de um vetor.

getIframe​

Método responsável por obter um iframe.

js
const iframe = await Browser.getIframe["v1_0_0"]({
    browser: navegador,
    selector: `#iframe`,
  })

Parâmetros obrigatórios​

  • browser: Browser - espera uma instância do tipo Browser obtida através do método open. Esse parâmetro não deve ser preenchido se o parâmetro element for passado.
  • selector: String - espera uma string para indicar o elemento que será obtido.

Retorno​

  • iframe._args: Object - retorna um objeto com as configurações do iframe.
  • iframe._browser: Browser - retorna uma instância do tipo Browser com o contexto do iframe que foi obtido.
  • iframe._page: Page - retorna uma instância Page do Iframe.

getPageURL​

Método responsável por obter a URL da página atual.

js
const url = await Browser.getPageURL["v1_0_0"]({
    browser: navegador,
  })

Parametros obrigatórios​

  • browser: Browser - espera uma instância do tipo Browser obtida através do método open.

Retorno​

Retorna uma string que será a URL da página atual.

goto​

Método responsável por direcionar a página do navegador para uma determinada URL.

js
await Browser.goto["v1_0_0"]({
    browser: navegador,
    url: `https://roberty.app/`,
  })

Parâmetros obrigatórios​

  • browser: Browser - espera uma instância do tipo Browser obtida através do método open.
  • url: String - espera uma url válida para direcionar a página do navegador.

Parâmetros opcionais​

  • timeout: Number - espera um valor em milissegundos para indicar o tempo máximo de espera para a página ser carregada. Caso não seja passado, o valor padrão é 30000 milissegundos.
  • waitUntil: String - espera uma string para indicar o tipo de condição de espera para a página ser carregada. Caso não seja passado, o valor padrão é load. Os tipos de condição de espera são:
    • Load - Carregamento padrão: Aguarda o carregamento da página (opção padrão);
    • DOMContentLoaded: Aguarda o carregamento total da estrutura (componentes HTML sem o CSS e imagens) da página;
    • Carregamento via *network*: Aguarda o carregamento através dos recursos de rede. Se não houver nenhuma requisição de rede durante 0,5 segundo a ação entenderá que a página está completamente carregada.

open​

Método responsável por abrir um navegador e direcionar para uma URL.

js
const navegador = await Browser.open["v1_0_0"]({
    url: `https://roberty.app/`,
    browser: `chrome`,
  })

Parâmetros obrigatórios​

  • url: String - espera uma url válida para direcionar o navegador assim que ele abrir.
  • browser: String - espera o nome do navegador que será utlizado.

Parâmetros opcionais​

  • incognito: Boolean - espera um valor booleano para indicar se o navegador será aberto em modo incognito. Caso não seja passado, o valor padrão é false.
  • options: Object - espera um objeto com as configurações do navegador. Aceita todas as configurações de contexto de browser fornecidas pela biblioteca Playwright.

Retornos​

  • navegador._args: Object - retorna um objeto com as configurações do navegador.
  • navegador._browser: Browser - retorna uma instância do tipo Browser com o contexto do navegador que foi aberto.
  • navegador._page: Page - retorna uma instância do tipo Page com a página que foi aberta.

pressKey​

Método responsável por pressionar uma tecla em um elemento do navegador.

js
const pressedElement = await Browser.pressKey["v1_0_0"]({
    browser: navegador,
    selector: `#button-login`,
    key: `Enter`,
  })

Parâmetros obrigatórios​

  • browser: Browser - espera uma instância do tipo Browser obtida através do método open.
  • selector: String - espera uma string para indicar o elemento que será pressionado.
  • element: Element - espera um elemento obtido através do método getElement. Esse parâmetro é opcional se o parâmetro selector for preenchido.
  • key: String - espera uma string para indicar a tecla que será pressionada.

Parâmetros opcionais​

  • count: Number - espera um valor inteiro para indicar a quantidade de vezes que a tecla será pressionada no elemento. Caso não seja passado, o valor padrão é 1.
  • delay: Number - espera um valor em milissegundos para indicar o tempo de espera entre cada pressionamento. Caso não seja passado, o valor padrão é 0.

Retorno​

A constante ou variável criada para receber o retorno do método, como a constante pressedElementmostrada no exemplo anterior, receberá um valor do tipo Element<SVGElement|HTMLElement>, ou seja, o elemento que foi focado.

reload​

Método responsável por recarregar a página de uma instância de um navegador.

js
await Browser.reload["v1_0_0"]({
    browser: navegador,
  })

Parâmetros obrigatórios​

  • browser: Browser - espera uma instância do tipo Browser obtida através do método open.

Parâmetros opcionais​

  • timeout: Number - espera um valor em milissegundos para indicar o tempo máximo de espera para a página ser carregada. Caso não seja passado, o valor padrão é 30000 milissegundos.
  • waitUntil: String - espera uma string para indicar o tipo de condição de espera para a página ser carregada. Caso não seja passado, o valor padrão é load. Os tipos de condição de espera são:
    • Load - Carregamento padrão: Aguarda o carregamento da página (opção padrão);
    • DOMContentLoaded: Aguarda o carregamento total da estrutura (componentes HTML sem o CSS e imagens) da página;
    • Carregamento via *network*: Aguarda o carregamento através dos recursos de rede. Se não houver nenhuma requisição de rede durante 0,5 segundo a ação entenderá que a página está completamente carregada.

screenShot​

Método responsável por capturar a imagem de um elemento do navegador.

js
const screenshot = await Browser.screenshot["v1_0_0"]({
    browser: navegador,
    selector: `#button-login`,
    filePath: 'C:/Users/Murillo Candioto/Download',
})

Parâmetros obrigatórios​

  • browser: Browser - espera uma instância do tipo Browser obtida através do método open.
  • selector: String - espera uma string para indicar o elemento que será capturado.
  • element: Element - espera um elemento obtido através do método getElement. Esse parâmetro é opcional se o parâmetro selector for preenchido.
  • filePath: String - espera uma string para indicar o caminho em que a captura do elemento será salva.

Parâmetros opcionais​

  • fileName: String - espera uma string para indicar o nome do arquivo que será salvo. Caso não seja passado, será gerado um nome aleatório.
  • fileType: String - espera uma string para indicar o tipo de arquivo que será salvo. Caso não seja passado, será gerado um arquivo JPEG.

Retorno​

A constante ou variável criada para receber o retorno do método, como a constante screenshot mostrada no exemplo anterior, receberá um valor do tipo String, ou seja, o caminho do arquivo salvo.

typeInput​

Método responsável por digitar um texto em um elemento do navegador.

js
const typedElement = await Browser.typeInput["v1_0_0"]({
    browser: navegador,
    selector: `#input-login`,
    value: `usuario`,
  })

Parâmetros obrigatórios​

  • browser: Browser - espera uma instância do tipo Browser obtida através do método open.
  • selector: String - espera uma string para indicar o elemento que será digitado.
  • element: Element - espera um elemento obtido através do método getElement. Esse parâmetro é opcional se o parâmetro selector for preenchido.
  • value: String - espera uma string que será o texto a ser digitado no elemento.

Parâmetros opcionais​

  • clearBefore: Boolean - espera um valor booleano para indicar se o elemento deverá ser limpo antes de digitar o texto. Caso não seja passado, o valor padrão é false.
  • delay: Number - espera um valor em milissegundos para indicar o tempo de espera entre caractere que será digitado. Caso não seja passado, o valor padrão é 0.
  • state: String - espera uma string para indicar o estado do elemento que será clicado. Caso não seja passado, o valor padrão é visible. Os tipos de estados são:
    • visible - Elemento visível;
    • hidden: Elemento oculto;
    • attached: Elemento presente na estrutura do DOM (HTML da página);
    • detached: Elemento não presente na estrutura do DOM.

Retorno​

A constante ou variável criada para receber o retorno do método, como a constante typedElementmostrada no exemplo anterior, receberá um valor do tipo Element<SVGElement|HTMLElement>, ou seja, o elemento que foi focado.

upload​

Método responsável por fazer o upload de um arquivo em um elemento do navegador.

js
const uploadedElement = await Browser.upload["v1_0_0"]({
    browser: navegador,
    selector: `#input-file`,
    files: [`C:/Users/Roberty/Download/file1.txt`,`C:/Users/Roberty/Download/file2.txt`]
  })

Parâmetros obrigatórios​

  • browser: Browser - espera uma instância do tipo Browser obtida através do método open.
  • selector: String - espera uma string para indicar o elemento que será clicado.
  • element: Element - espera um elemento obtido através do método getElement. Esse parâmetro é opcional se o parâmetro selector for preenchido.
  • files: String[] - espera um array de strings com os caminhos dos arquivos que serão enviados.

Parâmetros opcionais​

  • noWaitAfter: Boolean - espera um valor booleano para indicar se o método deverá aguardar o fim do upload. Caso não seja passado, o valor padrão é false.
  • timeout: Number - espera um valor em milissegundos para indicar o tempo de espera para o fim do upload. Caso não seja passado, o valor padrão é 0.

Retorno​

A constante ou variável criada para receber o retorno do método, como a constante uploadedElement mostrada no exemplo anterior, receberá um valor do tipo Element<SVGElement|HTMLElement>, ou seja, o elemento que recebeu os arquivos.

waitForNavigation​

Método responsável por esperar a página do navegador ser carregada.

js
await Browser.waitForNavigation["v1_0_0"]({
    browser: navegador,
  })

Parâmetros obrigatórios​

  • browser: Browser - espera uma instância do tipo Browser obtida através do método open.

Parâmetros opcionais​

  • timeout: Number - espera um valor em milissegundos para indicar o tempo máximo de espera para a página ser carregada. Caso não seja passado, o valor padrão é 30000 milissegundos.
  • waitUntil: String - espera uma string para indicar o tipo de condição de espera para a página ser carregada. Caso não seja passado, o valor padrão é load. Os tipos de condição de espera são:
    • Load - Carregamento padrão: Aguarda o carregamento da página (opção padrão);
    • DOMContentLoaded: Aguarda o carregamento total da estrutura (componentes HTML sem o CSS e imagens) da página;
    • Carregamento via *network*: Aguarda o carregamento através dos recursos de rede. Se não houver nenhuma requisição de rede durante 0,5 segundo a ação entenderá que a página está completamente carregada.

newTab​

Método responsável por abrir uma nova página em um navegador. O navegador pode ser um que já está aberto ou um que pode ser aberto pela própria ação. Basta passar o campo browser ao invés de schemaBrowser para que a página abra em um novo navegador.

js
const pagina = await Browser.newTab.v1_0_0({
      schemaBrowser: navegador,
      url: 'https://google.com'
    })

Parâmetros obrigatórios​

  • url: String - espera uma url válida que abrirá na nova página.

Parâmetros opcionais​

  • schemaBrowser: Browser - espera uma instância do tipo Browser que pode ser obtida através dos métodos open, newTab, getTab getTabFromList ou getMostRecentTab. Este campo só é opcional se o campo browser for preenchido.
  • browser: String - espera o nome do navegador instalado na máquina do usuário, sendo eles chrome ou edge. Este campo é opcional se o campo schemaBrowser for preenchido.
  • headless: Boolean - espera um valor verdadeiro ou falso que indica se o navegador aparecerá na tela ou executará escondido. Só será necessário passar esse campo quando o browser for preenchido.
  • incognito: Boolean - espera um valor verdadeiro ou falso que indica se o navegador abrirá em modo anônimo. Só será necessário passar esse campo quando o browser for preenchido.
  • keepOpened: Boolean - espera um valor verdadeiro ou falso que indica se o navegador continuará aberto após a execução ou não. Só será necessário passar esse campo quando o browser for preenchido.
  • timeout: Number - espera um valor em milissegundos para indicar o tempo máximo de espera para a página ser carregada. Caso não seja passado, o valor padrão é 30000 milissegundos.
  • waitUntil: String - espera uma string para indicar o tipo de condição de espera para a página ser carregada. Caso não seja passado, o valor padrão é load. Os tipos de condição de espera são:
    • Load - Carregamento padrão: Aguarda o carregamento da página (opção padrão);
    • DOMContentLoaded: Aguarda o carregamento total da estrutura (componentes HTML sem o CSS e imagens) da página;
    • Carregamento via *network*: Aguarda o carregamento através dos recursos de rede. Se não houver nenhuma requisição de rede durante 0,5 segundo a ação entenderá que a página está completamente carregada.

Retornos​

  • pagina._args: Object - retorna um objeto com as configurações do navegador em que está a nova página.
  • pagina._browser: Browser - retorna uma instância do tipo Browser com o contexto do navegador em que está a nova página.
  • pagina._page: Page - retorna uma instância do tipo Page com a página que foi aberta.

closeTab​

Método responsável por fechar uma página específica aberta em um navegador.

js
await Browser.closeTab.v1_0_0({
      browser: pagina
    })

Parâmetros obrigatórios​

getTab​

Método responsável por obter uma página do navegador que foi aberta fora de contexto, como por exemplo, clicar em um botão que abre uma nova página e é preciso manipular ela com as ações.

js
const pagina = await Browser.getTab.v1_0_0({
      schemaBrowser: navegador,
      getBy: `url`,
      value: `google.com`

    })

Parâmetros obrigatórios​

  • schemaBrowser: Browser - espera uma instância do tipo Browser que pode ser obtida através dos métodos open, newTab, getTab,getTabFromList ou getMostRecentTab.
  • getBy: Este campo ditará o que será usado para pegar a página que foi aberta fora de contexto. Uma das opções abaixo deverá ser escolhida:
    • url: String - nesta opção a página será procurada através de sua url.
    • selector: String - nesta opção a página será procurada através do seletor de um elemento que existe nela.
    • title: String - nesta opção a página será procurada através do título da página.
    • position: Number - pegará a página que está na posição passada.
  • value: espera o valor de acordo com o campo anterior getBy.

Retornos​

  • pagina._args: Object - retorna um objeto com as configurações do navegador em que está a página obtida.
  • pagina._browser: Browser - retorna uma instância do tipo Browser com o contexto do navegador em que está a página obtida.
  • pagina._page: Page - retorna uma instância do tipo Page com a página que foi aberta.

getAllTabs​

Método responsável por obter todas as páginas abertas em um navegador.

js
const todasPaginas = await Browser.getAllTabs.v1_0_0({
      browser: navegador
    })

Parâmetros obrigatórios​

Retornos​

O retorno deste método é um array contendo a estrutura de todas as páginas obtidas. A estrutura contém as seguintes propriedades:

  • pagina._args: Object - retorna um objeto com as configurações do navegador.
  • pagina._browser: Browser - retorna uma instância do tipo Browser com o contexto do navegador.
  • pagina._page: Page - retorna uma instância do tipo Page com a página que foi aberta.

getTabFromList​

Método responsável por obter uma página que está presente na lista de páginas obtidas pela a ação getAllTabs

js
const pagina = await Browser.getTabFromList.v1_0_0({
      listSchemaBrowser: todasPaginas,
      getBy: `url`,
      value: `google.com`

    })

Parâmetros obrigatórios​

  • listSchemaBrowser: Browser - espera uma lista que pode ser obtida através do método getAllTabs.
  • getBy: Este campo ditará o que será usado para pegar a página que está dentro da lista. Uma das opções abaixo deverá ser escolhida:
    • url: String - nesta opção a página será procurada através de sua url.
    • selector: String - nesta opção a página será procurada através do seletor de um elemento que existe nela.
    • title: String - nesta opção a página será procurada através do título da página.
    • position: Number - pegará a página que está na posição passada.
  • value: espera o valor de acordo com o campo anterior getBy.

Retornos​

  • pagina._args: Object - retorna um objeto com as configurações do navegador em que está a página obtida.
  • pagina._browser: Browser - retorna uma instância do tipo Browser com o contexto do navegador em que está a página obtida.
  • pagina._page: Page - retorna uma instância do tipo Page com a página que foi aberta.

getMostRecentTab​

Método responsável por obter uma página do navegador que foi aberta fora de contexto, como por exemplo, clicar em um botão que abre uma nova página e é preciso manipular ela com as ações.

js
const pagina = await Browser.getMostRecentTab.v1_0_0({
      schemaBrowser: navegador,
    })

Parâmetros obrigatórios​

Retornos​

  • pagina._args: Object - retorna um objeto com as configurações do navegador em que está a página obtida.
  • pagina._browser: Browser - retorna uma instância do tipo Browser com o contexto do navegador em que está a página obtida.
  • pagina._page: Page - retorna uma instância do tipo Page com a página que foi aberta.

commonCaptchaSolve​

Método responsável por resolver um captcha de imagem no navegador que possuí símbolos escondendo as letras e números.

js
const commonCaptchaSolve = await Browser.commonCaptchaSolve["v1_0_0"]({
    browser: navegador,
    selectorImg: `#imagemCaptcha`,
    selectorInput: '#input',
})

Parâmetros obrigatórios​

  • browser: Browser - espera uma instância do tipo Browser obtida através do método open.
  • selectorImg: String - espera uma string que deve ser o seletor do elemento onde está a imagem do captcha.
  • selectorInput: String - espera uma string que deve ser o seletor do campo de preenchimento do captcha.

Retorno​

Essa ação não possuí retornos.

reCaptchaImageSolve​

Ação responsável por resolver captchas de browser que necessitam que clique em determinadas imagens de um mesmo aspecto.

js
  const reCaptchaImageSolve = await Browser.reCaptchaImageSolve.v1_0_0({
    browser: navegador
  })

Parâmetros obrigatórios​

Retornos​

  • reCaptchaImageSolve.value: Value - Retorna a resposta da resolução do captcha.

reCaptchaSolve​

Ação responsável por resolver captchas de browser que necessitam de apenas um clique que confirma "não ser um robô".

js
  const recaptchaSolve = await Browser.reCaptchaSolve.v1_0_0({
    browser: navegador
  })

Parâmetros obrigatórios​

Retornos​

  • recaptchaSolve.value: Value - Retorna a resposta da resolução do captcha.

setSelectOptions​

Ação responsável por definir um valor, tanto por texto quanto por posição, em um menu de opções.

js
  const setSelectOptions = await Browser.setSelectOptions.v1_0_0({
    value: '',
    browser: navegador,
    selector: ''
  })

Parâmetros obrigatórios​

  • browser: Browser - espera uma instância do tipo Browser que pode ser obtida através dos métodos open, newTab, getTab ou getTabFromList.
  • value: String/Number - Este campo deve ser preenchido com o valor referente ao valor que se deseja selecionar.
  • selector: String - espera uma string para indicar o elemento que será clicado.

Parâmetros opcionais​

  • type: Este campo permite ao usuário escolher qual é o tipo do valor inserido no campos anterior. As opções são:
    • Posição: Number - Seleciona o valor de acordo com a posição informada;
    • Texto: String - Seleciona o valor Obtém o elemento se ele estiver invisível/escondido para visualização do usuário, porém se encontra na estrutura da página.