Saltar al contenido principal

Protocolo WebDriver

newSession

El comando New Session crea una nueva sesión de WebDriver con el nodo de punto final. Si la creación falla, se devuelve un error de sesión no creada.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.newSession(capabilities)
Parámetros
NombreTipoDetalles
capabilitiesobjectun objeto JSON, el conjunto de capacidades que finalmente se fusionó y coincidió en el algoritmo de procesamiento de capacidades
Devuelve
  • <Object> session: Objeto que contiene el sessionId y las capacidades de la sesión WebDriver creada.

deleteSession

El comando Delete Session cierra todos los contextos de navegación de nivel superior asociados a la sesión actual, termina la conexión y finalmente cierra la sesión actual.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.deleteSession(deleteSessionOpts)
Parámetros
NombreTipoDetalles
deleteSessionOpts
opcional
objectObjeto que contiene opciones para el comando deleteSession, por ejemplo { shutdownDriver: boolean }

status

El comando Status devuelve información sobre si un extremo remoto está en un estado en el que puede crear nuevas sesiones y además puede incluir información meta arbitraria que es específica de la implementación.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.status()
Ejemplo
examples.js
loading...
Devuelve
  • <Object> status: Objeto que contiene el estado del controlador.

getTimeouts

El comando Get Timeouts obtiene duraciones de tiempo de espera asociadas con la sesión actual.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.getTimeouts()
Ejemplo
examples.js
loading...
Devuelve
  • <Object> timeouts: Objeto que contiene duraciones de tiempo de espera para script, pageLoad e implicit.

setTimeouts

El comando Set Timeouts establece duraciones de tiempo de espera asociadas con la sesión actual. Los tiempos de espera que se pueden controlar se enumeran en la tabla de tiempos de espera de sesión a continuación.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.setTimeouts(implicit, pageLoad, script)
Parámetros
NombreTipoDetalles
implicit
opcional
numberentero en ms para el tiempo de espera implícito de la sesión
pageLoad
opcional
numberentero en ms para el tiempo de carga de página de la sesión
script
opcional
numberentero en ms para el tiempo de espera de script de la sesión
Ejemplo
examples.js
loading...

getUrl

El comando Get Current URL devuelve la URL del contexto de navegación de nivel superior actual.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.getUrl()
Ejemplo
examples.js
loading...
Devuelve
  • <string> url: URL del documento activo del contexto de navegación de nivel superior actual

El comando navigateTo (go) se utiliza para hacer que el agente de usuario navegue a una nueva ubicación en el contexto de navegación de nivel superior actual.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

información

Este comando de protocolo está integrado en el siguiente método conveniente: url. Se recomienda usar este comando en su lugar.

Uso
browser.navigateTo(url)
Parámetros
NombreTipoDetalles
urlstringcadena que representa una URL absoluta (comenzando con http(s)), posiblemente incluyendo un fragmento (#...), también podría ser un esquema local (about: etc)
Ejemplo
examples.js
loading...

back

El comando Back hace que el navegador retroceda un paso en el historial de sesión conjunto del contexto de navegación de nivel superior actual. Esto es equivalente a presionar el botón de retroceso en la interfaz del navegador o llamar a window.history.back.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.back()
Ejemplo
examples.js
loading...

forward

El comando Forward hace que el navegador avance un paso en el historial de sesión conjunto del contexto de navegación de nivel superior actual.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.forward()
Ejemplo
examples.js
loading...

refresh

El comando Refresh hace que el navegador recargue la página en el contexto de navegación de nivel superior actual.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.refresh()
Ejemplo
examples.js
loading...

getTitle

El comando Get Title devuelve el título del documento del contexto de navegación de nivel superior actual, equivalente a llamar a document.title.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.getTitle()
Ejemplo
examples.js
loading...
Devuelve
  • <string> title: Devuelve una cadena que es igual a document.title del contexto de navegación de nivel superior actual.

getWindowHandle

El comando Get Window Handle devuelve el identificador de ventana para el contexto de navegación de nivel superior actual. Se puede usar como argumento para Switch To Window.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.getWindowHandle()
Ejemplo
examples.js
loading...
Devuelve
  • <string> handle: Devuelve una cadena que es el identificador de ventana para el contexto de navegación de nivel superior actual.

closeWindow

El comando Close Window cierra el contexto de navegación de nivel superior actual. Una vez hecho esto, si no hay más contextos de navegación de nivel superior abiertos, la propia sesión de WebDriver se cierra.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.closeWindow()
Ejemplo
examples.js
loading...

switchToWindow

El comando Switch To Window se utiliza para seleccionar el contexto de navegación de nivel superior actual para la sesión actual, es decir, el que se utilizará para procesar los comandos.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

información

Este comando de protocolo está integrado en el siguiente método conveniente: switchWindow. Se recomienda usar este comando en su lugar.

Uso
browser.switchToWindow(handle)
Parámetros
NombreTipoDetalles
handlestringuna cadena que representa un identificador de ventana, debe ser una de las cadenas que se devolvieron en una llamada a getWindowHandles
Ejemplo
examples.js
loading...

createWindow

Crea un nuevo contexto de navegación de nivel superior.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.createWindow(type)
Parámetros
NombreTipoDetalles
typestringEstablecido en 'tab' si la ventana recién creada comparte una ventana a nivel de sistema operativo con el contexto de navegación actual, o 'window' en caso contrario.
Ejemplo
examples.js
loading...
Devuelve
  • <Object> window: Objeto de nueva ventana que contiene 'handle' con el valor del identificador y 'type' con el valor del tipo de ventana creado

getWindowHandles

El comando Get Window Handles devuelve una lista de identificadores de ventana para cada contexto de navegación de nivel superior abierto. El orden en que se devuelven los identificadores de ventana es arbitrario.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.getWindowHandles()
Ejemplo
examples.js
loading...
Devuelve
  • <String[]> handles: Un array que es una lista de identificadores de ventana.

printPage

El comando Print Page renderiza el documento a un documento PDF paginado. Nota: Chrome actualmente solo admite esto en modo headless, ver crbug753118).

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.printPage(orientation, scale, background, width, height, top, bottom, left, right, shrinkToFit, pageRanges)
Parámetros
NombreTipoDetalles
orientation
opcional
stringorientación de la página. Por defecto: portrait
scale
opcional
numberescala de la página. Por defecto: 1
background
opcional
booleanfondo de la página. Por defecto: false
width
opcional
numberancho de página en cm. Por defecto: 21.59 de la página
height
opcional
numberaltura de página en cm. Por defecto: 27.94 de la página
top
opcional
numbermargen de página en cm desde el margen superior. Por defecto: 1
bottom
opcional
numbermargen de página en cm desde el margen inferior. Por defecto: 1
left
opcional
numbermargen de página en cm desde el margen izquierdo. Por defecto: 1
right
opcional
numbermargen de página en cm desde el margen derecho. Por defecto: 1
shrinkToFit
opcional
booleanreducir pdf para ajustarse a la página. Por defecto: true
pageRanges
opcional
object[]rangos de página. Por defecto []
Ejemplo
examples.js
loading...
Devuelve
  • <string> pdf: La representación PDF codificada en base64 del documento paginado.

