Aller au contenu principal

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
NomTypeDétails
capabilitiesobjectun 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
NomTypeDétails
deleteSessionOpts
optionnel
objectObjet 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
examples.js
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
examples.js
loading...
Retourne
  • <Object> timeouts: Objet contenant les durées de timeout pour script, pageLoad et implicit.

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
NomTypeDétails
implicit
optionnel
numberentier en ms pour le timeout d'attente implicite de la session
pageLoad
optionnel
numberentier en ms pour le timeout de chargement de page de la session
script
optionnel
numberentier en ms pour le timeout de script de la session
Exemple
examples.js
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
examples.js
loading...
Retourne
  • <string> url: URL du document actif du contexte de navigation de premier niveau actuel

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.

info

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
NomTypeDétails
urlstringchaî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
examples.js
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
examples.js
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
examples.js
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
examples.js
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
examples.js
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
examples.js
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
examples.js
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.

info

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
NomTypeDétails
handlestringune 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
examples.js
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
NomTypeDétails
typestringDé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
examples.js
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
examples.js
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
NomTypeDétails
orientation
optionnel
stringorientation de la page. Par défaut: portrait
scale
optionnel
numberéchelle de la page. Par défaut: 1
background
optionnel
booleanarrière-plan de la page. Par défaut: false
width
optionnel
numberlargeur de la page en cm. Par défaut: 21.59 de la page
height
optionnel
numberhauteur de la page en cm. Par défaut: 27.94 de la page
top
optionnel
numbermarge de page en cm depuis la marge supérieure. Par défaut: 1
bottom
optionnel
numbermarge de page en cm depuis la marge inférieure. Par défaut: 1
left
optionnel
numbermarge de page en cm depuis la marge gauche. Par défaut: 1
right
optionnel
numbermarge de page en cm depuis la marge droite. Par défaut: 1
shrinkToFit
optionnel
booleanréduire le pdf pour l'adapter à la page. Par défaut: true
pageRanges
optionnel
object[]plages de pages. Par défaut []
Exemple
examples.js
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.

attention

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
NomTypeDétails
idnumber, object, nulll'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
examples.js
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
examples.js
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.

info

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
examples.js
loading...
Retourne
  • <Object> windowRect: Une représentation JSON d'un objet "window rect". Celui-ci possède 4 propriétés : x, y, width et height.

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.

info

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
NomTypeDétails
xnumber, nulll'attribut screenX de l'objet window
ynumber, nulll'attribut screenY de l'objet window
widthnumber, nullla largeur des dimensions externes du contexte de navigation de premier niveau, y compris l'interface du navigateur, etc...
heightnumber, nullla hauteur des dimensions externes du contexte de navigation de premier niveau, y compris l'interface du navigateur, etc...
Exemple
examples.js
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
examples.js
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.

info

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
NomTypeDétails
usingstringune stratégie de localisation d'élément valide
valuestringle sélecteur réel qui sera utilisé pour trouver un élément
Exemple
examples.js
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.

info

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
NomTypeDétails
shadowIdStringid d'élément d'un élément shadow root
usingstringune stratégie de localisation d'élément valide
valuestringle sélecteur réel qui sera utilisé pour trouver un élément
Exemple
examples.js
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.

info

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
NomTypeDétails
usingstringune stratégie de localisation d'élément valide
valuestringle sélecteur réel qui sera utilisé pour trouver un élément
Exemple
examples.js
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.

info

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)
Paramètres
NomTypeDétails
shadowIdStringid d'élément d'un élément shadow root
usingstringune stratégie de localisation d'élément valide
valuestringle sélecteur réel qui sera utilisé pour trouver un élément
Exemple
examples.js
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' }.

findElementFromElement

La commande Find Element From Element est utilisée pour trouver un élément à partir d'un élément web 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 (Voir findElement).

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

info

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.findElementFromElement(elementId, using, value)
Paramètres
NomTypeDétails
elementIdStringl'id d'un élément renvoyé dans un appel précédent à Find Element(s)
usingstringune stratégie de localisation d'élément valide
valuestringle sélecteur réel qui sera utilisé pour trouver un élément
Exemple
examples.js
loading...
Retourne
  • <object> element: Une représentation JSON d'un objet élément, par exemple { 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }.

