WebDriverプロトコル
newSession
New Sessionコマンドは、エンドポイントノードで新しいWebDriverセッションを作成します。作成に失敗した場合は、セッション未作成エラーが返されます。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.newSession(capabilities)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
capabilities | object | 機能処理アルゴリズムで最終的にマージされ、マッチングされた機能セットを含むJSONオブジェクト |
戻り値
- <Object>
session: 作成されたWebDriverセッションのsessionIdとcapabilitiesを含むオブジェクト。
deleteSession
Delete Sessionコマンドは、現在のセッションに関連付けられている最上位ブラウジングコンテキストを閉じ、接続を終了し、最後に現在のセッションを閉じます。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.deleteSession(deleteSessionOpts)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
deleteSessionOptsオプション | object | deleteSessionコマンドのオプションを含むオブジェクト、例：{ shutdownDriver: boolean } |
status
Statusコマンドは、リモートエンドが新しいセッションを作成できる状態にあるかどうかに関する情報を返し、実装に固有の任意のメタ情報を含めることができます。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.status()
例
loading...
戻り値
- <Object>
status: ドライバーステータスの状態を含むオブジェクト。
getTimeouts
Get Timeoutsコマンドは、現在のセッションに関連付けられたタイムアウト時間を取得します。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.getTimeouts()
例
loading...
戻り値
- <Object>
timeouts:script、pageLoad、implicitタイムアウトのタイムアウト時間を含むオブジェクト。
setTimeouts
Set Timeoutsコマンドは、現在のセッションに関連付けられたタイムアウト時間を設定します。制御できるタイムアウトは、以下のセッションタイムアウトの表に記載されています。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.setTimeouts(implicit, pageLoad, script)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
implicitオプション | number | セッションの暗黙的な待機タイムアウトのミリ秒単位の整数 |
pageLoadオプション | number | セッションのページロードタイムアウトのミリ秒単位の整数 |
scriptオプション | number | セッションのスクリプトタイムアウトのミリ秒単位の整数 |
例
loading...
getUrl
Get Current URLコマンドは、現在の最上位ブラウジングコンテキストのURLを返します。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.getUrl()
例
loading...
戻り値
- <string>
url: 現在の最上位ブラウジングコンテキストのアクティブドキュメントのドキュメントURL
navigateTo
navigateTo（go）コマンドは、ユーザーエージェントに現在の最上位ブラウジングコンテキストを新しい場所に移動させるために使用されます。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは、以下の便利なメソッドに組み込まれています：url。代わりにこのコマンドを使用することをお勧めします。
使用法
browser.navigateTo(url)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
url | string | 絶対URL（http(s)で始まる）を表す文字列、フラグメント（#...）を含む場合もあり、ローカルスキーム（about:など）の場合もあります |
例
loading...
back
Backコマンドは、ブラウザに現在の最上位ブラウジングコンテキストの共同セッション履歴内で1ステップ後退するよう指示します。これはブラウザのクロームの戻るボタンを押すか、window.history.backを呼び出すのと同等です。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.back()
例
loading...
forward
Forwardコマンドは、ブラウザに現在の最上位ブラウジングコンテキストの共同セッション履歴内で1ステップ前進するよう指示します。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.forward()
例
loading...
refresh
Refreshコマンドは、ブラウザに現在の最上位ブラウジングコンテキストでページを再読み込みさせます。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.refresh()
例
loading...
getTitle
Get Titleコマンドは、現在の最上位ブラウジングコンテキストのドキュメントタイトルを返します。これはdocument.titleを呼び出すのと同等です。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.getTitle()
例
loading...
戻り値
- <string>
title: 現在の最上位ブラウジングコンテキストのdocument.titleと同じ文字列を返します。
getWindowHandle
Get Window Handleコマンドは、現在の最上位ブラウジングコンテキストのウィンドウハンドルを返します。これはSwitch To Windowの引数として使用できます。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.getWindowHandle()
例
loading...
戻り値
- <string>
handle: 現在の最上位ブラウジングコンテキストのウィンドウハンドルである文字列を返します。
closeWindow
Close Windowコマンドは、現在の最上位ブラウジングコンテキストを閉じます。一度完了すると、開いている最上位ブラウジングコンテキストがなくなった場合、WebDriverセッション自体が閉じられます。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.closeWindow()
例
loading...
switchToWindow
Switch To Windowコマンドは、現在のセッションの現在の最上位ブラウジングコンテキストを選択するために使用されます。つまり、コマンドの処理に使用されるコンテキストを選択します。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは、以下の便利なメソッドに組み込まれています：switchWindow。代わりにこのコマンドを使用することをお勧めします。
使用法
browser.switchToWindow(handle)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
handle | string | ウィンドウハンドルを表す文字列。getWindowHandlesの呼び出しで返された文字列の1つである必要があります |
例
loading...
createWindow
新しい最上位ブラウジングコンテキストを作成します。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.createWindow(type)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
type | string | 新しく作成されたウィンドウが現在のブラウジングコンテキストとOS レベルのウィンドウを共有する場合は 'tab' に設定し、そうでない場合は 'window' に設定します。 |
例
loading...
戻り値
- <Object>
window: ハンドルの値を持つ「handle」と作成されたウィンドウタイプの値を持つ「type」を含む新しいウィンドウオブジェクト
getWindowHandles
Get Window Handlesコマンドは、開いているすべての最上位ブラウジングコンテキストのウィンドウハンドルのリストを返します。ウィンドウハンドルが返される順序は任意です。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.getWindowHandles()
例
loading...
戻り値
- <String[]>
handles: ウィンドウハンドルのリストである配列。
printPage
Print Pageコマンドは、ドキュメントをページ分割されたPDFドキュメントにレンダリングします。注意: Chromeは現在、ヘッドレスモードでのみこれをサポートしています。crbug753118を参照してください。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.printPage(orientation, scale, background, width, height, top, bottom, left, right, shrinkToFit, pageRanges)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
orientationオプション | string | ページの向き。デフォルト：portrait |
scaleオプション | number | ページのスケール。デフォルト：1 |
backgroundオプション | boolean | ページの背景。デフォルト：false |
widthオプション | number | ページの幅（cm）。デフォルト：ページから21.59 |
heightオプション | number | ページの高さ（cm）。デフォルト：ページから27.94 |
topオプション | number | 上部マージンからのページマージン（cm）。デフォルト：1 |
bottomオプション | number | 下部マージンからのページマージン（cm）。デフォルト：1 |
leftオプション | number | 左マージンからのページマージン（cm）。デフォルト：1 |
rightオプション | number | 右マージンからのページマージン（cm）。デフォルト：1 |
shrinkToFitオプション | boolean | PDFをページに合わせて縮小。デフォルト：true |
pageRangesオプション | object[] | ページ範囲。デフォルト [] |
例
loading...
戻り値
- <string>
pdf: ページ分割されたドキュメントのBase64エンコードされたPDF表現。
switchToFrame
Switch To Frameコマンドは、現在の最上位ブラウジングコンテキストまたは現在のブラウジングコンテキストの子ブラウジングコンテキストを選択し、後続のコマンドの現在のブラウジングコンテキストとして使用するために使用されます。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは非推奨です
このコマンドは非推奨であり、フレームに切り替えるには代わりにswitchFrameを使用することをお勧めします。このコマンドの詳細については、https://webdriver.io/docs/api/browser/switchFrame をご覧ください。
使用法
browser.switchToFrame(id)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
id | number, object, null | 3つの可能なタイプのうちの1つ：null：これは最上位ブラウジングコンテキスト（つまり、iframeではない）を表します、数値：フレームに対応するウィンドウオブジェクトのインデックスを表します、findElementを使用して受け取ったElementオブジェクト。 |
例
loading...
switchToParentFrame
Switch to Parent Frameコマンドは、将来のコマンドの現在のブラウジングコンテキストを現在のブラウジングコンテキストの親に設定します。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.switchToParentFrame()
例
loading...
getWindowRect
Get Window Rectコマンドは、現在の最上位ブラウジングコンテキストに対応するオペレーティングシステムウィンドウの画面上のサイズと位置を返します。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは、以下の便利なメソッドに組み込まれています：getWindowSize。代わりにこのコマンドを使用することをお勧めします。
使用法
browser.getWindowRect()
例
loading...
戻り値
- <Object>
windowRect: 「window rect」オブジェクトのJSON表現。これには4つのプロパティがあります：x、y、width、height。
setWindowRect
Set Window Rectコマンドは、現在の最上位ブラウジングコンテキストに対応するオペレーティングシステムウィンドウのサイズと位置を変更します。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは、以下の便利なメソッドに組み込まれています：setWindowSize。代わりにこのコマンドを使用することをお勧めします。
使用法
browser.setWindowRect(x, y, width, height)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
x | number, null | ウィンドウオブジェクトのscreenX属性 |
y | number, null | ウィンドウオブジェクトのscreenY属性 |
width | number, null | ブラウザのクロームなどを含む最上位ブラウジングコンテキストの外部寸法の幅 |
height | number, null | ブラウザのクロームなどを含む最上位ブラウジングコンテキストの外部寸法の高さ |
例
loading...
戻り値
- <Object>
windowRect: 新しいウィンドウ状態に基づく「window rect」オブジェクトのJSON表現。
maximizeWindow
Maximize Windowコマンドは、現在の最上位ブラウジングコンテキストを含むウィンドウに対して、ウィンドウマネージャー固有の「最大化」操作があれば実行します。これは通常、フルスクリーンにすることなく、ウィンドウを最大限利用可能なサイズに拡大します。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.maximizeWindow()
例
loading...
戻り値
- <Object>
windowRect: 新しいウィンドウ状態に基づく「window rect」オブジェクトのJSON表現。
minimizeWindow
Minimize Windowコマンドは、現在の最上位ブラウジングコンテキストを含むウィンドウに対して、ウィンドウマネージャー固有の「最小化」操作があれば実行します。これは通常、ウィンドウをシステムトレイに隠します。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.minimizeWindow()
戻り値
- <Object>
windowRect: （新しい）現在の最上位ブラウジングコンテキストの「window rect」オブジェクトのJSON表現。
fullscreenWindow
Fullscreen Windowコマンドは、現在の最上位ブラウジングコンテキストを含むウィンドウに対して、ウィンドウマネージャー固有の「フルスクリーン」操作があれば実行します。これは通常、ウィンドウを物理ディスプレイのサイズに拡大し、ツールバーなどのブラウザのクローム要素を非表示にすることができます。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.fullscreenWindow()
戻り値
- <Object>
windowRect: （新しい）現在の最上位ブラウジングコンテキストの「window rect」オブジェクトのJSON表現。
findElement
Find Elementコマンドは、現在のブラウジングコンテキストで将来のコマンドに使用できる要素を見つけるために使用されます。このコマンドは、要素のJSON表現を返し、それを$コマンドに渡して参照を拡張WebdriverIO要素に変換できます。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは、以下の便利なメソッドに組み込まれています：$。代わりにこのコマンドを使用することをお勧めします。
使用法
browser.findElement(using, value)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
using | string | 有効な要素の位置戦略 |
value | string | 要素を見つけるために使用される実際のセレクタ |
例
loading...
戻り値
- <object>
element: 要素オブジェクトのJSON表現、例：{ 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }。
findElementFromShadowRoot
Find Element From Shadow Rootコマンドは、要素のシャドウルート内で将来のコマンドに使用できる要素を見つけるために使用されます。このコマンドは、要素のJSON表現を返し、それを$コマンドに渡して参照を拡張WebdriverIO要素に変換できます。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは、以下の便利なメソッドに組み込まれています：shadow$。代わりにこのコマンドを使用することをお勧めします。
使用法
browser.findElementFromShadowRoot(shadowId, using, value)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
shadowId | String | シャドウルート要素の要素ID |
using | string | 有効な要素の位置戦略 |
value | string | 要素を見つけるために使用される実際のセレクタ |
例
loading...
戻り値
- <object>
element: 要素シャドウオブジェクトのJSON表現、例：{ 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }。
findElements
Find Elementsコマンドは、現在のブラウジングコンテキストで将来のコマンドに使用できる要素を見つけるために使用されます。このコマンドは、要素のJSON表現の配列を返し、それを$コマンドに渡して参照を拡張WebdriverIO要素に変換できます（findElementを参照）。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは、以下の便利なメソッドに組み込まれています：$$。代わりにこのコマンドを使用することをお勧めします。
使用法
browser.findElements(using, value)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
using | string | 有効な要素の位置戦略 |
value | string | 要素を見つけるために使用される実際のセレクタ |
例
loading...
戻り値
- <object[]>
elements: 要素オブジェクトの表現のJSON リスト（空の場合もある）、例：[{ 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }]。
findElementsFromShadowRoot
Find Elementsコマンドは、要素のシャドウルート内で将来のコマンドに使用できる要素を見つけるために使用されます。このコマンドは、要素のJSON表現の配列を返し、それを$コマンドに渡して参照を拡張WebdriverIO要素に変換できます（findElementを参照）。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは、以下の便利なメソッドに組み込まれています：shadow$$。代わりにこのコマンドを使用することをお勧めします。
使用法
browser.findElementsFromShadowRoot(shadowId, using, value)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
shadowId | String | シャドウルート要素の要素ID |
using | string | 有効な要素の位置戦略 |
value | string | 要素を見つけるために使用される実際のセレクタ |
例
loading...
戻り値
- <object[]>
elements: 要素オブジェクトの表現のJSON リスト（空の場合もある）、例：{ 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }。
findElementFromElement
Find Element From Elementコマンドは、現在のブラウジングコンテキスト内のウェブ要素から、将来のコマンドに使用できる要素を見つけるために使用されます。このコマンドは、要素のJSON表現を返し、それを$コマンドに渡して参照を拡張WebdriverIO要素に変換できます（findElementを参照）。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは、以下の便利なメソッドに組み込まれています：$。代わりにこのコマンドを使用することをお勧めします。
使用法
browser.findElementFromElement(elementId, using, value)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
elementId | String | 以前のFind Element(s)の呼び出しで返された要素のID |
using | string | 有効な要素の位置戦略 |
value | string | 要素を見つけるために使用される実際のセレクタ |
例
loading...
戻り値
- <object>
element: 要素オブジェクトのJSON表現、例：{ 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }。
findElementsFromElement
Find Elements From Elementコマンドは、現在のブラウジングコンテキスト内のウェブ要素から、将来のコマンドに使用できる要素を見つけるために使用されます。このコマンドは、要素のJSON表現の配列を返し、それを$コマンドに渡して参照を拡張WebdriverIO要素に変換できます（findElementを参照）。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは、以下の便利なメソッドに組み込まれています：$$。代わりにこのコマンドを使用することをお勧めします。
使用法
browser.findElementsFromElement(elementId, using, value)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
elementId | String | 以前のFind Element(s)の呼び出しで返された要素のID |
using | string | 有効な要素の位置戦略 |
value | string | 要素を見つけるために使用される実際のセレクタ |
例
loading...
戻り値
- <object[]>
elements: 要素オブジェクトの表現のJSON リスト（空の場合もある）、例：[{ 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }]。
getElementShadowRoot
要素のシャドウルートオブジェクトを取得します。結果オブジェクトは、findElementFromShadowRootsやfindElementsFromShadowRootsなどを使用してこのシャドウルート内の要素を取得するために使用できます。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは、以下の便利なメソッドに組み込まれています：shadow$。代わりにこのコマンドを使用することをお勧めします。
使用法
browser.getElementShadowRoot(elementId)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
elementId | String | 以前のFind Element(s)の呼び出しで返された要素のID |
例
loading...
戻り値
- <string>
shadowRoot: 要素シャドウルートのJSON表現、例：{ 'shadow-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }。
getActiveElement
Get Active Elementは、現在のブラウジングコンテキストのドキュメント要素のアクティブな要素を返します。このコマンドは、要素のJSON表現を返し、それを$コマンドに渡して参照を拡張WebdriverIO要素に変換できます（findElementを参照）。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.getActiveElement()
例
loading...
戻り値
- <string>
element: 要素オブジェクトのJSON表現、例：{ 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }。
isElementSelected
Is Element Selectedは、参照された要素が選択されているかどうかを判断します。この操作は、チェックボックス状態とラジオボタン状態の入力要素、またはオプション要素でのみ意味があります。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは、以下の便利なメソッドに組み込まれています：isSelected。代わりにこのコマンドを使用することをお勧めします。
使用法
browser.isElementSelected(elementId)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
elementId | String | 以前のFind Element(s)の呼び出しで返された要素のID |
例
loading...
戻り値
- <Boolean>
isSelected: 選択状態に基づいてtrueまたはfalse。
isElementDisplayed
Is Element Displayedは、人間の目に知覚的に見えるものによって要素の可視性を判断します。このコンテキストでは、要素の表示状態はvisibilityまたはdisplayスタイルプロパティには関連しません。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは、以下の便利なメソッドに組み込まれています：isDisplayed。代わりにこのコマンドを使用することをお勧めします。
使用法
browser.isElementDisplayed(elementId)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
elementId | String | 以前のFind Element(s)の呼び出しで返された要素のID |
例
loading...
戻り値
- <Boolean>
isDisplayed: 可視状態に基づいてtrueまたはfalse。
getElementAttribute
Get Element Attributeコマンドは、Web要素の属性を返します。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは、以下の便利なメソッドに組み込まれています：getAttribute。代わりにこのコマンドを使用することをお勧めします。
使用法
browser.getElementAttribute(elementId, name)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
elementId | String | 以前のFind Element(s)の呼び出しで返された要素のID |
name | String | 取得する属性値の名前 |
例
loading...
戻り値
- <string>
attribute: 要素の名前付き属性。
getElementProperty
Get Element Propertyコマンドは、要素のプロパティを取得した結果を返します。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは、以下の便利なメソッドに組み込まれています：getProperty。代わりにこのコマンドを使用することをお勧めします。
使用法
browser.getElementProperty(elementId, name)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
elementId | String | 以前のFind Element(s)の呼び出しで返された要素のID |
name | String | 取得する属性プロパティの名前 |
例
loading...
戻り値
- <string>
property: 要素オブジェクトでGetOwnPropertyを呼び出してアクセスした要素の名前付きプロパティ。
getElementCSSValue
Get Element CSS Valueコマンドは、指定されたWeb要素の指定されたCSSプロパティの計算値を取得します。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは、以下の便利なメソッドに組み込まれています：getCSSProperty。代わりにこのコマンドを使用することをお勧めします。
使用法
browser.getElementCSSValue(elementId, propertyName)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
elementId | String | 以前のFind Element(s)の呼び出しで返された要素のID |
propertyName | String | 取得するCSSプロパティの名前 |
例
loading...
戻り値
- <string>
cssValue: 要素のスタイル宣言からのプロパティ名に対応するパラメータの計算値（ドキュメントタイプがxmlの場合を除き、その場合は単に空の文字列を返します）。
getElementText
Get Element Textコマンドは、要素のテキストを「レンダリングされたまま」返そうとします。要素のレンダリングされたテキストは、リンクテキストや部分的なリンクテキストによる要素の検索にも使用されます。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.getElementText(elementId)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
elementId | String | 以前のFind Element(s)の呼び出しで返された要素のID |
例
loading...
戻り値
- <string>
text: 要素の可視テキスト（子要素を含む）、Selenium Atomsで定義されているbot.dom.getVisibleTextのアルゴリズムに従います。
getElementTagName
Get Element Tag Nameコマンドは、指定されたWeb要素の修飾要素名を返します。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは、以下の便利なメソッドに組み込まれています：getTagName。代わりにこのコマンドを使用することをお勧めします。
使用法
browser.getElementTagName(elementId)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
elementId | String | 以前のFind Element(s)の呼び出しで返された要素のID |
例
loading...
戻り値
- <string>
text: 要素のtagName属性。
getElementRect
Get Element Rectコマンドは、指定されたWeb要素の寸法と座標を返します。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは、以下の便利なメソッドに組み込まれています：getSize、getLocation。代わりにこれらのコマンドを使用することをお勧めします。
使用法
browser.getElementRect(elementId)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
elementId | String | 以前のFind Element(s)の呼び出しで返された要素のID |
例
loading...
戻り値
- <Object>
elementRect: 要素の位置と境界矩形を表すJSONオブジェクト。
isElementEnabled
Is Element Enabledは、参照された要素が有効かどうかを判断します。この操作はフォームコントロールでのみ意味があります。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは、以下の便利なメソッドに組み込まれています：isEnabled。代わりにこのコマンドを使用することをお勧めします。
使用法
browser.isElementEnabled(elementId)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
elementId | String | 以前のFind Element(s)の呼び出しで返された要素のID |
例
loading...
戻り値
- <Boolean>
isEnabled: 要素がxmlドキュメント内にある場合、または無効なフォームコントロールである場合：false、それ以外の場合はtrue。
elementClick
Element Clickコマンドは、要素がまだポインターで操作可能でない場合はスクロールして表示し、その表示中の中心点をクリックします。要素の中心点が別の要素によって覆われている場合、要素クリックが遮断されたエラーが返されます。要素がビューポートの外にある場合、要素が操作できないエラーが返されます。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは、以下の便利なメソッドに組み込まれています：click。代わりにこのコマンドを使用することをお勧めします。
使用法
browser.elementClick(elementId)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
elementId | String | 以前のFind Element(s)の呼び出しで返された要素のID |
例
loading...
elementClear
Element Clearコマンドは、編集可能またはリセット可能な要素をスクロールして表示し、選択されたファイルまたはテキストコンテンツをクリアしようとします。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは、以下の便利なメソッドに組み込まれています：clearValue。代わりにこのコマンドを使用することをお勧めします。
使用法
browser.elementClear(elementId)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
elementId | String | 以前のFind Element(s)の呼び出しで返された要素のID |
例
loading...
elementSendKeys
Element Send Keysコマンドは、フォーム制御要素をスクロールして表示し、指定されたキーを要素に送信します。要素がキーボードで操作できない場合、要素が操作できないエラーが返されます。
キー入力状態は、「タイピング」の途中でnullキー（U+E000（NULL））を送信することでクリアできます。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.elementSendKeys(elementId, text)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
elementId | String | 以前のFind Element(s)の呼び出しで返された要素のID |
text | string | 要素にキーストロークとして送信する文字列 |
例
loading...
getPageSource
Get Page Sourceコマンドは、現在のブラウジングコンテキストのアクティブドキュメントのDOMの文字列シリアライゼーションを返します。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.getPageSource()
例
loading...
戻り値
- <string>
pageSource: 現在のブラウジングコンテキストのアクティブドキュメントのDOM
executeScript
Execute Scriptコマンドは、現在のブラウジングコンテキストのコンテキストでJavaScript関数を実行し、関数の戻り値を返します。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは、以下の便利なメソッドに組み込まれています：execute。代わりにこのコマンドを使用することをお勧めします。
使用法
browser.executeScript(script, args)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
script | string | 実行したいJavaScript関数本体を表す文字列 |
args | string, object, number, boolean, null, undefined[] | デシリアライズされて関数に引数として渡されるJSON値の配列 |
例
loading...
戻り値
- <*>
result: スクリプトの戻り値、スクリプトによって返されたPromiseの成功、またはスクリプトによって返されたPromiseの拒否理由となったエラー。
executeAsyncScript
Execute Async Scriptコマンドは、JavaScriptを匿名関数として実行させます。Execute Scriptコマンドとは異なり、関数の結果は無視されます。代わりに、関数に最後の引数として追加の引数が提供されます。これは、呼び出されると、その最初の引数を応答として返す関数です。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは、以下の便利なメソッドに組み込まれています：executeAsync。代わりにこのコマンドを使用することをお勧めします。
使用法
browser.executeAsyncScript(script, args)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
script | string | 実行したいJavaScript関数本体を表す文字列 |
args | string, object, number, boolean, null, undefined[] | デシリアライズされて関数に引数として渡されるJSON値の配列 |
例
loading...
戻り値
- <*>
result: スクリプトの戻り値、スクリプトによって返されたPromiseの成功、またはスクリプトによって返されたPromiseの拒否理由となったエラー。
getAllCookies
Get All Cookiesコマンドは、現在のブラウジングコンテキストのアクティブドキュメントのアドレスに関連付けられているすべてのCookieを返します。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.getAllCookies()
例
loading...
戻り値
- <Object[]>
cookies: シリアライズされたクッキーのリスト。各シリアライズされたクッキーには、nameとvalueに加えて返されるかもしれないいくつかのオプションフィールドがあります。
addCookie
Add Cookieコマンドは、アクティブドキュメントのアドレスに関連付けられたCookieストアに単一のCookieを追加します。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.addCookie(cookie)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
cookie | object | クッキーを表すJSONオブジェクト。少なくとも名前と値のフィールドを持ち、有効期限などを含む他のフィールドを持つこともできます |
例
loading...
deleteAllCookies
Delete All Cookiesコマンドは、アクティブドキュメントのアドレスに関連付けられているすべてのCookieの削除を可能にします。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.deleteAllCookies()
例
loading...
getNamedCookie
Get Named Cookieコマンドは、現在のブラウジングコンテキストのアクティブドキュメントのCookieストア内の関連Cookieから要求された名前のCookieを返します。Cookieが見つからない場合、そのようなCookieがないというエラーが返されます。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.getNamedCookie(name)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
name | String | 取得するクッキーの名前 |
例
loading...
戻り値
- <Object>
cookie: 名前と値のフィールドを持つシリアライズされたクッキー。path、domain、expiry-timeなどのオプションフィールドも存在する場合があります。
deleteCookie
Delete Cookieコマンドを使用すると、パラメータ名で単一のCookieを削除するか、nameが未定義の場合はアクティブドキュメントのアドレスに関連付けられているすべてのCookieを削除できます。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.deleteCookie(name)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
name | String | 削除するクッキーの名前 |
例
loading...
performActions
Perform Actionsコマンドは、複雑なユーザーアクションを実行するために使用されます。詳細については、仕様を参照してください。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.performActions(actions)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
actions | object[] | オブジェクトのリスト。各オブジェクトは入力ソースとそれに関連するアクションを表します |
releaseActions
Release Actionsコマンドは、現在押されているすべてのキーとポインターボタンを解放するために使用されます。これにより、状態が一連の明示的なアクションによって解放されたかのようにイベントが発生します。また、仮想デバイスのすべての内部状態をクリアします。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.releaseActions()
dismissAlert
Dismiss Alertコマンドは、存在する場合は単純なダイアログを閉じ、そうでない場合はエラーを返します。必ずしも閉じるボタンがないかもしれないアラートユーザープロンプトを閉じるリクエストは、それを受け入れるのと同じ効果があります。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.dismissAlert()
例
loading...
acceptAlert
Accept Alertコマンドは、存在する場合は単純なダイアログを受け入れ、そうでない場合はエラーを返します。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.acceptAlert()
getAlertText
Get Alert Textコマンドは、現在のユーザープロンプトのメッセージを返します。現在のユーザープロンプトがない場合は、エラーを返します。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.getAlertText()
例
loading...
戻り値
- <string>
alertText: ユーザープロンプトのメッセージ。
sendAlertText
Send Alert Textコマンドは、window.promptユーザープロンプトのテキストフィールドを指定された値に設定します。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.sendAlertText(text)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
text | string | プロンプトを設定する文字列 |
takeScreenshot
Take Screenshotコマンドは、最上位ブラウジングコンテキストのビューポートのスクリーンショットを撮ります。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.takeScreenshot()
戻り値
- <string>
screenshot: 初期ビューポートのスクリーンショットを構成するBase64エンコードされたPNG画像データ。
takeElementScreenshot
Take Element Screenshotコマンドは、要素の境界矩形によって包含される可視領域のスクリーンショットを撮ります。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.takeElementScreenshot(elementId, scroll)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
elementId | String | 以前のFind Element(s)の呼び出しで返された要素のID |
scrollオプション | boolean | 要素を表示するためにスクロールします。デフォルト：true |
戻り値
- <string>
screenshot: 表示内に要素をスクロールした後の要素の境界矩形の可視領域のスクリーンショットを構成するBase64エンコードされたPNG画像データ。
getElementComputedRole
要素の計算されたWAI-ARIAロールを取得します。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.getElementComputedRole(elementId)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
elementId | String | 以前のFind Element(s)の呼び出しで返された要素のID |
戻り値
- <string>
role: 要素のWAI-ARIAロールを計算した結果。
getElementComputedLabel
要素のアクセシブルな名前を取得します。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.getElementComputedLabel(elementId)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
elementId | String | 以前のFind Element(s)の呼び出しで返された要素のID |
戻り値
- <string>
label: 要素のアクセシブルな名前のアクセシブルな名前と説明の計算の結果。
setPermissions
PermissionDescriptorの許可状態のユーザー変更をシミュレートします。注意: この機能はまだすべてのブラウザに実装されていません。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.setPermissions(descriptor, state, oneRealm)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
descriptor | object | 強力な機能はそれぞれ、ウェブサイトがアクセス許可を要求できる1つ以上の側面を持っています。これらの側面を説明するために、各機能はPermissionDescriptorのサブタイプをその許可記述子タイプとして定義します。注意: この機能はまだすべてのブラウザに実装されていません。 |
state | string | 許可が付与されるか、拒否されるか、プロンプトが表示されるかを決定します。 |
oneRealmオプション | boolean | すべての実行コンテキストに権限を適用するかどうか。 |
例
// MIDIの権限を設定
browser.setPermissions(
{ name: 'midi', sysex: true },
'granted' // "denied"または"prompt"も可能
);
// クリップボードの権限を設定
browser.setPermissions({ name: 'clipboard-read' }, 'granted');
// これでクリップボードを読み取ることができます、例えば
const clipboardText = await browser.execute(() => navigator.clipboard.readText());
generateTestReport
テスト用のレポートを生成します。Reporting APIの拡張機能です。注意: この機能はまだすべてのブラウザに実装されていません。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.generateTestReport(message, group)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
message | string | レポートに表示されるメッセージ。 |
groupオプション | string | レポートを配信するエンドポイントグループを指定します。 |
createMockSensor
環境光センサーなどのセンサーをエミュレートするためのモックセンサーを作成します。注意: この機能はまだすべてのブラウザに実装されていません。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.createMockSensor(mockSensorType, maxSamplingFrequency, minSamplingFrequency)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
mockSensorType | string | モックするセンサーAPIのタイプ、例：'ambient-light' |
maxSamplingFrequencyオプション | number | 関連するモックセンサーの最大サポートサンプリング周波数を設定するために使用される、Hzでの周波数を表す倍精度浮動小数点数。 |
minSamplingFrequencyオプション | number | 関連するモックセンサーの最小サポートサンプリング周波数を設定するために使用される、Hzでの周波数を表す倍精度浮動小数点数。 |
getMockSensor
指定されたタイプのモックセンサーに関する情報を取得します。注意: この機能はまだすべてのブラウザに実装されていません。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.getMockSensor(type)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
type | String | 情報を取得するモックセンサータイプ。 |
戻り値
- <object>
sensorReading: モックセンサー読み取りの値。
updateMockSensor
モックセンサータイプを更新します。注意: この機能はまだすべてのブラウザに実装されていません。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.updateMockSensor(type, mockSensorType, maxSamplingFrequency, minSamplingFrequency)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
type | String | 情報を更新するモックセンサータイプ。 |
mockSensorType | string | モックするセンサーAPIのタイプ、例：'ambient-light' |
maxSamplingFrequencyオプション | number | 関連するモックセンサーの最大サポートサンプリング周波数を設定するために使用される、Hzでの周波数を表す倍精度浮動小数点数。 |
minSamplingFrequencyオプション | number | 関連するモックセンサーの最小サポートサンプリング周波数を設定するために使用される、Hzでの周波数を表す倍精度浮動小数点数。 |
deleteMockSensor
Delete Sessionコマンドは、現在のセッションに関連付けられている最上位ブラウジングコンテキストをすべて閉じ、接続を終了し、最後に現在のセッションを閉じます。注意: この機能はまだすべてのブラウザに実装されていません。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.deleteMockSensor(type)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
type | String | 削除するモックセンサータイプ。 |
setTimeZone
テスト目的のためのタイムゾーンの変更をシミュレートします。注意: この機能はまだすべてのブラウザに実装されていません。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.setTimeZone(time_zone)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
time_zone | string | タイムゾーンの名前、例：Asia/Tokyo |
addVirtualAuthenticator
ソフトウェア仮想認証器を作成します。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.addVirtualAuthenticator(protocol, transport, hasResidentKey, hasUserVerification, isUserConsenting, isUserVerified, extensions, uvm)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
protocolオプション | string | 有効な値：'ctap1/u2f'、'ctap2'、'ctap2_1'。 |
transportオプション | string | 有効な値：'usb'、'nfc'、'ble'または'internal'。 |
hasResidentKeyオプション | boolean | 有効な値：true、false。 |
hasUserVerificationオプション | boolean | 有効な値：true、false。 |
isUserConsentingオプション | boolean | 有効な値：true、false。 |
isUserVerifiedオプション | boolean | 有効な値：拡張機能識別子を含む配列。 |
extensionsオプション | string[] | 有効な値：最大3つのユーザー検証方法エントリ。 |
uvmオプション | object[] |
戻り値
- <string>
authenticatorId: 認証器の文字列IDを返します。
removeVirtualAuthenticator
以前に作成された仮想認証器を削除します。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.removeVirtualAuthenticator(authenticatorId)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
authenticatorId | String | 認証器のID |
addCredential
公開鍵資格情報ソースを既存の仮想認証器に注入します。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.addCredential(authenticatorId, credentialId, isResidentCredential, rpId, privateKey, userHandle, signCount, largeBlob)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
authenticatorId | String | 認証器のID |
credentialId | string | Base64urlエンコーディングを使用してエンコードされた資格情報ID。 |
isResidentCredential | boolean | trueに設定すると、クライアント側で検出可能な資格情報が作成されます。falseに設定すると、代わりにサーバー側の資格情報が作成されます。 |
rpId | string | 資格情報がスコープされているRelying Party ID。 |
privateKey | string | [RFC5958]に従って単一の秘密鍵を含む非対称鍵パッケージで、Base64urlエンコーディングを使用してエンコードされています。 |
userHandle | string | Base64urlエンコーディングを使用してエンコードされた資格情報に関連付けられたuserHandle。このプロパティは定義されていない場合があります。 |
signCount | number | 公開鍵資格情報ソースに関連付けられた署名カウンターの初期値。 |
largeBlobオプション | string | 公開鍵資格情報ソースに関連付けられた大きな資格情報ごとのBlob。Base64urlエンコーディングを使用してエンコードされています。このプロパティは定義されていない場合があります。 |
getCredentials
AddCredentialまたはnavigator.credentials.create()を使用して保存されたかどうかに関係なく、仮想認証器に保存されているすべての公開鍵資格情報ソースごとに1つの資格情報パラメータオブジェクトを返します。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.getCredentials(authenticatorId)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
authenticatorId | String | 認証器のID |
戻り値
- <object[]>
credentials: 資格情報の配列を返します。
removeAllCredentials
仮想認証器に保存されているすべての公開鍵資格情報ソースを削除します。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.removeAllCredentials(authenticatorId)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
authenticatorId | String | 認証器のID |
removeCredential
仮想認証器に保存されている公開鍵資格情報ソースを削除します。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.removeCredential(authenticatorId, credentialId)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
authenticatorId | String | 認証器のID |
credentialId | String | 資格情報のID |
setUserVerified
Set User Verified拡張コマンドは、仮想認証器上のisUserVerifiedプロパティを設定します。
WebDriverプロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.setUserVerified(authenticatorId)
パラメータ
| 名前 | 型 | 詳細 |
|---|---|---|
authenticatorId | String | 認証器のID |
