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 | Nullable AxeDevToolsResult 結果の詳細にアクセスを提供します。 |
deleteResult(param)
指定された結果キーに一致するダッシュボードからスキャンの結果を削除します。
必須 param:
| 名前 | タイプ | 説明 |
|---|---|---|
| axeDevToolsResultKey | AxeDevToolsResultKey |
取得したい結果の識別子。 |
tearDown()
タグをリセットし、以前のテストからのテスト状態をクリアします。
ScanResultHandler
uploadToDashboard(param)
アクセシビリティスキャンの結果をダッシュボードにアップロードします。デフォルトでは、完全な結果オブジェクトが返されます。
オプション param:
| 名前 | タイプ | 説明 |
|---|---|---|
| uploadOnly | Boolean |
オプション、デフォルトは false です。true に設定すると、結果はダッシュボードにアップロードされ、結果キーは AxeDevToolsResult オブジェクト内でのみ利用可能です。 |
戻り値：
| タイプ | 説明 |
|---|---|
| AxeDevToolsResult | Nullable AxeDevToolsResult 結果の詳細にアクセスを提供します。 |
saveResultToLocalStorage(param)
アクセシビリティスキャンの結果をテストデバイスのローカルファイルに保存します。
必須 param：
| 名前 | タイプ | 説明 |
|---|---|---|
| prefixFilename | String |
結果を保存するファイル名の先頭。 |
getSerializedResult()
テスト内で使用するためにスキャン結果を取得します。