APIリファレンス
ライブラリの公開クラスと関数に関する情報。
自動テストを設定する際には、インストゥルメンテーションのレジストリを設定し、Axe DevTools for Android がアクセシビリティノード情報に接続できるようにします。テストを構築する際は、以下のライブラリのパブリッククラスと関数を参照してください。
AxeDevToolsの初期化
AxeDevToolsライブラリを初期化する際には、以下のAPIを使用します。
startScanSession(params)
APIキーを認証し、テストセッションを初期化します。結果をAxe Developer Hubに投稿するには、プロジェクトIDが必要です。
必須 param:
| 名前 | タイプ | 説明 |
|---|---|---|
| apiKey | String |
Deque APIキー |
オプション param:
| 名前 | タイプ | 説明 |
|---|---|---|
| projectId | String |
Axe Developer Hub プロジェクトID |
| axeAccountUrl | String |
接続するサーバーのURLを定義します |
startSession(params)
認証トークンを生成し、テストセッションを初期化します。結果を Axe Developer Hub に投稿するにはプロジェクト ID を含めます。この API は 2026 年に廃止されます。代わりに startScanSession を使用してください。
必須 param:
| 名前 | タイプ | 説明 |
|---|---|---|
| apiKey | String |
Deque APIキー |
オプション params:
| 名前 | タイプ | 説明 |
|---|---|---|
| projectId | String |
Axe Developer Hub プロジェクトID |
| serverUrl | String |
接続するサーバーのURLを定義します |
loginWithApiKey(param)
ダッシュボードに接続するための認証トークンを生成します。この API は 2026 年に廃止されます。代わりに startScanSession を使用してください。
必須 param:
| 名前 | タイプ | 説明 |
|---|---|---|
| apiKey | String |
Deque APIキー |
オプション param:
| 名前 | タイプ | 説明 |
|---|---|---|
| serverUrl | String |
接続するサーバーのURLを定義します |
setInstrumentation(param)
ライブラリがテスト中のアプリケーションのビュー階層を取得できるようにします。
必須 param:
| 名前 | タイプ | 説明 |
|---|---|---|
| instrumentation | android.app.Instrumentation |
アプリケーションのコンテキストと計測を提供するInstrumentation Registryオブジェクト。 |
isUserAuthenticated()
ユーザーが認証され、スキャンを送信する準備ができているかどうかを示すブール値を返します。
返り値：
| タイプ | 説明 |
|---|---|
| ブール | ユーザーがAxe DevTools Mobileに認証されているかどうかを示します |
disconnect()
現在のAxe DevToolsネットワークセッションをクリアし、新しい接続を可能にします。
スキャニング
AxeDevTools ライブラリをインポートし初期化したら、スキャンの準備が整います。
scan()
setInstrumentation(param) に渡されたインストゥルメンテーションレジストリオブジェクトが収集した情報をスキャンし、問題を検出し ScanResultHandler を返します。
返り値：
| 名前 | タイプ | 説明 |
|---|---|---|
| ScanResultHandler | ヌラブル | ScanResultHandler は、結果に関する詳細情報を取得したり、名前やタグを指定してスキャンをさらに更新したりする方法を提供します |
getResult(param)
提供された結果キーに一致するスキャン結果を要求します。
必須 param:
| 名前 | タイプ | 説明 |
|---|---|---|
| axeDevToolsResultKey | AxeDevToolsResultKey |
取得したい結果の識別子 |
返り値：
| タイプ | 説明 |
|---|---|
| AxeDevToolsResult | Nullable AxeDevToolsResult は結果の詳細へのアクセスを提供します |
結果の処理
generateHtmlReportAndSummary
セッション開始以来のすべてのスキャンを収集し、デバイス上でローカルにレポートを生成します。
オプション param:
| 名前 | タイプ | 説明 |
|---|---|---|
| scanName | String |
オプションのスキャン名。デフォルトは AxeAccessibilityReport です。 |
注意: スキャンから返された ScanResultHandler オブジェクトで次の API を使用します。
uploadToDashboard()
アクセシビリティスキャンの結果をアップロードします。
返り値：
| タイプ | 説明 |
|---|---|
| AxeDevToolsResult | Nullable AxeDevToolsResult は結果の詳細へのアクセスを提供します |
saveResultToLocalStorage(param)
アクセシビリティスキャンの結果をテストデバイス上のローカルファイルに保存します。
必須 param:
| 名前 | タイプ | 説明 |
|---|---|---|
| prefixFilename | String |
結果を保存するファイル名の先頭部分。 |
getSerializedResult()
テスト内で使用するためにスキャンの結果にアクセスします。
設定のカスタマイズ
スキャンに名前とタグを付け、特定のルールを無視するか、独自のカスタムルールを作成します。
setScanName(param)
アップロードする前にスキャンに名前を設定します。
必須 param:
| 名前 | タイプ | 説明 |
|---|---|---|
| name | String |
スキャンの名前 |
addCustomRule(param)
スキャン中にアプリケーションに実行するルールを追加します。
必須 param:
| 名前 | タイプ | 説明 |
|---|---|---|
| customRule | Class<AxeDevToolsRule> |
追加するルール |
ignoreRules(param)
特定のビューに対して実行されるルールを完全に無視します。
必須 param:
| 名前 | タイプ | 説明 |
|---|---|---|
| rulesToIgnore | List<String> |
無視するルールのリスト |
ignoreByViewIdResourceName(params)
必須 params:
| 名前 | タイプ | 説明 |
|---|---|---|
| viewIdResourceName | String |
ビューのリソースID名 |
| ruleList | List<String> |
無視するルールのリスト |
ignoreExperimental()
実験的なルールを除外します。実験的なルールの結果は AxeStatus.IGNORED のステータスになります。
resetIgnoredRules()
無視されたルールAPIで設定された無視リストをクリアします。自動テスト間でのルール設定の変更に役立ちます。
tagScanAs(param)
アップロード前にスキャンにタグを付けます。
必須 param:
| 名前 | タイプ | 説明 |
|---|---|---|
| tags | Set<String> |
スキャンに追加するタグのリスト。 |
tearDown()
タグをリセットし、以前のテストからのテスト状態をクリアします。
deleteResult(param)
提供された結果キーに一致するスキャンの結果を削除します。（モバイルダッシュボードのみ）
必須 param:
| 名前 | タイプ | 説明 |
|---|---|---|
| axeDevToolsResultKey | AxeDevToolsResultKey |
アクセスしたい結果の識別子。 |