BranchesTags

Repository files navigation

appium-dotnet-client

Nuget (with prereleases)Build and deploy NuGet packageNuGet Downloads

Functional TestsUnit Tests

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.

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 ClientSelenium Binding.NET Version
8.3.24.46.0.NET Standard 2.0
8.3.04.44.0.NET Standard 2.0
8.2.04.36.0.NET Standard 2.0
7.2.04.29.0.NET Standard 2.0
7.1.04.28.0.NET Standard 2.0
7.0.04.27.0.NET Standard 2.0
6.0.14.26.1.NET Standard 2.0
6.0.04.25.0.NET Standard 2.0
5.2.04.24.0.NET 6.0, .NET Framework 4.8
5.1.04.23.0.NET 6.0, .NET Framework 4.8
5.0.04.0.0 - 4.22.0.NET 6.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 with this PR. 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 MethodNote
ToggleAirplaneMode()Change with airplaneMode parameter in mobile:setConnectivity
ToggleData()Change with data parameter in mobile:setConnectivity
ToggleWifi()Change with wifi parameter in mobile:setConnectivity
SetConnectionType()Change connection type with mobile:setConnectivity
GetConnectionType()Get connection state with mobile:getConnectivity
EndTestCoverage()Already deprecated.
StartActivityWithIntent(), StartActivity()Use mobile:startActivity to start an expected activity
  • Removed strategy argument in HideKeyboard because the argument was only for outdated old 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

Additional Information

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

Migration Guide to W3C actions

usingOpenQA.Selenium.Interactions;vartouch=newPointerInputDevice(PointerKind.Touch,"finger");varsequence=newActionSequence(touch);varmove=touch.CreatePointerMove(elementToTouch,elementToTouch.Location.X,elementToTouch.Location.Y,TimeSpan.FromSeconds(1));varactionPress=touch.CreatePointerDown(MouseButton.Touch);varpause=touch.CreatePause(TimeSpan.FromMilliseconds(250));varactionRelease=touch.CreatePointerUp(MouseButton.Touch);sequence.AddAction(move);sequence.AddAction(actionPress);sequence.AddAction(pause);sequence.AddAction(actionRelease);varactions_seq=newList<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.
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
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:

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

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

About

.NET C# bindings for Appium, extending the Selenium .NET library

Topics

appiumcsharpdotnet

Resources

Readme
Apache-2.0 license

Code of conduct

Code of conduct

Contributing

Contributing

Security policy

Security policy
Activity
Custom properties

Stars

398 stars

Watchers

45 watching

Forks

184 forks
Report repository

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
BranchesTags
Repository files navigation
appium-dotnet-client
Nuget (with prereleases)Build and deploy NuGet packageNuGet Downloads
Functional TestsUnit Tests
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.
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 ClientSelenium Binding.NET Version
8.3.24.46.0.NET Standard 2.0
8.3.04.44.0.NET Standard 2.0
8.2.04.36.0.NET Standard 2.0
7.2.04.29.0.NET Standard 2.0
7.1.04.28.0.NET Standard 2.0
7.0.04.27.0.NET Standard 2.0
6.0.14.26.1.NET Standard 2.0
6.0.04.25.0.NET Standard 2.0
5.2.04.24.0.NET 6.0, .NET Framework 4.8
5.1.04.23.0.NET 6.0, .NET Framework 4.8
5.0.04.0.0 - 4.22.0.NET 6.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 with this PR. 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 MethodNote
ToggleAirplaneMode()Change with airplaneMode parameter in mobile:setConnectivity
ToggleData()Change with data parameter in mobile:setConnectivity
ToggleWifi()Change with wifi parameter in mobile:setConnectivity
SetConnectionType()Change connection type with mobile:setConnectivity
GetConnectionType()Get connection state with mobile:getConnectivity
EndTestCoverage()Already deprecated.
StartActivityWithIntent(), StartActivity()Use mobile:startActivity to start an expected activity
  • Removed strategy argument in HideKeyboard because the argument was only for outdated old 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
Additional Information
W3C Actions: https://www.selenium.dev/documentation/webdriver/actions_api

