Update Scan Name
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
Scans uploaded to the dashboard from Axe DevTools Mobile for Appium are named using the screen's name or title when available. You can set the name based on other criteria by using the scanName key within the settings object. Refer to the following Javascript example.
const axeSettings = {
apiKey: '<DEQUE_APIKEY>'
}
const scanSettings = {
scanName: '<YOUR_SCAN_NAME>'
// scanName is deprecated and only labels dashboard uploads;
// it has no effect on local results.
}
...
await driver.execute('mobile: axeStartSession', axeSettings)
// authentication settings are passed in once to `axeStartSession`
...
const result = await driver.execute(
'mobile: axeScan',
scanSettings
// deprecated features are not available on the session level and are still passed to `axeScan`
) important
Scan names only label dashboard uploads and have no effect on local results. Furthermore, the scan name is not passed to results in Axe Developer Hub. This settings parameter is being deprecated as we transition from the mobile dashboard to Axe Developer Hub.