Appium.WebDriver 5.0.0

dotnet add package Appium.WebDriver --version 5.0.0
NuGet\Install-Package Appium.WebDriver -Version 5.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Appium.WebDriver" Version="5.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Appium.WebDriver --version 5.0.0
#r "nuget: Appium.WebDriver, 5.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Appium.WebDriver as a Cake Addin
#addin nuget:?package=Appium.WebDriver&version=5.0.0

// Install Appium.WebDriver as a Cake Tool
#tool nuget:?package=Appium.WebDriver&version=5.0.0

appium-dotnet-client

Nuget (with prereleases) Build and deploy NuGet package NuGet Downloads

Build Status

Help Wanted

License

This driver is an extension of the Selenium C# client. It has all the functionalities of the regular driver, but add Appium-specific methods on top of this.

v5 Release Candidate

Appium server compatibility for v5.x

[!IMPORTANT] In case you are using the latest beta client v5.x please be aware you will either have to upgrade your appium server to 2.x or add the base-path argument: appium --base-path=/wd/hub, due to a breaking change on the default server base path. <br/> Regardless, moving to appium 2.x is highly recommended since appium 1.x is no longer maintained. <br/> For more details about how to migrate to 2.x, see the following link : appium 2.x migrating

Deprecated Methods

[!CAUTION]

  • MultiAction and TouchAction are deprecated. Please use W3C WebDriver actions or mobile: extensions.
  • LaunchApp, CloseApp, and reset are deprecated, please read each deprecation message as an alternative method.
  • The ReplaceValue method is deprecated and will be removed in future versions. Please use the following command extensions: 'mobile: replaceElementValue' instead.
  • The SetImmediateValue method is deprecated and will be removed in future versions. Please use 'SendKeys' instead.
Additional Information

W3C Actions: https://www.selenium.dev/documentation/webdriver/actions_api <br/> App management: Please read issue #15807 for more details

Migration Guide to W3C actions

  using OpenQA.Selenium.Interactions;
  
  var touch = new PointerInputDevice(PointerKind.Touch, "finger");
  var sequence = new ActionSequence(touch);
  var move = touch.CreatePointerMove(elementToTouch, elementToTouch.Location.X, elementToTouch.Location.Y,TimeSpan.FromSeconds(1));
  var actionPress = touch.CreatePointerDown(MouseButton.Touch);
  var pause = touch.CreatePause(TimeSpan.FromMilliseconds(250));
  var actionRelease = touch.CreatePointerUp(MouseButton.Touch);
 
  sequence.AddAction(move);
  sequence.AddAction(actionPress);
  sequence.AddAction(pause);
  sequence.AddAction(actionRelease);
  
  var actions_seq = new List<ActionSequence>
  {
      sequence
  };
 
  _driver.PerformActions(actions_seq);

WinAppDriver Notice!

[!WARNING] Because WinAppDriver has been abandoned by MS, running Appium dotnet-client 5.x with WAD will not work since it has not been updated to support the W3C protocol. <br/> To run appium on Windows Applications, you will need to use appium-windows-driver which will act as a proxy to WAD. Examples of running Windows Applications with dotnet-client can be found here: windows Integration test 5.0.0 <br/> Regardless, feel free to open an issue on the WAD repository that will help get MS to open-source that project.

NuGet

NuGet Package:

Dependencies:

Note: we will NOT publish a signed version of this assembly since the dependencies we access through NuGet do not have a signed version - thus breaking the chain and causing us headaches. With that said, you are more than welcome to download the code and build a signed version yourself.

Usage

basics

  • You need to add the following namespace line: using OpenQA.Selenium.Appium;.
  • Use the AppiumDriver class/subclass to construct the driver. It works the same as the Selenium Webdriver, except that the ports are defaulted to Appium values, and the driver does not know how to start the Appium independently.
  • To use the Appium methods on Element, you need to specify the parameter of AppiumDriver or its subclasses.

Read Wiki

See samples here

Dev Build+Test

Xamarin/Mono

  • Open with Xamarin
  • Rebuild all
  • Run tests in test/specs

JetBrains Rider

  • Open with Rider
  • From the menu Build -> Rebuild Solution
  • Run tests in Appium.Net.Integration.Tests

Visual Studio

Nuget Deployment (for maintainers)

