API Reference
Link to API Reference copied to clipboard
APIs used to initialize the AxeDevTools library.
Not for use with personal data
Initializing AxeDevTools
The following are APIs that may be used when initializing the AxeDevTools library. You can find all of the library's public classes and functions in the complete API Reference.
loginWithUsername(params)
Generates an auth token to connect to the dashboard.
Required params:
| Name | Type | Description |
|---|---|---|
| username | String |
Deque username |
| password | String |
Deque password |
Optional param:
| Name | Type | Description |
|---|---|---|
| serverConfig | String |
Defines the server URL to connect to. |
loginWithApiKey(param)
Generates an auth token to connect to the dashboard.
Required param:
| Name | Type | Description |
|---|---|---|
| apiKey | String |
Deque API key |
Optional param:
| Name | Type | Description |
|---|---|---|
| serverUrl | String |
Defines the server URL to connect to. |
setInstrumentation(param)
Allows the library to get the view hierarchy of the application under test.
Required param:
| Name | Type | Description |
|---|---|---|
| instrumentation | android.app.Instrumentation |
Instrumentation Registry Object providing application context and instrumentation. |
isUserAuthenticated()
Returns a boolean to indicate whether the user is authenticated and ready to send scans.
Returns:
| Type | Description |
|---|---|
| Boolean | Indicates whether a user is authenticated for axe DevTools Mobile. |