Desired Capabilities

Desired Capabilities

**`platformName`:**

• Description: Platform of the application under test (AUT).

• Support: Desktop (Y), Store App (Y)

• Value: Windows (default), WindowsModern or WindowsPhone (not supported yet).

  • Windows - A desktop applications or the whole desktop
  • WindowsModern - Windows Store apps (also known as Windows 8 apps, modern UI apps, or Metro-style apps)
  • WindowsPhone - Windows Phone apps

**`appId`:**

• Description: The identifier for the desktop AUT.

  Because desktop applications do not have the concept of package names, an identifier should be provided to manage states of each application separately.

• Support: Only relevant to desktop applications.

• Value: Defaults to Windows.

**`app`:**

• Description: The URL to the installation package.

  The downloaded installation package will be cached for further use.

• Support: Desktop (Y), Store App (Y)

• Value: For example, http://your-build-server/path/to/your/installation-package

**`appChecksum`:**

• Description: A MD5 checksum used to verify the integrity of the installation package.

  This capability helps WinAppDriver to detect whether the build (installation package) has been changed, or whether the the cached installation package could be reused.

• Support: Desktop (Y), Store App (Y)

• Value: For example, aa37e87483fb380a77f19c20415bf387

**`packageName`:**

• Description: The package name of a store app.
• Support: Desktop (N), Store App (Y)
• Value: For example, Microsoft.CoolWindowsStoreApp. Refer to How to find the package name of an app? for more details.

**`changeBuildStrategy`:**

• Description: The strategy of changing builds.
• Support: Desktop (Y), Store App (Y)
• Value: reinstall (default) or upgrade.

**`resetStrategy`:**

• Description: The strategy of resetting application states.
• Support: Desktop (Y), Store App (Y)
• Values: fastReset (default), fullReset or noReset.

**`keyboardDelay`:**

• Description: A delay (in milliseconds) between keystrokes.
• Support: Desktop (Y), Store App (Y)
• Value: Defaults to 50 ms.

**`overlayHighlightDelay`:**

• Description: The amount of time (in milliseconds) for highlighting elements that match the search criteria.
• Support: Desktop (Y), Store App (Y)
• Value: Defaults to 500 ms.

**`overlayTargetDelay`:**

• Description: The amount of time (in milliseconds) for pointing out the target of a mouse movement.
• Support: Desktop (Y), Store App (Y)
• Value: Defaults to 50 ms.

**`checkInstalledCommand`:**

• Description: A custom command to check whether the application is already installed.
• Support: Only relevant to desktop applications.
• Value: Refer to custom actions for more details.

**`installCommand`:**

• Description: A custom command to install the application.
• Support: Only relevant to desktop applications.
• Value: Refer to custom actions for more details.

**`uninstallCommand`:**

• Description: A custom command to uninstall the application.
• Support: Only relevant to desktop applications.
• Value: Refer to custom actions for more details.

**`backupCommand`:**

• Description: A custom command to backup application states.
• Support: Only relevant to desktop applications.
• Value: Refer to custom actions for more details.

**`restoreCommand`:**

• Description: A custom command to restore application states.
• Support: Only relevant to desktop applications.
• Value: Refer to custom actions for more details.

**`openCommand`:**

• Description: A custom command to open the application.
• Support: Only relevant to desktop applications.
• Value: Refer to custom actions for more details.

**`closeCommand`:**

• Description: A custom command to close the application.
• Support: Only relevant to desktop applications.
• Value: Refer to custom actions for more details.