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

AndroidDevice

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

メソッド​

close​

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

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

使用法

await androidDevice.close();

戻り値

drag​

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

selector で定義されたウィジェットを dest ポイントに向かってドラッグします。

使用法

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

引数

  • selector [AndroidSelector]#

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

  • dest Object#

    ドラッグ先のポイント。

  • options Object (optional)

    • speed number (optional)#

      ドラッグのオプションの速度（ピクセル/秒）。

    • timeout number (optional)#

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

戻り値

fill​

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

特定の selector 入力ボックスを text で埋めます。

使用法

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

引数

  • selector [AndroidSelector]#

    入力するセレクター。

  • text string#

    入力ボックスに埋めるテキスト。

  • options Object (optional)

    • timeout number (optional)#

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

戻り値

fling​

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

selector で定義されたウィジェットを、指定された direction にフリングします。

使用法

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

引数

  • selector [AndroidSelector]#

    フリングするセレクター。

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

    フリング方向。

  • options Object (optional)

    • speed number (optional)#

      フリングのオプションの速度（ピクセル/秒）。

    • timeout number (optional)#

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

戻り値

info​

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

selector で定義されたウィジェットに関する情報を返します。

使用法

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 (optional)

    • args Array<string> (optional)#

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

戻り値

launchBrowser​

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

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

使用法

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

