APIリファレンス

自動テストをセットアップする際には、インスツルメンテーションレジストリを設定し、axe DevTools for Androidがアクセシビリティノード情報に接続できるようにします。テストを構築する際には、以下のライブラリの公開クラスと関数を参照してください。

AxeDevToolsの初期化

AxeDevToolsライブラリを初期化する際には、以下のAPIを使用します。

startScanSession(params)

APIキーを認証し、テストセッションを初期化します。結果をAxe Developer Hubに投稿するには、プロジェクトIDが必要です。

必要な param：

オプション param：

startSession(params)

認証トークンを生成し、テストセッションを初期化します。結果をAxe Developer Hubに投稿するには、プロジェクトIDを含めてください。このAPIは2026年に非推奨になります。使用してください startScanSession を代わりに使用してください。

必要な param：

オプション param：

loginWithUsername(params)

ダッシュボードに接続するための認証トークンを生成します。このAPIは2026年に廃止予定です。 startScanSession を代わりに使用してください。

必要な params：

オプション param：

loginWithApiKey(param)

ダッシュボードに接続するための認証トークンを生成します。このAPIは2026年に廃止予定です。 startScanSession を代わりに使用してください。

必要な param：

オプション param：

setInstrumentation(param)

ライブラリがテスト中のアプリケーションのビュー階層を取得できるようにします。

必要な param：

isUserAuthenticated()

ユーザーが認証され、スキャンを送信する準備ができているかどうかを示すブール値を返します。

返り値：

disconnect()

現在のAxe DevToolsネットワークセッションをクリアし、新しい接続を可能にします。

スキャニング

ライブラリをインポートして初期化すると、 AxeDevTools スキャンの準備が整います。

scan()

提供された計測レジストリオブジェクトによって収集された情報をスキャンし、 setInstrumentation(param) 問題を確認し、 ScanResultHandler。

返り値：

getResult(param)

提供された結果キーに一致するスキャン結果を要求します。

必要な param：

返り値：

結果の処理

これらのAPIをスキャンから返された ScanResultHandler オブジェクトと共に使用してください。

uploadToDashboard()

アクセシビリティスキャンの結果をアップロードします。 返り値：

saveResultToLocalStorage(param)

アクセシビリティスキャンの結果をテストデバイス上のローカルファイルに保存します。

必要な param：

getSerializedResult()

テスト内で使用するためにスキャンの結果にアクセスします。

設定のカスタマイズ

スキャンに名前とタグを付け、特定のルールを無視するか、独自のカスタムルールを作成します。

setScanName(param)

アップロードする前にスキャンに名前を設定します。

必要な param：

addCustomRule(param)

スキャン中にアプリケーションに実行するルールを追加します。

必要な param：

ignoreRules(param)

特定のビューに対して実行されるルールを完全に無視します。

必要な param：

ignoreByViewIdResourceName(params)

必要なパラメーター：

ignoreExperimental()

実験的ルールをオプトアウトします。実験的ルールの結果は、状態になります AxeStatus.IGNORED。

resetIgnoredRules()

無視されたルールAPIで設定された無視リストをクリアします。自動テスト間でのルール設定の変更に役立ちます。

tagScanAs(param)

アップロード前にスキャンにタグを付けます。

必要な param：

tearDown()

タグをリセットし、以前のテストからのテスト状態をクリアします。

deleteResult(param)

提供された結果キーに一致するスキャンの結果を削除します。（モバイルダッシュボードのみ）

必要な param：