メインコンテンツにスキップ

AndroidDevice

AndroidDeviceは、接続されたデバイス(実際のハードウェアまたはエミュレートされたもの)を表します。デバイスは、android.devices()を使用して取得できます。


メソッド

close

追加バージョン: v1.9 androidDevice.close

デバイスから切断します。

使用法

await androidDevice.close();

戻り値


drag

追加バージョン: v1.9 androidDevice.drag

指定されたセレクターで定義されたウィジェットを宛先点に向けてドラッグします。

使用法

await androidDevice.drag(selector, dest);
await androidDevice.drag(selector, dest, options);

引数

  • selector [AndroidSelector]#

    ドラッグするセレクター。

  • dest Object#

    ドラッグ先の座標。

  • options Object (オプション)

    • speed number (オプション)#

      オプションで、ドラッグの速度をピクセル/秒で指定します。

    • timeout number (オプション)#

      ミリ秒単位の最大時間で、デフォルトは30秒です。タイムアウトを無効にするには0を渡します。デフォルト値はandroidDevice.setDefaultTimeout()メソッドを使用して変更できます。

戻り値


fill

追加バージョン: v1.9 androidDevice.fill

特定のセレクター入力ボックスにテキストを入力します。

使用法

await androidDevice.fill(selector, text);
await androidDevice.fill(selector, text, options);

引数

  • selector [AndroidSelector]#

    入力するセレクター。

  • text string#

    入力ボックスに記入するテキスト。

  • options Object (オプション)

    • timeout number (オプション)#

      ミリ秒単位の最大時間で、デフォルトは30秒です。タイムアウトを無効にするには0を渡します。デフォルト値はandroidDevice.setDefaultTimeout()メソッドを使用して変更できます。

戻り値


fling

追加バージョン: v1.9 androidDevice.fling

指定されたセレクターで定義されたウィジェットを指定された方向にフリックします。

使用法

await androidDevice.fling(selector, direction);
await androidDevice.fling(selector, direction, options);

引数

  • selector [AndroidSelector]#

    フリックするセレクター。

  • direction "down" | "up" | "left" | "right"#

    フリック方向。

  • options Object (オプション)

    • speed number (オプション)#

      オプションで、フリックの速度をピクセル/秒で指定します。

    • timeout number (オプション)#

      ミリ秒単位の最大時間で、デフォルトは30秒です。タイムアウトを無効にするには0を渡します。デフォルト値はandroidDevice.setDefaultTimeout()メソッドを使用して変更できます。

戻り値


info

追加バージョン: v1.9 androidDevice.info

セレクターで定義されたウィジェットに関する情報を返します。

使用法

await androidDevice.info(selector);

引数

  • selector [AndroidSelector]#

    情報を取得するセレクター。

戻り値


installApk

追加バージョン: v1.9 androidDevice.installApk

デバイスにapkをインストールします。

使用法

await androidDevice.installApk(file);
await androidDevice.installApk(file, options);

引数

  • file string | Buffer#

    apkファイルへのパス、またはapkファイルの内容のいずれか。

  • options Object (オプション)

    • args Array<string> (オプション)#

      shell:cmd package install呼び出しに渡すオプション引数。デフォルトは-r -t -Sです。

戻り値


launchBrowser

追加バージョン: v1.9 androidDevice.launchBrowser

デバイス上でChromeブラウザを起動し、その永続コンテキストを返します。

使用法

await androidDevice.launchBrowser();
await androidDevice.launchBrowser(options);

