Protocole WebDriver
newSession
La commande New Session crée une nouvelle session WebDriver avec le nœud d'extrémité. Si la création échoue, une erreur de session non créée est renvoyée.
Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.
Utilisation
browser.newSession(capabilities)
Paramètres
Nom | Type | Détails |
---|---|---|
capabilities | object | un objet JSON, l'ensemble des capacités qui a finalement été fusionné et correspondant dans l'algorithme de traitement des capacités |
Retourne
- <Object>
session
: Objet contenant sessionId et capabilities de la session WebDriver créée.
deleteSession
La commande Delete Session ferme tous les contextes de navigation de premier niveau associés à la session en cours, termine la connexion et ferme enfin la session en cours.
Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.
Utilisation
browser.deleteSession(deleteSessionOpts)
Paramètres
Nom | Type | Détails |
---|---|---|
deleteSessionOpts optionnel | object | Objet contenant des options pour la commande deleteSession, ex. { shutdownDriver: boolean } |
status
La commande Status renvoie des informations indiquant si une extrémité distante est dans un état dans lequel elle peut créer de nouvelles sessions et peut également inclure des métadonnées arbitraires spécifiques à l'implémentation.
Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.
Utilisation
browser.status()
Exemple
loading...
Retourne
- <Object>
status
: Objet contenant le statut du driver.
getTimeouts
La commande Get Timeouts obtient les durées de timeout associées à la session en cours.
Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.
Utilisation
browser.getTimeouts()
Exemple
loading...
Retourne
- <Object>
timeouts
: Objet contenant les durées de timeout pourscript
,pageLoad
etimplicit
.
setTimeouts
La commande Set Timeouts définit les durées de timeout associées à la session en cours. Les timeouts qui peuvent être contrôlés sont listés dans le tableau des timeouts de session ci-dessous.
Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.
Utilisation
browser.setTimeouts(implicit, pageLoad, script)
Paramètres
Nom | Type | Détails |
---|---|---|
implicit optionnel | number | entier en ms pour le timeout d'attente implicite de la session |
pageLoad optionnel | number | entier en ms pour le timeout de chargement de page de la session |
script optionnel | number | entier en ms pour le timeout de script de la session |
Exemple
loading...
getUrl
La commande Get Current URL renvoie l'URL du contexte de navigation de premier niveau actuel.
Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.
Utilisation
browser.getUrl()
Exemple
loading...
Retourne
- <string>
url
: URL du document actif du contexte de navigation de premier niveau actuel
navigateTo
La commande navigateTo (go) est utilisée pour faire naviguer l'agent utilisateur du contexte de navigation de premier niveau actuel vers un nouvel emplacement.
Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.
Cette commande de protocole est intégrée dans la méthode pratique suivante: url. Il est recommandé d'utiliser cette commande à la place.
Utilisation
browser.navigateTo(url)
Paramètres
Nom | Type | Détails |
---|---|---|
url | string | chaîne représentant une URL absolue (commençant par http(s)), pouvant inclure un fragment (#...), pourrait aussi être un schéma local (about: etc) |
Exemple
loading...
back
La commande Back fait passer le navigateur une étape en arrière dans l'historique de session conjoint du contexte de navigation de premier niveau actuel. Cela équivaut à appuyer sur le bouton retour dans la barre de navigation du navigateur ou à appeler window.history.back
.
Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.
Utilisation
browser.back()
Exemple
loading...
forward
La commande Forward fait passer le navigateur une étape en avant dans l'historique de session conjoint du contexte de navigation de premier niveau actuel.
Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.
Utilisation
browser.forward()
Exemple
loading...
refresh
La commande Refresh fait recharger la page dans le contexte de navigation de premier niveau actuel au navigateur.
Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.
Utilisation
browser.refresh()
Exemple
loading...
getTitle
La commande Get Title renvoie le titre du document du contexte de navigation de premier niveau actuel, équivalent à appeler document.title
.
Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.
Utilisation
browser.getTitle()
Exemple
loading...
Retourne
- <string>
title
: Retourne une chaîne qui est identique àdocument.title
du contexte de navigation de premier niveau actuel.
getWindowHandle
La commande Get Window Handle renvoie le handle de fenêtre pour le contexte de navigation de premier niveau actuel. Elle peut être utilisée comme argument pour Switch To Window.
Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.
Utilisation
browser.getWindowHandle()
Exemple
loading...
Retourne
- <string>
handle
: Renvoie une chaîne qui est le handle de fenêtre pour le contexte de navigation de premier niveau actuel.
closeWindow
La commande Close Window ferme le contexte de navigation de premier niveau actuel. Une fois terminé, s'il n'y a plus de contextes de navigation de premier niveau ouverts, la session WebDriver elle-même est fermée.
Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.
Utilisation
browser.closeWindow()
Exemple
loading...
switchToWindow
La commande Switch To Window est utilisée pour sélectionner le contexte de navigation de premier niveau actuel pour la session en cours, c'est-à-dire celui qui sera utilisé pour traiter les commandes.
Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.
Cette commande de protocole est intégrée dans la méthode pratique suivante: switchWindow. Il est recommandé d'utiliser cette commande à la place.
Utilisation
browser.switchToWindow(handle)
Paramètres
Nom | Type | Détails |
---|---|---|
handle | string | une chaîne représentant un handle de fenêtre, doit être l'une des chaînes qui ont été renvoyées dans un appel à getWindowHandles |
Exemple
loading...
createWindow
Crée un nouveau contexte de navigation de premier niveau.
Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.
Utilisation
browser.createWindow(type)
Paramètres
Nom | Type | Détails |
---|---|---|
type | string | Défini sur 'tab' si la fenêtre nouvellement créée partage une fenêtre au niveau du système d'exploitation avec le contexte de navigation actuel, ou 'window' dans le cas contraire. |
Exemple
loading...
Retourne
- <Object>
window
: Nouvel objet de fenêtre contenant 'handle' avec la valeur du handle et 'type' avec la valeur du type de fenêtre créé
getWindowHandles
La commande Get Window Handles renvoie une liste de handles de fenêtre pour chaque contexte de navigation de premier niveau ouvert. L'ordre dans lequel les handles de fenêtre sont renvoyés est arbitraire.
Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.
Utilisation
browser.getWindowHandles()
Exemple
loading...
Retourne
- <String[]>
handles
: Un tableau qui est une liste de handles de fenêtre.
printPage
La commande Print Page rend le document en un document PDF paginé. Remarque : Chrome ne prend actuellement en charge cela qu'en mode headless, voir crbug753118
).
Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.
Utilisation
browser.printPage(orientation, scale, background, width, height, top, bottom, left, right, shrinkToFit, pageRanges)
Paramètres
Nom | Type | Détails |
---|---|---|
orientation optionnel | string | orientation de la page. Par défaut: portrait |
scale optionnel | number | échelle de la page. Par défaut: 1 |
background optionnel | boolean | arrière-plan de la page. Par défaut: false |
width optionnel | number | largeur de la page en cm. Par défaut: 21.59 de la page |
height optionnel | number | hauteur de la page en cm. Par défaut: 27.94 de la page |
top optionnel | number | marge de page en cm depuis la marge supérieure. Par défaut: 1 |
bottom optionnel | number | marge de page en cm depuis la marge inférieure. Par défaut: 1 |
left optionnel | number | marge de page en cm depuis la marge gauche. Par défaut: 1 |
right optionnel | number | marge de page en cm depuis la marge droite. Par défaut: 1 |
shrinkToFit optionnel | boolean | réduire le pdf pour l'adapter à la page. Par défaut: true |
pageRanges optionnel | object[] | plages de pages. Par défaut [] |
Exemple
loading...
Retourne
- <string>
pdf
: La représentation PDF encodée en base64 du document paginé.
switchToFrame
La commande Switch To Frame est utilisée pour sélectionner le contexte de navigation de premier niveau actuel ou un contexte de navigation enfant du contexte de navigation actuel à utiliser comme contexte de navigation actuel pour les commandes suivantes.
Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.
Cette commande de protocole est dépréciée
Cette commande est dépréciée et nous encourageons tout le monde à utiliser switchFrame
à la place pour passer dans les frames. En savoir plus sur cette commande sur https://webdriver.io/docs/api/browser/switchFrame.
Utilisation
browser.switchToFrame(id)
Paramètres
Nom | Type | Détails |
---|---|---|
id | number, object, null | l'un des trois types possibles : null : cela représente le contexte de navigation de premier niveau (c'est-à-dire, pas un iframe), un nombre, représentant l'index de l'objet fenêtre correspondant à une frame, un objet Element reçu en utilisant findElement . |
Exemple
loading...
switchToParentFrame
La commande Switch to Parent Frame définit le contexte de navigation actuel pour les futures commandes au parent du contexte de navigation actuel.
Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.
Utilisation
browser.switchToParentFrame()
Exemple
loading...
getWindowRect
La commande Get Window Rect renvoie la taille et la position sur l'écran de la fenêtre du système d'exploitation correspondant au contexte de navigation de premier niveau actuel.
Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.
Cette commande de protocole est intégrée dans la méthode pratique suivante: getWindowSize. Il est recommandé d'utiliser cette commande à la place.
Utilisation
browser.getWindowRect()
Exemple
loading...
Retourne
- <Object>
windowRect
: Une représentation JSON d'un objet "window rect". Celui-ci possède 4 propriétés :x
,y
,width
etheight
.
setWindowRect
La commande Set Window Rect modifie la taille et la position de la fenêtre du système d'exploitation correspondant au contexte de navigation de premier niveau actuel.
Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.
Cette commande de protocole est intégrée dans la méthode pratique suivante: setWindowSize. Il est recommandé d'utiliser cette commande à la place.
Utilisation
browser.setWindowRect(x, y, width, height)
Paramètres
Nom | Type | Détails |
---|---|---|
x | number, null | l'attribut screenX de l'objet window |
y | number, null | l'attribut screenY de l'objet window |
width | number, null | la largeur des dimensions externes du contexte de navigation de premier niveau, y compris l'interface du navigateur, etc... |
height | number, null | la hauteur des dimensions externes du contexte de navigation de premier niveau, y compris l'interface du navigateur, etc... |
Exemple
loading...
Retourne
- <Object>
windowRect
: Une représentation JSON d'un objet "window rect" basé sur le nouvel état de la fenêtre.
maximizeWindow
La commande Maximize Window invoque l'opération "maximize" spécifique au gestionnaire de fenêtres, si elle existe, sur la fenêtre contenant le contexte de navigation de premier niveau actuel. Cela augmente généralement la fenêtre à la taille maximale disponible sans passer en mode plein écran.
Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.
Utilisation
browser.maximizeWindow()
Exemple
loading...
Retourne
- <Object>
windowRect
: Une représentation JSON d'un objet "window rect" basé sur le nouvel état de la fenêtre.
minimizeWindow
La commande Minimize Window invoque l'opération "minimize" spécifique au gestionnaire de fenêtres, si elle existe, sur la fenêtre contenant le contexte de navigation de premier niveau actuel. Cela cache généralement la fenêtre dans la barre des tâches du système.
Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.
Utilisation
browser.minimizeWindow()
Retourne
- <Object>
windowRect
: Une représentation JSON d'un objet "window rect" du contexte de navigation de premier niveau (nouveau) actuel.
fullscreenWindow
La commande Fullscreen Window invoque l'opération "full screen" spécifique au gestionnaire de fenêtres, si elle existe, sur la fenêtre contenant le contexte de navigation de premier niveau actuel. Cela augmente généralement la fenêtre à la taille de l'écran physique et peut masquer les éléments de l'interface du navigateur tels que les barres d'outils.
Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.
Utilisation
browser.fullscreenWindow()
Retourne
- <Object>
windowRect
: Une représentation JSON d'un objet "window rect" du contexte de navigation de premier niveau (nouveau) actuel.
findElement
La commande Find Element est utilisée pour trouver un élément dans le contexte de navigation actuel qui peut être utilisé pour les commandes futures. Cette commande renvoie une représentation JSON de l'élément qui peut être transmise à la commande $ pour transformer la référence en un élément WebdriverIO étendu.
Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.
Cette commande de protocole est intégrée dans la méthode pratique suivante: $. Il est recommandé d'utiliser cette commande à la place.
Utilisation
browser.findElement(using, value)
Paramètres
Nom | Type | Détails |
---|---|---|
using | string | une stratégie de localisation d'élément valide |
value | string | le sélecteur réel qui sera utilisé pour trouver un élément |
Exemple
loading...
Retourne
- <object>
element
: Une représentation JSON d'un objet élément, par exemple{ 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }
.
findElementFromShadowRoot
La commande Find Element From Shadow Root est utilisée pour trouver un élément dans le shadow root d'un élément qui peut être utilisé pour les commandes futures. Cette commande renvoie une représentation JSON de l'élément qui peut être transmise à la commande $ pour transformer la référence en un élément WebdriverIO étendu.
Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.
Cette commande de protocole est intégrée dans la méthode pratique suivante: shadow$. Il est recommandé d'utiliser cette commande à la place.
Utilisation
browser.findElementFromShadowRoot(shadowId, using, value)
Paramètres
Nom | Type | Détails |
---|---|---|
shadowId | String | id d'élément d'un élément shadow root |
using | string | une stratégie de localisation d'élément valide |
value | string | le sélecteur réel qui sera utilisé pour trouver un élément |
Exemple
loading...
Retourne
- <object>
element
: Une représentation JSON d'un objet élément shadow, par exemple{ 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }
.
findElements
La commande Find Elements est utilisée pour trouver des éléments dans le contexte de navigation actuel qui peuvent être utilisés pour les commandes futures. Cette commande renvoie un tableau de représentation JSON des éléments qui peuvent être transmis à la commande $ pour transformer la référence en un élément WebdriverIO étendu (Voir findElement).
Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.
Cette commande de protocole est intégrée dans la méthode pratique suivante: $$. Il est recommandé d'utiliser cette commande à la place.
Utilisation
browser.findElements(using, value)
Paramètres
Nom | Type | Détails |
---|---|---|
using | string | une stratégie de localisation d'élément valide |
value | string | le sélecteur réel qui sera utilisé pour trouver un élément |
Exemple
loading...
Retourne
- <object[]>
elements
: Une liste JSON (éventuellement vide) de représentations d'un objet élément, par exemple[{ 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }]
.
findElementsFromShadowRoot
La commande Find Elements est utilisée pour trouver des éléments dans le shadow root d'un élément qui peuvent être utilisés pour les commandes futures. Cette commande renvoie un tableau de représentation JSON des éléments qui peuvent être transmis à la commande $ pour transformer la référence en un élément WebdriverIO étendu (Voir findElement).
Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.
Cette commande de protocole est intégrée dans la méthode pratique suivante: shadow$$. Il est recommandé d'utiliser cette commande à la place.
Utilisation
browser.findElementsFromShadowRoot(shadowId, using, value)