Protocollo WebDriver
newSession
Il comando New Session crea una nuova sessione WebDriver con il nodo endpoint. Se la creazione fallisce, viene restituito un errore di sessione non creata.
Comando del protocollo WebDriver. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.
Utilizzo
browser.newSession(capabilities)
Parametri
Nome | Tipo | Dettagli |
---|---|---|
capabilities | object | un oggetto JSON, l'insieme di capabilities che è stato ultimamente unito e abbinato nell'algoritmo di elaborazione delle capabilities |
Restituisce
- <Object>
session
: Oggetto contenente sessionId e capabilities della sessione WebDriver creata.
deleteSession
Il comando Delete Session chiude qualsiasi contesto di navigazione di livello superiore associato alla sessione corrente, termina la connessione e infine chiude la sessione corrente.
Comando del protocollo WebDriver. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.
Utilizzo
browser.deleteSession(deleteSessionOpts)
Parametri
Nome | Tipo | Dettagli |
---|---|---|
deleteSessionOpts opzionale | object | Oggetto contenente opzioni per il comando deleteSession, ad es. { shutdownDriver: boolean } |
status
Il comando Status restituisce informazioni sul fatto che un endpoint remoto sia in uno stato in cui può creare nuove sessioni e può inoltre includere meta-informazioni arbitrarie specifiche dell'implementazione.
Comando del protocollo WebDriver. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.
Utilizzo
browser.status()
Esempio
loading...
Restituisce
- <Object>
status
: Oggetto contenente lo stato del driver.
getTimeouts
Il comando Get Timeouts ottiene le durate di timeout associate alla sessione corrente.
Comando del protocollo WebDriver. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.
Utilizzo
browser.getTimeouts()
Esempio
loading...
Restituisce
- <Object>
timeouts
: Oggetto contenente la durata dei timeout perscript
,pageLoad
e timeoutimplicit
.
setTimeouts
Il comando Set Timeouts imposta le durate di timeout associate alla sessione corrente. I timeout che possono essere controllati sono elencati nella tabella dei timeout di sessione qui sotto.
Comando del protocollo WebDriver. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.
Utilizzo
browser.setTimeouts(implicit, pageLoad, script)
Parametri
Nome | Tipo | Dettagli |
---|---|---|
implicit opzionale | number | intero in ms per il timeout implicito della sessione |
pageLoad opzionale | number | intero in ms per il timeout di caricamento della pagina della sessione |
script opzionale | number | intero in ms per il timeout di script della sessione |
Esempio
loading...
getUrl
Il comando Get Current URL restituisce l'URL del contesto di navigazione di livello superiore corrente.
Comando del protocollo WebDriver. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.
Utilizzo
browser.getUrl()
Esempio
loading...
Restituisce
- <string>
url
: URL del documento attivo del contesto di navigazione di livello superiore corrente
navigateTo
Il comando navigateTo (go) viene utilizzato per far navigare l'agente utente nel contesto di navigazione di livello superiore corrente verso una nuova posizione.
Comando del protocollo WebDriver. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.
Questo comando di protocollo è incorporato nel seguente metodo conveniente: url. Si consiglia di utilizzare questo comando.
Utilizzo
browser.navigateTo(url)
Parametri
Nome | Tipo | Dettagli |
---|---|---|
url | string | stringa che rappresenta un URL assoluto (che inizia con http(s)), possibilmente incluso un frammento (#...), potrebbe anche essere uno schema locale (about: ecc.) |
Esempio
loading...
back
Il comando Back fa sì che il browser si sposti di un passo indietro nella cronologia della sessione congiunta del contesto di navigazione di livello superiore corrente. Questo è equivalente a premere il pulsante indietro nel chrome del browser o a chiamare window.history.back
.
Comando del protocollo WebDriver. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.
Utilizzo
browser.back()
Esempio
loading...
forward
Il comando Forward fa sì che il browser si sposti di un passo avanti nella cronologia della sessione congiunta del contesto di navigazione di livello superiore corrente.
Comando del protocollo WebDriver. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.
Utilizzo
browser.forward()
Esempio
loading...
refresh
Il comando Refresh fa sì che il browser ricarichi la pagina nel contesto di navigazione di livello superiore corrente.
Comando del protocollo WebDriver. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.
Utilizzo
browser.refresh()
Esempio
loading...
getTitle
Il comando Get Title restituisce il titolo del documento del contesto di navigazione di livello superiore corrente, equivalente a chiamare document.title
.
Comando del protocollo WebDriver. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.
Utilizzo
browser.getTitle()
Esempio
loading...
Restituisce
- <string>
title
: Restituisce una stringa uguale adocument.title
del contesto di navigazione di livello superiore corrente.
getWindowHandle
Il comando Get Window Handle restituisce l'handle della finestra per il contesto di navigazione di livello superiore corrente. Può essere utilizzato come argomento per Switch To Window.
Comando del protocollo WebDriver. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.
Utilizzo
browser.getWindowHandle()
Esempio
loading...
Restituisce
- <string>
handle
: Restituisce una stringa che è l'handle della finestra per il contesto di navigazione di livello superiore corrente.
closeWindow
Il comando Close Window chiude il contesto di navigazione di livello superiore corrente. Una volta fatto, se non ci sono più contesti di navigazione di livello superiore aperti, la sessione WebDriver stessa viene chiusa.
Comando del protocollo WebDriver. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.
Utilizzo
browser.closeWindow()
Esempio
loading...
switchToWindow
Il comando Switch To Window viene utilizzato per selezionare il contesto di navigazione di livello superiore corrente per la sessione corrente, cioè quello che verrà utilizzato per l'elaborazione dei comandi.
Comando del protocollo WebDriver. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.
Questo comando di protocollo è incorporato nel seguente metodo conveniente: switchWindow. Si consiglia di utilizzare questo comando.
Utilizzo
browser.switchToWindow(handle)
Parametri
Nome | Tipo | Dettagli |
---|---|---|
handle | string | una stringa che rappresenta un handle di finestra, dovrebbe essere una delle stringhe restituite in una chiamata a getWindowHandles |
Esempio
loading...
createWindow
Crea un nuovo contesto di navigazione di livello superiore.
Comando del protocollo WebDriver. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.
Utilizzo
browser.createWindow(type)
Parametri
Nome | Tipo | Dettagli |
---|---|---|
type | string | Impostato a 'tab' se la finestra appena creata condivide una finestra a livello di sistema operativo con il contesto di navigazione corrente, o 'window' altrimenti. |
Esempio
loading...
Restituisce
- <Object>
window
: Nuovo oggetto finestra contenente 'handle' con il valore dell'handle e 'type' con il valore del tipo di finestra creata
getWindowHandles
Il comando Get Window Handles restituisce un elenco di handle di finestra per ogni contesto di navigazione di livello superiore aperto. L'ordine in cui vengono restituiti gli handle delle finestre è arbitrario.
Comando del protocollo WebDriver. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.
Utilizzo
browser.getWindowHandles()
Esempio
loading...
Restituisce
- <String[]>
handles
: Un array che è un elenco di handle di finestre.
printPage
Il comando Print Page rende il documento in un documento PDF impaginato. Nota: Chrome attualmente supporta questo solo in modalità headless, vedi crbug753118
).
Comando del protocollo WebDriver. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.
Utilizzo
browser.printPage(orientation, scale, background, width, height, top, bottom, left, right, shrinkToFit, pageRanges)
Parametri
Nome | Tipo | Dettagli |
---|---|---|
orientation opzionale | string | orientamento della pagina. Predefinito: portrait |
scale opzionale | number | scala della pagina. Predefinito: 1 |
background opzionale | boolean | sfondo della pagina. Predefinito: false |
width opzionale | number | larghezza della pagina in cm. Predefinito: 21.59 dalla pagina |
height opzionale | number | altezza della pagina in cm. Predefinito: 27.94 dalla pagina |
top opzionale | number | margine della pagina in cm dal margine superiore. Predefinito: 1 |
bottom opzionale | number | margine della pagina in cm dal margine inferiore. Predefinito: 1 |
left opzionale | number | margine della pagina in cm dal margine sinistro. Predefinito: 1 |
right opzionale | number | margine della pagina in cm dal margine destro. Predefinito: 1 |
shrinkToFit opzionale | boolean | ridurre il pdf per adattarlo alla pagina. Predefinito: true |
pageRanges opzionale | object[] | intervalli di pagine. Predefinito [] |
Esempio
loading...
Restituisce
- <string>
pdf
: La rappresentazione PDF codificata in base64 del documento impaginato.
switchToFrame
Il comando Switch To Frame viene utilizzato per selezionare il contesto di navigazione di livello superiore corrente o un contesto di navigazione figlio del contesto di navigazione corrente da utilizzare come contesto di navigazione corrente per i comandi successivi.
Comando del protocollo WebDriver. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.
Questo comando di protocollo è deprecato
Questo comando è deprecato e incoraggiamo tutti a utilizzare switchFrame
per passare ai frame. Maggiori informazioni su questo comando sono disponibili su https://webdriver.io/docs/api/browser/switchFrame.
Utilizzo
browser.switchToFrame(id)
Parametri
Nome | Tipo | Dettagli |
---|---|---|
id | number, object, null | uno di tre possibili tipi: null: rappresenta il contesto di navigazione di livello superiore (cioè, non un iframe), un Numero, che rappresenta l'indice dell'oggetto finestra corrispondente a un frame, un oggetto Element ricevuto usando findElement . |
Esempio
loading...
switchToParentFrame
Il comando Switch to Parent Frame imposta il contesto di navigazione corrente per i comandi futuri al genitore del contesto di navigazione corrente.
Comando del protocollo WebDriver. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.
Utilizzo
browser.switchToParentFrame()
Esempio
loading...
getWindowRect
Il comando Get Window Rect restituisce la dimensione e la posizione sullo schermo della finestra del sistema operativo corrispondente al contesto di navigazione di livello superiore corrente.
Comando del protocollo WebDriver. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.
Questo comando di protocollo è incorporato nel seguente metodo conveniente: getWindowSize. Si consiglia di utilizzare questo comando.
Utilizzo
browser.getWindowRect()
Esempio
loading...
Restituisce
- <Object>
windowRect
: Una rappresentazione JSON di un oggetto "window rect". Ha 4 proprietà:x
,y
,width
eheight
.
setWindowRect
Il comando Set Window Rect modifica la dimensione e la posizione della finestra del sistema operativo corrispondente al contesto di navigazione di livello superiore corrente.
Comando del protocollo WebDriver. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.
Questo comando di protocollo è incorporato nel seguente metodo conveniente: setWindowSize. Si consiglia di utilizzare questo comando.
Utilizzo
browser.setWindowRect(x, y, width, height)
Parametri
Nome | Tipo | Dettagli |
---|---|---|
x | number, null | l'attributo screenX dell'oggetto finestra |
y | number, null | l'attributo screenY dell'oggetto finestra |
width | number, null | la larghezza delle dimensioni esterne del contesto di navigazione di livello superiore, incluso chrome del browser ecc... |
height | number, null | l'altezza delle dimensioni esterne del contesto di navigazione di livello superiore, incluso chrome del browser ecc... |
Esempio
loading...
Restituisce
- <Object>
windowRect
: Una rappresentazione JSON di un oggetto "window rect" basata sul nuovo stato della finestra.
maximizeWindow
Il comando Maximize Window invoca l'operazione specifica del gestore finestre "massimizza", se presente, sulla finestra che contiene il contesto di navigazione di livello superiore corrente. Questo tipicamente aumenta la finestra alla dimensione massima disponibile senza andare a schermo intero.
Comando del protocollo WebDriver. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.
Utilizzo
browser.maximizeWindow()
Esempio
loading...
Restituisce
- <Object>
windowRect
: Una rappresentazione JSON di un oggetto "window rect" basata sul nuovo stato della finestra.
minimizeWindow
Il comando Minimize Window invoca l'operazione specifica del gestore finestre "minimizza", se presente, sulla finestra che contiene il contesto di navigazione di livello superiore corrente. Questo tipicamente nasconde la finestra nella barra delle applicazioni di sistema.
Comando del protocollo WebDriver. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.
Utilizzo
browser.minimizeWindow()
Restituisce
- <Object>
windowRect
: Una rappresentazione JSON di un oggetto "window rect" del (nuovo) contesto di navigazione di livello superiore corrente.
fullscreenWindow
Il comando Fullscreen Window invoca l'operazione specifica del gestore finestre "schermo intero", se presente, sulla finestra che contiene il contesto di navigazione di livello superiore corrente. Questo tipicamente aumenta la finestra alla dimensione del display fisico e può nascondere elementi del chrome del browser come le barre degli strumenti.
Comando del protocollo WebDriver. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.
Utilizzo
browser.fullscreenWindow()
Restituisce
- <Object>
windowRect
: Una rappresentazione JSON di un oggetto "window rect" del (nuovo) contesto di navigazione di livello superiore corrente.
findElement
Il comando Find Element viene utilizzato per trovare un elemento nel contesto di navigazione corrente che può essere utilizzato per comandi futuri. Questo comando restituisce una rappresentazione JSON dell'elemento che può essere passata al comando $ per trasformare il riferimento in un elemento WebdriverIO esteso.
Comando del protocollo WebDriver. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.
Questo comando di protocollo è incorporato nel seguente metodo conveniente: $. Si consiglia di utilizzare questo comando.
Utilizzo
browser.findElement(using, value)
Parametri
Nome | Tipo | Dettagli |
---|---|---|
using | string | una strategia di localizzazione di elementi valida |
value | string | il selettore effettivo che verrà utilizzato per trovare un elemento |
Esempio
loading...
Restituisce
- <object>
element
: Una rappresentazione JSON di un oggetto elemento, ad es.{ 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }
.
findElementFromShadowRoot
Il comando Find Element From Shadow Root viene utilizzato per trovare un elemento all'interno dello shadow root di un elemento che può essere utilizzato per comandi futuri. Questo comando restituisce una rappresentazione JSON dell'elemento che può essere passata al comando $ per trasformare il riferimento in un elemento WebdriverIO esteso.
Comando del protocollo WebDriver. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.
Questo comando di protocollo è incorporato nel seguente metodo conveniente: shadow$. Si consiglia di utilizzare questo comando.
Utilizzo
browser.findElementFromShadowRoot(shadowId, using, value)
Parametri
Nome | Tipo | Dettagli |
---|---|---|
shadowId | String | id dell'elemento di un elemento shadow root |
using | string | una strategia di localizzazione di elementi valida |
value | string | il selettore effettivo che verrà utilizzato per trovare un elemento |
Esempio
loading...
Restituisce
- <object>
element
: Una rappresentazione JSON di un oggetto shadow elemento, ad es.{ 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }
.
findElements
Il comando Find Elements viene utilizzato per trovare elementi nel contesto di navigazione corrente che possono essere utilizzati per comandi futuri. Questo comando restituisce un array di rappresentazioni JSON degli elementi che possono essere passati al comando $ per trasformare il riferimento in un elemento WebdriverIO esteso (Vedi findElement).
Comando del protocollo WebDriver. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.
Questo comando di protocollo è incorporato nel seguente metodo conveniente: $$. Si consiglia di utilizzare questo comando.
Utilizzo
browser.findElements(using, value)
Parametri
Nome | Tipo | Dettagli |
---|---|---|
using | string | una strategia di localizzazione di elementi valida |
value | string | il selettore effettivo che verrà utilizzato per trovare un elemento |
Esempio
loading...
Restituisce
- <object[]>
elements
: Un elenco JSON (possibilmente vuoto) di rappresentazioni di un oggetto elemento, ad es.[{ 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }]
.
findElementsFromShadowRoot
Il comando Find Elements viene utilizzato per trovare elementi all'interno dello shadow root di un elemento che possono essere utilizzati per comandi futuri. Questo comando restituisce un array di rappresentazioni JSON degli elementi che possono essere passati al comando $ per trasformare il riferimento in un elemento WebdriverIO esteso (Vedi findElement).
Comando del protocollo WebDriver. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.
Questo comando di protocollo è incorporato nel seguente metodo conveniente: shadow$$. Si consiglia di utilizzare questo comando.
Utilizzo
browser.findElementsFromShadowRoot(shadowId, using, value)
Parametri
Nome | Tipo | Dettagli |
---|---|---|
shadowId | String | id dell'elemento di un elemento shadow root |
using | string | una strategia di localizzazione di elementi valida |
value | string | il selettore effettivo che verrà utilizzato per trovare un elemento |
Esempio
loading...
Restituisce
- <object[]>
elements
: Un elenco JSON (possibilmente vuoto) di rappresentazioni di un oggetto elemento, ad es.{ 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }
.
findElementFromElement
Il comando Find Element From Element viene utilizzato per trovare un elemento da un elemento web nel contesto di navigazione corrente che può essere utilizzato per comandi futuri. Questo comando restituisce una rappresentazione JSON dell'elemento che può essere passata al comando $ per trasformare il riferimento in un elemento WebdriverIO esteso (Vedi findElement).
Comando del protocollo WebDriver. Maggiori dettagli possono essere trovati nella documentazione ufficiale del protocollo.
Questo comando di protocollo è incorporato nel seguente metodo conveniente: $. Si consiglia di utilizzare questo comando.
Utilizzo
browser.findElementFromElement(elementId, using, value)
Parametri
Nome | Tipo | Dettagli |
---|---|---|
elementId | String | l'id di un elemento restituito in una precedente chiamata a Find Element(s) |
using | string | una strategia di localizzazione di elementi valida |
value | string | il selettore effettivo che verrà utilizzato per trovare un elemento |
Esempio
loading...