APIリファレンス
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
スキャンを行い、スキャン結果を処理するためのAPI
Not for use with personal data
スキャンと結果の処理
次のAPIを使用して、アプリをスキャンし、結果を処理します。ライブラリのすべての公開クラスと関数は完全なAPIリファレンスで見つけることができます。
scan()
setInstrumentation(param)に渡されたインストゥルメンテーションレジストリオブジェクトによって収集された情報をスキャンし、問題点を探してScanResultHandlerを返します。
戻り値：
| 名前 | タイプ | 説明 |
|---|---|---|
| ScanResultHandler | Nullable | ScanResultHandlerは、リザルトに関する詳細情報を得たり、名前やタグを指定してスキャンをさらに更新する方法を提供します。 |
getResult(param)
指定された結果キーに一致するダッシュボードからスキャンの結果を要求します。
必須のparam:
| 名前 | タイプ | 説明 |
|---|---|---|
| axeDevToolsResultKey | AxeDevToolsResultKey |
取得したい結果の識別子。 |
戻り値：
| タイプ | 説明 |
|---|---|
| AxeDevToolsResult | Null許容のAxeDevToolsResultは、リザルトの詳細にアクセスを提供します。 |
deleteResult(param)
指定された結果キーに一致するダッシュボードからスキャンの結果を削除します。
必須のparam:
| 名前 | タイプ | 説明 |
|---|---|---|
| axeDevToolsResultKey | AxeDevToolsResultKey |
取得したい結果の識別子。 |
tearDown()
タグをリセットし、以前のテストからのテスト状態をクリアします。
ScanResultHandler
uploadToDashboard(param)
アクセシビリティスキャンの結果をダッシュボードにアップロードします。デフォルトでは、完全な結果オブジェクトが返されます。
オプションのparam:
| 名前 | タイプ | 説明 |
|---|---|---|
| uploadOnly | Boolean |
オプション、デフォルトはfalseです。trueに設定すると、結果がダッシュボードにアップロードされ、結果キーはAxeDevToolsResultオブジェクト内でのみ利用可能です。 |
戻り値：
| タイプ | 説明 |
|---|---|
| AxeDevToolsResult | Null許容のAxeDevToolsResultは、リザルトの詳細にアクセスを提供します。 |
saveResultToLocalStorage(param)
アクセシビリティスキャンの結果をテストデバイスのローカルファイルに保存します。
必須のparam:
| 名前 | タイプ | 説明 |
|---|---|---|
| prefixFilename | String |
結果を保存するファイル名の先頭。 |
getSerializedResult()
テスト内で使用するためにスキャン結果を取得します。