引数

  • options Object (オプション)
    • acceptDownloads boolean (オプション)#

      すべての添付ファイルを自動的にダウンロードするかどうか。デフォルトはtrueで、すべてのダウンロードが許可されます。

    • args Array<string> (オプション)追加バージョン: v1.29#

      警告

      カスタムブラウザ引数を使用すると、Playwrightの機能が一部損なわれる可能性があるため、自己責任でご使用ください。

      ブラウザインスタンスに渡す追加引数。Chromiumフラグのリストはこちらで確認できます。

    • baseURL string (オプション)#

      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になります。
    • bypassCSP boolean (オプション)#

      ページの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'です。

    • geolocation Object (オプション)#

      • latitude number

        -90から90までの緯度。

      • longitude number

        -180から180までの経度。

      • accuracy number (オプション)

        非負の精度値。デフォルトは0です。

    • hasTouch boolean (オプション)#

      ビューポートがタッチイベントをサポートするかどうかを指定します。デフォルトは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です。

    • isMobile boolean (オプション)#

      meta viewportタグが考慮され、タッチイベントが有効になるかどうか。isMobileはデバイスの一部であるため、手動で設定する必要はありません。デフォルトはfalseであり、Firefoxではサポートされていません。モバイルエミュレーションについて詳しくはこちらをご覧ください。

    • javaScriptEnabled boolean (オプション)#

      コンテキストでJavaScriptを有効にするかどうか。デフォルトはtrueです。JavaScriptの無効化について詳しくはこちらをご覧ください。

    • locale string (オプション)#

      ユーザーロケールを指定します。例: en-GBde-DEなど。ロケールはnavigator.languageの値、Accept-Languageリクエストヘッダーの値、および数値と日付の書式設定ルールに影響します。デフォルトはシステムのデフォルトロケールです。エミュレーションに関する詳細はエミュレーションガイドをご覧ください。

    • logger Logger (オプション)#

      Playwrightのログ出力先となるロガーシンク。

    • offline boolean (オプション)#

      ネットワークがオフラインであることをエミュレートするかどうか。デフォルトはfalseです。ネットワークエミュレーションについて詳しくはこちらをご覧ください。

    • permissions Array<string> (オプション)#

      このコンテキストのすべてのページに付与する権限のリスト。詳細はbrowserContext.grantPermissions()を参照してください。デフォルトはなし。

    • pkg string (オプション)#

      デフォルトの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 (オプション)

        ネットワークプロキシ設定。

      recordHar Object (オプション)#

    • 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です。

        urlFilter string | RegExp (オプション)

      • HARに保存されるリクエストをフィルタリングするためのglobまたは正規表現パターン。コンテキストオプションを介してbaseURLが提供され、渡されたURLがパスである場合、new URL()コンストラクタを介してマージされます。デフォルトはなし。

        すべてのページのHAR記録をrecordHar.pathファイルに有効にします。指定されていない場合、HARは記録されません。HARを保存するには、browserContext.close()をawaitすることを確認してください。

      recordVideo Object (オプション)#

    • dir string

      • ビデオを保存するディレクトリへのパス。

        size Object (オプション)

      • width number

        • ビデオフレームの幅。

          height number

        • ビデオフレームの高さ。

          記録されるビデオのオプションの寸法。指定されていない場合、サイズは800x800に収まるようにviewportを縮小したサイズになります。viewportが明示的に設定されていない場合、ビデオサイズはデフォルトで800x450になります。各ページの実際の画像は、指定されたサイズに収まるように必要に応じて縮小されます。

        すべてのページのビデオ記録をrecordVideo.dirディレクトリに有効にします。指定されていない場合、ビデオは記録されません。ビデオを保存するには、browserContext.close()をawaitすることを確認してください。

      reducedMotion null | "reduce" | "no-preference" (オプション)#

    • 'prefers-reduced-motion'メディア機能をエミュレートします。サポートされる値は'reduce''no-preference'です。詳細はpage.emulateMedia()を参照してください。nullを渡すと、エミュレーションがシステムのデフォルトにリセットされます。デフォルトは'no-preference'です。

      screen Object (オプション)#

    • ページの幅(ピクセル単位)。

      • ビデオフレームの幅。

        ページの高さ(ピクセル単位)。

      • ビデオフレームの高さ。

        window.screenを介してウェブページ内で利用可能な一貫したウィンドウ画面サイズをエミュレートします。ビューポートが設定されている場合にのみ使用されます。

      serviceWorkers "allow" | "block" (オプション)#

    • サイトがService Workerを登録することを許可するかどうか。デフォルトは'allow'です。

      'allow': Service Workersを登録できます。

      • 'block': PlaywrightはService Workerのすべての登録をブロックします。
      • strictSelectors boolean (オプション)#
    • trueに設定すると、このコンテキストで厳格セレクターモードが有効になります。厳格セレクターモードでは、単一のターゲットDOM要素を意味するセレクターに対するすべての操作は、複数の要素がセレクターに一致する場合にエラーをスローします。このオプションはLocator APIには影響しません(Locatorは常に厳格です)。デフォルトはfalseです。厳格モードの詳細については、Locatorを参照してください。

      timezoneId string (オプション)#

    • コンテキストのタイムゾーンを変更します。サポートされているタイムゾーンIDのリストについては、ICUのmetaZones.txtを参照してください。デフォルトはシステムのタイムゾーンです。

      userAgent string (オプション)#

    • このコンテキストで使用する特定のユーザーエージェント。

      videoSize Object (オプション)#

    • 非推奨

      代わりにrecordVideoを使用してください。

      videosPath string (オプション)#

      • ビデオフレームの幅。

        height number

      • ビデオフレームの高さ。

        記録されるビデオのオプションの寸法。指定されていない場合、サイズは800x800に収まるようにviewportを縮小したサイズになります。viewportが明示的に設定されていない場合、ビデオサイズはデフォルトで800x450になります。各ページの実際の画像は、指定されたサイズに収まるように必要に応じて縮小されます。

    • viewport null | Object (オプション)#

      代わりにrecordVideoを使用してください。

      videosPath string (オプション)#

    • 各ページで一貫したビューポートをエミュレートします。デフォルトは1280x720のビューポートです。一貫したビューポートのエミュレーションを無効にするにはnullを使用します。ビューポートエミュレーションについて詳しくはこちらをご覧ください。

      • ビデオフレームの幅。

        ページの高さ(ピクセル単位)。

      • ビデオフレームの高さ。

        window.screenを介してウェブページ内で利用可能な一貫したウィンドウ画面サイズをエミュレートします。ビューポートが設定されている場合にのみ使用されます。

      注意

      null値はデフォルトのプリセットからオプトアウトし、ビューポートをオペレーティングシステムによって定義されたホストウィンドウサイズに依存させます。これにより、テストの実行は非決定論的になります。

