AndroidDevice
AndroidDeviceは、接続されたデバイス(実際のハードウェアまたはエミュレートされたもの)を表します。デバイスは、android.devices()を使用して取得できます。
メソッド
close
追加バージョン: v1.9デバイスから切断します。
使用法
await androidDevice.close();
戻り値
drag
追加バージョン: v1.9指定されたセレクターで定義されたウィジェットを宛先点に向けてドラッグします。
使用法
await androidDevice.drag(selector, dest);
await androidDevice.drag(selector, dest, options);
引数
-
selector
[AndroidSelector]#ドラッグするセレクター。
-
ドラッグ先の座標。
-
options
Object (オプション)-
オプションで、ドラッグの速度をピクセル/秒で指定します。
-
ミリ秒単位の最大時間で、デフォルトは30秒です。タイムアウトを無効にするには
0
を渡します。デフォルト値はandroidDevice.setDefaultTimeout()メソッドを使用して変更できます。
-
戻り値
fill
追加バージョン: v1.9使用法
await androidDevice.fill(selector, text);
await androidDevice.fill(selector, text, options);
引数
-
selector
[AndroidSelector]#入力するセレクター。
-
入力ボックスに記入するテキスト。
-
options
Object (オプション)-
ミリ秒単位の最大時間で、デフォルトは30秒です。タイムアウトを無効にするには
0
を渡します。デフォルト値はandroidDevice.setDefaultTimeout()メソッドを使用して変更できます。
-
戻り値
fling
追加バージョン: v1.9指定されたセレクターで定義されたウィジェットを指定された方向にフリックします。
使用法
await androidDevice.fling(selector, direction);
await androidDevice.fling(selector, direction, options);
引数
-
selector
[AndroidSelector]#フリックするセレクター。
-
direction
"down" | "up" | "left" | "right"#フリック方向。
-
options
Object (オプション)-
オプションで、フリックの速度をピクセル/秒で指定します。
-
ミリ秒単位の最大時間で、デフォルトは30秒です。タイムアウトを無効にするには
0
を渡します。デフォルト値はandroidDevice.setDefaultTimeout()メソッドを使用して変更できます。
-
戻り値
info
追加バージョン: v1.9セレクターで定義されたウィジェットに関する情報を返します。
使用法
await androidDevice.info(selector);
引数
-
selector
[AndroidSelector]#情報を取得するセレクター。
戻り値
installApk
追加バージョン: v1.9デバイスにapkをインストールします。
使用法
await androidDevice.installApk(file);
await androidDevice.installApk(file, options);
引数
-
apkファイルへのパス、またはapkファイルの内容のいずれか。
-
options
Object (オプション)
戻り値
launchBrowser
追加バージョン: v1.9デバイス上でChromeブラウザを起動し、その永続コンテキストを返します。
使用法
await androidDevice.launchBrowser();
await androidDevice.launchBrowser(options);
引数
options
Object (オプション)-
acceptDownloads
boolean (オプション)#すべての添付ファイルを自動的にダウンロードするかどうか。デフォルトは
true
で、すべてのダウンロードが許可されます。 -
args
Array<string> (オプション)追加バージョン: v1.29#警告カスタムブラウザ引数を使用すると、Playwrightの機能が一部損なわれる可能性があるため、自己責任でご使用ください。
ブラウザインスタンスに渡す追加引数。Chromiumフラグのリストはこちらで確認できます。
-
page.goto()、page.route()、page.waitForURL()、page.waitForRequest()、またはpage.waitForResponse()を使用する場合、対応するURLを構築するために
URL()
コンストラクタを使用してベースURLを考慮します。デフォルトでは設定されていません。例- baseURL:
https://:3000
で/bar.html
に移動すると、https://:3000/bar.html
になります。 - baseURL:
https://:3000/foo/
で./bar.html
に移動すると、https://:3000/foo/bar.html
になります。 - baseURL:
https://:3000/foo
(末尾のスラッシュなし)で./bar.html
に移動すると、https://:3000/bar.html
になります。
- baseURL:
-
ページのContent-Security-Policyのバイパスを切り替えます。デフォルトは
false
です。 -
colorScheme
null | "light" | "dark" | "no-preference" (オプション)#prefers-colors-schemeメディア機能をエミュレートします。サポートされる値は
'light'
と'dark'
です。詳細はpage.emulateMedia()を参照してください。null
を渡すと、エミュレーションがシステムのデフォルトにリセットされます。デフォルトは'light'
です。 -
contrast
null | "no-preference" | "more" (オプション)#'prefers-contrast'
メディア機能をエミュレートします。サポートされる値は'no-preference'
、'more'
です。詳細はpage.emulateMedia()を参照してください。null
を渡すと、エミュレーションがシステムのデフォルトにリセットされます。デフォルトは'no-preference'
です。 -
deviceScaleFactor
number (オプション)#デバイスのスケールファクター(dprとして考えられます)を指定します。デフォルトは
1
です。デバイススケールファクターでのデバイスエミュレーションについて詳しくはこちらをご覧ください。 -
extraHTTPHeaders
Object<string, string> (オプション)#すべてのリクエストとともに送信される追加のHTTPヘッダーを含むオブジェクト。デフォルトはなし。
-
forcedColors
null | "active" | "none" (オプション)#'forced-colors'
メディア機能をエミュレートします。サポートされる値は'active'
、'none'
です。詳細はpage.emulateMedia()を参照してください。null
を渡すと、エミュレーションがシステムのデフォルトにリセットされます。デフォルトは'none'
です。 -
ビューポートがタッチイベントをサポートするかどうかを指定します。デフォルトはfalseです。モバイルエミュレーションについて詳しくはこちらをご覧ください。
-
httpCredentials
Object (オプション)#-
username
string -
password
string -
origin
string (オプション)特定のオリジン (scheme://host):port).
-
send
"unauthorized" | "always" (オプション)このオプションは、対応するAPIRequestContextから送信されたリクエストにのみ適用され、ブラウザから送信されたリクエストには影響しません。
'always'
- 各APIリクエストとともにBasic認証資格情報を含むAuthorization
ヘッダーが送信されます。'unauthorized
- 資格情報は、WWW-Authenticate
ヘッダーを含む401 (Unauthorized) レスポンスが受信された場合にのみ送信されます。デフォルトは'unauthorized'
です。
HTTP認証の資格情報。オリジンが指定されていない場合、ユーザー名とパスワードは不正なレスポンスを受け取った場合にすべてのサーバーに送信されます。
-
-
ignoreHTTPSErrors
boolean (オプション)#ネットワークリクエストを送信する際にHTTPSエラーを無視するかどうか。デフォルトは
false
です。 -
meta viewport
タグが考慮され、タッチイベントが有効になるかどうか。isMobileはデバイスの一部であるため、手動で設定する必要はありません。デフォルトはfalse
であり、Firefoxではサポートされていません。モバイルエミュレーションについて詳しくはこちらをご覧ください。 -
javaScriptEnabled
boolean (オプション)#コンテキストでJavaScriptを有効にするかどうか。デフォルトは
true
です。JavaScriptの無効化について詳しくはこちらをご覧ください。 -
ユーザーロケールを指定します。例:
en-GB
、de-DE
など。ロケールはnavigator.language
の値、Accept-Language
リクエストヘッダーの値、および数値と日付の書式設定ルールに影響します。デフォルトはシステムのデフォルトロケールです。エミュレーションに関する詳細はエミュレーションガイドをご覧ください。 -
Playwrightのログ出力先となるロガーシンク。
-
ネットワークがオフラインであることをエミュレートするかどうか。デフォルトは
false
です。ネットワークエミュレーションについて詳しくはこちらをご覧ください。 -
permissions
Array<string> (オプション)#このコンテキストのすべてのページに付与する権限のリスト。詳細はbrowserContext.grantPermissions()を参照してください。デフォルトはなし。
-
デフォルトのAndroid用Chromeの代わりに起動するオプションのパッケージ名。
-
proxy
Object (オプション)追加バージョン: v1.29#-
server
stringすべてのリクエストに使用するプロキシ。HTTPおよびSOCKSプロキシがサポートされており、例えば
http://myproxy.com:3128
またはsocks5://myproxy.com:3128
です。省略形myproxy.com:3128
はHTTPプロキシと見なされます。 -
bypass
string (オプション)プロキシをバイパスするオプションのカンマ区切りドメイン。例:
".com, chromium.org, .domain.com"
。 -
username
string (オプション)HTTPプロキシが認証を必要とする場合に使用するオプションのパスワード。
-
password
string (オプション)ネットワークプロキシ設定。
-
-
omitContent
boolean (オプション)-
HARからリクエストコンテンツを省略するかどうかを制御するオプション設定。デフォルトは
false
です。非推奨です。代わりにcontent
ポリシーを使用してください。content
"omit" | "embed" | "attach" (オプション) -
リソースコンテンツの管理を制御するオプション設定。
omit
が指定されている場合、コンテンツは保持されません。attach
が指定されている場合、リソースは個別のファイルまたはZIPアーカイブ内のエントリとして保持されます。embed
が指定されている場合、HAR仕様に従ってコンテンツはHARファイル内にインラインで保存されます。.zip
出力ファイルの場合はデフォルトでattach
、その他のファイル拡張子の場合はembed
です。path
string -
HARファイルを書き込むファイルシステム上のパス。ファイル名が
.zip
で終わる場合、デフォルトでcontent: 'attach'
が使用されます。mode
"full" | "minimal" (オプション) -
minimal
に設定すると、HARからのルーティングに必要な情報のみが記録されます。これにより、HARから再生する際に使用されないサイズ、タイミング、ページ、クッキー、セキュリティ、およびその他の種類のHAR情報は省略されます。デフォルトはfull
です。 -
HARに保存されるリクエストをフィルタリングするためのglobまたは正規表現パターン。コンテキストオプションを介してbaseURLが提供され、渡されたURLがパスである場合、
new URL()
コンストラクタを介してマージされます。デフォルトはなし。すべてのページのHAR記録を
recordHar.path
ファイルに有効にします。指定されていない場合、HARは記録されません。HARを保存するには、browserContext.close()をawaitすることを確認してください。
-
-
dir
string-
ビデオを保存するディレクトリへのパス。
size
Object (オプション) -
width
number-
ビデオフレームの幅。
height
number -
ビデオフレームの高さ。
記録されるビデオのオプションの寸法。指定されていない場合、サイズは800x800に収まるように
viewport
を縮小したサイズになります。viewport
が明示的に設定されていない場合、ビデオサイズはデフォルトで800x450になります。各ページの実際の画像は、指定されたサイズに収まるように必要に応じて縮小されます。
すべてのページのビデオ記録を
recordVideo.dir
ディレクトリに有効にします。指定されていない場合、ビデオは記録されません。ビデオを保存するには、browserContext.close()をawaitすることを確認してください。 -
-
-
'prefers-reduced-motion'
メディア機能をエミュレートします。サポートされる値は'reduce'
、'no-preference'
です。詳細はpage.emulateMedia()を参照してください。null
を渡すと、エミュレーションがシステムのデフォルトにリセットされます。デフォルトは'no-preference'
です。 -
ページの幅(ピクセル単位)。
-
ビデオフレームの幅。
ページの高さ(ピクセル単位)。
-
ビデオフレームの高さ。
window.screen
を介してウェブページ内で利用可能な一貫したウィンドウ画面サイズをエミュレートします。ビューポートが設定されている場合にのみ使用されます。
serviceWorkers
"allow" | "block" (オプション)# -
-
サイトがService Workerを登録することを許可するかどうか。デフォルトは
'allow'
です。'allow'
: Service Workersを登録できます。 -
trueに設定すると、このコンテキストで厳格セレクターモードが有効になります。厳格セレクターモードでは、単一のターゲットDOM要素を意味するセレクターに対するすべての操作は、複数の要素がセレクターに一致する場合にエラーをスローします。このオプションはLocator APIには影響しません(Locatorは常に厳格です)。デフォルトは
false
です。厳格モードの詳細については、Locatorを参照してください。 -
コンテキストのタイムゾーンを変更します。サポートされているタイムゾーンIDのリストについては、ICUのmetaZones.txtを参照してください。デフォルトはシステムのタイムゾーンです。
-
このコンテキストで使用する特定のユーザーエージェント。
-
非推奨
代わりにrecordVideoを使用してください。-
ビデオフレームの幅。
height
number -
ビデオフレームの高さ。
記録されるビデオのオプションの寸法。指定されていない場合、サイズは800x800に収まるように
viewport
を縮小したサイズになります。viewport
が明示的に設定されていない場合、ビデオサイズはデフォルトで800x450になります。各ページの実際の画像は、指定されたサイズに収まるように必要に応じて縮小されます。
-
-
viewport
null | Object (オプション)#代わりにrecordVideoを使用してください。 -
各ページで一貫したビューポートをエミュレートします。デフォルトは1280x720のビューポートです。一貫したビューポートのエミュレーションを無効にするには
null
を使用します。ビューポートエミュレーションについて詳しくはこちらをご覧ください。-
ビデオフレームの幅。
ページの高さ(ピクセル単位)。
-
ビデオフレームの高さ。
window.screen
を介してウェブページ内で利用可能な一貫したウィンドウ画面サイズをエミュレートします。ビューポートが設定されている場合にのみ使用されます。
注意
null
値はデフォルトのプリセットからオプトアウトし、ビューポートをオペレーティングシステムによって定義されたホストウィンドウサイズに依存させます。これにより、テストの実行は非決定論的になります。 -
-
戻り値
- longTap
androidDevice.longTap
追加バージョン: v1.9selector
[AndroidSelector]#
使用法
await androidDevice.longTap(selector);
await androidDevice.longTap(selector, options);
引数
-
タップするセレクター。
-
options
Object (オプション)-
ミリ秒単位の最大時間で、デフォルトは30秒です。タイムアウトを無効にするには
0
を渡します。デフォルト値はandroidDevice.setDefaultTimeout()メソッドを使用して変更できます。
-
戻り値
- model
androidDevice.model
追加バージョン: v1.9使用法
androidDevice.model();
戻り値
- open
androidDevice.open
追加バージョン: v1.9使用法
await androidDevice.open(command);
引数
-
実行するシェルコマンド。
戻り値
- pinchClose
androidDevice.pinchClose
追加バージョン: v1.9selector
[AndroidSelector]#
使用法
await androidDevice.pinchClose(selector, percent);
await androidDevice.pinchClose(selector, percent, options);
引数
-
ピンチクローズするセレクター。
-
ウィジェットのサイズに対するピンチのサイズをパーセンテージで指定します。
-
options
Object (オプション)
戻り値
- pinchOpen
androidDevice.pinchOpen
追加バージョン: v1.9selector
[AndroidSelector]#
使用法
await androidDevice.pinchOpen(selector, percent);
await androidDevice.pinchOpen(selector, percent, options);
引数
-
ピンチオープンするセレクター。
-
options
Object (オプション)
戻り値
- press
androidDevice.press
追加バージョン: v1.9selector
[AndroidSelector]#
使用法
await androidDevice.press(selector, key);
await androidDevice.press(selector, key, options);
引数
-
キーを押すセレクター。
key
[AndroidKey]# -
押すキー。
-
options
Object (オプション)-
ミリ秒単位の最大時間で、デフォルトは30秒です。タイムアウトを無効にするには
0
を渡します。デフォルト値はandroidDevice.setDefaultTimeout()メソッドを使用して変更できます。
-
戻り値
- push
androidDevice.push
追加バージョン: v1.9使用法
await androidDevice.push(file, path);
await androidDevice.push(file, path, options);
引数
-
ファイルへのパス、またはファイルの内容のいずれか。
-
デバイス上のファイルへのパス。
-
options
Object (オプション)
戻り値
- screenshot
androidDevice.screenshot
追加バージョン: v1.9使用法
await androidDevice.screenshot();
await androidDevice.screenshot(options);
引数
options
Object (オプション)
戻り値
- scroll
androidDevice.scroll
追加バージョン: v1.9selector
[AndroidSelector]#
使用法
await androidDevice.scroll(selector, direction, percent);
await androidDevice.scroll(selector, direction, percent, options);
引数
-
スクロールするセレクター。
direction
"down" | "up" | "left" | "right"# -
スクロール方向。
-
ウィジェットのサイズに対するスクロール距離をパーセンテージで指定します。
-
options
Object (オプション)
戻り値
- serial
androidDevice.serial
追加バージョン: v1.9使用法
androidDevice.serial();
戻り値
- setDefaultTimeout
androidDevice.setDefaultTimeout
追加バージョン: v1.9使用法
androidDevice.setDefaultTimeout(timeout);
引数
-
ミリ秒単位の最大時間
shell
androidDevice.shell
追加バージョン: v1.9使用法
await androidDevice.shell(command);
引数
戻り値
- swipe
androidDevice.swipe
追加バージョン: v1.9selector
[AndroidSelector]#
使用法
await androidDevice.swipe(selector, direction, percent);
await androidDevice.swipe(selector, direction, percent, options);
引数
-
スワイプするセレクター。
direction
"down" | "up" | "left" | "right"# -
スワイプ方向。
-
ウィジェットのサイズに対するスワイプ距離をパーセンテージで指定します。
-
options
Object (オプション)
戻り値
- tap
androidDevice.tap
追加バージョン: v1.9selector
[AndroidSelector]#
使用法
await androidDevice.tap(selector);
await androidDevice.tap(selector, options);
引数
-
options
Object (オプション)
戻り値
- wait
androidDevice.wait
追加バージョン: v1.9selector
[AndroidSelector]#
使用法
await androidDevice.wait(selector);
await androidDevice.wait(selector, options);
引数
戻り値
- waitForEvent
androidDevice.waitForEvent
追加バージョン: v1.9使用法
await androidDevice.waitForEvent(event);
await androidDevice.waitForEvent(event, optionsOrPredicate);
引数
-
イベント名。通常、
*.on(event)
に渡されるものと同じです。 -
predicate
function-
イベントデータを受け取り、待機が解決されるべき場合に真の値を返します。
timeout
number (オプション) -
ミリ秒単位での最大待機時間。デフォルトは
30000
(30秒)です。タイムアウトを無効にするには0
を渡します。デフォルト値はandroidDevice.setDefaultTimeout()を使用して変更できます。イベントを受け取る述語、またはオプションオブジェクトのいずれか。オプション。
-
戻り値
- webView
androidDevice.webView
追加バージョン: v1.9使用法
await androidDevice.webView(selector);
await androidDevice.webView(selector, options);
引数
pkg
string (オプション)options
Object (オプション)-
ミリ秒単位の最大時間で、デフォルトは30秒です。タイムアウトを無効にするには
0
を渡します。デフォルト値はandroidDevice.setDefaultTimeout()メソッドを使用して変更できます。
-
戻り値
- webViews
androidDevice.webViews
追加バージョン: v1.9使用法
androidDevice.webViews();
戻り値
- プロパティ
input
androidDevice.input
追加バージョン: v1.9使用法
androidDevice.input
イベント
on('close')
追加バージョン: v1.28
androidDevice.on('close')イベントデータ
使用法
androidDevice.on('close', data => {});
on('webview')
androidDevice.on('webview')
追加バージョン: v1.9使用法
androidDevice.on('webview', data => {});
on('webview')