switchToFrame

El comando Switch To Frame se utiliza para seleccionar el contexto de navegación de nivel superior actual o un contexto de navegación hijo del contexto de navegación actual para usar como contexto de navegación actual para comandos posteriores.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

precaución

Este comando de protocolo está obsoleto
Este comando está obsoleto y recomendamos a todos usar switchFrame en su lugar para cambiar a frames. Lee más sobre este comando en https://webdriver.io/docs/api/browser/switchFrame.

Uso
browser.switchToFrame(id)
Parámetros
NombreTipoDetalles
idnumber, object, nulluno de tres tipos posibles: null: esto representa el contexto de navegación de nivel superior (es decir, no un iframe), un Number, que representa el índice del objeto de ventana correspondiente a un frame, un objeto Element recibido usando findElement.
Ejemplo
examples.js
loading...

switchToParentFrame

El comando Switch to Parent Frame establece el contexto de navegación actual para futuros comandos al padre del contexto de navegación actual.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.switchToParentFrame()
Ejemplo
examples.js
loading...

getWindowRect

El comando Get Window Rect devuelve el tamaño y la posición en la pantalla de la ventana del sistema operativo correspondiente al contexto de navegación de nivel superior actual.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

información

Este comando de protocolo está integrado en el siguiente método conveniente: getWindowSize. Se recomienda usar este comando en su lugar.

Uso
browser.getWindowRect()
Ejemplo
examples.js
loading...
Devuelve
  • <Object> windowRect: Una representación JSON de un objeto "window rect". Tiene 4 propiedades: x, y, width y height.

setWindowRect

El comando Set Window Rect altera el tamaño y la posición de la ventana del sistema operativo correspondiente al contexto de navegación de nivel superior actual.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

información

Este comando de protocolo está integrado en el siguiente método conveniente: setWindowSize. Se recomienda usar este comando en su lugar.

Uso
browser.setWindowRect(x, y, width, height)
Parámetros
NombreTipoDetalles
xnumber, nullel atributo screenX del objeto window
ynumber, nullel atributo screenY del objeto window
widthnumber, nullel ancho de las dimensiones externas del contexto de navegación de nivel superior, incluido el chrome del navegador, etc...
heightnumber, nullla altura de las dimensiones externas del contexto de navegación de nivel superior, incluido el chrome del navegador, etc...
Ejemplo
examples.js
loading...
Devuelve
  • <Object> windowRect: Una representación JSON de un objeto "window rect" basado en el nuevo estado de la ventana.

maximizeWindow

El comando Maximize Window invoca la operación específica del administrador de ventanas "maximizar", si la hay, en la ventana que contiene el contexto de navegación de nivel superior actual. Normalmente, esto aumenta la ventana al tamaño máximo disponible sin ir a pantalla completa.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.maximizeWindow()
Ejemplo
examples.js
loading...
Devuelve
  • <Object> windowRect: Una representación JSON de un objeto "window rect" basado en el nuevo estado de la ventana.