戻り値


androidDevice.longTap

追加バージョン: v1.9 セレクターで定義されたウィジェットに対してロングタップを実行します。

selector [AndroidSelector]#

使用法

await androidDevice.longTap(selector);
await androidDevice.longTap(selector, options);

引数

  • タップするセレクター。

    timeout number (オプション)#

  • options Object (オプション)

    • Promise<void>#

      ミリ秒単位の最大時間で、デフォルトは30秒です。タイムアウトを無効にするには0を渡します。デフォルト値はandroidDevice.setDefaultTimeout()メソッドを使用して変更できます。

戻り値


androidDevice.model

追加バージョン: v1.9 デバイスのモデル。

string#

使用法

androidDevice.model();

戻り値


androidDevice.open

追加バージョン: v1.9 デバイスのシェルでプロセスを起動し、起動されたプロセスと通信するためのソケットを返します。

command string#

使用法

await androidDevice.open(command);

引数

戻り値

  • pinchClose

androidDevice.pinchClose

追加バージョン: v1.9 セレクターで定義されたウィジェットを閉じる方向にピンチします。

selector [AndroidSelector]#

使用法

await androidDevice.pinchClose(selector, percent);
await androidDevice.pinchClose(selector, percent, options);

引数

  • ピンチクローズするセレクター。

    percent number#

  • ウィジェットのサイズに対するピンチのサイズをパーセンテージで指定します。

    speed number (オプション)#

  • options Object (オプション)

    • オプションで、ピンチの速度をピクセル/秒で指定します。

      timeout number (オプション)#

    • Promise<void>#

      ミリ秒単位の最大時間で、デフォルトは30秒です。タイムアウトを無効にするには0を渡します。デフォルト値はandroidDevice.setDefaultTimeout()メソッドを使用して変更できます。