App management: Please read issue #15807 for more details
Migration Guide to W3C actions
usingOpenQA.Selenium.Interactions;vartouch=newPointerInputDevice(PointerKind.Touch,"finger");varsequence=newActionSequence(touch);varmove=touch.CreatePointerMove(elementToTouch,elementToTouch.Location.X,elementToTouch.Location.Y,TimeSpan.FromSeconds(1));varactionPress=touch.CreatePointerDown(MouseButton.Touch);varpause=touch.CreatePause(TimeSpan.FromMilliseconds(250));varactionRelease=touch.CreatePointerUp(MouseButton.Touch);sequence.AddAction(move);sequence.AddAction(actionPress);sequence.AddAction(pause);sequence.AddAction(actionRelease);varactions_seq=newList<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. 

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

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:
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
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
About
.NET C# bindings for Appium, extending the Selenium .NET library
Topics
appiumcsharpdotnet
Resources
Readme
Apache-2.0 license
Code of conduct
Code of conduct
Contributing
Contributing
Security policy
Security policy
Activity
Custom properties
Stars
398 stars
Watchers
45 watching
Forks
184 forks
Report repository
Releases
Packages
Used by
Contributors
Languages

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
BranchesTags
Repository files navigation
appium-dotnet-client
Nuget (with prereleases)Build and deploy NuGet packageNuGet Downloads
Functional TestsUnit Tests
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.
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 ClientSelenium Binding.NET Version
8.3.24.46.0.NET Standard 2.0
8.3.04.44.0.NET Standard 2.0
8.2.04.36.0.NET Standard 2.0
7.2.04.29.0.NET Standard 2.0
7.1.04.28.0.NET Standard 2.0
7.0.04.27.0.NET Standard 2.0
6.0.14.26.1.NET Standard 2.0
6.0.04.25.0.NET Standard 2.0
5.2.04.24.0.NET 6.0, .NET Framework 4.8
5.1.04.23.0.NET 6.0, .NET Framework 4.8
5.0.04.0.0 - 4.22.0.NET 6.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 with this PR. 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 MethodNote
ToggleAirplaneMode()Change with airplaneMode parameter in mobile:setConnectivity
ToggleData()Change with data parameter in mobile:setConnectivity
ToggleWifi()Change with wifi parameter in mobile:setConnectivity
SetConnectionType()Change connection type with mobile:setConnectivity
GetConnectionType()Get connection state with mobile:getConnectivity
EndTestCoverage()Already deprecated.
StartActivityWithIntent(), StartActivity()Use mobile:startActivity to start an expected activity
  • Removed strategy argument in HideKeyboard because the argument was only for outdated old 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
Additional Information
W3C Actions: https://www.selenium.dev/documentation/webdriver/actions_api

App management: Please read issue #15807 for more details
Migration Guide to W3C actions
usingOpenQA.Selenium.Interactions;vartouch=newPointerInputDevice(PointerKind.Touch,"finger");varsequence=newActionSequence(touch);varmove=touch.CreatePointerMove(elementToTouch,elementToTouch.Location.X,elementToTouch.Location.Y,TimeSpan.FromSeconds(1));varactionPress=touch.CreatePointerDown(MouseButton.Touch);varpause=touch.CreatePause(TimeSpan.FromMilliseconds(250));varactionRelease=touch.CreatePointerUp(MouseButton.Touch);sequence.AddAction(move);sequence.AddAction(actionPress);sequence.AddAction(pause);sequence.AddAction(actionRelease);varactions_seq=newList<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. 

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

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:
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
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
About
.NET C# bindings for Appium, extending the Selenium .NET library
Topics
appiumcsharpdotnet
Resources
Readme
Apache-2.0 license
Code of conduct
Code of conduct
Contributing
Contributing
Security policy
Security policy
Activity
Custom properties
Stars
398 stars
Watchers
45 watching
Forks
184 forks
Report repository
Releases
Packages
Used by
Contributors
Languages

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
BranchesTags
Repository files navigation
appium-dotnet-client
Nuget (with prereleases)Build and deploy NuGet packageNuGet Downloads
Functional TestsUnit Tests
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.
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 ClientSelenium Binding.NET Version
8.3.24.46.0.NET Standard 2.0
8.3.04.44.0.NET Standard 2.0
8.2.04.36.0.NET Standard 2.0
7.2.04.29.0.NET Standard 2.0
7.1.04.28.0.NET Standard 2.0
7.0.04.27.0.NET Standard 2.0
6.0.14.26.1.NET Standard 2.0
6.0.04.25.0.NET Standard 2.0
5.2.04.24.0.NET 6.0, .NET Framework 4.8
5.1.04.23.0.NET 6.0, .NET Framework 4.8
5.0.04.0.0 - 4.22.0.NET 6.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 with this PR. 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 MethodNote
ToggleAirplaneMode()Change with airplaneMode parameter in mobile:setConnectivity
ToggleData()Change with data parameter in mobile:setConnectivity
ToggleWifi()Change with wifi parameter in mobile:setConnectivity
SetConnectionType()Change connection type with mobile:setConnectivity
GetConnectionType()Get connection state with mobile:getConnectivity
EndTestCoverage()Already deprecated.
StartActivityWithIntent(), StartActivity()Use mobile:startActivity to start an expected activity
  • Removed strategy argument in HideKeyboard because the argument was only for outdated old 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