minimizeWindow

El comando Minimize Window invoca la operación específica del administrador de ventanas "minimizar", si la hay, en la ventana que contiene el contexto de navegación de nivel superior actual. Normalmente, esto oculta la ventana en la bandeja del sistema.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.minimizeWindow()
Devuelve
  • <Object> windowRect: Una representación JSON de un objeto "window rect" del contexto de navegación de nivel superior (nuevo) actual.

fullscreenWindow

El comando Fullscreen Window invoca la operación específica del administrador de ventanas "pantalla completa", si la hay, en la ventana que contiene el contexto de navegación de nivel superior actual. Normalmente, esto aumenta la ventana al tamaño de la pantalla física y puede ocultar elementos de chrome del navegador como barras de herramientas.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.fullscreenWindow()
Devuelve
  • <Object> windowRect: Una representación JSON de un objeto "window rect" del contexto de navegación de nivel superior (nuevo) actual.

findElement

El comando Find Element se utiliza para encontrar un elemento en el contexto de navegación actual que se puede utilizar para futuros comandos. Este comando devuelve una representación JSON del elemento que se puede pasar al comando $ para transformar la referencia en un elemento WebdriverIO extendido.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

información

Este comando de protocolo está integrado en el siguiente método conveniente: $. Se recomienda usar este comando en su lugar.

Uso
browser.findElement(using, value)
Parámetros
NombreTipoDetalles
usingstringuna estrategia de localización de elementos válida
valuestringel selector real que se utilizará para encontrar un elemento
Ejemplo
examples.js
loading...
Devuelve
  • <object> element: Una representación JSON de un objeto de elemento, por ejemplo, { 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }.

findElementFromShadowRoot

El comando Find Element From Shadow Root se utiliza para encontrar un elemento dentro de la raíz de sombra de un elemento que se puede utilizar para futuros comandos. Este comando devuelve una representación JSON del elemento que se puede pasar al comando $ para transformar la referencia en un elemento WebdriverIO extendido.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

información

Este comando de protocolo está integrado en el siguiente método conveniente: shadow$. Se recomienda usar este comando en su lugar.

Uso
browser.findElementFromShadowRoot(shadowId, using, value)
Parámetros
NombreTipoDetalles
shadowIdStringID de elemento de un elemento raíz de sombra
usingstringuna estrategia de localización de elementos válida
valuestringel selector real que se utilizará para encontrar un elemento
Ejemplo
examples.js
loading...
Devuelve
  • <object> element: Una representación JSON de un objeto de elemento shadow, por ejemplo, { 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }.

findElements

El comando Find Elements se utiliza para encontrar elementos en el contexto de navegación actual que pueden utilizarse para futuros comandos. Este comando devuelve una matriz de representación JSON de los elementos que se pueden pasar al comando $ para transformar la referencia en un elemento WebdriverIO extendido (Ver findElement).

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

información

Este comando de protocolo está integrado en el siguiente método conveniente: $$. Se recomienda usar este comando en su lugar.

Uso
browser.findElements(using, value)
Parámetros
NombreTipoDetalles
usingstringuna estrategia de localización de elementos válida
valuestringel selector real que se utilizará para encontrar un elemento
Ejemplo
examples.js
loading...
Devuelve
  • <object[]> elements: Una lista JSON (posiblemente vacía) de representaciones de un objeto de elemento, por ejemplo, [{ 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }].

findElementsFromShadowRoot

El comando Find Elements se utiliza para encontrar elementos dentro de la raíz de sombra de un elemento que pueden utilizarse para futuros comandos. Este comando devuelve una matriz de representación JSON de los elementos que se pueden pasar al comando $ para transformar la referencia en un elemento WebdriverIO extendido (Ver findElement).

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

información

Este comando de protocolo está integrado en el siguiente método conveniente: shadow$$. Se recomienda usar este comando en su lugar.

Uso
browser.findElementsFromShadowRoot(shadowId, using, value)
Parámetros
NombreTipoDetalles
shadowIdStringID de elemento de un elemento raíz de sombra
usingstringuna estrategia de localización de elementos válida
valuestringel selector real que se utilizará para encontrar un elemento
Ejemplo
examples.js
loading...
Devuelve
  • <object[]> elements: Una lista JSON (posiblemente vacía) de representaciones de un objeto de elemento, por ejemplo, { 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }.

findElementFromElement

El comando Find Element From Element se utiliza para encontrar un elemento a partir de un elemento web en el contexto de navegación actual que se puede utilizar para futuros comandos. Este comando devuelve una representación JSON del elemento que se puede pasar al comando $ para transformar la referencia en un elemento WebdriverIO extendido (Ver findElement).

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

información

Este comando de protocolo está integrado en el siguiente método conveniente: $. Se recomienda usar este comando en su lugar.