戻り値


androidDevice.pinchOpen

追加バージョン: v1.9 セレクターで定義されたウィジェットを開く方向にピンチします。

selector [AndroidSelector]#

使用法

await androidDevice.pinchOpen(selector, percent);
await androidDevice.pinchOpen(selector, percent, options);

引数

  • ピンチオープンするセレクター。

    percent number#

  • speed number (オプション)#

    speed number (オプション)#

  • options Object (オプション)

    • timeout number (オプション)#

      timeout number (オプション)#

    • Promise<void>#

      ミリ秒単位の最大時間で、デフォルトは30秒です。タイムアウトを無効にするには0を渡します。デフォルト値はandroidDevice.setDefaultTimeout()メソッドを使用して変更できます。

戻り値


androidDevice.press

追加バージョン: v1.9 セレクターで定義されたウィジェット内で、特定のキーを押します。

selector [AndroidSelector]#

使用法

await androidDevice.press(selector, key);
await androidDevice.press(selector, key, options);

引数

  • キーを押すセレクター。

    key [AndroidKey]#

  • 押すキー。

    timeout number (オプション)#

  • options Object (オプション)

    • Promise<void>#

      ミリ秒単位の最大時間で、デフォルトは30秒です。タイムアウトを無効にするには0を渡します。デフォルト値はandroidDevice.setDefaultTimeout()メソッドを使用して変更できます。

戻り値


androidDevice.push

追加バージョン: v1.9 デバイスにファイルをコピーします。

file string | Buffer#

使用法

await androidDevice.push(file, path);
await androidDevice.push(file, path, options);

引数

  • ファイルへのパス、またはファイルの内容のいずれか。

    path string#

  • デバイス上のファイルへのパス。

    mode number (オプション)#

  • options Object (オプション)

    • オプションのファイルモード。デフォルトは644 (rw-r--r--) です。

      Promise<void>#

戻り値

  • screenshot

androidDevice.screenshot

追加バージョン: v1.9 デバイスのキャプチャされたスクリーンショットを含むバッファを返します。

path string (オプション)#

使用法

await androidDevice.screenshot();
await androidDevice.screenshot(options);

引数

  • options Object (オプション)
    • 画像を保存するファイルパス。pathが相対パスの場合、現在の作業ディレクトリを基準に解決されます。パスが提供されない場合、画像はディスクに保存されません。

      Promise<Buffer>#

戻り値


androidDevice.scroll

追加バージョン: v1.9 指定されたセレクターで定義されたウィジェットを指定された方向にスクロールします。

selector [AndroidSelector]#

使用法

await androidDevice.scroll(selector, direction, percent);
await androidDevice.scroll(selector, direction, percent, options);

引数

  • スクロールするセレクター。

    direction "down" | "up" | "left" | "right"#

  • スクロール方向。

    percent number#

  • ウィジェットのサイズに対するスクロール距離をパーセンテージで指定します。

    speed number (オプション)#

  • options Object (オプション)

    • オプションで、スクロールの速度をピクセル/秒で指定します。

      timeout number (オプション)#

    • Promise<void>#

      ミリ秒単位の最大時間で、デフォルトは30秒です。タイムアウトを無効にするには0を渡します。デフォルト値はandroidDevice.setDefaultTimeout()メソッドを使用して変更できます。

戻り値


androidDevice.serial

追加バージョン: v1.9 デバイスのシリアル番号。

string#

使用法

androidDevice.serial();

戻り値

  • setDefaultTimeout

androidDevice.setDefaultTimeout

追加バージョン: v1.9 この設定は、timeoutオプションを受け入れるすべてのメソッドのデフォルトの最大時間を変更します。

timeout number#

使用法

androidDevice.setDefaultTimeout(timeout);

引数

  • ミリ秒単位の最大時間

    shell


androidDevice.shell

追加バージョン: v1.9 デバイス上でシェルコマンドを実行し、その出力を返します。

command string#

使用法

await androidDevice.shell(command);

引数

戻り値


androidDevice.swipe