Additional Information
W3C Actions: https://www.selenium.dev/documentation/webdriver/actions_api

App management: Please read issue #15807 for more details
Migration Guide to W3C actions
usingOpenQA.Selenium.Interactions;vartouch=newPointerInputDevice(PointerKind.Touch,"finger");varsequence=newActionSequence(touch);varmove=touch.CreatePointerMove(elementToTouch,elementToTouch.Location.X,elementToTouch.Location.Y,TimeSpan.FromSeconds(1));varactionPress=touch.CreatePointerDown(MouseButton.Touch);varpause=touch.CreatePause(TimeSpan.FromMilliseconds(250));varactionRelease=touch.CreatePointerUp(MouseButton.Touch);sequence.AddAction(move);sequence.AddAction(actionPress);sequence.AddAction(pause);sequence.AddAction(actionRelease);varactions_seq=newList<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. 

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

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:
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
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
About
.NET C# bindings for Appium, extending the Selenium .NET library
Topics
appiumcsharpdotnet
Resources
Readme
Apache-2.0 license
Code of conduct
Code of conduct
Contributing
Contributing
Security policy
Security policy
Activity
Custom properties
Stars
398 stars
Watchers
45 watching
Forks
184 forks
Report repository
Releases
Packages
Used by
Contributors
Languages

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
BranchesTags
Repository files navigation
appium-dotnet-client
Nuget (with prereleases)Build and deploy NuGet packageNuGet Downloads
Functional TestsUnit Tests
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.
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 ClientSelenium Binding.NET Version
8.3.24.46.0.NET Standard 2.0
8.3.04.44.0.NET Standard 2.0
8.2.04.36.0.NET Standard 2.0
7.2.04.29.0.NET Standard 2.0
7.1.04.28.0.NET Standard 2.0
7.0.04.27.0.NET Standard 2.0
6.0.14.26.1.NET Standard 2.0
6.0.04.25.0.NET Standard 2.0
5.2.04.24.0.NET 6.0, .NET Framework 4.8
5.1.04.23.0.NET 6.0, .NET Framework 4.8
5.0.04.0.0 - 4.22.0.NET 6.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 with this PR. 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 MethodNote
ToggleAirplaneMode()Change with airplaneMode parameter in mobile:setConnectivity
ToggleData()Change with data parameter in mobile:setConnectivity
ToggleWifi()Change with wifi parameter in mobile:setConnectivity
SetConnectionType()Change connection type with mobile:setConnectivity
GetConnectionType()Get connection state with mobile:getConnectivity
EndTestCoverage()Already deprecated.
StartActivityWithIntent(), StartActivity()Use mobile:startActivity to start an expected activity
  • Removed strategy argument in HideKeyboard because the argument was only for outdated old 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
Additional Information
W3C Actions: https://www.selenium.dev/documentation/webdriver/actions_api