Uso
browser.findElementFromElement(elementId, using, value)
Parámetros
NombreTipoDetalles
elementIdStringel id de un elemento devuelto en una llamada anterior a Find Element(s)
usingstringuna estrategia de localización de elementos válida
valuestringel selector real que se utilizará para encontrar un elemento
Ejemplo
examples.js
loading...
Devuelve
  • <object> element: Una representación JSON de un objeto de elemento, por ejemplo, { 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }.

findElementsFromElement

El comando Find Elements From Element se utiliza para encontrar elementos a partir de un elemento web en el contexto de navegación actual que pueden utilizarse para futuros comandos. Este comando devuelve una matriz de representación JSON de los elementos que se pueden pasar al comando $ para transformar la referencia en un elemento WebdriverIO extendido (Ver findElement).

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

información

Este comando de protocolo está integrado en el siguiente método conveniente: $$. Se recomienda usar este comando en su lugar.

Uso
browser.findElementsFromElement(elementId, using, value)
Parámetros
NombreTipoDetalles
elementIdStringel id de un elemento devuelto en una llamada anterior a Find Element(s)
usingstringuna estrategia de localización de elementos válida
valuestringel selector real que se utilizará para encontrar un elemento
Ejemplo
examples.js
loading...
Devuelve
  • <object[]> elements: Una lista JSON (posiblemente vacía) de representaciones de un objeto de elemento, por ejemplo, [{ 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }].

getElementShadowRoot

Obtiene el objeto raíz de sombra de un elemento. El objeto de resultado se puede utilizar para buscar elementos dentro de esta raíz de sombra utilizando, por ejemplo, findElementFromShadowRoots o findElementsFromShadowRoots.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

información

Este comando de protocolo está integrado en el siguiente método conveniente: shadow$. Se recomienda usar este comando en su lugar.

