スキャンを実行する
This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard
Not for use with personal data
準備、設定、スキャン開始
Axe DevToolsモバイルライブラリを初期化するとき、設定をaxeStartSessionメソッドに渡します。ここでAxe Developer Hubへ結果をアップロードするか、ローカルに結果を保存するだけかを宣言します。
// Once per test run
await driver.execute('mobile: axeStartSession', {
apiKey: "<DEQUE_APIKEY>",
projectId: "<DEQUE_PROJECT_ID>",
axeUploadResults: true
// Note: Results are uploaded to Axe Developer Hub by default;
// you can omit this value or set to `false` to only save results locally
});テスト中の任意のタイミングでアクセシビリティスキャンを有効にします。アクセシビリティスキャンを開始する準備ができたら、Execute Script APIを呼び出し、axeScanを渡します。
// Per screen
driver.execute('mobile: axeScan')入力
| パラメータ | タイプ | 説明 |
|---|---|---|
| axeSettings | Object |
Axe DevTools Mobileの認証と設定が含まれます。（必要なキーはSettingsのAuthentication Keysを参照してください）。 |
設定内の認証キー
セッションを初期化していない場合していない場合、スキャンを認証するためにaxeSettingsオブジェクトに以下のいずれかを提供する必要があります。
| キー | タイプ | 説明 |
|---|---|---|
| apiKey | String |
Dequeによって認証されたユーザーへのアクセスを提供するために必要です。Axe アカウントポータルでAxe DevToolsモバイルAPIキーにアクセスします。 |
| licenseKey | String |
Dequeによってオフラインスキャンのために認証されたユーザーへのアクセスを提供するために必要です。ライセンスキーの配布を調整するために、Dequeの担当者に連絡するか、サポートに問い合わせてください。 |
設定内の構成キー
テストの設定をカスタマイズしたい場合は、以下のオプションキーをaxeSettingsオブジェクトに追加できます。これらのプロパティの詳細（非推奨も含む）は設定をカスタマイズするで見つけることができます。
| キー | タイプ | 説明 |
|---|---|---|
| axeUploadResults | Boolean |
認証しつつAxe Developer Hubセッションを開始しないようにfalseに設定すると、結果がローカルに留まります。デフォルトはtrueです。 |
| ignoreRules（非推奨） | [String] |
すべてのビューで無視するルールのリストを適用するには文字列の配列を提供します。配列内の各文字列は有効なruleIdである必要があります。例えば、ColorContrast。どのスキャンのJSON結果内のaxeConfオブジェクト内にruleIdがあります。この値をmobile: axeScan呼び出しに渡します。 |
| ignoreExperimental（非推奨） | Boolean |
このパラメータがtrueに設定されている場合、実験的なルールは無視されます。デフォルト値はfalseです。この値をmobile: axeScan呼び出しに渡します。 |
| uploadToDashboard（非推奨） | Boolean |
このパラメータがfalseに設定されている場合、スキャンはアップロードされません。デフォルト値はtrueです。 代わりに mobile: axeStartSessionでaxeUploadResultsを使用してください。 |
tip
アクセシビリティスキャンを開始するための中央の場所として、テストスクリプトにユーティリティ関数を追加することを検討してください。