getContext

現在のセッションのコンテキストを取得します。

このメソッドは、詳細なコンテキスト情報を返すオプションを提供することで、デフォルトのAppium context/WebdriverIO getContextコマンドを拡張し、ウェブビューを使用するハイブリッドアプリでの作業を容易にします。

コンテキストの仕組み

詳細についてはハイブリッドアプリのドキュメントを参照してください。以下はgetContextコマンドに関連する課題の説明です：

Androidの場合：

• ウェブビューには複数のページ（ブラウザのタブのような）が含まれることがあり、正しいページを特定するにはtitleやurlなどの追加のメタデータが必要です。
• デフォルトのAppiumメソッドは、ウェブビュー内のページに関する詳細情報なしに、基本的なコンテキスト名（例：WEBVIEW_{packageName}）のみを提供します。

iOSの場合：

• 各ウェブビューは一般的なWEBVIEW_{id}文字列で識別されますが、その内容やそれが属するアプリ画面を示すものではありません。

このメソッドを使用する理由

• デフォルトの動作：
  • 現在のコンテキストを文字列（例：NATIVE_APPまたはWEBVIEW_{id}）として返します。
• 詳細なコンテキスト：
  • returnDetailedContextが有効な場合、次のようなメタデータを取得します：
    • Android：packageName、title、url、およびwebviewPageId。
    • iOS：bundleId、title、およびurl。
• Android固有のオプション：
  • ウェブビューの初期化の遅延に対応するために、リトライ間隔とタイムアウトをカスタマイズできます。

注意と制限

• returnDetailedContextが有効でない場合、このメソッドはデフォルトのAppium getContextメソッドと同じように動作します。
• デフォルトのAppium contextメソッドを使用したい場合は、driver.getAppiumContext()メソッドを使用できます。Appium Contextsコマンドも参照してください。
• Android: Android固有のオプション（androidWebviewConnectionRetryTimeとandroidWebviewConnectTimeout）はiOSでは効果がありません。
• 複数または詳細なコンテキストが見つからない場合、警告がログに記録されます：
  • 現在のコンテキスト'{context}'に対して複数の詳細なコンテキストが見つかりました。最初のコンテキストを返します。
  • 現在のコンテキスト'{context}'に対する詳細なコンテキストが取得できませんでした。現在のコンテキストを文字列として返します。

パラメータ

名前	タイプ	詳細
options オプション	GetContextsOptions	getContextオプション（省略可能）
options.returnDetailedContext オプション	boolean	デフォルトでは、デフォルトのAppium context APIに基づいて、文字列のみのコンテキスト名を返します。詳細なコンテキスト情報を取得したい場合は、これをtrueに設定します。デフォルトはfalseです（省略可能）。
options.androidWebviewConnectionRetryTime オプション	number	ウェブビューに接続するための各リトライ間の待機時間（ミリ秒）。デフォルトは500ミリ秒です（省略可能）。 ANDROIDのみ
options.androidWebviewConnectTimeout オプション	number	ウェブビューページが検出されるまでの最大待機時間（ミリ秒）。デフォルトは5000ミリ秒です（省略可能）。 ANDROIDのみ

例

default.test.js

it('should return the current context with the default Appium `context` method', async () => {
    // For Android
    await driver.getContext()
    // Returns 'WEBVIEW_com.wdiodemoapp' or 'NATIVE_APP'
    //
    // For iOS, the context will be 'WEBVIEW_{number}'
    await driver.getContext()
    // Returns 'WEBVIEW_94703.19' or 'NATIVE_APP'
})

detailed.test.js

it('should return the context of the current session with more detailed information', async () => {
    // For Android
    await driver.getContext({ returnDetailedContext: true})
    // Returns or `NATIVE_APP`, or
    // {
    //   id: 'WEBVIEW_com.wdiodemoapp',
    //   title: 'WebdriverIO · Next-gen browser and mobile automation test framework for Node.js | WebdriverIO',
    //   url: 'https://webdriver.io/',
    //   packageName: 'com.wdiodemoapp',
    //   webviewPageId: '5C0425CF67E9B169245F48FF21172912'
    // }
    //
    // For iOS, the context will be 'WEBVIEW_{number}'
    await driver.getContext({ returnDetailedContext: true})
    // Returns or `NATIVE_APP`, or
    // {
    //   id: 'WEBVIEW_64981.1',
    //   title: 'WebdriverIO · Next-gen browser and mobile automation test framework for Node.js | WebdriverIO',
    //   url: 'https://webdriver.io/',
    //   bundleId: 'org.reactjs.native.example.wdiodemoapp'
    // }
})

customize.retry.test.js

it('should be able to cusomize the retry intervals and timeouts to handle delayed webview initialization', async () => {
    // For Android
    await driver.getContext({
        returnDetailedContext: true,
        // NOTE: The following options are Android-specific
        // For Android we might need to wait a bit longer to connect to the webview, so we can provide some additional options
        androidWebviewConnectionRetryTime: 1*1000,  // Retry every 1 second
        androidWebviewConnectTimeout: 10*1000,      // Timeout after 10 seconds
    })
})