Uso
browser.getElementShadowRoot(elementId)
Parámetros
NombreTipoDetalles
elementIdStringel id de un elemento devuelto en una llamada anterior a Find Element(s)
Ejemplo
examples.js
loading...
Devuelve
  • <string> shadowRoot: Una representación JSON de una raíz de sombra de elemento, por ejemplo, { 'shadow-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }.

getActiveElement

Get Active Element devuelve el elemento activo del elemento del documento del contexto de navegación actual. Este comando devuelve una representación JSON del elemento que se puede pasar al comando $ para transformar la referencia en un elemento WebdriverIO extendido (Ver findElement).

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.getActiveElement()
Ejemplo
examples.js
loading...
Devuelve
  • <string> element: Una representación JSON de un objeto de elemento, por ejemplo, { 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }.

isElementSelected

Is Element Selected determina si el elemento referenciado está seleccionado o no. Esta operación solo tiene sentido en elementos de entrada de los estados Checkbox y Radio Button, o elementos de opción.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

información

Este comando de protocolo está integrado en el siguiente método conveniente: isSelected. Se recomienda usar este comando en su lugar.

Uso
browser.isElementSelected(elementId)
Parámetros
NombreTipoDetalles
elementIdStringel id de un elemento devuelto en una llamada anterior a Find Element(s)
Ejemplo
examples.js
loading...
Devuelve
  • <Boolean> isSelected: true o false basado en el estado seleccionado.

isElementDisplayed

Is Element Displayed determina la visibilidad de un elemento, que se guía por lo que es perceptiblemente visible para el ojo humano. En este contexto, la visibilidad de un elemento no se relaciona con las propiedades de estilo visibility o display.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

información

Este comando de protocolo está integrado en el siguiente método conveniente: isDisplayed. Se recomienda usar este comando en su lugar.

Uso
browser.isElementDisplayed(elementId)
Parámetros
NombreTipoDetalles
elementIdStringel id de un elemento devuelto en una llamada anterior a Find Element(s)
Ejemplo
examples.js
loading...
Devuelve
  • <Boolean> isDisplayed: true o false basado en el estado visible.

getElementAttribute

El comando Get Element Attribute devolverá el atributo de un elemento web.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

información

Este comando de protocolo está integrado en el siguiente método conveniente: getAttribute. Se recomienda usar este comando en su lugar.

Uso
browser.getElementAttribute(elementId, name)
Parámetros
NombreTipoDetalles
elementIdStringel id de un elemento devuelto en una llamada anterior a Find Element(s)
nameStringnombre del valor de atributo a recuperar
Ejemplo
examples.js
loading...
Devuelve
  • <string> attribute: El atributo nombrado del elemento.

getElementProperty

El comando Get Element Property devolverá el resultado de obtener una propiedad de un elemento.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

información

Este comando de protocolo está integrado en el siguiente método conveniente: getProperty. Se recomienda usar este comando en su lugar.

Uso
browser.getElementProperty(elementId, name)
Parámetros
NombreTipoDetalles
elementIdStringel id de un elemento devuelto en una llamada anterior a Find Element(s)
nameStringnombre de la propiedad de atributo a recuperar
Ejemplo
examples.js
loading...
Devuelve
  • <string> property: La propiedad nombrada del elemento, accedida llamando a GetOwnProperty en el objeto de elemento.

getElementCSSValue

El comando Get Element CSS Value recupera el valor calculado de la propiedad CSS dada del elemento web dado.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

información

Este comando de protocolo está integrado en el siguiente método conveniente: getCSSProperty. Se recomienda usar este comando en su lugar.

Uso
browser.getElementCSSValue(elementId, propertyName)
Parámetros
NombreTipoDetalles
elementIdStringel id de un elemento devuelto en una llamada anterior a Find Element(s)
propertyNameStringnombre de la propiedad CSS a recuperar
Ejemplo
examples.js
loading...
Devuelve
  • <string> cssValue: El valor calculado del parámetro correspondiente al nombre de la propiedad de las declaraciones de estilo del elemento (a menos que el tipo de documento sea xml, en cuyo caso el valor de retorno es simplemente una cadena vacía).

getElementText

El comando Get Element Text pretende devolver el texto de un elemento "como se renderiza". El texto renderizado de un elemento también se utiliza para localizar elementos por su texto de enlace y texto de enlace parcial.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.getElementText(elementId)
Parámetros
NombreTipoDetalles
elementIdStringel id de un elemento devuelto en una llamada anterior a Find Element(s)
Ejemplo
examples.js
loading...
Devuelve
  • <string> text: El texto visible del elemento (incluidos los elementos secundarios), siguiendo el algoritmo definido en los Selenium Atoms para bot.dom.getVisibleText.

getElementTagName

El comando Get Element Tag Name devuelve el nombre de elemento calificado del elemento web dado.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

información

Este comando de protocolo está integrado en el siguiente método conveniente: getTagName. Se recomienda usar este comando en su lugar.

Uso
browser.getElementTagName(elementId)
Parámetros
NombreTipoDetalles
elementIdStringel id de un elemento devuelto en una llamada anterior a Find Element(s)
Ejemplo
examples.js
loading...
Devuelve
  • <string> text: El atributo tagName del elemento.

getElementRect

El comando Get Element Rect devuelve las dimensiones y coordenadas del elemento web dado.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

información

Este comando de protocolo está integrado en los siguientes métodos convenientes: getSize, getLocation. Se recomienda usar estos comandos en su lugar.

Uso
browser.getElementRect(elementId)
Parámetros
NombreTipoDetalles
elementIdStringel id de un elemento devuelto en una llamada anterior a Find Element(s)
Ejemplo
examples.js
loading...
Devuelve
  • <Object> elementRect: Un objeto JSON que representa la posición y el rectángulo delimitador del elemento.

isElementEnabled

Is Element Enabled determina si el elemento referenciado está habilitado o no. Esta operación solo tiene sentido en controles de formulario.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

información

Este comando de protocolo está integrado en el siguiente método conveniente: isEnabled. Se recomienda usar este comando en su lugar.

Uso
browser.isElementEnabled(elementId)
Parámetros
NombreTipoDetalles
elementIdStringel id de un elemento devuelto en una llamada anterior a Find Element(s)
Ejemplo
examples.js
loading...
Devuelve
  • <Boolean> isEnabled: Si el elemento está en un documento xml, o es un control de formulario deshabilitado: false, de lo contrario, true.

elementClick

El comando Element Click desplaza a la vista el elemento si aún no es interactuable por puntero, y hace clic en su punto central en la vista. Si el punto central del elemento está oscurecido por otro elemento, se devuelve un error de clic de elemento interceptado. Si el elemento está fuera de la ventana gráfica, se devuelve un error de elemento no interactuable.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

información

Este comando de protocolo está integrado en el siguiente método conveniente: click. Se recomienda usar este comando en su lugar.

Uso
browser.elementClick(elementId)
Parámetros
NombreTipoDetalles
elementIdStringel id de un elemento devuelto en una llamada anterior a Find Element(s)
Ejemplo
examples.js
loading...

elementClear

El comando Element Clear desplaza a la vista un elemento editable o reiniciable y luego intenta borrar sus archivos seleccionados o contenido de texto.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

información

Este comando de protocolo está integrado en el siguiente método conveniente: clearValue. Se recomienda usar este comando en su lugar.

Uso
browser.elementClear(elementId)
Parámetros
NombreTipoDetalles
elementIdStringel id de un elemento devuelto en una llamada anterior a Find Element(s)
Ejemplo
examples.js
loading...

elementSendKeys

El comando Element Send Keys desplaza a la vista el elemento de control de formulario y luego envía las teclas proporcionadas al elemento. En caso de que el elemento no sea interactuable por teclado, se devuelve un error de elemento no interactuable.

El estado de entrada de tecla utilizado para la entrada puede borrarse a mitad de la "escritura" enviando la tecla nula, que es U+E000 (NULL).

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

información

Este comando de protocolo está integrado en los siguientes métodos convenientes: addValue, setValue. Se recomienda usar estos comandos en su lugar.

Uso
browser.elementSendKeys(elementId, text)
Parámetros
NombreTipoDetalles
elementIdStringel id de un elemento devuelto en una llamada anterior a Find Element(s)
textstringcadena para enviar como pulsaciones de tecla al elemento
Ejemplo
examples.js
loading...

getPageSource

El comando Get Page Source devuelve una serialización de cadena del DOM del documento activo del contexto de navegación actual.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.getPageSource()
Ejemplo
examples.js
loading...
Devuelve
  • <string> pageSource: el DOM del documento activo del contexto de navegación actual

executeScript

El comando Execute Script ejecuta una función JavaScript en el contexto del contexto de navegación actual y devuelve el valor de retorno de la función.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

información

Este comando de protocolo está integrado en el siguiente método conveniente: execute. Se recomienda usar este comando en su lugar.

Uso
browser.executeScript(script, args)
Parámetros
NombreTipoDetalles
scriptstringuna cadena, el cuerpo de la función Javascript que desea ejecutar
argsstring, object, number, boolean, null, undefined[]una matriz de valores JSON que serán deserializados y pasados como argumentos a tu función
Ejemplo
examples.js
loading...
Devuelve
  • <*> result: El valor de retorno de tu script, el cumplimiento de la Promesa devuelta por tu script, o el error que fue la razón del rechazo de la Promesa devuelta por tu script.

executeAsyncScript

El comando Execute Async Script hace que JavaScript se ejecute como una función anónima. A diferencia del comando Execute Script, el resultado de la función se ignora. En su lugar, se proporciona un argumento adicional como argumento final de la función. Esta es una función que, cuando se llama, devuelve su primer argumento como respuesta.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

información

Este comando de protocolo está integrado en el siguiente método conveniente: executeAsync. Se recomienda usar este comando en su lugar.

Uso
browser.executeAsyncScript(script, args)
Parámetros
NombreTipoDetalles
scriptstringuna cadena, el cuerpo de la función Javascript que desea ejecutar
argsstring, object, number, boolean, null, undefined[]una matriz de valores JSON que serán deserializados y pasados como argumentos a tu función
Ejemplo
examples.js
loading...
Devuelve
  • <*> result: El valor de retorno de tu script, el cumplimiento de la Promesa devuelta por tu script, o el error que fue la razón del rechazo de la Promesa devuelta por tu script.

getAllCookies

El comando Get All Cookies devuelve todas las cookies asociadas con la dirección del documento activo del contexto de navegación actual.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.getAllCookies()
Ejemplo
examples.js
loading...
Devuelve
  • <Object[]> cookies: Una lista de cookies serializadas. Cada cookie serializada tiene una serie de campos opcionales que pueden o no devolverse además de name y value.

addCookie

El comando Add Cookie agrega una sola cookie al almacén de cookies asociado con la dirección del documento activo.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.addCookie(cookie)
Parámetros
NombreTipoDetalles
cookieobjectUn objeto JSON que representa una cookie. Debe tener al menos los campos name y value y podría tener más, incluyendo expiry-time y así sucesivamente
Ejemplo
examples.js
loading...

deleteAllCookies

El comando Delete All Cookies permite la eliminación de todas las cookies asociadas con la dirección del documento activo.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.deleteAllCookies()
Ejemplo
examples.js
loading...

getNamedCookie

El comando Get Named Cookie devuelve la cookie con el nombre solicitado de las cookies asociadas en el almacén de cookies del documento activo del contexto de navegación actual. Si no se encuentra ninguna cookie, se devuelve un error de no existe tal cookie.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.getNamedCookie(name)
Parámetros
NombreTipoDetalles
nameStringnombre de la cookie a recuperar
Ejemplo
examples.js
loading...
Devuelve
  • <Object> cookie: Una cookie serializada, con campos name y value. Hay una serie de campos opcionales como path, domain y expiry-time que también pueden estar presentes.

deleteCookie

El comando Delete Cookie te permite eliminar ya sea una sola cookie por nombre de parámetro, o todas las cookies asociadas con la dirección del documento activo si name es indefinido.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.deleteCookie(name)
Parámetros
NombreTipoDetalles
nameStringnombre de la cookie a eliminar
Ejemplo
examples.js
loading...

performActions

El comando Perform Actions se utiliza para ejecutar acciones de usuario complejas. Ver especificación para más detalles.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.performActions(actions)
Parámetros
NombreTipoDetalles
actionsobject[]una lista de objetos, cada uno de los cuales representa una fuente de entrada y sus acciones asociadas

releaseActions

El comando Release Actions se utiliza para liberar todas las teclas y botones del puntero que están actualmente presionados. Esto hace que se generen eventos como si el estado se hubiera liberado mediante una serie explícita de acciones. También borra todo el estado interno de los dispositivos virtuales.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.releaseActions()

dismissAlert

El comando Dismiss Alert descarta un diálogo simple si está presente, de lo contrario error. Una solicitud para descartar una alerta de usuario, que puede no tener necesariamente un botón de descarte, tiene el mismo efecto que aceptarla.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.dismissAlert()
Ejemplo
examples.js
loading...

acceptAlert

El comando Accept Alert acepta un diálogo simple si está presente, de lo contrario error.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.acceptAlert()

getAlertText

El comando Get Alert Text devuelve el mensaje del mensaje de usuario actual. Si no hay ningún mensaje de usuario actual, devuelve un error.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.getAlertText()
Ejemplo
examples.js
loading...
Devuelve
  • <string> alertText: El mensaje del mensaje de usuario.

sendAlertText

El comando Send Alert Text establece el campo de texto de un mensaje de usuario window.prompt al valor dado.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.sendAlertText(text)
Parámetros
NombreTipoDetalles
textstringcadena para establecer el mensaje

takeScreenshot

El comando Take Screenshot toma una captura de pantalla de la ventana gráfica del contexto de navegación de nivel superior.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.takeScreenshot()
Devuelve
  • <string> screenshot: Los datos de imagen PNG codificados en base64 que comprenden la captura de pantalla de la ventana gráfica inicial.

takeElementScreenshot

El comando Take Element Screenshot toma una captura de pantalla de la región visible abarcada por el rectángulo delimitador de un elemento.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.takeElementScreenshot(elementId, scroll)
Parámetros
NombreTipoDetalles
elementIdStringel id de un elemento devuelto en una llamada anterior a Find Element(s)
scroll
opcional
booleandesplazar a la vista el elemento. Por defecto: true
Devuelve
  • <string> screenshot: Los datos de imagen PNG codificados en base64 que comprenden la captura de pantalla de la región visible del rectángulo delimitador de un elemento después de que se ha desplazado a la vista.

getElementComputedRole

Obtener el rol WAI-ARIA calculado de un elemento.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.getElementComputedRole(elementId)
Parámetros
NombreTipoDetalles
elementIdStringel id de un elemento devuelto en una llamada anterior a Find Element(s)
Devuelve
  • <string> role: El resultado de calcular el rol WAI-ARIA del elemento.

getElementComputedLabel

Obtener el nombre accesible del elemento.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.getElementComputedLabel(elementId)
Parámetros
NombreTipoDetalles
elementIdStringel id de un elemento devuelto en una llamada anterior a Find Element(s)
Devuelve
  • <string> label: El resultado de un Cálculo de Nombre y Descripción Accesible para el Nombre Accesible del elemento.

setPermissions

Simula la modificación por parte del usuario del estado de permiso de un PermissionDescriptor. Nota: esta característica aún no ha llegado a todos los navegadores.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.setPermissions(descriptor, state, oneRealm)
Parámetros
NombreTipoDetalles
descriptorobjectCada característica potente tiene uno o más aspectos para los que los sitios web pueden solicitar permiso de acceso. Para describir estos aspectos, cada característica define un subtipo de PermissionDescriptor para ser su tipo descriptor de permiso. Nota: esta característica aún no ha llegado a todos los navegadores.
statestringDetermina si el permiso es concedido, denegado o solicitado.
oneRealm
opcional
booleanSi se aplican o no los permisos a todos los contextos de ejecución.
Ejemplos
// establecer permisos midi
browser.setPermissions(
{ name: 'midi', sysex: true },
'granted' // puede ser también "denied" o "prompt"
);
// establecer permisos de portapapeles
browser.setPermissions({ name: 'clipboard-read' }, 'granted');
// ahora puedes leer el portapapeles a través de, por ejemplo
const clipboardText = await browser.execute(() => navigator.clipboard.readText());

generateTestReport

Genera un informe para pruebas. Extensión para Reporting API. Nota: esta característica aún no ha llegado a todos los navegadores.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.generateTestReport(message, group)
Parámetros
NombreTipoDetalles
messagestringMensaje a mostrar en el informe.
group
opcional
stringEspecifica el grupo de punto final al que entregar el informe.

createMockSensor

Crea un sensor simulado para emular sensores como el Sensor de Luz Ambiental. Nota: esta característica aún no ha llegado a todos los navegadores.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.createMockSensor(mockSensorType, maxSamplingFrequency, minSamplingFrequency)
Parámetros
NombreTipoDetalles
mockSensorTypestringTipo de API de sensor a simular, por ejemplo 'ambient-light'
maxSamplingFrequency
opcional
numberUn doble que representa la frecuencia en Hz que se utiliza para establecer la frecuencia de muestreo máxima soportada para el sensor simulado asociado.
minSamplingFrequency
opcional
numberUn doble que representa la frecuencia en Hz que se utiliza para establecer la frecuencia de muestreo mínima soportada para el sensor simulado asociado.

getMockSensor

Recupera información sobre un tipo dado de sensor simulado. Nota: esta característica aún no ha llegado a todos los navegadores.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.getMockSensor(type)
Parámetros
NombreTipoDetalles
typeStringTipo de sensor simulado del que recuperar información.
Devuelve
  • <object> sensorReading: Valores de la lectura del sensor simulado.

updateMockSensor

Actualiza el tipo de sensor simulado. Nota: esta característica aún no ha llegado a todos los navegadores.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.updateMockSensor(type, mockSensorType, maxSamplingFrequency, minSamplingFrequency)
Parámetros
NombreTipoDetalles
typeStringTipo de sensor simulado para actualizar información.
mockSensorTypestringTipo de API de sensor a simular, por ejemplo 'ambient-light'
maxSamplingFrequency
opcional
numberUn doble que representa la frecuencia en Hz que se utiliza para establecer la frecuencia de muestreo máxima soportada para el sensor simulado asociado.
minSamplingFrequency
opcional
numberUn doble que representa la frecuencia en Hz que se utiliza para establecer la frecuencia de muestreo mínima soportada para el sensor simulado asociado.

deleteMockSensor

El comando Delete Session cierra cualquier contexto de navegación de nivel superior asociado con la sesión actual, termina la conexión y finalmente cierra la sesión actual. Nota: esta característica aún no ha llegado a todos los navegadores.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.deleteMockSensor(type)
Parámetros
NombreTipoDetalles
typeStringTipo de sensor simulado a eliminar.

setTimeZone

Simula el cambio de una zona horaria con fines de prueba. Nota: esta característica aún no ha llegado a todos los navegadores.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.setTimeZone(time_zone)
Parámetros
NombreTipoDetalles
time_zonestringNombre de la zona horaria, por ejemplo Asia/Tokyo

addVirtualAuthenticator

Crea un Autenticador Virtual de software.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.addVirtualAuthenticator(protocol, transport, hasResidentKey, hasUserVerification, isUserConsenting, isUserVerified, extensions, uvm)
Parámetros
NombreTipoDetalles
protocol
opcional
stringValores válidos: 'ctap1/u2f', 'ctap2', 'ctap2_1'.
transport
opcional
stringValores válidos: 'usb', 'nfc', 'ble' o 'internal'.
hasResidentKey
opcional
booleanValores válidos: true, false.
hasUserVerification
opcional
booleanValores válidos: true, false.
isUserConsenting
opcional
booleanValores válidos: true, false.
isUserVerified
opcional
booleanValores válidos: Una matriz que contiene identificadores de extensión.
extensions
opcional
string[]Valores válidos: Hasta 3 entradas de Método de Verificación de Usuario.
uvm
opcional
object[]
Devuelve
  • <string> authenticatorId: Devuelve el ID de cadena del autenticador.

removeVirtualAuthenticator

Elimina un Autenticador Virtual creado previamente.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.removeVirtualAuthenticator(authenticatorId)
Parámetros
NombreTipoDetalles
authenticatorIdStringid del autenticador

addCredential

Inyecta una Fuente de Credencial de Clave Pública en un Autenticador Virtual existente.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.addCredential(authenticatorId, credentialId, isResidentCredential, rpId, privateKey, userHandle, signCount, largeBlob)
Parámetros
NombreTipoDetalles
authenticatorIdStringID del autenticador
credentialIdstringEl ID de Credencial codificado usando Codificación Base64url.
isResidentCredentialbooleanSi se establece en true, se crea una credencial descubrible del lado del cliente. Si se establece en false, se crea una credencial del lado del servidor en su lugar.
rpIdstringEl ID de Parte Confiante al que está limitada la credencial.
privateKeystringUn paquete de clave asimétrica que contiene una sola clave privada por [RFC5958], codificado usando Codificación Base64url.
userHandlestringEl userHandle asociado a la credencial codificado usando Codificación Base64url. Esta propiedad puede no estar definida.
signCountnumberEl valor inicial para un contador de firma asociado a la fuente de credencial de clave pública.
largeBlob
opcional
stringEl blob grande, por credencial, asociado a la fuente de credencial de clave pública, codificado usando Codificación Base64url. Esta propiedad puede no estar definida.

getCredentials

Devuelve un objeto de Parámetros de Credencial para cada Fuente de Credencial de Clave Pública almacenada en un Autenticador Virtual, independientemente de si se almacenaron usando Add Credential o navigator.credentials.create().

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.getCredentials(authenticatorId)
Parámetros
NombreTipoDetalles
authenticatorIdStringid del autenticador
Devuelve
  • <object[]> credentials: Devuelve un array de credenciales.

removeAllCredentials

Elimina todas las Fuentes de Credencial de Clave Pública almacenadas en un Autenticador Virtual.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.removeAllCredentials(authenticatorId)
Parámetros
NombreTipoDetalles
authenticatorIdStringid del autenticador

removeCredential

Elimina una Fuente de Credencial de Clave Pública almacenada en un Autenticador Virtual.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.removeCredential(authenticatorId, credentialId)
Parámetros
NombreTipoDetalles
authenticatorIdStringid del autenticador
credentialIdStringid de la credencial

setUserVerified

El comando de extensión Set User Verified establece la propiedad isUserVerified en el Autenticador Virtual.

Comando del Protocolo WebDriver. Más detalles se pueden encontrar en la documentación oficial del protocolo.

Uso
browser.setUserVerified(authenticatorId)
Parámetros
NombreTipoDetalles
authenticatorIdStringid del autenticador

Welcome! How can I help?

WebdriverIO AI Copilot