findElementsFromElement

La commande Find Elements From Element est utilisée pour trouver des éléments à partir d'un élément web 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.

info

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.findElementsFromElement(elementId, using, value)
Paramètres
NomTypeDétails
elementIdStringl'id d'un élément renvoyé dans un appel précédent à Find Element(s)
usingstringune stratégie de localisation d'élément valide
valuestringle sélecteur réel qui sera utilisé pour trouver un élément
Exemple
examples.js
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' }].

getElementShadowRoot

Obtient l'objet shadow root d'un élément. L'objet résultant peut être utilisé pour récupérer des éléments dans ce shadow root en utilisant par exemple findElementFromShadowRoots ou findElementsFromShadowRoots.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

info

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.getElementShadowRoot(elementId)
Paramètres
NomTypeDétails
elementIdStringl'id d'un élément renvoyé dans un appel précédent à Find Element(s)
Exemple
examples.js
loading...
Retourne
  • <string> shadowRoot: Une représentation JSON d'un shadow root d'élément, par exemple { 'shadow-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }.

getActiveElement

Get Active Element renvoie l'élément actif du document de l'élément du contexte de navigation actuel. 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 (Voir findElement).

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation
browser.getActiveElement()
Exemple
examples.js
loading...
Retourne
  • <string> element: Une représentation JSON d'un objet élément, par exemple { 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }.

isElementSelected

Is Element Selected détermine si l'élément référencé est sélectionné ou non. Cette opération n'a de sens que sur les éléments d'entrée des états Checkbox et Radio Button, ou les éléments d'option.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

info

Cette commande de protocole est intégrée dans la méthode pratique suivante: isSelected. Il est recommandé d'utiliser cette commande à la place.

Utilisation
browser.isElementSelected(elementId)
Paramètres
NomTypeDétails
elementIdStringl'id d'un élément renvoyé dans un appel précédent à Find Element(s)
Exemple
examples.js
loading...
Retourne
  • <Boolean> isSelected: true ou false selon l'état de sélection.

isElementDisplayed

Is Element Displayed détermine la visibilité d'un élément qui est guidé par ce qui est perceptuellement visible pour l'œil humain. Dans ce contexte, la visibilité d'un élément n'est pas liée aux propriétés de style visibility ou display.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

info

Cette commande de protocole est intégrée dans la méthode pratique suivante: isDisplayed. Il est recommandé d'utiliser cette commande à la place.

Utilisation
browser.isElementDisplayed(elementId)
Paramètres
NomTypeDétails
elementIdStringl'id d'un élément renvoyé dans un appel précédent à Find Element(s)
Exemple
examples.js
loading...
Retourne
  • <Boolean> isDisplayed: true ou false selon l'état de visibilité.

getElementAttribute

La commande Get Element Attribute renverra l'attribut d'un élément web.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

info

Cette commande de protocole est intégrée dans la méthode pratique suivante: getAttribute. Il est recommandé d'utiliser cette commande à la place.

Utilisation
browser.getElementAttribute(elementId, name)
Paramètres
NomTypeDétails
elementIdStringl'id d'un élément renvoyé dans un appel précédent à Find Element(s)
nameStringnom de la valeur d'attribut à récupérer
Exemple
examples.js
loading...
Retourne
  • <string> attribute: L'attribut nommé de l'élément.

getElementProperty

La commande Get Element Property renverra le résultat de l'obtention d'une propriété d'un élément.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

info

Cette commande de protocole est intégrée dans la méthode pratique suivante: getProperty. Il est recommandé d'utiliser cette commande à la place.

Utilisation
browser.getElementProperty(elementId, name)
Paramètres
NomTypeDétails
elementIdStringl'id d'un élément renvoyé dans un appel précédent à Find Element(s)
nameStringnom de la propriété d'attribut à récupérer
Exemple
examples.js
loading...
Retourne
  • <string> property: La propriété nommée de l'élément, accessible en appelant GetOwnProperty sur l'objet élément.

getElementCSSValue

La commande Get Element CSS Value récupère la valeur calculée de la propriété CSS donnée de l'élément web donné.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

info

Cette commande de protocole est intégrée dans la méthode pratique suivante: getCSSProperty. Il est recommandé d'utiliser cette commande à la place.

Utilisation
browser.getElementCSSValue(elementId, propertyName)
Paramètres
NomTypeDétails
elementIdStringl'id d'un élément renvoyé dans un appel précédent à Find Element(s)
propertyNameStringnom de la propriété CSS à récupérer
Exemple
examples.js
loading...
Retourne
  • <string> cssValue: La valeur calculée du paramètre correspondant au nom de la propriété à partir des déclarations de style de l'élément (sauf si le type de document est xml, auquel cas la valeur de retour est simplement la chaîne vide).

getElementText

La commande Get Element Text vise à renvoyer le texte d'un élément "tel que rendu". Le texte rendu d'un élément est également utilisé pour localiser des éléments par leur texte de lien et leur texte de lien partiel.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation
browser.getElementText(elementId)
Paramètres
NomTypeDétails
elementIdStringl'id d'un élément renvoyé dans un appel précédent à Find Element(s)
Exemple
examples.js
loading...
Retourne
  • <string> text: Le texte visible de l'élément (y compris les éléments enfants), suivant l'algorithme défini dans les Selenium Atoms pour bot.dom.getVisibleText.

getElementTagName

La commande Get Element Tag Name renvoie le nom d'élément qualifié de l'élément web donné.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

info

Cette commande de protocole est intégrée dans la méthode pratique suivante: getTagName. Il est recommandé d'utiliser cette commande à la place.

Utilisation
browser.getElementTagName(elementId)
Paramètres
NomTypeDétails
elementIdStringl'id d'un élément renvoyé dans un appel précédent à Find Element(s)
Exemple
examples.js
loading...
Retourne
  • <string> text: L'attribut tagName de l'élément.

getElementRect

La commande Get Element Rect renvoie les dimensions et les coordonnées de l'élément web donné.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

info

Cette commande de protocole est intégrée dans les méthodes pratiques suivantes: getSize, getLocation. Il est recommandé d'utiliser ces commandes à la place.

Utilisation
browser.getElementRect(elementId)
Paramètres
NomTypeDétails
elementIdStringl'id d'un élément renvoyé dans un appel précédent à Find Element(s)
Exemple
examples.js
loading...
Retourne
  • <Object> elementRect: Un objet JSON représentant la position et le rectangle englobant de l'élément.

isElementEnabled

Is Element Enabled détermine si l'élément référencé est activé ou non. Cette opération n'a de sens que sur les contrôles de formulaire.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

info

Cette commande de protocole est intégrée dans la méthode pratique suivante: isEnabled. Il est recommandé d'utiliser cette commande à la place.

Utilisation
browser.isElementEnabled(elementId)
Paramètres
NomTypeDétails
elementIdStringl'id d'un élément renvoyé dans un appel précédent à Find Element(s)
Exemple
examples.js
loading...
Retourne
  • <Boolean> isEnabled: Si l'élément est dans un document xml, ou est un contrôle de formulaire désactivé: false, sinon, true.

elementClick

La commande Element Click fait défiler l'élément en vue s'il n'est pas déjà interactif par pointeur, puis clique sur son point central en vue. Si le point central de l'élément est masqué par un autre élément, une erreur d'interception de clic d'élément est renvoyée. Si l'élément est en dehors de la fenêtre d'affichage, une erreur d'élément non interactif est renvoyée.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

info

Cette commande de protocole est intégrée dans la méthode pratique suivante: click. Il est recommandé d'utiliser cette commande à la place.

Utilisation
browser.elementClick(elementId)
Paramètres
NomTypeDétails
elementIdStringl'id d'un élément renvoyé dans un appel précédent à Find Element(s)
Exemple
examples.js
loading...

elementClear

La commande Element Clear fait défiler l'élément modifiable ou réinitialisable en vue et tente ensuite d'effacer ses fichiers sélectionnés ou son contenu textuel.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

info

Cette commande de protocole est intégrée dans la méthode pratique suivante: clearValue. Il est recommandé d'utiliser cette commande à la place.

Utilisation
browser.elementClear(elementId)
Paramètres
NomTypeDétails
elementIdStringl'id d'un élément renvoyé dans un appel précédent à Find Element(s)
Exemple
examples.js
loading...

elementSendKeys

La commande Element Send Keys fait défiler l'élément de contrôle de formulaire en vue, puis envoie les touches fournies à l'élément. Dans le cas où l'élément n'est pas interactif par clavier, une erreur d'élément non interactif est renvoyée.

L'état d'entrée des touches utilisé pour l'entrée peut être effacé au milieu de la "frappe" en envoyant la touche null, qui est U+E000 (NULL).

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

info

Cette commande de protocole est intégrée dans les méthodes pratiques suivantes: addValue, setValue. Il est recommandé d'utiliser ces commandes à la place.

Utilisation
browser.elementSendKeys(elementId, text)
Paramètres
NomTypeDétails
elementIdStringl'id d'un élément renvoyé dans un appel précédent à Find Element(s)
textstringchaîne à envoyer sous forme de frappes de touches à l'élément
Exemple
examples.js
loading...

getPageSource

La commande Get Page Source renvoie une sérialisation de chaîne du DOM du document actif 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.getPageSource()
Exemple
examples.js
loading...
Retourne
  • <string> pageSource: le DOM du document actif du contexte de navigation actuel

executeScript

La commande Execute Script exécute une fonction JavaScript dans le contexte du contexte de navigation actuel et renvoie la valeur de retour de la fonction.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

info

Cette commande de protocole est intégrée dans la méthode pratique suivante: execute. Il est recommandé d'utiliser cette commande à la place.

Utilisation
browser.executeScript(script, args)
Paramètres
NomTypeDétails
scriptstringune chaîne, le corps de la fonction JavaScript que vous voulez exécuter
argsstring, object, number, boolean, null, undefined[]un tableau de valeurs JSON qui seront désérialisées et passées comme arguments à votre fonction
Exemple
examples.js
loading...
Retourne
  • <*> result: Soit la valeur de retour de votre script, l'accomplissement de la Promise renvoyée par votre script, ou l'erreur qui était la raison du rejet de la Promise renvoyée par votre script.

executeAsyncScript

La commande Execute Async Script amène JavaScript à exécuter en tant que fonction anonyme. Contrairement à la commande Execute Script, le résultat de la fonction est ignoré. À la place, un argument supplémentaire est fourni comme argument final à la fonction. Il s'agit d'une fonction qui, lorsqu'elle est appelée, renvoie son premier argument comme réponse.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

info

Cette commande de protocole est intégrée dans la méthode pratique suivante: executeAsync. Il est recommandé d'utiliser cette commande à la place.

Utilisation
browser.executeAsyncScript(script, args)
Paramètres
NomTypeDétails
scriptstringune chaîne, le corps de la fonction JavaScript que vous voulez exécuter
argsstring, object, number, boolean, null, undefined[]un tableau de valeurs JSON qui seront désérialisées et passées comme arguments à votre fonction
Exemple
examples.js
loading...
Retourne
  • <*> result: Soit la valeur de retour de votre script, l'accomplissement de la Promise renvoyée par votre script, ou l'erreur qui était la raison du rejet de la Promise renvoyée par votre script.

getAllCookies

La commande Get All Cookies renvoie tous les cookies associés à l'adresse du document actif 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.getAllCookies()
Exemple
examples.js
loading...
Retourne
  • <Object[]> cookies: Une liste de cookies sérialisés. Chaque cookie sérialisé a un certain nombre de champs optionnels qui peuvent ou non être renvoyés en plus de name et value.

addCookie

La commande Add Cookie ajoute un seul cookie au magasin de cookies associé à l'adresse du document actif.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation
browser.addCookie(cookie)
Paramètres
NomTypeDétails
cookieobjectUn objet JSON représentant un cookie. Il doit avoir au moins les champs name et value et pourrait en avoir plus, y compris expiry-time, etc.
Exemple
examples.js
loading...

deleteAllCookies

La commande Delete All Cookies permet la suppression de tous les cookies associés à l'adresse du document actif.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation
browser.deleteAllCookies()
Exemple
examples.js
loading...

getNamedCookie

La commande Get Named Cookie renvoie le cookie avec le nom demandé parmi les cookies associés dans le magasin de cookies du document actif du contexte de navigation actuel. Si aucun cookie n'est trouvé, une erreur "pas de cookie" est renvoyée.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation
browser.getNamedCookie(name)
Paramètres
NomTypeDétails
nameStringnom du cookie à récupérer
Exemple
examples.js
loading...
Retourne
  • <Object> cookie: Un cookie sérialisé, avec les champs name et value. Il y a un certain nombre de champs optionnels comme path, domain et expiry-time qui peuvent également être présents.

deleteCookie

La commande Delete Cookie vous permet de supprimer soit un seul cookie par nom de paramètre, soit tous les cookies associés à l'adresse du document actif si name est indéfini.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation
browser.deleteCookie(name)
Paramètres
NomTypeDétails
nameStringnom du cookie à supprimer
Exemple
examples.js
loading...

performActions

La commande Perform Actions est utilisée pour exécuter des actions utilisateur complexes. Voir spec pour plus de détails.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation
browser.performActions(actions)
Paramètres
NomTypeDétails
actionsobject[]une liste d'objets, chacun représentant une source d'entrée et ses actions associées

releaseActions

La commande Release Actions est utilisée pour relâcher toutes les touches et boutons de pointeur qui sont actuellement enfoncés. Cela provoque le déclenchement d'événements comme si l'état était relâché par une série explicite d'actions. Cela efface également tout l'état interne des dispositifs virtuels.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation
browser.releaseActions()

dismissAlert

La commande Dismiss Alert rejette une boîte de dialogue simple si elle est présente, sinon erreur. Une demande de rejet d'une invite utilisateur d'alerte, qui peut ne pas nécessairement avoir un bouton de rejet, a le même effet que de l'accepter.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation
browser.dismissAlert()
Exemple
examples.js
loading...

acceptAlert

La commande Accept Alert accepte une boîte de dialogue simple si elle est présente, sinon erreur.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation
browser.acceptAlert()

getAlertText

La commande Get Alert Text renvoie le message de l'invite utilisateur actuelle. S'il n'y a pas d'invite utilisateur actuelle, elle renvoie une erreur.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation
browser.getAlertText()
Exemple
examples.js
loading...
Retourne
  • <string> alertText: Le message de l'invite utilisateur.

sendAlertText

La commande Send Alert Text définit le champ de texte d'une invite utilisateur window.prompt à la valeur donnée.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation
browser.sendAlertText(text)
Paramètres
NomTypeDétails
textstringchaîne à définir pour l'invite

takeScreenshot

La commande Take Screenshot prend une capture d'écran de la fenêtre d'affichage du 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.takeScreenshot()
Retourne
  • <string> screenshot: Les données d'image PNG encodées en base64 comprenant la capture d'écran de la fenêtre d'affichage initiale.

takeElementScreenshot

La commande Take Element Screenshot prend une capture d'écran de la région visible englobée par le rectangle englobant d'un élément.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation
browser.takeElementScreenshot(elementId, scroll)
Paramètres
NomTypeDétails
elementIdStringl'id d'un élément renvoyé dans un appel précédent à Find Element(s)
scroll
optionnel
booleanfaire défiler l'élément en vue. Par défaut: true
Retourne
  • <string> screenshot: Les données d'image PNG encodées en base64 comprenant la capture d'écran de la région visible du rectangle englobant d'un élément après qu'il ait été défilé en vue.

getElementComputedRole

Obtient le rôle WAI-ARIA calculé d'un élément.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation
browser.getElementComputedRole(elementId)
Paramètres
NomTypeDétails
elementIdStringl'id d'un élément renvoyé dans un appel précédent à Find Element(s)
Retourne
  • <string> role: Le résultat du calcul du rôle WAI-ARIA de l'élément.

getElementComputedLabel

Obtient le nom accessible de l'élément.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation
browser.getElementComputedLabel(elementId)
Paramètres
NomTypeDétails
elementIdStringl'id d'un élément renvoyé dans un appel précédent à Find Element(s)
Retourne
  • <string> label: Le résultat d'un calcul de nom et de description accessible pour le nom accessible de l'élément.

setPermissions

Simule la modification par l'utilisateur de l'état de permission d'un PermissionDescriptor. Remarque : cette fonctionnalité n'a pas encore été implémentée dans tous les navigateurs.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation
browser.setPermissions(descriptor, state, oneRealm)
Paramètres
NomTypeDétails
descriptorobjectChaque fonctionnalité puissante a un ou plusieurs aspects pour lesquels les sites Web peuvent demander l'autorisation d'accéder. Pour décrire ces aspects, chaque fonctionnalité définit un sous-type de PermissionDescriptor comme son type de descripteur de permission. Remarque : cette fonctionnalité n'a pas encore été implémentée dans tous les navigateurs.
statestringDétermine si la permission est accordée, refusée ou invitée.
oneRealm
optionnel
booleanIndique s'il faut appliquer les permissions à tous les contextes d'exécution.
Exemples
// définir les permissions midi
browser.setPermissions(
{ name: 'midi', sysex: true },
'granted' // peut aussi être "denied" ou "prompt"
);
// définir les permissions du presse-papiers
browser.setPermissions({ name: 'clipboard-read' }, 'granted');
// maintenant vous pouvez lire le presse-papiers via, par exemple
const clipboardText = await browser.execute(() => navigator.clipboard.readText());

generateTestReport

Génère un rapport pour les tests. Extension pour Reporting API. Remarque : cette fonctionnalité n'a pas encore été implémentée dans tous les navigateurs.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation
browser.generateTestReport(message, group)
Paramètres
NomTypeDétails
messagestringMessage à afficher dans le rapport.
group
optionnel
stringSpécifie le groupe de point de terminaison auquel livrer le rapport.

createMockSensor

Crée un capteur simulé pour émuler des capteurs comme le capteur de lumière ambiante. Remarque : cette fonctionnalité n'a pas encore été implémentée dans tous les navigateurs.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation
browser.createMockSensor(mockSensorType, maxSamplingFrequency, minSamplingFrequency)
Paramètres
NomTypeDétails
mockSensorTypestringType d'API de capteur à simuler, par exemple 'ambient-light'
maxSamplingFrequency
optionnel
numberUn double représentant la fréquence en Hz qui est utilisé pour définir la fréquence d'échantillonnage maximale prise en charge pour le capteur simulé associé.
minSamplingFrequency
optionnel
numberUn double représentant la fréquence en Hz qui est utilisé pour définir la fréquence d'échantillonnage minimale prise en charge pour le capteur simulé associé.

getMockSensor

Récupère des informations sur un type donné de capteur simulé. Remarque : cette fonctionnalité n'a pas encore été implémentée dans tous les navigateurs.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation
browser.getMockSensor(type)
Paramètres
NomTypeDétails
typeStringType de capteur simulé pour récupérer des informations.
Retourne
  • <object> sensorReading: Valeurs de la lecture du capteur simulé.

updateMockSensor

Met à jour le type de capteur simulé. Remarque : cette fonctionnalité n'a pas encore été implémentée dans tous les navigateurs.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation
browser.updateMockSensor(type, mockSensorType, maxSamplingFrequency, minSamplingFrequency)
Paramètres
NomTypeDétails
typeStringType de capteur simulé pour mettre à jour les informations.
mockSensorTypestringType d'API de capteur à simuler, par exemple 'ambient-light'
maxSamplingFrequency
optionnel
numberUn double représentant la fréquence en Hz qui est utilisé pour définir la fréquence d'échantillonnage maximale prise en charge pour le capteur simulé associé.
minSamplingFrequency
optionnel
numberUn double représentant la fréquence en Hz qui est utilisé pour définir la fréquence d'échantillonnage minimale prise en charge pour le capteur simulé associé.

deleteMockSensor

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. Remarque : cette fonctionnalité n'a pas encore été implémentée dans tous les navigateurs.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation
browser.deleteMockSensor(type)
Paramètres
NomTypeDétails
typeStringType de capteur simulé à supprimer.

setTimeZone

Simule le changement d'un fuseau horaire aux fins de test. Remarque : cette fonctionnalité n'a pas encore été implémentée dans tous les navigateurs.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation
browser.setTimeZone(time_zone)
Paramètres
NomTypeDétails
time_zonestringNom du fuseau horaire, par exemple Asia/Tokyo

addVirtualAuthenticator

Crée un Authentificateur Virtuel logiciel.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation
browser.addVirtualAuthenticator(protocol, transport, hasResidentKey, hasUserVerification, isUserConsenting, isUserVerified, extensions, uvm)
Paramètres
NomTypeDétails
protocol
optionnel
stringValeurs valides: 'ctap1/u2f', 'ctap2', 'ctap2_1'.
transport
optionnel
stringValeurs valides: 'usb', 'nfc', 'ble' ou 'internal'.
hasResidentKey
optionnel
booleanValeurs valides: true, false.
hasUserVerification
optionnel
booleanValeurs valides: true, false.
isUserConsenting
optionnel
booleanValeurs valides: true, false.
isUserVerified
optionnel
booleanValeurs valides: Un tableau contenant des identifiants d'extension.
extensions
optionnel
string[]Valeurs valides: Jusqu'à 3 entrées de méthode de vérification utilisateur.
uvm
optionnel
object[]
Retourne
  • <string> authenticatorId: Renvoie l'ID de chaîne de l'authentificateur.

removeVirtualAuthenticator

Supprime un authentificateur virtuel précédemment créé.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation
browser.removeVirtualAuthenticator(authenticatorId)
Paramètres
NomTypeDétails
authenticatorIdStringid de l'authentificateur

addCredential

Injecte une source d'identification à clé publique dans un authentificateur virtuel existant.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation
browser.addCredential(authenticatorId, credentialId, isResidentCredential, rpId, privateKey, userHandle, signCount, largeBlob)
Paramètres
NomTypeDétails
authenticatorIdStringID de l'authentificateur
credentialIdstringL'ID d'identification encodé en Base64url.
isResidentCredentialbooleanSi défini sur true, une identification découvrable côté client est créée. Si défini sur false, une identification côté serveur est créée à la place.
rpIdstringL'ID de partie utilisatrice auquel l'identification est limitée.
privateKeystringUn paquet de clé asymétrique contenant une seule clé privée selon [RFC5958], encodé en Base64url.
userHandlestringLe userHandle associé à l'identification encodé en Base64url. Cette propriété peut ne pas être définie.
signCountnumberLa valeur initiale d'un compteur de signature associé à la source d'identification à clé publique.
largeBlob
optionnel
stringLe grand blob par identification associé à la source d'identification à clé publique, encodé en Base64url. Cette propriété peut ne pas être définie.

getCredentials

Renvoie un objet Credential Parameters pour chaque source d'identification à clé publique stockée dans un authentificateur virtuel, qu'elles aient été stockées à l'aide de Add Credential ou de navigator.credentials.create().

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation
browser.getCredentials(authenticatorId)
Paramètres
NomTypeDétails
authenticatorIdStringid de l'authentificateur
Retourne
  • <object[]> credentials: Renvoie un tableau d'identifiants.

removeAllCredentials

Supprime toutes les sources d'identification à clé publique stockées sur un authentificateur virtuel.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation
browser.removeAllCredentials(authenticatorId)
Paramètres
NomTypeDétails
authenticatorIdStringid de l'authentificateur

removeCredential

Supprime une source d'identification à clé publique stockée sur un authentificateur virtuel.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation
browser.removeCredential(authenticatorId, credentialId)
Paramètres
NomTypeDétails
authenticatorIdStringid de l'authentificateur
credentialIdStringid de l'identification

setUserVerified

La commande d'extension Set User Verified définit la propriété isUserVerified sur l'authentificateur virtuel.

Commande du protocole WebDriver. Plus de détails peuvent être trouvés dans les docs officiels du protocole.

Utilisation
browser.setUserVerified(authenticatorId)
Paramètres
NomTypeDétails
authenticatorIdStringid de l'authentificateur

Welcome! How can I help?

WebdriverIO AI Copilot