WebDriver プロトコル
newSession
New Sessionコマンドは、エンドポイントノードとの新しいWebDriverセッションを作成します。作成に失敗した場合、セッションが作成されなかったエラーが返されます。
WebDriverプロトコルコマンド。詳細については、公式プロトコルドキュメントを参照してください。
使用方法
browser.newSession(capabilities)
パラメータ
| 名前 | 種類 | 詳細 |
|---|---|---|
capabilities | object | JSONオブジェクト、機能処理アルゴリズムで最終的にマージおよびマッチングされた機能のセット |
戻り値
- <Object>
session: 作成されたWebDriverセッションのsessionIdと機能を含むオブジェクト。
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の呼び出しで返された文字列のいずれかである必要があります。 |
例
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オプション | ブール値 | ページの背景。デフォルト：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オプション | ブール値 | ページに収まるようにPDFを縮小します。デフォルト：true |
pageRangesオプション | object[] | ページ範囲。デフォルト[] |
例
loading...
戻り値
- <string>
pdf: ページ分割されたドキュメントのBase64エンコードされたPDF表現。
switchToFrame
Switch To Frameコマンドは、後続のコマンドの現在のブラウジングコンテキストとして使用する現在のトップレベルブラウジングコンテキスト、または現在のブラウジングコンテキストの子ブラウジングコンテキストを選択するために使用されます。
WebDriverプロトコルコマンドです。詳細については、公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは非推奨です
このコマンドは非推奨であり、フレームに切り替えるにはswitchFrameを使用することを推奨します。このコマンドの詳細については、https://webdriverio.dokyumento.jp/docs/api/browser/switchFrameを参照してください。
使用法
browser.switchToFrame(id)
パラメーター
| 名前 | 種類 | 詳細 |
|---|---|---|
id | 数値、オブジェクト、null | 3つの可能なタイプのいずれか。null：これはトップレベルのブラウジングコンテキスト（つまり、iframeではない）を表します。フレームに対応するwindowオブジェクトのインデックスを表す数値、またはfindElementを使用して受信したElementオブジェクト。 |
例
loading...
switchToParentFrame
Switch to Parent Frameコマンドは、今後のコマンドの現在のブラウジングコンテキストを、現在のブラウジングコンテキストの親に設定します。
WebDriverプロトコルコマンドです。詳細については、公式プロトコルドキュメントを参照してください。
使用法
browser.switchToParentFrame()
例
loading...
getWindowRect
Get Window Rectコマンドは、現在のトップレベルブラウジングコンテキストに対応するオペレーティングシステムウィンドウの画面上のサイズと位置を返します。
WebDriverプロトコルコマンドです。詳細については、公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは、次の便利なメソッドに組み込まれています：getWindowSize。代わりにこのコマンドを使用することをお勧めします。
使用法
browser.getWindowRect()
例
loading...
戻り値
- <Object>
windowRect: 「ウィンドウrect」オブジェクトのJSON表現。これには、x、y、width、heightの4つのプロパティがあります。
setWindowRect
Set Window Rectコマンドは、現在のトップレベルブラウジングコンテキストに対応するオペレーティングシステムウィンドウのサイズと位置を変更します。
WebDriverプロトコルコマンドです。詳細については、公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは、次の便利なメソッドに組み込まれています：setWindowSize。代わりにこのコマンドを使用することをお勧めします。
使用法
browser.setWindowRect(x, y, width, height)
パラメーター
| 名前 | 種類 | 詳細 |
|---|---|---|
x | 数値、null | ウィンドウオブジェクトのscreenX属性 |
y | 数値、null | windowオブジェクトのscreenY属性 |
width | 数値、null | ブラウザのクロムなどを含む、最上位のブラウジングコンテキストの外側の寸法（幅） |
height | 数値、null | ブラウザのクロムなどを含む、最上位のブラウジングコンテキストの外側の寸法（高さ） |
例
loading...
戻り値
- <Object>
windowRect: 新しいウィンドウの状態に基づいた "ウィンドウ矩形" オブジェクトのJSON表現。
maximizeWindow
Maximize Window コマンドは、現在の最上位ブラウジングコンテキストを含むウィンドウに対して、ウィンドウマネージャー固有の「最大化」操作（存在する場合）を呼び出します。これは通常、ウィンドウをフルスクリーンにすることなく、利用可能な最大のサイズに拡大します。
WebDriverプロトコルコマンド。詳細については、公式プロトコルドキュメントを参照してください。
使い方
browser.maximizeWindow()
例
loading...
戻り値
- <Object>
windowRect: 新しいウィンドウの状態に基づいた "ウィンドウ矩形" オブジェクトのJSON表現。
minimizeWindow
Minimize Window コマンドは、現在の最上位ブラウジングコンテキストを含むウィンドウに対して、ウィンドウマネージャー固有の「最小化」操作（存在する場合）を呼び出します。これは通常、ウィンドウをシステムトレイに隠します。
WebDriverプロトコルコマンド。詳細については、公式プロトコルドキュメントを参照してください。
使い方
browser.minimizeWindow()
戻り値
- <Object>
windowRect: （新しい）現在の最上位ブラウジングコンテキストの「ウィンドウ矩形」オブジェクトのJSON表現。
fullscreenWindow
Fullscreen Window コマンドは、現在の最上位ブラウジングコンテキストを含むウィンドウに対して、ウィンドウマネージャー固有の「フルスクリーン」操作（存在する場合）を呼び出します。これは通常、ウィンドウを物理ディスプレイのサイズに拡大し、ツールバーなどのブラウザクロム要素を非表示にできます。
WebDriverプロトコルコマンド。詳細については、公式プロトコルドキュメントを参照してください。
使い方
browser.fullscreenWindow()
戻り値
- <Object>
windowRect: （新しい）現在の最上位ブラウジングコンテキストの「ウィンドウ矩形」オブジェクトのJSON表現。
findElement
Find Element コマンドは、将来のコマンドで使用できる現在のブラウジングコンテキスト内の要素を検索するために使用されます。このコマンドは、拡張WebdriverIO要素への参照を変換するために $ コマンドに渡すことができる要素のJSON表現を返します。
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 コマンドは、将来のコマンドで使用できる要素のシャドウルート内の要素を検索するために使用されます。このコマンドは、拡張WebdriverIO要素への参照を変換するために $ コマンドに渡すことができる要素のJSON表現を返します。
WebDriverプロトコルコマンド。詳細については、公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは、次の便利なメソッドに組み込まれています：shadow$。代わりにこのコマンドを使用することをお勧めします。
使い方
browser.findElementFromShadowRoot(shadowId, using, value)
パラメータ
| 名前 | 種類 | 詳細 |
|---|---|---|
shadowId | 文字列 | シャドウルート要素の要素ID |
using | string | 有効な要素の場所特定戦略 |
value | string | 要素を見つけるために使用される実際のセレクター |
例
loading...
戻り値
- <object>
element: 要素シャドウオブジェクトのJSON表現。例：{ 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }。
findElements
Find Elements コマンドは、将来のコマンドで使用できる現在のブラウジングコンテキスト内の要素を検索するために使用されます。このコマンドは、$ コマンドに渡して拡張WebdriverIO要素への参照を変換できる要素のJSON表現の配列を返します（findElementを参照）。
WebDriverプロトコルコマンド。詳細については、公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは、次の便利なメソッドに組み込まれています：$$。代わりにこのコマンドを使用することをお勧めします。
使い方
browser.findElements(using, value)
パラメータ
| 名前 | 種類 | 詳細 |
|---|---|---|
using | string | 有効な要素の場所特定戦略 |
value | string | 要素を見つけるために使用される実際のセレクター |
例
loading...
戻り値
- <object[]>
elements: 要素オブジェクトの表現の（空の場合もある）JSONリスト。例：[{ 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }]。
findElementsFromShadowRoot
Find Elements コマンドは、将来のコマンドで使用できる要素のシャドウルート内の要素を検索するために使用されます。このコマンドは、$ コマンドに渡して拡張WebdriverIO要素への参照を変換できる要素のJSON表現の配列を返します（findElementを参照）。
WebDriverプロトコルコマンド。詳細については、公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは、次の便利なメソッドに組み込まれています：shadow$$。代わりにこのコマンドを使用することをお勧めします。
使い方
browser.findElementsFromShadowRoot(shadowId, using, value)
パラメータ
| 名前 | 種類 | 詳細 |
|---|---|---|
shadowId | 文字列 | シャドウルート要素の要素ID |
using | string | 有効な要素の場所特定戦略 |
value | string | 要素を見つけるために使用される実際のセレクター |
例
loading...
戻り値
- <object[]>
elements: 要素オブジェクトの表現の（空の場合もある）JSONリスト。例：{ 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }。
findElementFromElement
Find Element From Element コマンドは、将来のコマンドで使用できる現在のブラウジングコンテキスト内のWeb要素から要素を検索するために使用されます。このコマンドは、$ コマンドに渡して拡張WebdriverIO要素への参照を変換できる要素のJSON表現を返します（findElementを参照）。
WebDriverプロトコルコマンド。詳細については、公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは、次の便利なメソッドに組み込まれています：$。代わりにこのコマンドを使用することをお勧めします。
使い方
browser.findElementFromElement(elementId, using, value)
パラメータ
| 名前 | 種類 | 詳細 |
|---|---|---|
elementId | 文字列 | Find Element(s)への以前の呼び出しで返された要素のID |
using | string | 有効な要素の場所特定戦略 |
value | string | 要素を見つけるために使用される実際のセレクター |
例
loading...
戻り値
- <object>
element: 要素オブジェクトのJSON表現。例：{ 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }。
findElementsFromElement
Find Elements From Element コマンドは、将来のコマンドで使用できる現在のブラウジングコンテキスト内のWeb要素から要素を検索するために使用されます。このコマンドは、$ コマンドに渡して拡張WebdriverIO要素への参照を変換できる要素のJSON表現の配列を返します（findElementを参照）。
WebDriverプロトコルコマンド。詳細については、公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは、次の便利なメソッドに組み込まれています：$$。代わりにこのコマンドを使用することをお勧めします。
使い方
browser.findElementsFromElement(elementId, using, value)
パラメータ
| 名前 | 種類 | 詳細 |
|---|---|---|
elementId | 文字列 | 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 | 文字列 | Find Element(s)への以前の呼び出しで返された要素のID |
例
loading...
戻り値
- <string>
shadowRoot: 要素のシャドウルートのJSON表現。例：{ 'shadow-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }。
getActiveElement
アクティブ要素の取得は、現在のブラウジングコンテキストのドキュメント要素のアクティブな要素を返します。このコマンドは、拡張されたWebdriverIO要素への参照を変換するために、$コマンドに渡すことができる要素のJSON表現を返します（findElementを参照）。
WebDriverプロトコルコマンド。詳細については、公式プロトコルドキュメントを参照してください。
使い方
browser.getActiveElement()
例
loading...
戻り値
- <string>
element: 要素オブジェクトのJSON表現。例：{ 'element-6066-11e4-a52e-4f735466cecf': 'ELEMENT_1' }。
isElementSelected
要素が選択されているかどうかの判定は、参照されている要素が選択されているかどうかを判断します。この操作は、チェックボックスとラジオボタンの状態の入力要素、またはオプション要素でのみ意味を持ちます。
WebDriverプロトコルコマンド。詳細については、公式プロトコルのドキュメントをご覧ください。
このプロトコルコマンドは、次の便利なメソッドに組み込まれています：isSelected。代わりにこのコマンドを使用することをお勧めします。
使い方
browser.isElementSelected(elementId)
パラメータ
| 名前 | 種類 | 詳細 |
|---|---|---|
elementId | 文字列 | Find Element(s)への以前の呼び出しで返された要素のID |
例
loading...
戻り値
- <Boolean>
isSelected: 選択状態に基づいてtrueまたはfalse。
isElementDisplayed
要素が表示されているかどうかは、人間の目に見えるかどうかによって判断されます。このコンテキストでは、要素の表示状態は、visibilityやdisplayスタイルプロパティとは関係ありません。
WebDriverプロトコルコマンド。詳細については、公式プロトコルのドキュメントをご覧ください。
このプロトコルコマンドは、次の便利なメソッドに組み込まれています：isDisplayed。代わりにこのコマンドを使用することをお勧めします。
使い方
browser.isElementDisplayed(elementId)
パラメータ
| 名前 | 種類 | 詳細 |
|---|---|---|
elementId | 文字列 | Find Element(s)への以前の呼び出しで返された要素のID |
例
loading...
戻り値
- <Boolean>
isDisplayed: 表示状態に基づいてtrueまたはfalse。
getElementAttribute
要素属性の取得コマンドは、Web要素の属性を返します。
WebDriverプロトコルコマンド。詳細については、公式プロトコルのドキュメントをご覧ください。
このプロトコルコマンドは、次の便利なメソッドに組み込まれています：getAttribute。代わりにこのコマンドを使用することをお勧めします。
使い方
browser.getElementAttribute(elementId, name)
パラメータ
| 名前 | 種類 | 詳細 |
|---|---|---|
elementId | 文字列 | Find Element(s)への以前の呼び出しで返された要素のID |
name | 文字列 | 取得する属性値の名前 |
例
loading...
戻り値
- <string>
attribute: 要素の指定された属性。
getElementProperty
要素プロパティの取得コマンドは、要素のプロパティを取得した結果を返します。
WebDriverプロトコルコマンド。詳細については、公式プロトコルのドキュメントをご覧ください。
このプロトコルコマンドは、次の便利なメソッドに組み込まれています：getProperty。代わりにこのコマンドを使用することをお勧めします。
使い方
browser.getElementProperty(elementId, name)
パラメータ
| 名前 | 種類 | 詳細 |
|---|---|---|
elementId | 文字列 | Find Element(s)への以前の呼び出しで返された要素のID |
name | 文字列 | 取得する属性プロパティの名前 |
例
loading...
戻り値
- <string>
property: 要素の指定されたプロパティ。要素オブジェクトのGetOwnPropertyを呼び出すことでアクセスします。
getElementCSSValue
要素CSS値の取得コマンドは、指定されたWeb要素の指定されたCSSプロパティの計算された値を取得します。
WebDriverプロトコルコマンド。詳細については、公式プロトコルのドキュメントをご覧ください。
このプロトコルコマンドは、次の便利なメソッドに組み込まれています：getCSSProperty。代わりにこのコマンドを使用することをお勧めします。
使い方
browser.getElementCSSValue(elementId, propertyName)
パラメータ
| 名前 | 種類 | 詳細 |
|---|---|---|
elementId | 文字列 | Find Element(s)への以前の呼び出しで返された要素のID |
propertyName | 文字列 | 取得するCSSプロパティの名前 |
例
loading...
戻り値
- <string>
cssValue: 要素のスタイル宣言からプロパティ名に対応するパラメータの計算値（ドキュメントタイプがXMLの場合を除く。その場合は戻り値は単に空の文字列）。
getElementText
要素テキストの取得コマンドは、要素の「レンダリングされた」テキストを返すことを目的としています。要素のレンダリングされたテキストは、リンクテキストと部分リンクテキストで要素を検索するためにも使用されます。
WebDriverプロトコルコマンド。詳細については、公式プロトコルのドキュメントをご覧ください。
使い方
browser.getElementText(elementId)
パラメータ
| 名前 | 種類 | 詳細 |
|---|---|---|
elementId | 文字列 | Find Element(s)への以前の呼び出しで返された要素のID |
例
loading...
戻り値
- <string>
text:bot.dom.getVisibleTextのSelenium Atomsで定義されているアルゴリズムに従った、要素の可視テキスト（子要素を含む）。
getElementTagName
要素タグ名の取得コマンドは、指定されたWeb要素の修飾された要素名を返します。
WebDriverプロトコルコマンド。詳細については、公式プロトコルのドキュメントをご覧ください。
このプロトコルコマンドは、次の便利なメソッドに組み込まれています：getTagName。代わりにこのコマンドを使用することをお勧めします。
使い方
browser.getElementTagName(elementId)
パラメータ
| 名前 | 種類 | 詳細 |
|---|---|---|
elementId | 文字列 | Find Element(s)への以前の呼び出しで返された要素のID |
例
loading...
戻り値
- <string>
text: 要素のtagName属性。
getElementRect
要素矩形の取得コマンドは、指定されたWeb要素の寸法と座標を返します。
WebDriverプロトコルコマンド。詳細については、公式プロトコルのドキュメントをご覧ください。
このプロトコルコマンドは、次の便利なメソッドに組み込まれています：getSize、getLocation。代わりにこれらのコマンドを使用することをお勧めします。
使い方
browser.getElementRect(elementId)
パラメータ
| 名前 | 種類 | 詳細 |
|---|---|---|
elementId | 文字列 | Find Element(s)への以前の呼び出しで返された要素のID |
例
loading...
戻り値
- <Object>
elementRect: 要素の位置と境界矩形を表すJSONオブジェクト。
isElementEnabled
要素が有効かどうかを判断します。参照されている要素が有効かどうかを判断します。この操作は、フォームコントロールでのみ意味を持ちます。
WebDriverプロトコルコマンド。詳細については、公式プロトコルのドキュメントをご覧ください。
このプロトコルコマンドは、次の便利なメソッドに組み込まれています：isEnabled。代わりにこのコマンドを使用することをお勧めします。
使い方
browser.isElementEnabled(elementId)
パラメータ
| 名前 | 種類 | 詳細 |
|---|---|---|
elementId | 文字列 | Find Element(s)への以前の呼び出しで返された要素のID |
例
loading...
戻り値
- <Boolean>
isEnabled: 要素がXMLドキュメント内にある場合、または無効なフォームコントロールである場合はfalse、それ以外の場合はtrue。
elementClick
Element Clickコマンドは、要素がまだポインター操作可能でない場合は、要素をビューにスクロールし、ビュー内の中心点をクリックします。要素の中心点が別の要素によって隠されている場合、要素クリックがインターセプトされたエラーが返されます。要素がビューポートの外にある場合は、要素が操作不能エラーが返されます。
WebDriverプロトコルコマンド。詳細については、公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは、次の便利なメソッドに組み込まれています: click。代わりにこのコマンドを使用することをお勧めします。
使用法
browser.elementClick(elementId)
パラメータ
| 名前 | 種類 | 詳細 |
|---|---|---|
elementId | 文字列 | Find Element(s)への以前の呼び出しで返された要素のID |
例
loading...
elementClear
Element Clearコマンドは、編集可能またはリセット可能な要素をビューにスクロールし、選択されたファイルまたはテキストコンテンツをクリアしようとします。
WebDriverプロトコルコマンド。詳細については、公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは、次の便利なメソッドに組み込まれています: clearValue。代わりにこのコマンドを使用することをお勧めします。
使用法
browser.elementClear(elementId)
パラメータ
| 名前 | 種類 | 詳細 |
|---|---|---|
elementId | 文字列 | Find Element(s)への以前の呼び出しで返された要素のID |
例
loading...
elementSendKeys
Element Send Keysコマンドは、フォームコントロール要素をビューにスクロールし、指定されたキーを要素に送信します。要素がキーボード操作可能でない場合、要素が操作不能エラーが返されます。
入力に使用されるキー入力状態は、U+E000（NULL）であるヌルキーを送信することで、「入力」の途中でクリアできます。
WebDriverプロトコルコマンド。詳細については、公式プロトコルドキュメントを参照してください。
使用法
browser.elementSendKeys(elementId, text)
パラメータ
| 名前 | 種類 | 詳細 |
|---|---|---|
elementId | 文字列 | 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 | 文字列、オブジェクト、数値、ブール値、null、undefined[] | 逆シリアル化され、関数への引数として渡されるJSON値の配列 |
例
loading...
戻り値
- <*>
result: スクリプトの戻り値、スクリプトによって返されたPromiseの履行、またはスクリプトの返されたPromiseの拒否の原因となったエラーのいずれか。
executeAsyncScript
Execute Async Scriptコマンドは、JavaScriptを匿名関数として実行させます。Execute Scriptコマンドとは異なり、関数の結果は無視されます。代わりに、追加の引数が関数の最後の引数として提供されます。これは、呼び出されると、最初の引数を応答として返す関数です。
WebDriverプロトコルコマンド。詳細については、公式プロトコルドキュメントを参照してください。
このプロトコルコマンドは、次の便利なメソッドに組み込まれています: executeAsync。代わりにこのコマンドを使用することをお勧めします。
使用法
browser.executeAsyncScript(script, args)
パラメータ
| 名前 | 種類 | 詳細 |
|---|---|---|
script | string | 実行するJavaScript関数本体である文字列 |
args | 文字列、オブジェクト、数値、ブール値、null、undefined[] | 逆シリアル化され、関数への引数として渡されるJSON値の配列 |
例
loading...
戻り値
- <*>
result: スクリプトの戻り値、スクリプトによって返されたPromiseの履行、またはスクリプトの返されたPromiseの拒否の原因となったエラーのいずれか。
getAllCookies
Get All Cookiesコマンドは、現在の閲覧コンテキストのアクティブなドキュメントのアドレスに関連付けられたすべてのCookieを返します。
WebDriverプロトコルコマンド。詳細については、公式プロトコルドキュメントを参照してください。
使用法
browser.getAllCookies()
例
loading...
戻り値
- <Object[]>
cookies: シリアライズされたCookieのリスト。シリアライズされた各Cookieには、nameとvalueに加えて、オプションのフィールドがいくつかあります。これらのフィールドは返される場合と返されない場合があります。
addCookie
Add Cookieコマンドは、アクティブなドキュメントのアドレスに関連付けられたCookieストアに単一のCookieを追加します。
WebDriverプロトコルコマンド。詳細については、公式プロトコルドキュメントを参照してください。
使用法
browser.addCookie(cookie)
パラメータ
| 名前 | 種類 | 詳細 |
|---|---|---|
cookie | object | Cookieを表すJSONオブジェクト。少なくともnameとvalueフィールドがあり、有効期限などを含むさらに多くのフィールドを持つことができます |
例
loading...
deleteAllCookies
Delete All Cookiesコマンドを使用すると、アクティブなドキュメントのアドレスに関連付けられたすべてのCookieを削除できます。
WebDriverプロトコルコマンド。詳細については、公式プロトコルドキュメントを参照してください。
使用法
browser.deleteAllCookies()
例
loading...
getNamedCookie
Get Named Cookieコマンドは、現在の閲覧コンテキストのアクティブなドキュメントのCookieストアにある、関連付けられたCookieからリクエストされた名前のCookieを返します。Cookieが見つからない場合は、そのようなCookieエラーがないことが返されます。
WebDriverプロトコルコマンド。詳細については、公式プロトコルドキュメントを参照してください。
使用法
browser.getNamedCookie(name)
パラメータ
| 名前 | 種類 | 詳細 |
|---|---|---|
name | 文字列 | 取得するCookieの名前 |
例
loading...
戻り値
- <Object>
cookie: シリアライズされたCookie。nameフィールドとvalueフィールドがあります。path、domain、expiry-timeのようなオプションのフィールドも存在する可能性があります。
deleteCookie
Delete Cookieコマンドを使用すると、パラメータ名で単一のCookieを削除するか、名前が未定義の場合はアクティブなドキュメントのアドレスに関連付けられたすべてのCookieを削除できます。
WebDriverプロトコルコマンド。詳細については、公式プロトコルドキュメントを参照してください。
使用法
browser.deleteCookie(name)
パラメータ
| 名前 | 種類 | 詳細 |
|---|---|---|
name | 文字列 | 削除するCookieの名前 |
例
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 | 文字列 | Find Element(s)への以前の呼び出しで返された要素のID |
scrollオプション | ブール値 | 要素をスクロールして表示します。デフォルト：true |
戻り値
- <string>
screenshot: 表示されるまでスクロールされた後の、要素のバウンディング矩形の可視領域のスクリーンショットで構成される base64 エンコードされた PNG イメージデータ。
getElementComputedRole
要素の計算された WAI-ARIA ロールを取得します。
WebDriverプロトコルコマンド。詳細については、公式プロトコルドキュメントを参照してください。
使い方
browser.getElementComputedRole(elementId)
パラメータ
| 名前 | 種類 | 詳細 |
|---|---|---|
elementId | 文字列 | Find Element(s)への以前の呼び出しで返された要素のID |
戻り値
- <string>
role: 要素の WAI-ARIA ロールを計算した結果。
getElementComputedLabel
要素のアクセシブルな名前を取得します。
WebDriverプロトコルコマンド。詳細については、公式プロトコルドキュメントを参照してください。
使い方
browser.getElementComputedLabel(elementId)
パラメータ
| 名前 | 種類 | 詳細 |
|---|---|---|
elementId | 文字列 | Find Element(s)への以前の呼び出しで返された要素のID |
戻り値
- <string>
label: 要素のアクセシブルな名前に対するアクセシブルな名前と説明の計算の結果。
setPermissions
PermissionDescriptor の許可状態に対するユーザーの変更をシミュレートします。注: この機能は、まだすべてのブラウザで実装されていません。
WebDriverプロトコルコマンド。詳細については、公式プロトコルドキュメントを参照してください。
使い方
browser.setPermissions(descriptor, state, oneRealm)
パラメータ
| 名前 | 種類 | 詳細 |
|---|---|---|
descriptor | object | 各強力な機能には、Webサイトがアクセス許可を要求できる1つ以上のアスペクトがあります。これらのアスペクトを記述するために、各機能は PermissionDescriptor のサブタイプをその許可記述子タイプとして定義します。注: この機能は、まだすべてのブラウザで実装されていません。 |
state | string | 許可が付与されているか、拒否されているか、プロンプトが表示されているかを決定します。 |
oneRealmオプション | ブール値 | すべての実行コンテキストに許可を適用するかどうか。 |
例
// set midi permissions
browser.setPermissions(
{ name: 'midi', sysex: true },
'granted' // can be also "denied" or "prompt"
);
// set clipboard permissions
browser.setPermissions({ name: 'clipboard-read' }, 'granted');
// now you can read the clipboard via, e.g.
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単位の周波数を表す double 値。 |
minSamplingFrequencyオプション | number | 関連するモックセンサーに対してサポートされている最小サンプリング周波数を設定するために使用されるHz単位の周波数を表す double 値。 |
getMockSensor
特定のタイプのモックセンサーに関する情報を取得します。注: この機能は、まだすべてのブラウザで実装されていません。
WebDriverプロトコルコマンド。詳細については、公式プロトコルドキュメントを参照してください。
使い方
browser.getMockSensor(type)
パラメータ
| 名前 | 種類 | 詳細 |
|---|---|---|
type | 文字列 | 情報を取得するモックセンサーのタイプ。 |
戻り値
- <object>
sensorReading: モックセンサーの読み取り値。
updateMockSensor
モックセンサーのタイプを更新します。注: この機能は、まだすべてのブラウザで実装されていません。
WebDriverプロトコルコマンド。詳細については、公式プロトコルドキュメントを参照してください。
使い方
browser.updateMockSensor(type, mockSensorType, maxSamplingFrequency, minSamplingFrequency)
パラメータ
| 名前 | 種類 | 詳細 |
|---|---|---|
type | 文字列 | 情報を更新するモックセンサーのタイプ。 |
mockSensorType | string | モックするセンサーAPIのタイプ（例：'ambient-light'） |
maxSamplingFrequencyオプション | number | 関連するモックセンサーに対してサポートされている最大サンプリング周波数を設定するために使用されるHz単位の周波数を表す double 値。 |
minSamplingFrequencyオプション | number | 関連するモックセンサーに対してサポートされている最小サンプリング周波数を設定するために使用されるHz単位の周波数を表す double 値。 |
deleteMockSensor
Delete Session コマンドは、現在のセッションに関連付けられたトップレベルのブラウジングコンテキストを閉じ、接続を終了し、最後に現在のセッションを閉じます。注: この機能は、まだすべてのブラウザで実装されていません。
WebDriverプロトコルコマンド。詳細については、公式プロトコルドキュメントを参照してください。
使い方
browser.deleteMockSensor(type)
パラメータ
| 名前 | 種類 | 詳細 |
|---|---|---|
type | 文字列 | 削除するモックセンサーのタイプ。 |
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オプション | ブール値 | 有効な値：true、false。 |
hasUserVerificationオプション | ブール値 | 有効な値：true、false。 |
isUserConsentingオプション | ブール値 | 有効な値：true、false。 |
isUserVerifiedオプション | ブール値 | 有効な値：拡張識別子を含む配列。 |
extensionsオプション | string[] | 有効な値：最大3つのユーザー検証方法エントリ。 |
uvmオプション | object[] |
戻り値
- <string>
authenticatorId：認証器の文字列IDを返します。
removeVirtualAuthenticator
以前に作成された仮想認証器を削除します。
WebDriver プロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.removeVirtualAuthenticator(authenticatorId)
パラメータ
| 名前 | 種類 | 詳細 |
|---|---|---|
authenticatorId | 文字列 | 認証器のID |
addCredential
既存の仮想認証器に公開鍵クレデンシャルソースを注入します。
WebDriver プロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.addCredential(authenticatorId, credentialId, isResidentCredential, rpId, privateKey, userHandle, signCount, largeBlob)
パラメータ
| 名前 | 種類 | 詳細 |
|---|---|---|
authenticatorId | 文字列 | 認証器のID |
credentialId | string | Base64urlエンコーディングを使用してエンコードされたクレデンシャルID。 |
isResidentCredential | ブール値 | trueに設定すると、クライアント側で検出可能なクレデンシャルが作成されます。 falseに設定すると、代わりにサーバー側のクレデンシャルが作成されます。 |
rpId | string | クレデンシャルがスコープされるリライングパーティID。 |
privateKey | string | [RFC5958]に従って、Base64urlエンコーディングを使用してエンコードされた、単一の秘密鍵を含む非対称鍵パッケージ。 |
userHandle | string | Base64urlエンコーディングを使用してエンコードされた、クレデンシャルに関連付けられたuserHandle。このプロパティは定義されない場合があります。 |
signCount | number | 公開鍵クレデンシャルソースに関連付けられた署名カウンターの初期値。 |
largeBlobオプション | string | Base64urlエンコーディングを使用してエンコードされた、公開鍵クレデンシャルソースに関連付けられた、大きなクレデンシャルごとのブロブ。このプロパティは定義されない場合があります。 |
getCredentials
仮想認証器に格納されているすべての公開鍵クレデンシャルソースに対して、Add Credentialまたはnavigator.credentials.create()を使用して格納されたかどうかにかかわらず、1つのクレデンシャルパラメーターオブジェクトを返します。
WebDriver プロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.getCredentials(authenticatorId)
パラメータ
| 名前 | 種類 | 詳細 |
|---|---|---|
authenticatorId | 文字列 | 認証器のID |
戻り値
- <object[]>
credentials：クレデンシャルの配列を返します。
removeAllCredentials
仮想認証器に格納されているすべての公開鍵クレデンシャルソースを削除します。
WebDriver プロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.removeAllCredentials(authenticatorId)
パラメータ
| 名前 | 種類 | 詳細 |
|---|---|---|
authenticatorId | 文字列 | 認証器のID |
removeCredential
仮想認証器に格納されている公開鍵クレデンシャルソースを削除します。
WebDriver プロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.removeCredential(authenticatorId, credentialId)
パラメータ
| 名前 | 種類 | 詳細 |
|---|---|---|
authenticatorId | 文字列 | 認証器のID |
credentialId | 文字列 | クレデンシャルのID |
setUserVerified
Set User Verified拡張コマンドは、仮想認証器のisUserVerifiedプロパティを設定します。
WebDriver プロトコルコマンド。詳細は公式プロトコルドキュメントを参照してください。
使用法
browser.setUserVerified(authenticatorId)
パラメータ
| 名前 | 種類 | 詳細 |
|---|---|---|
authenticatorId | 文字列 | 認証器のID |