App management: Please read issue #15807 for more details
Migration Guide to W3C actions
usingOpenQA.Selenium.Interactions;vartouch=newPointerInputDevice(PointerKind.Touch,"finger");varsequence=newActionSequence(touch);varmove=touch.CreatePointerMove(elementToTouch,elementToTouch.Location.X,elementToTouch.Location.Y,TimeSpan.FromSeconds(1));varactionPress=touch.CreatePointerDown(MouseButton.Touch);varpause=touch.CreatePause(TimeSpan.FromMilliseconds(250));varactionRelease=touch.CreatePointerUp(MouseButton.Touch);sequence.AddAction(move);sequence.AddAction(actionPress);sequence.AddAction(pause);sequence.AddAction(actionRelease);varactions_seq=newList<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. 

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

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:
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
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
About
.NET C# bindings for Appium, extending the Selenium .NET library
Topics
appiumcsharpdotnet
Resources
Readme
Apache-2.0 license
Code of conduct
Code of conduct
Contributing
Contributing
Security policy
Security policy
Activity
Custom properties
Stars
398 stars
Watchers
45 watching
Forks
184 forks
Report repository
Releases
Packages
Used by
Contributors
Languages

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
BranchesTags
Repository files navigation
appium-dotnet-client
Nuget (with prereleases)Build and deploy NuGet packageNuGet Downloads
Functional TestsUnit Tests
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.
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 ClientSelenium Binding.NET Version
8.3.24.46.0.NET Standard 2.0
8.3.04.44.0.NET Standard 2.0
8.2.04.36.0.NET Standard 2.0
7.2.04.29.0.NET Standard 2.0
7.1.04.28.0.NET Standard 2.0
7.0.04.27.0.NET Standard 2.0
6.0.14.26.1.NET Standard 2.0
6.0.04.25.0.NET Standard 2.0
5.2.04.24.0.NET 6.0, .NET Framework 4.8
5.1.04.23.0.NET 6.0, .NET Framework 4.8
5.0.04.0.0 - 4.22.0.NET 6.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 with this PR. 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 MethodNote
ToggleAirplaneMode()Change with airplaneMode parameter in mobile:setConnectivity
ToggleData()Change with data parameter in mobile:setConnectivity
ToggleWifi()Change with wifi parameter in mobile:setConnectivity
SetConnectionType()Change connection type with mobile:setConnectivity
GetConnectionType()Get connection state with mobile:getConnectivity
EndTestCoverage()Already deprecated.
StartActivityWithIntent(), StartActivity()Use mobile:startActivity to start an expected activity
  • Removed strategy argument in HideKeyboard because the argument was only for outdated old 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
Additional Information
W3C Actions: https://www.selenium.dev/documentation/webdriver/actions_api

App management: Please read issue #15807 for more details
Migration Guide to W3C actions
usingOpenQA.Selenium.Interactions;vartouch=newPointerInputDevice(PointerKind.Touch,"finger");varsequence=newActionSequence(touch);varmove=touch.CreatePointerMove(elementToTouch,elementToTouch.Location.X,elementToTouch.Location.Y,TimeSpan.FromSeconds(1));varactionPress=touch.CreatePointerDown(MouseButton.Touch);varpause=touch.CreatePause(TimeSpan.FromMilliseconds(250));varactionRelease=touch.CreatePointerUp(MouseButton.Touch);sequence.AddAction(move);sequence.AddAction(actionPress);sequence.AddAction(pause);sequence.AddAction(actionRelease);varactions_seq=newList<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. 

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

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:
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
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
About
.NET C# bindings for Appium, extending the Selenium .NET library
Topics
appiumcsharpdotnet
Resources
Readme
Apache-2.0 license
Code of conduct
Code of conduct
Contributing
Contributing
Security policy
Security policy
Activity
Custom properties
Stars
398 stars
Watchers
45 watching
Forks
184 forks
Report repository
Releases
Packages
Used by
Contributors
Languages

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
BranchesTags
Repository files navigation
appium-dotnet-client
Nuget (with prereleases)Build and deploy NuGet packageNuGet Downloads
Functional TestsUnit Tests
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.
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 ClientSelenium Binding.NET Version
8.3.24.46.0.NET Standard 2.0
8.3.04.44.0.NET Standard 2.0
8.2.04.36.0.NET Standard 2.0
7.2.04.29.0.NET Standard 2.0
7.1.04.28.0.NET Standard 2.0
7.0.04.27.0.NET Standard 2.0
6.0.14.26.1.NET Standard 2.0
6.0.04.25.0.NET Standard 2.0
5.2.04.24.0.NET 6.0, .NET Framework 4.8
5.1.04.23.0.NET 6.0, .NET Framework 4.8
5.0.04.0.0 - 4.22.0.NET 6.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 with this PR. 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 MethodNote
ToggleAirplaneMode()Change with airplaneMode parameter in mobile:setConnectivity
ToggleData()Change with data parameter in mobile:setConnectivity
ToggleWifi()Change with wifi parameter in mobile:setConnectivity
SetConnectionType()Change connection type with mobile:setConnectivity
GetConnectionType()Get connection state with mobile:getConnectivity
EndTestCoverage()Already deprecated.
StartActivityWithIntent(), StartActivity()Use mobile:startActivity to start an expected activity
  • Removed strategy argument in HideKeyboard because the argument was only for outdated old 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