引数

  • options Object (optional)

    • acceptDownloads boolean (optional)#

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

    • args Array<string> (optional)追加: v1.29#

      警告

      一部のカスタムブラウザ引数はPlaywrightの機能を破壊する可能性があるため、自己責任で使用してください。

      ブラウザインスタンスに渡す追加の引数。Chromiumフラグのリストはこちらで見つけることができます。

    • baseURL string (optional)#

      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 (optional)#

      ページのコンテンツセキュリティポリシーをバイパスするかどうかを切り替えます。デフォルトはfalseです。

    • colorScheme null | "light" | "dark" | "no-preference" (optional)#

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

    • contrast null | "no-preference" | "more" (optional)#

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

    • deviceScaleFactor number (optional)#

      デバイスのスケールファクタ（dprと考えることができます）を指定します。デフォルトは1です。デバイススケールファクタによるデバイスエミュレーションについて詳しく学びましょう。

    • extraHTTPHeaders Object<string, string> (optional)#

      すべてのリクエストと一緒に送信される追加のHTTPヘッダーを含むオブジェクト。デフォルトはなし。

    • forcedColors null | "active" | "none" (optional)#

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

    • geolocation Object (optional)#

      • latitude number

        -90から90の間の緯度。

      • longitude number

        -180から180の間の経度。

      • accuracy number (optional)

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

    • hasTouch boolean (optional)#

      ビューポートがタッチイベントをサポートするかどうかを指定します。デフォルトはfalseです。モバイルエミュレーションについて詳しく学びましょう。

    • httpCredentials Object (optional)#

      • username string

      • password string

      • origin string (optional)

        特定のオリジン(scheme://host:port)でのhttp資格情報の送信を制限します:ポート).

      • send "unauthorized" | "always" (optional)

        このオプションは、対応するAPIRequestContextから送信されたリクエストにのみ適用され、ブラウザから送信されたリクエストには影響しません。'always' - 基本認証資格情報を含むAuthorizationヘッダーは、各APIリクエストとともに送信されます。'unauthorized - 資格情報は、WWW-Authenticateヘッダーを持つ401（Unauthorized）応答が受信された場合にのみ送信されます。デフォルトは'unauthorized'です。

      HTTP認証用の資格情報。オリジンが指定されていない場合、ユーザー名とパスワードは、不正な応答があった場合にすべてのサーバーに送信されます。

    • ignoreHTTPSErrors boolean (optional)#

      ネットワークリクエストを送信する際にHTTPSエラーを無視するかどうか。デフォルトはfalseです。

    • isMobile boolean (optional)#

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

    • javaScriptEnabled boolean (optional)#

      コンテキストでJavaScriptを有効にするかどうか。デフォルトはtrueです。JavaScriptの無効化について詳しく学びましょう。

    • locale string (optional)#

      ユーザーロケールを指定します。例: en-GB, de-DEなど。ロケールはnavigator.languageの値、Accept-Languageリクエストヘッダーの値、および数値と日付のフォーマット規則に影響します。デフォルトはシステムのデフォルトロケールです。エミュレーションガイドでエミュレーションの詳細について学びましょう。

    • logger Logger (optional)#

      非推奨

      ロガーによって受信されるログは不完全です。代わりにトレースを使用してください。

      Playwrightログ用のロガーシンク。

    • offline boolean (optional)#

      ネットワークがオフラインであるとエミュレートするかどうか。デフォルトはfalseです。ネットワークエミュレーションについて詳しく学びましょう。

    • permissions Array<string> (optional)#

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

    • pkg string (optional)#

      デフォルトのAndroid用Chromeの代わりに起動するオプションのパッケージ名。

    • proxy Object (optional)追加: v1.29#

      • server string

        すべてのリクエストに使用するプロキシ。HTTPおよびSOCKSプロキシがサポートされており、例としてhttp://myproxy.com:3128またはsocks5://myproxy.com:3128があります。短縮形myproxy.com:3128はHTTPプロキシと見なされます。

      • bypass string (optional)

        プロキシをバイパスするオプションのカンマ区切りドメイン。例: ".com, chromium.org, .domain.com"。

      • username string (optional)

        HTTPプロキシが認証を必要とする場合に使用するオプションのユーザー名。

      • password string (optional)

        HTTPプロキシが認証を必要とする場合に使用するオプションのパスワード。

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

    • recordHar Object (optional)#

      • omitContent boolean (optional)

        HARからリクエストコンテンツを省略するかどうかを制御するオプションの設定。デフォルトはfalseです。非推奨、代わりにcontentポリシーを使用してください。

      • content "omit" | "embed" | "attach" (optional)

        リソースコンテンツ管理を制御するオプション設定。omitが指定されている場合、コンテンツは永続化されません。attachが指定されている場合、リソースは個別のファイルまたはZIPアーカイブのエントリとして永続化されます。embedが指定されている場合、HAR仕様に従ってコンテンツはHARファイルにインラインで保存されます。.zip出力ファイルの場合はデフォルトでattach、その他のすべてのファイル拡張子の場合はembedです。

      • path string

        HARファイルを書き込むファイルシステム上のパス。ファイル名が.zipで終わる場合、デフォルトでcontent: 'attach'が使用されます。

      • mode "full" | "minimal" (optional)

        minimalに設定すると、HARからのルーティングに必要な情報のみが記録されます。これにより、HARからリプレイするときに使用されないサイズ、タイミング、ページ、クッキー、セキュリティ、その他の種類のHAR情報が省略されます。デフォルトはfullです。

      • urlFilter string | RegExp (optional)

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

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

    • recordVideo Object (optional)#

      • dir string

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

      • size Object (optional)

        • width number

          ビデオフレームの幅。

        • height number

          ビデオフレームの高さ。

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

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

    • reducedMotion null | "reduce" | "no-preference" (optional)#

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

    • screen Object (optional)#

      • width number

        ページ幅（ピクセル単位）。

      • height number

        ページ高さ（ピクセル単位）。

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

    • serviceWorkers "allow" | "block" (optional)#

      サイトがサービスワーカーを登録することを許可するかどうか。デフォルトは'allow'です。

      • 'allow': サービスワーカーを登録できます。
      • 'block': Playwrightはすべてのサービスワーカーの登録をブロックします。

    • strictSelectors boolean (optional)#

      trueに設定すると、このコンテキストに対して厳格セレクタモードが有効になります。厳格セレクタモードでは、単一のターゲットDOM要素を意味するセレクタに対するすべての操作は、複数の要素がセレクタに一致する場合にスローされます。このオプションはLocator APIには影響しません（Locatorsは常に厳格です）。デフォルトはfalseです。厳格モードの詳細については、Locatorを参照してください。

    • timezoneId string (optional)#

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

    • userAgent string (optional)#

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

    • videoSize Object (optional)#

      非推奨

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

      • width number

        ビデオフレームの幅。

      • height number

        ビデオフレームの高さ。

    • videosPath string (optional)#

      非推奨

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

    • viewport null | Object (optional)#

      • width number

        ページ幅（ピクセル単位）。

      • height number

        ページ高さ（ピクセル単位）。

      各ページの一貫したビューポートをエミュレートします。デフォルトは1280x720ビューポートです。一貫したビューポートエミュレーションを無効にするにはnullを使用します。ビューポートエミュレーションについて詳しく学びましょう。

      注

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

戻り値

longTap​

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

selector で定義されたウィジェットをロングタップします。

使用法

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

引数

  • selector [AndroidSelector]#

    タップするセレクター。

  • options Object (optional)

    • timeout number (optional)#

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

戻り値

model​

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

デバイスモデル。

使用法

androidDevice.model();

戻り値

open​

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

デバイスのシェルでプロセスを起動し、起動されたプロセスと通信するためのソケットを返します。

使用法

await androidDevice.open(command);

引数

  • command string#

    実行するシェルコマンド。

戻り値

pinchClose​

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

selector で定義されたウィジェットを閉じる方向にピンチします。

使用法

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

引数

  • selector [AndroidSelector]#

    閉じる方向にピンチするセレクター。

  • percent number#

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

  • options Object (optional)

    • speed number (optional)#

      ピンチのオプションの速度（ピクセル/秒）。

    • timeout number (optional)#

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

戻り値

pinchOpen​

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

selector で定義されたウィジェットを開く方向にピンチします。

使用法

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

引数

  • selector [AndroidSelector]#

    開く方向にピンチするセレクター。

  • percent number#

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

  • options Object (optional)

    • speed number (optional)#

      ピンチのオプションの速度（ピクセル/秒）。

    • timeout number (optional)#

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

戻り値

press​

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

selector で定義されたウィジェットで、特定の key を押します。

使用法

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

引数

  • selector [AndroidSelector]#

    キーを押すセレクター。

  • key [AndroidKey]#

    押すキー。

  • options Object (optional)

    • timeout number (optional)#

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

戻り値

push​

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

ファイルをデバイスにコピーします。

使用法

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

引数

  • file string | Buffer#

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

  • path string#

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

  • options Object (optional)

    • mode number (optional)#

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

戻り値

screenshot​

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

デバイスのキャプチャされたスクリーンショットのバッファを返します。

使用法

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

引数

  • options Object (optional)

    • path string (optional)#

      画像を保存するファイルパス。 path が相対パスの場合、現在の作業ディレクトリを基準にして解決されます。パスが指定されていない場合、画像はディスクに保存されません。

戻り値

scroll​

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

selector で定義されたウィジェットを、指定された direction にスクロールします。

使用法

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

引数

  • selector [AndroidSelector]#

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

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

    スクロール方向。

  • percent number#

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

  • options Object (optional)

    • speed number (optional)#

      スクロールのオプションの速度（ピクセル/秒）。

    • timeout number (optional)#

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

戻り値

serial​

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

デバイスのシリアル番号。

使用法

androidDevice.serial();

戻り値

setDefaultTimeout​

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

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

使用法

androidDevice.setDefaultTimeout(timeout);

引数

  • timeout number#

    最大時間（ミリ秒）

shell​

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

デバイス上でシェルコマンドを実行し、その出力を返します。

使用法

await androidDevice.shell(command);

引数

  • command string#

    実行するシェルコマンド。

戻り値

swipe​

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

selector で定義されたウィジェットを、指定された direction にスワイプします。

使用法

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

引数

  • selector [AndroidSelector]#

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

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

    スワイプ方向。

  • percent number#

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

  • options Object (optional)

    • speed number (optional)#

      スワイプのオプションの速度（ピクセル/秒）。

    • timeout number (optional)#

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

戻り値

tap​

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

selector で定義されたウィジェットをタップします。

使用法

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

引数

  • selector [AndroidSelector]#

    タップするセレクター。

  • options Object (optional)

    • duration number (optional)#

      タップのオプションの持続時間（ミリ秒）。

    • timeout number (optional)#

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

戻り値

wait​

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

state に応じて、特定の selector が表示されるか消えるかを待ちます。

使用法

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

引数

  • selector [AndroidSelector]#

    待機するセレクター。

  • options Object (optional)

    • state "gone" (optional)#

      オプションの状態。以下の中から選択できます。

      • default - 要素が存在するのを待ちます。
      • 'gone' - 要素が存在しないのを待ちます。

    • timeout number (optional)#

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

戻り値

waitForEvent​

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

イベントが発生するのを待ち、その値を述語関数に渡します。述語が真の値を返すと解決されます。

使用法

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

引数

  • event string#

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

  • optionsOrPredicate function | Object (optional)#

    • predicate function

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

    • timeout number (optional)

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

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

戻り値

webView​

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

このメソッドは、selector に一致する AndroidWebView が開かれるまで待機し、それを返します。すでに selector に一致する AndroidWebView が開いている場合は、すぐに返します。

使用法

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

引数

  • selector Object#

    • pkg string (optional)

      オプションのパッケージ識別子。

    • socketName string (optional)

      オプションのWebビューソケット名。

  • options Object (optional)

    • timeout number (optional)#

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

戻り値

webViews​

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

現在開いているWebView。

使用法

androidDevice.webViews();

戻り値

プロパティ​

input​

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

使用法

androidDevice.input

タイプ

イベント​

on('close')​

追加バージョン: v1.28 androidDevice.on('close')

デバイス接続が閉じられたときに発行されます。

使用法

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

イベントデータ

on('webview')​

追加バージョン: v1.9 androidDevice.on('webview')

新しいWebViewインスタンスが検出されたときに発行されます。

使用法

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

イベントデータ