Appium.WebDriver
6.0.1
dotnet add package Appium.WebDriver --version 6.0.1
NuGet\Install-Package Appium.WebDriver -Version 6.0.1
<PackageReference Include="Appium.WebDriver" Version="6.0.1" />
paket add Appium.WebDriver --version 6.0.1
#r "nuget: Appium.WebDriver, 6.0.1"
// Install Appium.WebDriver as a Cake Addin #addin nuget:?package=Appium.WebDriver&version=6.0.1 // Install Appium.WebDriver as a Cake Tool #tool nuget:?package=Appium.WebDriver&version=6.0.1
appium-dotnet-client
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.
Compatibility Matrix
The Appium .NET Client depends on Selenium .NET binding, thus the Selenium .NET binding update might affect the Appium .NET Client behavior. For example, some changes in the Selenium binding could break the Appium client.
Appium .NET Client | Selenium Binding | .NET Version |
---|---|---|
6.0.0 |
4.25.0 + |
.NET Standard 2.0, .NET 6.0 |
5.1.0 |
4.23.0 |
.NET 6.0, .NET Framework 4.8 |
5.0.0 |
4.0.0 - 4.22.0 |
.NET 6.0, .NET Framework 4.8 |
4.4.5 |
3.141.0 |
.NET Standard 2.0, .NET Framework 4.8 |
v5
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
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
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 default to Appium values, and the driver does not know how to start the Appium independently. - To use the Appium methods on Element, specify the parameter of
AppiumDriver
or its subclasses.
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
- Open with Visual Studio
- build solution
Nuget Deployment (for maintainers)
To Setup Nuget
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
withRelease
target.NuGet pack appium-dotnet-driver.nuspec
NuGet push Appium.WebDriver.<version>.nupkg
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. 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 Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Selenium.WebDriver (>= 4.26.1)
- System.Drawing.Common (>= 8.0.10)
NuGet packages (79)
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 (21)
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
A modern file manager that helps users organize their files and folders.
|
|
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 |
---|---|---|
6.0.1 | 17,373 | 11/15/2024 |
6.0.0 | 33,727 | 10/19/2024 |
5.2.0 | 49,916 | 9/15/2024 |
5.1.0 | 149,638 | 7/28/2024 |
5.0.0 | 78,322 | 6/15/2024 |
5.0.0-rc.8 | 26,010 | 4/26/2024 |
5.0.0-rc.7 | 35,951 | 3/29/2024 |
5.0.0-rc.6 | 23,886 | 3/3/2024 |
5.0.0-rc.5 | 46,347 | 1/26/2024 |
5.0.0-rc.4 | 53,807 | 12/29/2023 |
5.0.0-rc.3 | 2,983 | 12/24/2023 |
5.0.0-rc.2 | 124,867 | 11/16/2023 |
5.0.0-rc.1 | 83,641 | 9/6/2023 |
5.0.0-beta04 | 206,394 | 4/29/2023 |
5.0.0-beta03 | 170,893 | 1/6/2023 |
5.0.0-beta02 | 68,219 | 10/26/2022 |
5.0.0-beta01 | 341,763 | 10/21/2021 |
5.0.0-alpha2 | 72,251 | 10/19/2021 |
5.0.0-alpha | 9,075 | 10/15/2021 |
4.4.5 | 775,709 | 5/5/2023 |
4.4.0 | 460,235 | 10/26/2022 |
4.3.2 | 365,229 | 7/4/2022 |
4.3.1 | 5,275,941 | 1/14/2021 |
4.3.0 | 14,427 | 1/14/2021 |
4.2.1 | 1,040,267 | 9/19/2020 |
4.2.0 | 59,360 | 9/13/2020 |
4.1.1 | 1,832,819 | 11/19/2019 |
4.1.0 | 40,000 | 11/14/2019 |
4.0.0.6-beta | 261,779 | 4/15/2019 |
4.0.0.5-beta | 64,048 | 1/26/2019 |
4.0.0.4-beta | 222,040 | 10/15/2018 |
4.0.0.3-beta | 4,712 | 10/1/2018 |
4.0.0.2-beta | 2,033 | 9/22/2018 |
4.0.0.1-beta | 56,869 | 1/15/2018 |
4.0.0 | 238,375 | 9/2/2019 |
3.0.0.2 | 1,909,257 | 2/5/2017 |
3.0.0.1 | 116,994 | 1/5/2017 |
2.0.1.1 | 33,240 | 9/2/2016 |
2.0.0.1 | 13,023 | 7/23/2016 |
1.5.1.1 | 134,608 | 3/20/2016 |
1.5.0.1 | 49,217 | 1/5/2016 |
1.4.1.1 | 31,083 | 11/17/2015 |
1.4.0.3 | 63,023 | 8/14/2015 |
1.4.0.2 | 12,686 | 8/4/2015 |
1.3.0.1 | 13,201 | 6/19/2015 |
1.2.0.8 | 42,277 | 1/13/2015 |
1.2.0.7 | 2,632 | 1/5/2015 |
1.2.0.6 | 3,030 | 12/3/2014 |
1.2.0.5 | 11,326 | 9/25/2014 |
1.2.0.4 | 45,021 | 9/17/2014 |
1.2.0.1 | 8,231 | 7/8/2014 |
1.0.0 | 2,795 | 6/6/2014 |
0.3.0 | 2,218 | 6/3/2014 |
0.2.0 | 3,056 | 4/27/2014 |
0.1.0 | 59,673 | 4/18/2014 |