Additional Information
W3C Actions: https://www.selenium.dev/documentation/webdriver/actions_api

App management: Please read issue #15807 for more details
Migration Guide to W3C actions
usingOpenQA.Selenium.Interactions;vartouch=newPointerInputDevice(PointerKind.Touch,"finger");varsequence=newActionSequence(touch);varmove=touch.CreatePointerMove(elementToTouch,elementToTouch.Location.X,elementToTouch.Location.Y,TimeSpan.FromSeconds(1));varactionPress=touch.CreatePointerDown(MouseButton.Touch);varpause=touch.CreatePause(TimeSpan.FromMilliseconds(250));varactionRelease=touch.CreatePointerUp(MouseButton.Touch);sequence.AddAction(move);sequence.AddAction(actionPress);sequence.AddAction(pause);sequence.AddAction(actionRelease);varactions_seq=newList<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. 

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

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:
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
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
About
.NET C# bindings for Appium, extending the Selenium .NET library
Topics
appiumcsharpdotnet
Resources
Readme
Apache-2.0 license
Code of conduct
Code of conduct
Contributing
Contributing
Security policy
Security policy
Activity
Custom properties
Stars
398 stars
Watchers
45 watching
Forks
184 forks
Report repository
Releases
Packages
Used by
Contributors
Languages

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
BranchesTags
Repository files navigation
appium-dotnet-client
Nuget (with prereleases)Build and deploy NuGet packageNuGet Downloads
Functional TestsUnit Tests
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.
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 ClientSelenium Binding.NET Version
8.3.24.46.0.NET Standard 2.0
8.3.04.44.0.NET Standard 2.0
8.2.04.36.0.NET Standard 2.0
7.2.04.29.0.NET Standard 2.0
7.1.04.28.0.NET Standard 2.0
7.0.04.27.0.NET Standard 2.0
6.0.14.26.1.NET Standard 2.0
6.0.04.25.0.NET Standard 2.0
5.2.04.24.0.NET 6.0, .NET Framework 4.8
5.1.04.23.0.NET 6.0, .NET Framework 4.8
5.0.04.0.0 - 4.22.0.NET 6.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 with this PR. 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 MethodNote
ToggleAirplaneMode()Change with airplaneMode parameter in mobile:setConnectivity
ToggleData()Change with data parameter in mobile:setConnectivity
ToggleWifi()Change with wifi parameter in mobile:setConnectivity
SetConnectionType()Change connection type with mobile:setConnectivity
GetConnectionType()Get connection state with mobile:getConnectivity
EndTestCoverage()Already deprecated.
StartActivityWithIntent(), StartActivity()Use mobile:startActivity to start an expected activity
  • Removed strategy argument in HideKeyboard because the argument was only for outdated old 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
Additional Information
W3C Actions: https://www.selenium.dev/documentation/webdriver/actions_api

App management: Please read issue #15807 for more details
Migration Guide to W3C actions
usingOpenQA.Selenium.Interactions;vartouch=newPointerInputDevice(PointerKind.Touch,"finger");varsequence=newActionSequence(touch);varmove=touch.CreatePointerMove(elementToTouch,elementToTouch.Location.X,elementToTouch.Location.Y,TimeSpan.FromSeconds(1));varactionPress=touch.CreatePointerDown(MouseButton.Touch);varpause=touch.CreatePause(TimeSpan.FromMilliseconds(250));varactionRelease=touch.CreatePointerUp(MouseButton.Touch);sequence.AddAction(move);sequence.AddAction(actionPress);sequence.AddAction(pause);sequence.AddAction(actionRelease);varactions_seq=newList<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. 

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

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:
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
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
About
.NET C# bindings for Appium, extending the Selenium .NET library
Topics
appiumcsharpdotnet
Resources
Readme
Apache-2.0 license
Code of conduct
Code of conduct
Contributing
Contributing
Security policy
Security policy
Activity
Custom properties
Stars
398 stars
Watchers
45 watching
Forks
184 forks
Report repository
Releases
Packages
Used by
Contributors
Languages