追加バージョン: v1.9 指定されたセレクターで定義されたウィジェットを指定された方向にスワイプします。

selector [AndroidSelector]#

使用法

await androidDevice.swipe(selector, direction, percent);
await androidDevice.swipe(selector, direction, percent, options);

引数

  • スワイプするセレクター。

    direction "down" | "up" | "left" | "right"#

  • スワイプ方向。

    percent number#

  • ウィジェットのサイズに対するスワイプ距離をパーセンテージで指定します。

    speed number (オプション)#

  • options Object (オプション)

    • オプションで、スワイプの速度をピクセル/秒で指定します。

      timeout number (オプション)#

    • Promise<void>#

      ミリ秒単位の最大時間で、デフォルトは30秒です。タイムアウトを無効にするには0を渡します。デフォルト値はandroidDevice.setDefaultTimeout()メソッドを使用して変更できます。

戻り値


androidDevice.tap

追加バージョン: v1.9 セレクターで定義されたウィジェットをタップします。

selector [AndroidSelector]#

使用法

await androidDevice.tap(selector);
await androidDevice.tap(selector, options);

引数

  • duration number (オプション)#

    timeout number (オプション)#

  • options Object (オプション)

    • オプションで、タップの継続時間をミリ秒で指定します。

      timeout number (オプション)#

    • Promise<void>#

      ミリ秒単位の最大時間で、デフォルトは30秒です。タイムアウトを無効にするには0を渡します。デフォルト値はandroidDevice.setDefaultTimeout()メソッドを使用して変更できます。

戻り値


androidDevice.wait

追加バージョン: v1.9 特定のセレクターが、状態に応じて出現または消滅するのを待ちます。

selector [AndroidSelector]#

使用法

await androidDevice.wait(selector);
await androidDevice.wait(selector, options);

引数

  • 待機するセレクター。

    state "gone" (オプション)#

  • options Object (オプション)

    • オプションの状態。以下のいずれか。

      default - 要素が存在するまで待機します。

      • 'gone' - 要素が存在しなくなるまで待機します。
      • timeout number (オプション)#
    • Promise<void>#

      ミリ秒単位の最大時間で、デフォルトは30秒です。タイムアウトを無効にするには0を渡します。デフォルト値はandroidDevice.setDefaultTimeout()メソッドを使用して変更できます。

戻り値

  • waitForEvent

androidDevice.waitForEvent

追加バージョン: v1.9 イベントが発火するのを待ち、その値を述語関数に渡します。述語が真の値を返すと、処理が返されます。

event string#

使用法

await androidDevice.waitForEvent(event);
await androidDevice.waitForEvent(event, optionsOrPredicate);

引数

  • イベント名。通常、*.on(event)に渡されるものと同じです。

    optionsOrPredicate function | Object (オプション)#

  • predicate function

    • イベントデータを受け取り、待機が解決されるべき場合に真の値を返します。

      timeout number (オプション)

    • ミリ秒単位での最大待機時間。デフォルトは30000(30秒)です。タイムアウトを無効にするには0を渡します。デフォルト値はandroidDevice.setDefaultTimeout()を使用して変更できます。

      イベントを受け取る述語、またはオプションオブジェクトのいずれか。オプション。

    Promise<Object>#

戻り値


androidDevice.webView

追加バージョン: v1.9 このメソッドは、セレクターに一致するAndroidWebViewが開かれるまで待機し、それを返します。セレクターに一致するAndroidWebViewがすでに開かれている場合、すぐに返されます。

selector Object#

使用法

await androidDevice.webView(selector);
await androidDevice.webView(selector, options);

引数

  • pkg string (オプション)
    • オプションのパッケージ識別子。

      socketName string (オプション)

    • オプションのウェブビューソケット名。

      timeout number (オプション)#

  • options Object (オプション)

戻り値


androidDevice.webViews

追加バージョン: v1.9 現在開いているWebView。

Array<AndroidWebView>#

使用法

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 新しいWebViewインスタンスが検出されたときに発生します。

次へ
AndroidInput

使用法

androidDevice.on('webview', data => {});

on('webview')