https://github.com/appium/dotnet-client
Extension to the official Selenium dotnet webdriver
https://github.com/appium/dotnet-client
Last synced: 3 months ago
JSON representation
Extension to the official Selenium dotnet webdriver
- Host: GitHub
- URL: https://github.com/appium/dotnet-client
- Owner: appium
- License: apache-2.0
- Created: 2014-04-14T15:56:33.000Z (about 12 years ago)
- Default Branch: main
- Last Pushed: 2026-04-02T01:00:31.000Z (3 months ago)
- Last Synced: 2026-04-05T11:02:20.008Z (3 months ago)
- Language: C#
- Homepage:
- Size: 51.8 MB
- Stars: 398
- Watchers: 45
- Forks: 185
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.MD
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Notice: NOTICE
Awesome Lists containing this project
README
# appium-dotnet-client
[](https://www.nuget.org/packages/Appium.WebDriver/absoluteLatest)
[](https://github.com/appium/dotnet-client/actions/workflows/release-nuget.yml)
[](https://www.nuget.org/packages/Appium.Webdriver)
----
[](https://github.com/appium/dotnet-client/actions/workflows/functional-test.yml)
[](https://github.com/appium/dotnet-client/actions/workflows/functional-android-test.yml)
[](https://github.com/appium/dotnet-client/actions/workflows/functional-ios-test.yml)
[](https://github.com/appium/dotnet-client/actions/workflows/unit-test.yml)
----
[](https://github.com/appium/dotnet-client/issues?q=is%3Aopen+is%3Aissue+label%3AHelpWanted)
[](https://opensource.org/licenses/Apache-2.0)
This driver is an extension of the [Selenium](http://docs.seleniumhq.org/) 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](https://www.nuget.org/packages/Selenium.WebDriver), 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 |
|----|----|----|
|`8.0.1` |`4.36.0` |.NET Standard 2.0 |
|`7.0.0` |`4.27.0` |.NET Standard 2.0 |
|`6.0.0` |`4.25.0` |.NET Standard 2.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 |
> [!Note]
> We only raise the minimum required Selenium.WebDriver version when a newer Selenium release introduces changes that require updates in the Appium .NET Client.
> If you need deterministic builds, we recommend pinning the Selenium.WebDriver version in your own project.
## v8
To keep compatibility with Appium v3, most deprecated endpoint method calls have been replaced with compatible [extension command](https://appium.io/docs/en/latest/guides/execute-methods/) with [this PR](https://github.com/appium/dotnet-client/pull/939). Old drivers which still haven't implemented extension commands might not have proper implementation. Then, you will need to update Appium driver versions first.
| Removed Method | Note |
|---------------------------|------|
| `ToggleAirplaneMode()` | Change with `airplaneMode` parameter in [mobile:setConnectivity](https://github.com/appium/appium-uiautomator2-driver#mobile-setconnectivity) |
| `ToggleData()` | Change with `data` parameter in [mobile:setConnectivity](https://github.com/appium/appium-uiautomator2-driver#mobile-setconnectivity) |
| `ToggleWifi()` | Change with `wifi` parameter in [mobile:setConnectivity](https://github.com/appium/appium-uiautomator2-driver#mobile-setconnectivity) |
| `SetConnectionType()` | Change connection type with [mobile:setConnectivity](https://github.com/appium/appium-uiautomator2-driver#mobile-setconnectivity) |
| `GetConnectionType()` | Get connection state with [mobile:getConnectivity](https://github.com/appium/appium-uiautomator2-driver#mobile-getconnectivity) |
| `EndTestCoverage()` | Already deprecated. |
| `StartActivityWithIntent()`, `StartActivity()` | Use [mobile:startActivity](https://github.com/appium/appium-uiautomator2-driver#mobile-startactivity) to start an expected activity |
- Removed `strategy` argument in `HideKeyboard` because the argument was only for outdated [old ios driver](https://github.com/appium-boneyard/appium-ios-driver)
## 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.
> Regardless, moving to appium 2.x is highly recommended since appium 1.x is no longer maintained.
> For more details about how to migrate to 2.x, see the following link : [appium 2.x migrating](https://appium.github.io/appium/docs/en/2.0/guides/migrating-1-to-2/)
#### Additional Information
W3C Actions: https://www.selenium.dev/documentation/webdriver/actions_api
App management: Please read [issue #15807](https://github.com/appium/appium/issues/15807) for more details
### Migration Guide to W3C actions
```csharp
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
{
sequence
};
_driver.PerformActions(actions_seq);
```
### WinAppDriver Notice!
> [!WARNING]
> Because [WinAppDriver](https://github.com/microsoft/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.
> To run appium on Windows Applications, you will need to use [appium-windows-driver](https://github.com/appium/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](https://github.com/appium/dotnet-client/tree/release/5.0.0/test/integration/Windows)
> Regardless, feel free to open an issue on the [WAD](https://github.com/microsoft/WinAppDriver/issues) repository that will help get MS to open-source that project.
## NuGet
[NuGet Package](http://www.nuget.org/packages/Appium.WebDriver/)
Dependencies:
- [Selenium.WebDriver](http://www.nuget.org/packages/Selenium.WebDriver/)
- [System.Drawing.Common](https://www.nuget.org/packages/System.Drawing.Common/)
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.
[Read Wiki](https://github.com/appium/appium-dotnet-driver/wiki)
[See samples here](https://github.com/appium/sample-code/tree/master/sample-code/examples/dotnet/AppiumDotNetSample)
## Dev Build+Test
Xamarin/Mono
- Open with [Xamarin](http://xamarin.com/)
- `Rebuild all`
- `Run tests in test/specs`
JetBrains Rider
- Open with [Rider](https://www.jetbrains.com/rider/)
- From the menu `Build -> Rebuild Solution`
- Run tests in Appium.Net.Integration.Tests
Visual Studio
- Open with [Visual Studio](https://www.visualstudio.com/)
- build solution
## Nuget Deployment (for maintainers)
### To Setup Nuget
- Download [Nuget exe](http://nuget.org/nuget.exe).
- Setup the Api Key ([see here](http://docs.nuget.org/docs/creating-packages/creating-and-publishing-a-package#api-key)).
- `alias NuGet='mono /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..nupkg`