To Setup Nuget

  • Download Nuget exe.
  • Setup the Api Key (see here).
  • alias NuGet='mono <Nuget Path>/NuGet.exe'

To Release a New Version

  • update assemblyInfo.cs, RELEASE_NOTES.md, and appium-dotnet-driver.nuspec with the new version number and release details, then check it in
  • pull new code
  • Rebuild All with Release target.
  • NuGet pack appium-dotnet-driver.nuspec
  • NuGet push Appium.WebDriver.<version>.nupkg
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Framework net48 is compatible.  net481 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (83)

Showing the top 5 NuGet packages that depend on Appium.WebDriver:

Package Downloads
Gravity.Services.DataContracts

Data Contracts (DTOs) for all Gravity API Products.

Gravity.Drivers.Mock

Mock implementation of IWebDriver which does not open a browser, for high performance testing of Selenium based frameworks, without a dependency on browsers and web drivers.

Gravity.Extensions

Extensions package for Gravity API products line.

Gravity.Abstraction

Gravity API, Web Driver abstraction. Allows to create any type and or combination of Web Driver, using a simple API abstraction which can also be send over HTTP.

Saucery2

Sourcery for SauceLabs - Unlocking SauceLabs capability.

GitHub repositories (19)

Showing the top 5 popular GitHub repositories that depend on Appium.WebDriver:

Repository Stars
microsoft/PowerToys
Windows system utilities to maximize productivity
files-community/Files
Building the best file manager for Windows
AvaloniaUI/Avalonia
Develop Desktop, Embedded, Mobile and WebAssembly apps with C# and XAML. The most popular .NET UI client technology
dotnet/maui
.NET MAUI is the .NET Multi-platform App UI, a framework for building native device applications spanning mobile, tablet, and desktop.
xamarin/Xamarin.Forms
Xamarin.Forms is no longer supported. Migrate your apps to .NET MAUI.
Version Downloads Last updated
5.0.0 2,689 6/15/2024
5.0.0-rc.8 14,596 4/26/2024
5.0.0-rc.7 14,840 3/29/2024
5.0.0-rc.6 18,010 3/3/2024
5.0.0-rc.5 38,982 1/26/2024
5.0.0-rc.4 25,877 12/29/2023
5.0.0-rc.3 2,540 12/24/2023
5.0.0-rc.2 47,744 11/16/2023
5.0.0-rc.1 54,830 9/6/2023
5.0.0-beta04 138,249 4/29/2023
5.0.0-beta03 149,546 1/6/2023
5.0.0-beta02 57,383 10/26/2022
5.0.0-beta01 294,758 10/21/2021
5.0.0-alpha2 62,268 10/19/2021
5.0.0-alpha 7,833 10/15/2021
4.4.5 421,038 5/5/2023
4.4.0 374,029 10/26/2022
4.3.2 310,482 7/4/2022
4.3.1 4,530,622 1/14/2021
4.3.0 13,004 1/14/2021
4.2.1 929,381 9/19/2020
4.2.0 58,208 9/13/2020
4.1.1 1,738,886 11/19/2019
4.1.0 39,234 11/14/2019
4.0.0.6-beta 250,311 4/15/2019
4.0.0.5-beta 62,105 1/26/2019
4.0.0.4-beta 220,304 10/15/2018
4.0.0.3-beta 4,589 10/1/2018
4.0.0.2-beta 1,948 9/22/2018
4.0.0.1-beta 55,415 1/15/2018
4.0.0 210,800 9/2/2019
3.0.0.2 1,832,381 2/5/2017
3.0.0.1 116,131 1/5/2017
2.0.1.1 32,869 9/2/2016
2.0.0.1 12,103 7/23/2016
1.5.1.1 131,699 3/20/2016
1.5.0.1 48,917 1/5/2016
1.4.1.1 30,557 11/17/2015
1.4.0.3 60,592 8/14/2015
1.4.0.2 12,584 8/4/2015
1.3.0.1 12,700 6/19/2015
1.2.0.8 41,599 1/13/2015
1.2.0.7 2,565 1/5/2015
1.2.0.6 2,944 12/3/2014
1.2.0.5 11,261 9/25/2014
1.2.0.4 44,687 9/17/2014
1.2.0.1 8,134 7/8/2014
1.0.0 2,675 6/6/2014
0.3.0 2,155 6/3/2014
0.2.0 2,982 4/27/2014
0.1.0 42,469 4/18/2014